com.esri.arcgis.controls
Class IMapControl4Proxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.controls.IMapControl2Proxy
          com.esri.arcgis.controls.IMapControl3Proxy
              com.esri.arcgis.controls.IMapControl4Proxy

All Implemented Interfaces:

IMapControl2, IMapControl3, IMapControl4, Externalizable, Serializable

public class IMapControl4Proxy
extends IMapControl3Proxy
implements IMapControl4, Serializable

Provides access to members that control the MapControl.

Description

The IMapControl4 interface provides additional members for tasks related to navigating the display of the MapControl using the keyboard and mouse.

Product Availability

Available with ArcGIS Engine.

See Also:

Serialized Form

Field Summary

boolean

noncastable

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IMapControl4Proxy()
	IMapControl4Proxy(Object obj)
protected	IMapControl4Proxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
boolean	isAutoKeyboardScrolling() Indicates whether keyboard scrolling is enabled.
boolean	isAutoMouseWheel() Indicates whether the mouse wheel is enabled.
void	removeListener(String iidStr, Object theListener)
void	setAutoKeyboardScrolling(boolean enabled) Indicates whether keyboard scrolling is enabled.
void	setAutoMouseWheel(boolean enabled) Indicates whether the mouse wheel is enabled.

Methods inherited from class com.esri.arcgis.controls.IMapControl3Proxy

getCustomProperty, getDocumentFilename, getDocumentMap, getKeyIntercept, getObject, getTipDelay, getTipStyle, isShowMapTips, setCustomProperty, setDocumentFilename, setDocumentMap, setKeyIntercept, setShowMapTips, setTipDelay, setTipStyle, suppressResizeDrawing

Methods inherited from class com.esri.arcgis.controls.IMapControl2Proxy

aboutBox, addLayer, addLayerFromFile, addShapeFile, centerAt, checkMxFile, clearLayers, deleteLayer, drawShape, drawText, esri_isEnabled, esri_setEnabled, flashShape, fromMapPoint, getActiveView, getAppearance, getBackColor, getBorderStyle, getCurrentTool, getExtent, getFullExtent, getHWnd, getLayer, getLayerCount, getMap, getMapScale, getMapUnits, getMouseIcon, getMousePointer, getReferenceScale, getRotation, getSpatialReference, getTrackCancel, isOleDropEnabled, isShowScrollbars, loadMxFile, moveLayerTo, pan, readMxMaps, refresh, setAppearance, setBackColor, setBorderStyle, setCurrentToolByRef, setExtent, setFullExtent, setMapByRef, setMapScale, setMapUnits, setMouseIconByRef, setMousePointer, setOleDropEnabled, setReferenceScale, setRotation, setShowScrollbars, setSpatialReferenceByRef, setTrackCancelByRef, setVisibleRegion, toMapPoint, trackCircle, trackLine, trackPolygon, trackRectangle

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

Methods inherited from interface com.esri.arcgis.controls.IMapControl3

getCustomProperty, getDocumentFilename, getDocumentMap, getKeyIntercept, getObject, getTipDelay, getTipStyle, isShowMapTips, setCustomProperty, setDocumentFilename, setDocumentMap, setKeyIntercept, setShowMapTips, setTipDelay, setTipStyle, suppressResizeDrawing

Methods inherited from interface com.esri.arcgis.controls.IMapControl2

aboutBox, addLayer, addLayerFromFile, addShapeFile, centerAt, checkMxFile, clearLayers, deleteLayer, drawShape, drawText, esri_isEnabled, esri_setEnabled, flashShape, fromMapPoint, getActiveView, getAppearance, getBackColor, getBorderStyle, getCurrentTool, getExtent, getFullExtent, getHWnd, getLayer, getLayerCount, getMap, getMapScale, getMapUnits, getMouseIcon, getMousePointer, getReferenceScale, getRotation, getSpatialReference, getTrackCancel, isOleDropEnabled, isShowScrollbars, loadMxFile, moveLayerTo, pan, readMxMaps, refresh, setAppearance, setBackColor, setBorderStyle, setCurrentToolByRef, setExtent, setFullExtent, setMapByRef, setMapScale, setMapUnits, setMouseIconByRef, setMousePointer, setOleDropEnabled, setReferenceScale, setRotation, setShowScrollbars, setSpatialReferenceByRef, setTrackCancelByRef, setVisibleRegion, toMapPoint, trackCircle, trackLine, trackPolygon, trackRectangle

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IMapControl4Proxy

public IMapControl4Proxy()

IMapControl4Proxy

public IMapControl4Proxy(Object obj)
                  throws IOException

Throws:

IOException

IMapControl4Proxy

protected IMapControl4Proxy(Object obj,
                            String iid)
                     throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class IMapControl3Proxy

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class IMapControl3Proxy

Throws:

IOException

isAutoMouseWheel

public boolean isAutoMouseWheel()
                         throws IOException,
                                AutomationException

Indicates whether the mouse wheel is enabled.

Description

Determines whether the mouse wheel can be used to zoom in and zoom out of the control's display. This property is true by default.

Product Availability

Available with ArcGIS Engine.

Specified by:

isAutoMouseWheel in interface IMapControl4

Returns:

The enabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoMouseWheel

public void setAutoMouseWheel(boolean enabled)
                       throws IOException,
                              AutomationException

Indicates whether the mouse wheel is enabled.

Product Availability

Available with ArcGIS Engine.

Specified by:

setAutoMouseWheel in interface IMapControl4

Parameters:

enabled - The enabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoKeyboardScrolling

public boolean isAutoKeyboardScrolling()
                                throws IOException,
                                       AutomationException

Indicates whether keyboard scrolling is enabled.

Description

Determines whether the 'Home' (keyCode 36), 'End' (keyCode 35), 'Page Down' (keyCode 34), 'PageUp' (keyCode 33) and 'Arrow' (keyCode 37-40) keys on the keyboard can be used to pan around the control's display. This property is true by default.

Most development environments use the 'Arrow' keys to switch focus between the controls embedded in a form or container. In such environments the MapControl will not by default receive the 'Arrow' keys to pan the display. To ensure 'Arrow' keys are received by the MapControl the KeyIntercept property must be set to intercept the 'Arrow' keys in order to pan the display when AutoKeyboardScrolling is true.

Product Availability

Available with ArcGIS Engine.

Specified by:

isAutoKeyboardScrolling in interface IMapControl4

Returns:

The enabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoKeyboardScrolling

public void setAutoKeyboardScrolling(boolean enabled)
                              throws IOException,
                                     AutomationException

Indicates whether keyboard scrolling is enabled.

Product Availability

Available with ArcGIS Engine.

Specified by:

setAutoKeyboardScrolling in interface IMapControl4

Parameters:

enabled - The enabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.