com.esri.arcgis.controls
Class IMapControlDefaultProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.controls.IMapControlDefaultProxy

All Implemented Interfaces:

IMapControlDefault, java.io.Externalizable, java.io.Serializable

public class IMapControlDefaultProxy
extends com.esri.arcgis.interop.Dispatch
implements IMapControlDefault, java.io.Serializable

Internal use class Proxy for COM Interface 'IMapControlDefault'. 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 =

See Also:

Serialized Form

Field Summary

boolean	noncastable
static java.lang.Class	targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Fields inherited from interface com.esri.arcgis.controls.IMapControlDefault

DISPID__501_GET_NAME, DISPID__501_PUT_NAME, DISPID__504_GET_NAME, DISPID__504_PUT_NAME, DISPID__514_GET_NAME, DISPID__514_PUT_NAME, DISPID__515_GET_NAME, DISPID__520_GET_NAME, DISPID__520_PUT_NAME, DISPID__521_GET_NAME, DISPID__521_PUT_NAME, DISPID__522_GET_NAME, DISPID__522_PUTREF_NAME, DISPID__552_NAME, DISPID_1_GET_NAME, DISPID_1_PUTREF_NAME, DISPID_10_GET_NAME, DISPID_10_PUT_NAME, DISPID_13_GET_NAME, DISPID_13_PUT_NAME, DISPID_14_GET_NAME, DISPID_14_PUTREF_NAME, DISPID_15_NAME, DISPID_16_NAME, DISPID_17_NAME, DISPID_18_NAME, DISPID_19_NAME, DISPID_2_GET_NAME, DISPID_20_NAME, DISPID_21_NAME, DISPID_22_NAME, DISPID_23_NAME, DISPID_24_NAME, DISPID_25_NAME, DISPID_26_NAME, DISPID_27_NAME, DISPID_28_NAME, DISPID_29_NAME, DISPID_3_GET_NAME, DISPID_30_NAME, DISPID_31_NAME, DISPID_32_NAME, DISPID_33_NAME, DISPID_34_NAME, DISPID_35_NAME, DISPID_37_GET_NAME, DISPID_37_PUT_NAME, DISPID_38_GET_NAME, DISPID_38_PUT_NAME, DISPID_39_GET_NAME, DISPID_39_PUT_NAME, DISPID_4_GET_NAME, DISPID_40_GET_NAME, DISPID_40_PUTREF_NAME, DISPID_41_GET_NAME, DISPID_41_PUT_NAME, DISPID_42_NAME, DISPID_43_GET_NAME, DISPID_43_PUT_NAME, DISPID_44_GET_NAME, DISPID_44_PUT_NAME, DISPID_45_GET_NAME, DISPID_46_GET_NAME, DISPID_46_PUT_NAME, DISPID_47_GET_NAME, DISPID_47_PUT_NAME, DISPID_48_GET_NAME, DISPID_48_PUT_NAME, DISPID_49_GET_NAME, DISPID_49_PUT_NAME, DISPID_5_GET_NAME, DISPID_5_PUT_NAME, DISPID_50_GET_NAME, DISPID_50_PUT_NAME, DISPID_51_GET_NAME, DISPID_51_PUT_NAME, DISPID_6_GET_NAME, DISPID_6_PUT_NAME, DISPID_7_GET_NAME, DISPID_7_PUT_NAME, DISPID_8_PUT_NAME, DISPID_9_GET_NAME, DISPID_9_PUTREF_NAME, IID, IIDc864e7b1_c5ba_42bb_9c2f_d311f218c55b

Constructor Summary

	IMapControlDefaultProxy() For internal use only
	IMapControlDefaultProxy(java.lang.Object obj)
protected	IMapControlDefaultProxy(java.lang.Object obj, java.lang.String iid)
	IMapControlDefaultProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	IMapControlDefaultProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)

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	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
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 rhs1) 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.
java.lang.Object	getCustomProperty() A property to associate data with a control.
java.lang.String	getDocumentFilename() The filename of the last map document loaded into the control.
java.lang.String	getDocumentMap() The name of the map that was last loaded into the control from a map document.
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.
int	getKeyIntercept() A property that specifies interception of key strokes that are normally handled by the container.
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.
java.lang.Object	getObject() A property that returns the underlying control.
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.
int	getTipDelay() The delay before map tips are shown.
int	getTipStyle() The style of map tips.
ITrackCancel	getTrackCancel() The object used by the MapControl to check if drawing has been aborted.
boolean	isAutoKeyboardScrolling() Indicates whether keyboard scrolling is enabled.
boolean	isAutoMouseWheel() Indicates whether the mouse wheel is enabled.
boolean	isOleDropEnabled() Indicates if the MapControl will fire events when data is dragged over the control's window.
boolean	isShowMapTips() Indicates if map tips are shown.
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	removeListener(java.lang.String iidStr, java.lang.Object theListener)
void	setAppearance(int rhs1) The appearance of the MapControl.
void	setAutoKeyboardScrolling(boolean rhs1) Indicates whether keyboard scrolling is enabled.
void	setAutoMouseWheel(boolean rhs1) Indicates whether the mouse wheel is enabled.
void	setBackColor(int rhs1) Background color of the MapControl.
void	setBorderStyle(int rhs1) The border style of the MapControl.
void	setCurrentToolByRef(ITool rhs1) Current active tool for the MapControl.
void	setCustomProperty(java.lang.Object rhs1) A property to associate data with a control.
void	setDocumentFilename(java.lang.String rhs1) The filename of the last map document loaded into the control.
void	setDocumentMap(java.lang.String rhs1) The name of the map that was last loaded into the control from a map document.
void	setExtent(IEnvelope rhs1) Current extent of the Map in map units.
void	setFullExtent(IEnvelope rhs1) Rectangular shape that encloses all features of all layers in the Map.
void	setKeyIntercept(int rhs1) A property that specifies interception of key strokes that are normally handled by the container.
void	setMapByRef(IMap rhs1) The Map contained by the MapControl.
void	setMapScale(double rhs1) Scale of the map as a representative fraction.
void	setMapUnits(int rhs1) The geographical units of the map.
void	setMouseIconByRef(Picture rhs1) Custom mouse icon used if MousePointer is 99.
void	setMousePointer(int rhs1) The mouse pointer displayed over the MapControl.
void	setOleDropEnabled(boolean rhs1) Indicates if the MapControl will fire events when data is dragged over the control's window.
void	setReferenceScale(double rhs1) Reference scale of the Map as a representative fraction.
void	setRotation(double rhs1) Determines how many degrees the map display is rotated.
void	setShowMapTips(boolean rhs1) Indicates if map tips are shown.
void	setShowScrollbars(boolean rhs1) Indicates whether or not the Map's scrollbars are visible.
void	setSpatialReferenceByRef(ISpatialReference rhs1) Spatial reference of the Map.
void	setTipDelay(int rhs1) The delay before map tips are shown.
void	setTipStyle(int rhs1) The style of map tips.
void	setTrackCancelByRef(ITrackCancel rhs1) 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.
void	suppressResizeDrawing(boolean suppressResize, int resizeHWnd) Suppress full redraw of control during resize operations.
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.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable

Constructor Detail

IMapControlDefaultProxy

public IMapControlDefaultProxy(java.lang.String CLSID,
                               java.lang.String host,
                               com.esri.arcgis.interop.AuthInfo authInfo)
                        throws java.net.UnknownHostException,
                               java.io.IOException

Throws:

java.net.UnknownHostException

java.io.IOException

IMapControlDefaultProxy

public IMapControlDefaultProxy()

For internal use only

IMapControlDefaultProxy

public IMapControlDefaultProxy(java.lang.Object obj)
                        throws java.io.IOException

Throws:

java.io.IOException

IMapControlDefaultProxy

protected IMapControlDefaultProxy(java.lang.Object obj,
                                  java.lang.String iid)
                           throws java.io.IOException

Throws:

java.io.IOException

IMapControlDefaultProxy

protected IMapControlDefaultProxy(java.lang.String CLSID,
                                  java.lang.String iid,
                                  java.lang.String host,
                                  com.esri.arcgis.interop.AuthInfo authInfo)
                           throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

getHWnd

public int getHWnd()
            throws java.io.IOException,
                   AutomationException

Handle to the window associated with the MapControl.

Specified by:

getHWnd in interface IMapControlDefault

Returns:

The returnValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackColor

public void setBackColor(int rhs1)
                  throws java.io.IOException,
                         AutomationException

Background color of the MapControl.

Specified by:

setBackColor in interface IMapControlDefault

Parameters:

rhs1 - The rhs1 (A COM typedef) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackColor

public int getBackColor()
                 throws java.io.IOException,
                        AutomationException

Background color of the MapControl.

Specified by:

getBackColor in interface IMapControlDefault

Returns:

The returnValue (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMousePointer

public void setMousePointer(int rhs1)
                     throws java.io.IOException,
                            AutomationException

The mouse pointer displayed over the MapControl.

Specified by:

setMousePointer in interface IMapControlDefault

Parameters:

rhs1 - 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

public int getMousePointer()
                    throws java.io.IOException,
                           AutomationException

The mouse pointer displayed over the MapControl.

Specified by:

getMousePointer in interface IMapControlDefault

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

public void setMouseIconByRef(Picture rhs1)
                       throws java.io.IOException,
                              AutomationException

Custom mouse icon used if MousePointer is 99.

Specified by:

setMouseIconByRef in interface IMapControlDefault

Parameters:

rhs1 - 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

public Picture getMouseIcon()
                     throws java.io.IOException,
                            AutomationException

Custom mouse icon used if MousePointer is 99.

Specified by:

getMouseIcon in interface IMapControlDefault

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

public void setBorderStyle(int rhs1)
                    throws java.io.IOException,
                           AutomationException

The border style of the MapControl.

Specified by:

setBorderStyle in interface IMapControlDefault

Parameters:

rhs1 - 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

public int getBorderStyle()
                   throws java.io.IOException,
                          AutomationException

The border style of the MapControl.

Specified by:

getBorderStyle in interface IMapControlDefault

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

public void esri_setEnabled(boolean rhs1)
                     throws java.io.IOException,
                            AutomationException

Indicates whether the MapControl can respond to user generated events.

Specified by:

esri_setEnabled in interface IMapControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_isEnabled

public boolean esri_isEnabled()
                       throws java.io.IOException,
                              AutomationException

Indicates whether the MapControl can respond to user generated events.

Specified by:

esri_isEnabled in interface IMapControlDefault

Returns:

The returnValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAppearance

public void setAppearance(int rhs1)
                   throws java.io.IOException,
                          AutomationException

The appearance of the MapControl.

Specified by:

setAppearance in interface IMapControlDefault

Parameters:

rhs1 - 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

public int getAppearance()
                  throws java.io.IOException,
                         AutomationException

The appearance of the MapControl.

Specified by:

getAppearance in interface IMapControlDefault

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

public void aboutBox()
              throws java.io.IOException,
                     AutomationException

Displays a dialog of information about the MapControl.

Specified by:

aboutBox in interface IMapControlDefault

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapByRef

public void setMapByRef(IMap rhs1)
                 throws java.io.IOException,
                        AutomationException

The Map contained by the MapControl.

Specified by:

setMapByRef in interface IMapControlDefault

Parameters:

rhs1 - 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

public IMap getMap()
            throws java.io.IOException,
                   AutomationException

The Map contained by the MapControl.

Specified by:

getMap in interface IMapControlDefault

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

public IActiveView getActiveView()
                          throws java.io.IOException,
                                 AutomationException

The active view of the Map contained by the MapControl.

Specified by:

getActiveView in interface IMapControlDefault

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

public int getLayerCount()
                  throws java.io.IOException,
                         AutomationException

Number of layers in the Map.

Specified by:

getLayerCount in interface IMapControlDefault

Returns:

The returnValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer(int index)
                throws java.io.IOException,
                       AutomationException

Layer at the supplied index.

Specified by:

getLayer in interface IMapControlDefault

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

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

Current extent of the Map in map units.

Specified by:

getExtent in interface IMapControlDefault

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

public void setExtent(IEnvelope rhs1)
               throws java.io.IOException,
                      AutomationException

Current extent of the Map in map units.

Specified by:

setExtent in interface IMapControlDefault

Parameters:

rhs1 - 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

public IEnvelope getFullExtent()
                        throws java.io.IOException,
                               AutomationException

Rectangular shape that encloses all features of all layers in the Map.

Specified by:

getFullExtent in interface IMapControlDefault

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

public void setFullExtent(IEnvelope rhs1)
                   throws java.io.IOException,
                          AutomationException

Rectangular shape that encloses all features of all layers in the Map.

Specified by:

setFullExtent in interface IMapControlDefault

Parameters:

rhs1 - 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

public boolean isShowScrollbars()
                         throws java.io.IOException,
                                AutomationException

Indicates whether or not the Map's scrollbars are visible.

Specified by:

isShowScrollbars in interface IMapControlDefault

Returns:

The returnValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowScrollbars

public void setShowScrollbars(boolean rhs1)
                       throws java.io.IOException,
                              AutomationException

Indicates whether or not the Map's scrollbars are visible.

Specified by:

setShowScrollbars in interface IMapControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisibleRegion

public void setVisibleRegion(IGeometry rhs1)
                      throws java.io.IOException,
                             AutomationException

The geometry specifying the visible region of the Map.

Specified by:

setVisibleRegion in interface IMapControlDefault

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

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

Spatial reference of the Map.

Specified by:

getSpatialReference in interface IMapControlDefault

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

public void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws java.io.IOException,
                                     AutomationException

Spatial reference of the Map.

Specified by:

setSpatialReferenceByRef in interface IMapControlDefault

Parameters:

rhs1 - 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

public double getReferenceScale()
                         throws java.io.IOException,
                                AutomationException

Reference scale of the Map as a representative fraction.

Specified by:

getReferenceScale in interface IMapControlDefault

Returns:

The returnValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenceScale

public void setReferenceScale(double rhs1)
                       throws java.io.IOException,
                              AutomationException

Reference scale of the Map as a representative fraction.

Specified by:

setReferenceScale in interface IMapControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapScale

public double getMapScale()
                   throws java.io.IOException,
                          AutomationException

Scale of the map as a representative fraction.

Specified by:

getMapScale in interface IMapControlDefault

Returns:

The returnValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapScale

public void setMapScale(double rhs1)
                 throws java.io.IOException,
                        AutomationException

Scale of the map as a representative fraction.

Specified by:

setMapScale in interface IMapControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentTool

public ITool getCurrentTool()
                     throws java.io.IOException,
                            AutomationException

Current active tool for the MapControl. Set to nothing to clear the tool.

Specified by:

getCurrentTool in interface IMapControlDefault

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

public void setCurrentToolByRef(ITool rhs1)
                         throws java.io.IOException,
                                AutomationException

Current active tool for the MapControl. Set to nothing to clear the tool.

Specified by:

setCurrentToolByRef in interface IMapControlDefault

Parameters:

rhs1 - 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

public 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.

Specified by:

addLayer in interface IMapControlDefault

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

public 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.

Specified by:

addLayerFromFile in interface IMapControlDefault

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

public void clearLayers()
                 throws java.io.IOException,
                        AutomationException

Removes all layers from the Map.

Specified by:

clearLayers in interface IMapControlDefault

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteLayer

public void deleteLayer(int index)
                 throws java.io.IOException,
                        AutomationException

Removes a Layer from the Map's collection of layers at the specified index position.

Specified by:

deleteLayer in interface IMapControlDefault

Parameters:

index - The index (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveLayerTo

public 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.

Specified by:

moveLayerTo in interface IMapControlDefault

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

public 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.

Specified by:

loadMxFile in interface IMapControlDefault

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

public 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.

Specified by:

refresh in interface IMapControlDefault

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

public void pan()
         throws java.io.IOException,
                AutomationException

Tracks the mouse while panning the MapControl.

Specified by:

pan in interface IMapControlDefault

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

centerAt

public void centerAt(IPoint centerPoint)
              throws java.io.IOException,
                     AutomationException

Moves the center of the MapControl to the specified location.

Specified by:

centerAt in interface IMapControlDefault

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

public IEnvelope trackRectangle()
                         throws java.io.IOException,
                                AutomationException

Rubber-bands a rectangle on the MapControl.

Specified by:

trackRectangle in interface IMapControlDefault

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

public IGeometry trackPolygon()
                       throws java.io.IOException,
                              AutomationException

Rubber-bands a polygon on the MapControl.

Specified by:

trackPolygon in interface IMapControlDefault

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

public IGeometry trackLine()
                    throws java.io.IOException,
                           AutomationException

Rubber-bands a polyline on the MapControl.

Specified by:

trackLine in interface IMapControlDefault

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

public IGeometry trackCircle()
                      throws java.io.IOException,
                             AutomationException

Rubber-bands a circle on the MapControl.

Specified by:

trackCircle in interface IMapControlDefault

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

public void drawShape(IGeometry shape,
                      java.lang.Object symbol)
               throws java.io.IOException,
                      AutomationException

Draws a geometry shape on the MapControl.

Specified by:

drawShape in interface IMapControlDefault

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

public 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.

Specified by:

flashShape in interface IMapControlDefault

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

public 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).

Specified by:

fromMapPoint in interface IMapControlDefault

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

public 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).

Specified by:

toMapPoint in interface IMapControlDefault

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

public void addShapeFile(java.lang.String path,
                         java.lang.String fileName)
                  throws java.io.IOException,
                         AutomationException

Adds a shapefile as a layer to the Map.

Specified by:

addShapeFile in interface IMapControlDefault

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

public void drawText(IGeometry pGeometry,
                     java.lang.String text,
                     java.lang.Object pSymbol)
              throws java.io.IOException,
                     AutomationException

Draws text along the supplied geometry.

Specified by:

drawText in interface IMapControlDefault

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

public 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.

Specified by:

checkMxFile in interface IMapControlDefault

Parameters:

fileName - The fileName (in)

Returns:

The returnValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

readMxMaps

public 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.

Specified by:

readMxMaps in interface IMapControlDefault

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

public void setOleDropEnabled(boolean rhs1)
                       throws java.io.IOException,
                              AutomationException

Indicates if the MapControl will fire events when data is dragged over the control's window.

Specified by:

setOleDropEnabled in interface IMapControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOleDropEnabled

public boolean isOleDropEnabled()
                         throws java.io.IOException,
                                AutomationException

Indicates if the MapControl will fire events when data is dragged over the control's window.

Specified by:

isOleDropEnabled in interface IMapControlDefault

Returns:

The returnValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotation

public void setRotation(double rhs1)
                 throws java.io.IOException,
                        AutomationException

Determines how many degrees the map display is rotated.

Specified by:

setRotation in interface IMapControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRotation

public double getRotation()
                   throws java.io.IOException,
                          AutomationException

Determines how many degrees the map display is rotated.

Specified by:

getRotation in interface IMapControlDefault

Returns:

The returnValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapUnits

public int getMapUnits()
                throws java.io.IOException,
                       AutomationException

The geographical units of the map.

Specified by:

getMapUnits in interface IMapControlDefault

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

public void setMapUnits(int rhs1)
                 throws java.io.IOException,
                        AutomationException

The geographical units of the map.

Specified by:

setMapUnits in interface IMapControlDefault

Parameters:

rhs1 - 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

public ITrackCancel getTrackCancel()
                            throws java.io.IOException,
                                   AutomationException

The object used by the MapControl to check if drawing has been aborted.

Specified by:

getTrackCancel in interface IMapControlDefault

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

public void setTrackCancelByRef(ITrackCancel rhs1)
                         throws java.io.IOException,
                                AutomationException

The object used by the MapControl to check if drawing has been aborted.

Specified by:

setTrackCancelByRef in interface IMapControlDefault

Parameters:

rhs1 - 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.

getCustomProperty

public java.lang.Object getCustomProperty()
                                   throws java.io.IOException,
                                          AutomationException

A property to associate data with a control.

Specified by:

getCustomProperty in interface IMapControlDefault

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(java.lang.Object rhs1)
                       throws java.io.IOException,
                              AutomationException

A property to associate data with a control.

Specified by:

setCustomProperty in interface IMapControlDefault

Parameters:

rhs1 - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

suppressResizeDrawing

public void suppressResizeDrawing(boolean suppressResize,
                                  int resizeHWnd)
                           throws java.io.IOException,
                                  AutomationException

Suppress full redraw of control during resize operations.

Specified by:

suppressResizeDrawing in interface IMapControlDefault

Parameters:

suppressResize - The suppressResize (in)

resizeHWnd - The resizeHWnd (in, optional, pass 0 if not required)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentFilename

public java.lang.String getDocumentFilename()
                                     throws java.io.IOException,
                                            AutomationException

The filename of the last map document loaded into the control.

Specified by:

getDocumentFilename in interface IMapControlDefault

Returns:

The returnValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDocumentFilename

public void setDocumentFilename(java.lang.String rhs1)
                         throws java.io.IOException,
                                AutomationException

The filename of the last map document loaded into the control.

Specified by:

setDocumentFilename in interface IMapControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentMap

public java.lang.String getDocumentMap()
                                throws java.io.IOException,
                                       AutomationException

The name of the map that was last loaded into the control from a map document.

Specified by:

getDocumentMap in interface IMapControlDefault

Returns:

The returnValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDocumentMap

public void setDocumentMap(java.lang.String rhs1)
                    throws java.io.IOException,
                           AutomationException

The name of the map that was last loaded into the control from a map document.

Specified by:

setDocumentMap in interface IMapControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObject

public java.lang.Object getObject()
                           throws java.io.IOException,
                                  AutomationException

A property that returns the underlying control. This can be used when the control is inside a wrapper object that has been added by a development environment.

Specified by:

getObject in interface IMapControlDefault

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowMapTips

public void setShowMapTips(boolean rhs1)
                    throws java.io.IOException,
                           AutomationException

Indicates if map tips are shown.

Specified by:

setShowMapTips in interface IMapControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowMapTips

public boolean isShowMapTips()
                      throws java.io.IOException,
                             AutomationException

Indicates if map tips are shown.

Specified by:

isShowMapTips in interface IMapControlDefault

Returns:

The returnValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTipStyle

public void setTipStyle(int rhs1)
                 throws java.io.IOException,
                        AutomationException

The style of map tips.

Specified by:

setTipStyle in interface IMapControlDefault

Parameters:

rhs1 - A com.esri.arcgis.systemUI.esriTipStyle constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTipStyle

public int getTipStyle()
                throws java.io.IOException,
                       AutomationException

The style of map tips.

Specified by:

getTipStyle in interface IMapControlDefault

Returns:

A com.esri.arcgis.systemUI.esriTipStyle constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTipDelay

public void setTipDelay(int rhs1)
                 throws java.io.IOException,
                        AutomationException

The delay before map tips are shown.

Specified by:

setTipDelay in interface IMapControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTipDelay

public int getTipDelay()
                throws java.io.IOException,
                       AutomationException

The delay before map tips are shown.

Specified by:

getTipDelay in interface IMapControlDefault

Returns:

The returnValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeyIntercept

public int getKeyIntercept()
                    throws java.io.IOException,
                           AutomationException

A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Specified by:

getKeyIntercept in interface IMapControlDefault

Returns:

The returnValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeyIntercept

public void setKeyIntercept(int rhs1)
                     throws java.io.IOException,
                            AutomationException

A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Specified by:

setKeyIntercept in interface IMapControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoMouseWheel

public boolean isAutoMouseWheel()
                         throws java.io.IOException,
                                AutomationException

Indicates whether the mouse wheel is enabled.

Specified by:

isAutoMouseWheel in interface IMapControlDefault

Returns:

The returnValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoMouseWheel

public void setAutoMouseWheel(boolean rhs1)
                       throws java.io.IOException,
                              AutomationException

Indicates whether the mouse wheel is enabled.

Specified by:

setAutoMouseWheel in interface IMapControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoKeyboardScrolling

public boolean isAutoKeyboardScrolling()
                                throws java.io.IOException,
                                       AutomationException

Indicates whether keyboard scrolling is enabled.

Specified by:

isAutoKeyboardScrolling in interface IMapControlDefault

Returns:

The returnValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoKeyboardScrolling

public void setAutoKeyboardScrolling(boolean rhs1)
                              throws java.io.IOException,
                                     AutomationException

Indicates whether keyboard scrolling is enabled.

Specified by:

setAutoKeyboardScrolling in interface IMapControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.