Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.controls
Interface IMapControl2

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
IMapControl3, IMapControl4
All Known Implementing Classes:
IMapControl2Proxy, IMapControl3Proxy, IMapControl4Proxy, MapBean, MapControl
public interface IMapControl2
extends java.io.Serializable

COM Interface 'IMapControl2'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to members that control the MapControl.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary
static java.lang.String DISPID__501_GET_NAME
           
static java.lang.String DISPID__501_PUT_NAME
           
static java.lang.String DISPID__504_GET_NAME
           
static java.lang.String DISPID__504_PUT_NAME
           
static java.lang.String DISPID__514_GET_NAME
           
static java.lang.String DISPID__514_PUT_NAME
           
static java.lang.String DISPID__515_GET_NAME
           
static java.lang.String DISPID__520_GET_NAME
           
static java.lang.String DISPID__520_PUT_NAME
           
static java.lang.String DISPID__521_GET_NAME
           
static java.lang.String DISPID__521_PUT_NAME
           
static java.lang.String DISPID__522_GET_NAME
           
static java.lang.String DISPID__522_PUTREF_NAME
           
static java.lang.String DISPID__552_NAME
           
static java.lang.String DISPID_1_GET_NAME
           
static java.lang.String DISPID_1_PUTREF_NAME
           
static java.lang.String DISPID_10_GET_NAME
           
static java.lang.String DISPID_10_PUT_NAME
           
static java.lang.String DISPID_13_GET_NAME
           
static java.lang.String DISPID_13_PUT_NAME
           
static java.lang.String DISPID_14_GET_NAME
           
static java.lang.String DISPID_14_PUTREF_NAME
           
static java.lang.String DISPID_15_NAME
           
static java.lang.String DISPID_16_NAME
           
static java.lang.String DISPID_17_NAME
           
static java.lang.String DISPID_18_NAME
           
static java.lang.String DISPID_19_NAME
           
static java.lang.String DISPID_2_GET_NAME
           
static java.lang.String DISPID_20_NAME
           
static java.lang.String DISPID_21_NAME
           
static java.lang.String DISPID_22_NAME
           
static java.lang.String DISPID_23_NAME
           
static java.lang.String DISPID_24_NAME
           
static java.lang.String DISPID_25_NAME
           
static java.lang.String DISPID_26_NAME
           
static java.lang.String DISPID_27_NAME
           
static java.lang.String DISPID_28_NAME
           
static java.lang.String DISPID_29_NAME
           
static java.lang.String DISPID_3_GET_NAME
           
static java.lang.String DISPID_30_NAME
           
static java.lang.String DISPID_31_NAME
           
static java.lang.String DISPID_32_NAME
           
static java.lang.String DISPID_33_NAME
           
static java.lang.String DISPID_34_NAME
           
static java.lang.String DISPID_35_NAME
           
static java.lang.String DISPID_37_GET_NAME
           
static java.lang.String DISPID_37_PUT_NAME
           
static java.lang.String DISPID_38_GET_NAME
           
static java.lang.String DISPID_38_PUT_NAME
           
static java.lang.String DISPID_39_GET_NAME
           
static java.lang.String DISPID_39_PUT_NAME
           
static java.lang.String DISPID_4_GET_NAME
           
static java.lang.String DISPID_40_GET_NAME
           
static java.lang.String DISPID_40_PUTREF_NAME
           
static java.lang.String DISPID_5_GET_NAME
           
static java.lang.String DISPID_5_PUT_NAME
           
static java.lang.String DISPID_6_GET_NAME
           
static java.lang.String DISPID_6_PUT_NAME
           
static java.lang.String DISPID_7_GET_NAME
           
static java.lang.String DISPID_7_PUT_NAME
           
static java.lang.String DISPID_8_PUT_NAME
           
static java.lang.String DISPID_9_GET_NAME
           
static java.lang.String DISPID_9_PUTREF_NAME
           
static java.lang.String IID
          Deprecated. Internal use only
static int IID423dbca0_b7e6_11d5_a9de_00104bb6fc1c
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void aboutBox()
          Displays a dialog of information about the MapControl.
 void addLayer(ILayer layer, int toIndex)
          Adds a layer to the Map's collection of layers at the specified index position.
 void addLayerFromFile(java.lang.String lyrPath, int toIndex)
          Loads a layer file and adds it to the Map's collection of layers at the specified index position.
 void addShapeFile(java.lang.String path, java.lang.String fileName)
          Adds a shapefile as a layer to the Map.
 void centerAt(IPoint centerPoint)
          Moves the center of the MapControl to the specified location.
 boolean checkMxFile(java.lang.String fileName)
          Checks the specified filename to see if it is a map document that can be loaded into the MapControl.
 void clearLayers()
          Removes all layers from the Map.
 void deleteLayer(int index)
          Removes a Layer from the Map's collection of layers at the specified index position.
 void drawShape(IGeometry shape, java.lang.Object symbol)
          Draws a geometry shape on the MapControl.
 void drawText(IGeometry pGeometry, java.lang.String text, java.lang.Object pSymbol)
          Draws text along the supplied geometry.
 boolean esri_isEnabled()
          Indicates whether the MapControl can respond to user generated events.
 void esri_setEnabled(boolean enabled)
          Indicates whether the MapControl can respond to user generated events.
 void flashShape(IGeometry pShape, int nFlashes, int flashInterval, java.lang.Object symbol)
          Flashes a shape on the MapControl, duration is in milliseconds.
 void fromMapPoint(IPoint pt, int[] x, int[] y)
          Converts a point on the Map (in map units) to device co-ordinates (typically pixels).
 IActiveView getActiveView()
          The active view of the Map contained by the MapControl.
 int getAppearance()
          The appearance of the MapControl.
 int getBackColor()
          Background color of the MapControl.
 int getBorderStyle()
          The border style of the MapControl.
 ITool getCurrentTool()
          Current active tool for the MapControl.
 IEnvelope getExtent()
          Current extent of the Map in map units.
 IEnvelope getFullExtent()
          Rectangular shape that encloses all features of all layers in the Map.
 int getHWnd()
          Handle to the window associated with the MapControl.
 ILayer getLayer(int index)
          Layer at the supplied index.
 int getLayerCount()
          Number of layers in the Map.
 IMap getMap()
          The Map contained by the MapControl.
 double getMapScale()
          Scale of the map as a representative fraction.
 int getMapUnits()
          The geographical units of the map.
 Picture getMouseIcon()
          Custom mouse icon used if MousePointer is 99.
 int getMousePointer()
          The mouse pointer displayed over the MapControl.
 double getReferenceScale()
          Reference scale of the Map as a representative fraction.
 double getRotation()
          Determines how many degrees the map display is rotated.
 ISpatialReference getSpatialReference()
          Spatial reference of the Map.
 ITrackCancel getTrackCancel()
          The object used by the MapControl to check if drawing has been aborted.
 boolean isOleDropEnabled()
          Indicates if the MapControl will fire events when data is dragged over the control's window.
 boolean isShowScrollbars()
          Indicates whether or not the Map's scrollbars are visible.
 void loadMxFile(java.lang.String mxPath, java.lang.Object mapNameOrIndex, java.lang.Object password)
          Loads the specified Map from the map document into the MapControl.
 void moveLayerTo(int fromIndex, int toIndex)
          Moves a layer within the Map's collection from its current index position to a new index position.
 void pan()
          Tracks the mouse while panning the MapControl.
 IArray readMxMaps(java.lang.String fileName, java.lang.Object password)
          Opens a map document specified by the supplied filename and reads the maps into an array object.
 void refresh(int phase, java.lang.Object layerOrElement, java.lang.Object envelope)
          Redraws the Map, optionally just redraw specified phases or envelope.
 void setAppearance(int appearance)
          The appearance of the MapControl.
 void setBackColor(int backColor)
          Background color of the MapControl.
 void setBorderStyle(int borderStyle)
          The border style of the MapControl.
 void setCurrentToolByRef(ITool pTool)
          Current active tool for the MapControl.
 void setExtent(IEnvelope extent)
          Current extent of the Map in map units.
 void setFullExtent(IEnvelope fullExtent)
          Rectangular shape that encloses all features of all layers in the Map.
 void setMapByRef(IMap pMap)
          The Map contained by the MapControl.
 void setMapScale(double mapScale)
          Scale of the map as a representative fraction.
 void setMapUnits(int units)
          The geographical units of the map.
 void setMouseIconByRef(Picture mouseIcon)
          Custom mouse icon used if MousePointer is 99.
 void setMousePointer(int mousePointer)
          The mouse pointer displayed over the MapControl.
 void setOleDropEnabled(boolean enabled)
          Indicates if the MapControl will fire events when data is dragged over the control's window.
 void setReferenceScale(double referenceScale)
          Reference scale of the Map as a representative fraction.
 void setRotation(double rotation)
          Determines how many degrees the map display is rotated.
 void setShowScrollbars(boolean showScrollbars)
          Indicates whether or not the Map's scrollbars are visible.
 void setSpatialReferenceByRef(ISpatialReference spRef)
          Spatial reference of the Map.
 void setTrackCancelByRef(ITrackCancel ppTrackCancel)
          The object used by the MapControl to check if drawing has been aborted.
 void setVisibleRegion(IGeometry rhs1)
          The geometry specifying the visible region of the Map.
 IPoint toMapPoint(int x, int y)
          Converts a point in device co-ordinates (typically pixels) to a point on the Map (in map units).
 IGeometry trackCircle()
          Rubber-bands a circle on the MapControl.
 IGeometry trackLine()
          Rubber-bands a polyline on the MapControl.
 IGeometry trackPolygon()
          Rubber-bands a polygon on the MapControl.
 IEnvelope trackRectangle()
          Rubber-bands a rectangle on the MapControl.
 

Field Detail

IID423dbca0_b7e6_11d5_a9de_00104bb6fc1c

static final int IID423dbca0_b7e6_11d5_a9de_00104bb6fc1c
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values

DISPID__515_GET_NAME

static final java.lang.String DISPID__515_GET_NAME
See Also:
Constant Field Values

DISPID__501_PUT_NAME

static final java.lang.String DISPID__501_PUT_NAME
See Also:
Constant Field Values

DISPID__501_GET_NAME

static final java.lang.String DISPID__501_GET_NAME
See Also:
Constant Field Values

DISPID__521_PUT_NAME

static final java.lang.String DISPID__521_PUT_NAME
See Also:
Constant Field Values

DISPID__521_GET_NAME

static final java.lang.String DISPID__521_GET_NAME
See Also:
Constant Field Values

DISPID__522_PUTREF_NAME

static final java.lang.String DISPID__522_PUTREF_NAME
See Also:
Constant Field Values

DISPID__522_GET_NAME

static final java.lang.String DISPID__522_GET_NAME
See Also:
Constant Field Values

DISPID__504_PUT_NAME

static final java.lang.String DISPID__504_PUT_NAME
See Also:
Constant Field Values

DISPID__504_GET_NAME

static final java.lang.String DISPID__504_GET_NAME
See Also:
Constant Field Values

DISPID__514_PUT_NAME

static final java.lang.String DISPID__514_PUT_NAME
See Also:
Constant Field Values

DISPID__514_GET_NAME

static final java.lang.String DISPID__514_GET_NAME
See Also:
Constant Field Values

DISPID__520_PUT_NAME

static final java.lang.String DISPID__520_PUT_NAME
See Also:
Constant Field Values

DISPID__520_GET_NAME

static final java.lang.String DISPID__520_GET_NAME
See Also:
Constant Field Values

DISPID__552_NAME

static final java.lang.String DISPID__552_NAME
See Also:
Constant Field Values

DISPID_1_PUTREF_NAME

static final java.lang.String DISPID_1_PUTREF_NAME
See Also:
Constant Field Values

DISPID_1_GET_NAME

static final java.lang.String DISPID_1_GET_NAME
See Also:
Constant Field Values

DISPID_2_GET_NAME

static final java.lang.String DISPID_2_GET_NAME
See Also:
Constant Field Values

DISPID_3_GET_NAME

static final java.lang.String DISPID_3_GET_NAME
See Also:
Constant Field Values

DISPID_4_GET_NAME

static final java.lang.String DISPID_4_GET_NAME
See Also:
Constant Field Values

DISPID_5_GET_NAME

static final java.lang.String DISPID_5_GET_NAME
See Also:
Constant Field Values

DISPID_5_PUT_NAME

static final java.lang.String DISPID_5_PUT_NAME
See Also:
Constant Field Values

DISPID_6_GET_NAME

static final java.lang.String DISPID_6_GET_NAME
See Also:
Constant Field Values

DISPID_6_PUT_NAME

static final java.lang.String DISPID_6_PUT_NAME
See Also:
Constant Field Values

DISPID_7_GET_NAME

static final java.lang.String DISPID_7_GET_NAME
See Also:
Constant Field Values

DISPID_7_PUT_NAME

static final java.lang.String DISPID_7_PUT_NAME
See Also:
Constant Field Values

DISPID_8_PUT_NAME

static final java.lang.String DISPID_8_PUT_NAME
See Also:
Constant Field Values

DISPID_9_GET_NAME

static final java.lang.String DISPID_9_GET_NAME
See Also:
Constant Field Values

DISPID_9_PUTREF_NAME

static final java.lang.String DISPID_9_PUTREF_NAME
See Also:
Constant Field Values

DISPID_10_GET_NAME

static final java.lang.String DISPID_10_GET_NAME
See Also:
Constant Field Values

DISPID_10_PUT_NAME

static final java.lang.String DISPID_10_PUT_NAME
See Also:
Constant Field Values

DISPID_13_GET_NAME

static final java.lang.String DISPID_13_GET_NAME
See Also:
Constant Field Values

DISPID_13_PUT_NAME

static final java.lang.String DISPID_13_PUT_NAME
See Also:
Constant Field Values

DISPID_14_GET_NAME

static final java.lang.String DISPID_14_GET_NAME
See Also:
Constant Field Values

DISPID_14_PUTREF_NAME

static final java.lang.String DISPID_14_PUTREF_NAME
See Also:
Constant Field Values

DISPID_15_NAME

static final java.lang.String DISPID_15_NAME
See Also:
Constant Field Values

DISPID_16_NAME

static final java.lang.String DISPID_16_NAME
See Also:
Constant Field Values

DISPID_17_NAME

static final java.lang.String DISPID_17_NAME
See Also:
Constant Field Values

DISPID_18_NAME

static final java.lang.String DISPID_18_NAME
See Also:
Constant Field Values

DISPID_19_NAME

static final java.lang.String DISPID_19_NAME
See Also:
Constant Field Values

DISPID_20_NAME

static final java.lang.String DISPID_20_NAME
See Also:
Constant Field Values

DISPID_21_NAME

static final java.lang.String DISPID_21_NAME
See Also:
Constant Field Values

DISPID_22_NAME

static final java.lang.String DISPID_22_NAME
See Also:
Constant Field Values

DISPID_23_NAME

static final java.lang.String DISPID_23_NAME
See Also:
Constant Field Values

DISPID_24_NAME

static final java.lang.String DISPID_24_NAME
See Also:
Constant Field Values

DISPID_25_NAME

static final java.lang.String DISPID_25_NAME
See Also:
Constant Field Values

DISPID_26_NAME

static final java.lang.String DISPID_26_NAME
See Also:
Constant Field Values

DISPID_27_NAME

static final java.lang.String DISPID_27_NAME
See Also:
Constant Field Values

DISPID_28_NAME

static final java.lang.String DISPID_28_NAME
See Also:
Constant Field Values

DISPID_29_NAME

static final java.lang.String DISPID_29_NAME
See Also:
Constant Field Values

DISPID_30_NAME

static final java.lang.String DISPID_30_NAME
See Also:
Constant Field Values

DISPID_31_NAME

static final java.lang.String DISPID_31_NAME
See Also:
Constant Field Values

DISPID_32_NAME

static final java.lang.String DISPID_32_NAME
See Also:
Constant Field Values

DISPID_33_NAME

static final java.lang.String DISPID_33_NAME
See Also:
Constant Field Values

DISPID_34_NAME

static final java.lang.String DISPID_34_NAME
See Also:
Constant Field Values

DISPID_35_NAME

static final java.lang.String DISPID_35_NAME
See Also:
Constant Field Values

DISPID_37_PUT_NAME

static final java.lang.String DISPID_37_PUT_NAME
See Also:
Constant Field Values

DISPID_37_GET_NAME

static final java.lang.String DISPID_37_GET_NAME
See Also:
Constant Field Values

DISPID_38_PUT_NAME

static final java.lang.String DISPID_38_PUT_NAME
See Also:
Constant Field Values

DISPID_38_GET_NAME

static final java.lang.String DISPID_38_GET_NAME
See Also:
Constant Field Values

DISPID_39_GET_NAME

static final java.lang.String DISPID_39_GET_NAME
See Also:
Constant Field Values

DISPID_39_PUT_NAME

static final java.lang.String DISPID_39_PUT_NAME
See Also:
Constant Field Values

DISPID_40_GET_NAME

static final java.lang.String DISPID_40_GET_NAME
See Also:
Constant Field Values

DISPID_40_PUTREF_NAME

static final java.lang.String DISPID_40_PUTREF_NAME
See Also:
Constant Field Values
Method Detail

getHWnd

int getHWnd()
            throws java.io.IOException,
                   AutomationException
Handle to the window associated with the MapControl.

Returns:
The hWnd
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackColor

void setBackColor(int backColor)
                  throws java.io.IOException,
                         AutomationException
Background color of the MapControl.

Parameters:
backColor - The backColor (A COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackColor

int getBackColor()
                 throws java.io.IOException,
                        AutomationException
Background color of the MapControl.

Returns:
The backColor (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMousePointer

void setMousePointer(int mousePointer)
                     throws java.io.IOException,
                            AutomationException
The mouse pointer displayed over the MapControl.

Parameters:
mousePointer - A com.esri.arcgis.controls.esriControlsMousePointer constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMousePointer

int getMousePointer()
                    throws java.io.IOException,
                           AutomationException
The mouse pointer displayed over the MapControl.

Returns:
A com.esri.arcgis.controls.esriControlsMousePointer constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMouseIconByRef

void setMouseIconByRef(Picture mouseIcon)
                       throws java.io.IOException,
                              AutomationException
Custom mouse icon used if MousePointer is 99.

Parameters:
mouseIcon - A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMouseIcon

Picture getMouseIcon()
                     throws java.io.IOException,
                            AutomationException
Custom mouse icon used if MousePointer is 99.

Returns:
A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBorderStyle

void setBorderStyle(int borderStyle)
                    throws java.io.IOException,
                           AutomationException
The border style of the MapControl.

Parameters:
borderStyle - A com.esri.arcgis.controls.esriControlsBorderStyle constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBorderStyle

int getBorderStyle()
                   throws java.io.IOException,
                          AutomationException
The border style of the MapControl.

Returns:
A com.esri.arcgis.controls.esriControlsBorderStyle constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_setEnabled

void esri_setEnabled(boolean enabled)
                     throws java.io.IOException,
                            AutomationException
Indicates whether the MapControl can respond to user generated events.

Parameters:
enabled - The enabled (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_isEnabled

boolean esri_isEnabled()
                       throws java.io.IOException,
                              AutomationException
Indicates whether the MapControl can respond to user generated events.

Returns:
The enabled
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAppearance

void setAppearance(int appearance)
                   throws java.io.IOException,
                          AutomationException
The appearance of the MapControl.

Parameters:
appearance - A com.esri.arcgis.controls.esriControlsAppearance constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAppearance

int getAppearance()
                  throws java.io.IOException,
                         AutomationException
The appearance of the MapControl.

Returns:
A com.esri.arcgis.controls.esriControlsAppearance constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

aboutBox

void aboutBox()
              throws java.io.IOException,
                     AutomationException
Displays a dialog of information about the MapControl.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapByRef

void setMapByRef(IMap pMap)
                 throws java.io.IOException,
                        AutomationException
The Map contained by the MapControl.

Parameters:
pMap - A reference to a com.esri.arcgis.carto.IMap (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMap

IMap getMap()
            throws java.io.IOException,
                   AutomationException
The Map contained by the MapControl.

Returns:
A reference to a com.esri.arcgis.carto.IMap
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActiveView

IActiveView getActiveView()
                          throws java.io.IOException,
                                 AutomationException
The active view of the Map contained by the MapControl.

Returns:
A reference to a com.esri.arcgis.carto.IActiveView
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerCount

int getLayerCount()
                  throws java.io.IOException,
                         AutomationException
Number of layers in the Map.

Returns:
The numLayers
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayer

ILayer getLayer(int index)
                throws java.io.IOException,
                       AutomationException
Layer at the supplied index.

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException
Current extent of the Map in map units.

Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExtent

void setExtent(IEnvelope extent)
               throws java.io.IOException,
                      AutomationException
Current extent of the Map in map units.

Parameters:
extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFullExtent

IEnvelope getFullExtent()
                        throws java.io.IOException,
                               AutomationException
Rectangular shape that encloses all features of all layers in the Map.

Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFullExtent

void setFullExtent(IEnvelope fullExtent)
                   throws java.io.IOException,
                          AutomationException
Rectangular shape that encloses all features of all layers in the Map.

Parameters:
fullExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowScrollbars

boolean isShowScrollbars()
                         throws java.io.IOException,
                                AutomationException
Indicates whether or not the Map's scrollbars are visible.

Returns:
The showScrollbars
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowScrollbars

void setShowScrollbars(boolean showScrollbars)
                       throws java.io.IOException,
                              AutomationException
Indicates whether or not the Map's scrollbars are visible.

Parameters:
showScrollbars - The showScrollbars (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVisibleRegion

void setVisibleRegion(IGeometry rhs1)
                      throws java.io.IOException,
                             AutomationException
The geometry specifying the visible region of the Map.

Parameters:
rhs1 - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpatialReference

ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException
Spatial reference of the Map.

Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

void setSpatialReferenceByRef(ISpatialReference spRef)
                              throws java.io.IOException,
                                     AutomationException
Spatial reference of the Map.

Parameters:
spRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReferenceScale

double getReferenceScale()
                         throws java.io.IOException,
                                AutomationException
Reference scale of the Map as a representative fraction.

Returns:
The referenceScale
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReferenceScale

void setReferenceScale(double referenceScale)
                       throws java.io.IOException,
                              AutomationException
Reference scale of the Map as a representative fraction.

Parameters:
referenceScale - The referenceScale (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapScale

double getMapScale()
                   throws java.io.IOException,
                          AutomationException
Scale of the map as a representative fraction.

Returns:
The mapScale
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapScale

void setMapScale(double mapScale)
                 throws java.io.IOException,
                        AutomationException
Scale of the map as a representative fraction.

Parameters:
mapScale - The mapScale (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentTool

ITool getCurrentTool()
                     throws java.io.IOException,
                            AutomationException
Current active tool for the MapControl. Set to nothing to clear the tool.

Returns:
A reference to a com.esri.arcgis.systemUI.ITool
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentToolByRef

void setCurrentToolByRef(ITool pTool)
                         throws java.io.IOException,
                                AutomationException
Current active tool for the MapControl. Set to nothing to clear the tool.

Parameters:
pTool - A reference to a com.esri.arcgis.systemUI.ITool (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addLayer

void addLayer(ILayer layer,
              int toIndex)
              throws java.io.IOException,
                     AutomationException
Adds a layer to the Map's collection of layers at the specified index position.

Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
toIndex - The toIndex (in, optional, pass 0 if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addLayerFromFile

void addLayerFromFile(java.lang.String lyrPath,
                      int toIndex)
                      throws java.io.IOException,
                             AutomationException
Loads a layer file and adds it to the Map's collection of layers at the specified index position.

Parameters:
lyrPath - The lyrPath (in)
toIndex - The toIndex (in, optional, pass 0 if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearLayers

void clearLayers()
                 throws java.io.IOException,
                        AutomationException
Removes all layers from the Map.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteLayer

void deleteLayer(int index)
                 throws java.io.IOException,
                        AutomationException
Removes a Layer from the Map's collection of layers at the specified index position.

Parameters:
index - The index (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

moveLayerTo

void moveLayerTo(int fromIndex,
                 int toIndex)
                 throws java.io.IOException,
                        AutomationException
Moves a layer within the Map's collection from its current index position to a new index position.

Parameters:
fromIndex - The fromIndex (in)
toIndex - The toIndex (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadMxFile

void loadMxFile(java.lang.String mxPath,
                java.lang.Object mapNameOrIndex,
                java.lang.Object password)
                throws java.io.IOException,
                       AutomationException
Loads the specified Map from the map document into the MapControl. The Map can be an index or a name, if it is not supplied the focus map is used.

Parameters:
mxPath - The mxPath (in)
mapNameOrIndex - A Variant (in, optional, pass null if not required)
password - A Variant (in, optional, pass null if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refresh

void refresh(int phase,
             java.lang.Object layerOrElement,
             java.lang.Object envelope)
             throws java.io.IOException,
                    AutomationException
Redraws the Map, optionally just redraw specified phases or envelope.

Parameters:
phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in, optional, pass 65535 if not required)
layerOrElement - A Variant (in, optional, pass null if not required)
envelope - A Variant (in, optional, pass null if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

pan

void pan()
         throws java.io.IOException,
                AutomationException
Tracks the mouse while panning the MapControl.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

centerAt

void centerAt(IPoint centerPoint)
              throws java.io.IOException,
                     AutomationException
Moves the center of the MapControl to the specified location.

Parameters:
centerPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

trackRectangle

IEnvelope trackRectangle()
                         throws java.io.IOException,
                                AutomationException
Rubber-bands a rectangle on the MapControl.

Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

trackPolygon

IGeometry trackPolygon()
                       throws java.io.IOException,
                              AutomationException
Rubber-bands a polygon on the MapControl.

Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

trackLine

IGeometry trackLine()
                    throws java.io.IOException,
                           AutomationException
Rubber-bands a polyline on the MapControl.

Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

trackCircle

IGeometry trackCircle()
                      throws java.io.IOException,
                             AutomationException
Rubber-bands a circle on the MapControl.

Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawShape

void drawShape(IGeometry shape,
               java.lang.Object symbol)
               throws java.io.IOException,
                      AutomationException
Draws a geometry shape on the MapControl.

Parameters:
shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
symbol - A Variant (in, optional, pass null if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

flashShape

void flashShape(IGeometry pShape,
                int nFlashes,
                int flashInterval,
                java.lang.Object symbol)
                throws java.io.IOException,
                       AutomationException
Flashes a shape on the MapControl, duration is in milliseconds.

Parameters:
pShape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
nFlashes - The nFlashes (in, optional, pass 3 if not required)
flashInterval - The flashInterval (in, optional, pass 300 if not required)
symbol - A Variant (in, optional, pass null if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

fromMapPoint

void fromMapPoint(IPoint pt,
                  int[] x,
                  int[] y)
                  throws java.io.IOException,
                         AutomationException
Converts a point on the Map (in map units) to device co-ordinates (typically pixels).

Parameters:
pt - A reference to a com.esri.arcgis.geometry.IPoint (in)
x - The x (in/out: use single element array)
y - The y (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

toMapPoint

IPoint toMapPoint(int x,
                  int y)
                  throws java.io.IOException,
                         AutomationException
Converts a point in device co-ordinates (typically pixels) to a point on the Map (in map units).

Parameters:
x - The x (in)
y - The y (in)
Returns:
A reference to a com.esri.arcgis.geometry.IPoint
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addShapeFile

void addShapeFile(java.lang.String path,
                  java.lang.String fileName)
                  throws java.io.IOException,
                         AutomationException
Adds a shapefile as a layer to the Map.

Parameters:
path - The path (in)
fileName - The fileName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawText

void drawText(IGeometry pGeometry,
              java.lang.String text,
              java.lang.Object pSymbol)
              throws java.io.IOException,
                     AutomationException
Draws text along the supplied geometry.

Parameters:
pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
text - The text (in)
pSymbol - A Variant (in, optional, pass null if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

checkMxFile

boolean checkMxFile(java.lang.String fileName)
                    throws java.io.IOException,
                           AutomationException
Checks the specified filename to see if it is a map document that can be loaded into the MapControl.

Parameters:
fileName - The fileName (in)
Returns:
The result
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

readMxMaps

IArray readMxMaps(java.lang.String fileName,
                  java.lang.Object password)
                  throws java.io.IOException,
                         AutomationException
Opens a map document specified by the supplied filename and reads the maps into an array object.

Parameters:
fileName - The fileName (in)
password - A Variant (in, optional, pass null if not required)
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOleDropEnabled

void setOleDropEnabled(boolean enabled)
                       throws java.io.IOException,
                              AutomationException
Indicates if the MapControl will fire events when data is dragged over the control's window.

Parameters:
enabled - The enabled (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOleDropEnabled

boolean isOleDropEnabled()
                         throws java.io.IOException,
                                AutomationException
Indicates if the MapControl will fire events when data is dragged over the control's window.

Returns:
The enabled
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRotation

void setRotation(double rotation)
                 throws java.io.IOException,
                        AutomationException
Determines how many degrees the map display is rotated.

Parameters:
rotation - The rotation (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRotation

double getRotation()
                   throws java.io.IOException,
                          AutomationException
Determines how many degrees the map display is rotated.

Returns:
The rotation
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapUnits

int getMapUnits()
                throws java.io.IOException,
                       AutomationException
The geographical units of the map.

Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapUnits

void setMapUnits(int units)
                 throws java.io.IOException,
                        AutomationException
The geographical units of the map.

Parameters:
units - A com.esri.arcgis.system.esriUnits constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTrackCancel

ITrackCancel getTrackCancel()
                            throws java.io.IOException,
                                   AutomationException
The object used by the MapControl to check if drawing has been aborted.

Returns:
A reference to a com.esri.arcgis.system.ITrackCancel
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrackCancelByRef

void setTrackCancelByRef(ITrackCancel ppTrackCancel)
                         throws java.io.IOException,
                                AutomationException
The object used by the MapControl to check if drawing has been aborted.

Parameters:
ppTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD