com.esri.arcgis.beans.map
Class MapBean

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended bycom.esri.arcgis.beans.map.MapBean
All Implemented Interfaces:
BuddyControl, IConnectionPointContainer, java.awt.image.ImageObserver, IMapControl2, IMapControl3, IMapControlDefault, IMxdContents, IPersist, IPersistStreamInit, ISupportErrorInfo, ITOCBuddy, IToolbarBuddy, java.awt.MenuContainer, RemoteObjRef, java.io.Serializable

public class MapBean
extends javax.swing.JComponent
implements BuddyControl, RemoteObjRef, IMapControlDefault, IMapControl2, IMapControl3, ITOCBuddy, IToolbarBuddy, IMxdContents, IConnectionPointContainer, IPersistStreamInit, IPersist, ISupportErrorInfo

The MapBean is a wrapper class of MapControl to facilitate the use of MapControl at the design time. Users could access the actual control by getMapControl method.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
static java.lang.String LAYER_SEPARATER
           
protected  MapControl m_mapControl
           
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
MapBean()
          Default constructor.
 
Method Summary
 void aboutBox()
          Displays a dialog of information about the MapControl.
 void addIMapControlEvents2Listener(IMapControlEvents2Adapter theListener)
           
 void addITOCBuddyEventsListener(ITOCBuddyEventsAdapter theListener)
           
 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 name)
          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.
 void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
          Supported Platforms
 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 findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)
          Supported Platforms
 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.
 IConnectionPointContainer getAsIConnectionPointContainer()
           
 IMapControl2 getAsIMapControl2()
           
 IMapControl3 getAsIMapControl3()
           
 IMapControlDefault getAsIMapControlDefault()
           
 IMxdContents getAsIMxdContents()
           
 IPersist getAsIPersist()
           
 IPersistStreamInit getAsIPersistStreamInit()
           
 ISupportErrorInfo getAsISupportErrorInfo()
           
 ITOCBuddy getAsITOCBuddy()
           
 IToolbarBuddy getAsIToolbarBuddy()
           
 int getBackColor()
          Background color of the MapControl.
 int getBorderStyle()
          The border style of the MapControl.
 java.lang.Object getBuddyControl()
          returns com.esri.arcgis.beans.ui.BuddyControl object.
 void getClassID(GUID[] gUIDArray)
          Supported Platforms
 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.
 Dispatch getJintegraDispatch()
          Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
 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.
 MapControl getMapControl()
          Returns the actual 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.
 IPageLayout getPageLayout()
          The PageLayout object.
 double getReferenceScale()
          Reference scale of the Map as a representative fraction.
 double getRotation()
          Determines how many degrees the map display is rotated.
 double getScale(IBasicMap pBasicMap)
          Returns the scale of the supplied BasicMap, this allows for objects that do not support IMap.
 void getSizeMax(_ULARGE_INTEGER[] pCbSize)
          Supported Platforms
 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.
 void initNew()
          Supported Platforms
 void interfaceSupportsErrorInfo(GUID gUID)
          Supported Platforms
 boolean isAutoKeyboardScrolling()
          Indicates whether keyboard scrolling is enabled.
 boolean isAutoMouseWheel()
          Indicates whether the mouse wheel is enabled.
 void isDirty()
          Supported Platforms
 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 load(IStream pStm)
          Supported Platforms
 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 paint(java.awt.Graphics g)
          Paints this component in desing tome
 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 release()
          Release this COM object reference
 void removeIMapControlEvents2Listener(IMapControlEvents2Adapter theListener)
           
 void removeITOCBuddyEventsListener(ITOCBuddyEventsAdapter theListener)
           
 void save(IStream pStm, int fClearDirty)
          Supported Platforms
 void setAppearance(int appearance)
          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 filename)
          The filename of the last map document loaded into the control.
 void setDocumentMap(java.lang.String map)
          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 key)
          A property that specifies interception of key strokes that are normally handled by the container.
 void setLayout(java.awt.LayoutManager layout)
          Overrides the setLayout method of super class.
 void setMapByRef(IMap rhs1)
          The Map contained by the MapControl.
 void setMapScale(double s)
          Scale of the map as a representative fraction.
 void setMapUnits(int i)
          The geographical units of the map.
 void setMouseIconByRef(Picture picture)
          Custom mouse icon used if MousePointer is 99.
 void setMousePointer(int pointer)
          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 d)
          Reference scale of the Map as a representative fraction.
 void setRotation(double rotate)
          Determines how many degrees the map display is rotated.
 void setShowMapTips(boolean tips)
          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 style)
          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 javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

m_mapControl

protected MapControl m_mapControl

LAYER_SEPARATER

public static final java.lang.String LAYER_SEPARATER
See Also:
Constant Field Values
Constructor Detail

MapBean

public MapBean()
Default constructor.

Method Detail

getMapControl

public MapControl getMapControl()
Returns the actual MapControl.

Returns:
MapControl

getBuddyControl

public java.lang.Object getBuddyControl()
returns com.esri.arcgis.beans.ui.BuddyControl object.

Specified by:
getBuddyControl in interface BuddyControl
Returns:
Object

setLayout

public void setLayout(java.awt.LayoutManager layout)
Overrides the setLayout method of super class.

Parameters:
layout - LayoutManager - a LayoutManager object.

paint

public void paint(java.awt.Graphics g)
Paints this component in desing tome

Parameters:
g - the graphics context to use for painting

addShapeFile

public void addShapeFile(java.lang.String path,
                         java.lang.String name)
                  throws java.io.IOException
Description copied from interface: IMapControlDefault
Adds a shapefile as a layer to the Map.

Description

When a shapefile is added to the MapControl's layer collection it is added to the beginning or top of the collection with an index of 0. The numeric index of any other layers in the layer collection increments by one.

Remarks

The Layer at the beginning or top of the collection with an index of 0 will be drawn last, whilst the Layer at the bottom of the collection will be drawn first.

Use the MoveLayerTo method to change the position of a Layer within the layer collection.

Specified by:
addShapeFile in interface IMapControlDefault
Parameters:
path - The path (in)
name - The fileName (in)
Throws:
java.io.IOException - If there are interop problems.

setDocumentMap

public void setDocumentMap(java.lang.String map)
                    throws java.io.IOException
Description copied from interface: IMapControlDefault
The name of the map that was last loaded into the control from a map document.

Specified by:
setDocumentMap in interface IMapControlDefault
Parameters:
map - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.

getDocumentMap

public java.lang.String getDocumentMap()
                                throws java.io.IOException
Description copied from interface: IMapControlDefault
The name of the map that was last loaded into the control from a map document.

Description

Returns the name of the last Map loaded into the MapControl with the LoadMxFile method. An empty string will be returned if no document is loaded.

Specified by:
getDocumentMap in interface IMapControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.

setRotation

public void setRotation(double rotate)
                 throws java.io.IOException
Description copied from interface: IMapControlDefault
Determines how many degrees the map display is rotated.

Specified by:
setRotation in interface IMapControlDefault
Parameters:
rotate - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.

getRotation

public double getRotation()
                   throws java.io.IOException
Description copied from interface: IMapControlDefault
Determines how many degrees the map display is rotated.

Description

This property is a shortcut to IDisplayTransformation::Rotation. The Rotation property controls the rotation of the display, and so the angle data appears inside the Map. The angle of the rotation is measured in degrees. Positive numbers rotate the display counter clockwise and negative numbers clockwise. 

Specified by:
getRotation in interface IMapControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.

setMapUnits

public void setMapUnits(int i)
                 throws java.io.IOException
Description copied from interface: IMapControlDefault
The geographical units of the map.

Specified by:
setMapUnits in interface IMapControlDefault
Parameters:
i - A com.esri.arcgis.system.esriUnits constant (in)
Throws:
java.io.IOException - If there are interop problems.

getMapUnits

public int getMapUnits()
                throws java.io.IOException
Description copied from interface: IMapControlDefault
The geographical units of the map.

Description

This property is a shortcut to IMap::MapUnits.

Specified by:
getMapUnits in interface IMapControlDefault
Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
java.io.IOException - If there are interop problems.

setMapScale

public void setMapScale(double s)
                 throws java.io.IOException
Description copied from interface: IMapControlDefault
Scale of the map as a representative fraction.

Specified by:
setMapScale in interface IMapControlDefault
Parameters:
s - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.

getMapScale

public double getMapScale()
                   throws java.io.IOException
Description copied from interface: IMapControlDefault
Scale of the map as a representative fraction.

Description

This property is a shortcut to IMap::MapScale which itself is a shortcut to IDisplayTransformation::ScaleRatio.

Remarks

MapScale is the relationship between the dimensions of features on a map and the geographic objects they represent on the earth, commonly expressed as a fraction or a ratio.  A MapScale of 1/100,000 or 1:100,000 means that one unit of measure on the map equals 100,000 of the same units on the earth.

Some common scales are as follows:

Specified by:
getMapScale in interface IMapControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.

setReferenceScale

public void setReferenceScale(double d)
                       throws java.io.IOException
Description copied from interface: IMapControlDefault
Reference scale of the Map as a representative fraction.

Specified by:
setReferenceScale in interface IMapControlDefault
Parameters:
d - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.

getReferenceScale

public double getReferenceScale()
                         throws java.io.IOException
Description copied from interface: IMapControlDefault
Reference scale of the Map as a representative fraction.

Description

This property is a shortcut to IMap::ReferenceScale and is the scale to which all symbol and text sizes used in the Map will be made relative.

Remarks

A ReferenceScale set to 0 indicates that no ReferenceScale is set and is the default. When no ReferenceScale is set, the size of any symbols or text on the Map remains the same irrespective of MapScale. When a reference scale is set, the size of any symbols or text on the map changes as the MapScale changes. For example, text labels will get larger if you zoom in to a scale larger than the ReferenceScale and smaller if you zoom out to a scale smaller than the ReferenceScale.

Specified by:
getReferenceScale in interface IMapControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.

getAppearance

public int getAppearance()
                  throws java.io.IOException
Description copied from interface: IMapControlDefault
The appearance of the MapControl.

Description

Returns or sets the paint style of a MapControl to either Flat or 3D. By default the appearance is flat.

Specified by:
getAppearance in interface IMapControlDefault
Returns:
A com.esri.arcgis.controls.esriControlsAppearance constant
Throws:
java.io.IOException - If there are interop problems.

setAppearance

public void setAppearance(int appearance)
                   throws java.io.IOException
Description copied from interface: IMapControlDefault
The appearance of the MapControl.

Specified by:
setAppearance in interface IMapControlDefault
Parameters:
appearance - A com.esri.arcgis.controls.esriControlsAppearance constant (in)
Throws:
java.io.IOException - If there are interop problems.

getBorderStyle

public int getBorderStyle()
                   throws java.io.IOException
Description copied from interface: IMapControlDefault
The border style of the MapControl.

Description

Returns or sets the border style of a MapControl. By default a border is drawn.

Specified by:
getBorderStyle in interface IMapControlDefault
Returns:
A com.esri.arcgis.controls.esriControlsBorderStyle constant
Throws:
java.io.IOException - If there are interop problems.

setBorderStyle

public void setBorderStyle(int rhs1)
                    throws java.io.IOException
Description copied from interface: IMapControlDefault
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.

getMousePointer

public int getMousePointer()
                    throws java.io.IOException
Description copied from interface: IMapControlDefault
The mouse pointer displayed over the MapControl.

Description

Use this property when you want to indicate changes in functionality as the mouse pointer passes over the MapControl. The esriPointerArrowHourglass setting (11) is useful for indicating that the user should wait for a process or operation to finish.

Specified by:
getMousePointer in interface IMapControlDefault
Returns:
A com.esri.arcgis.controls.esriControlsMousePointer constant
Throws:
java.io.IOException - If there are interop problems.

setMousePointer

public void setMousePointer(int pointer)
                     throws java.io.IOException
Description copied from interface: IMapControlDefault
The mouse pointer displayed over the MapControl.

Specified by:
setMousePointer in interface IMapControlDefault
Parameters:
pointer - A com.esri.arcgis.controls.esriControlsMousePointer constant (in)
Throws:
java.io.IOException - If there are interop problems.

getTipStyle

public int getTipStyle()
                throws java.io.IOException
Description copied from interface: IMapControlDefault
The style of map tips.

Description

Returns or sets the TipStyle used by the map tips when ShowMapTips is set to true to either solid or transparent. By default the TipStyle is solid.

Specified by:
getTipStyle in interface IMapControlDefault
Returns:
A com.esri.arcgis.systemUI.esriTipStyle constant
Throws:
java.io.IOException - If there are interop problems.

setTipStyle

public void setTipStyle(int style)
                 throws java.io.IOException
Description copied from interface: IMapControlDefault
The style of map tips.

Specified by:
setTipStyle in interface IMapControlDefault
Parameters:
style - A com.esri.arcgis.systemUI.esriTipStyle constant (in)
Throws:
java.io.IOException - If there are interop problems.

esri_isEnabled

public boolean esri_isEnabled()
                       throws java.io.IOException
Description copied from interface: IMapControlDefault
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.

esri_setEnabled

public void esri_setEnabled(boolean rhs1)
                     throws java.io.IOException
Description copied from interface: IMapControlDefault
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.

isShowScrollbars

public boolean isShowScrollbars()
                         throws java.io.IOException
Description copied from interface: IMapControlDefault
Indicates whether or not the Map's scrollbars are visible.

Description

If ShowScrollbars is true, the MapControl's internal scrollbars will appear when the Extent property is less than the FullExtent property.

Specified by:
isShowScrollbars in interface IMapControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.

setShowScrollbars

public void setShowScrollbars(boolean rhs1)
                       throws java.io.IOException
Description copied from interface: IMapControlDefault
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.

isOleDropEnabled

public boolean isOleDropEnabled()
                         throws java.io.IOException
Description copied from interface: IMapControlDefault
Indicates if the MapControl will fire events when data is dragged over the control's window.

Description

Indicates if the MapControl will accept data dragged from another application and fire the IMapControlEvents2::OnOleDrop event. By default the OleDropEnabled property is set to false.

Specified by:
isOleDropEnabled in interface IMapControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.

setOleDropEnabled

public void setOleDropEnabled(boolean rhs1)
                       throws java.io.IOException
Description copied from interface: IMapControlDefault
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.

setShowMapTips

public void setShowMapTips(boolean tips)
                    throws java.io.IOException
Description copied from interface: IMapControlDefault
Indicates if map tips are shown.

Specified by:
setShowMapTips in interface IMapControlDefault
Parameters:
tips - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.

isShowMapTips

public boolean isShowMapTips()
                      throws java.io.IOException
Description copied from interface: IMapControlDefault
Indicates if map tips are shown.

Description

Determines whether map tips are displayed (if they exist) as the mouse moves over layer features. By default the ShowMapTips property is set to false. To alter the appearance and behaviour of the map tips use the TipStyle and TipDelay properties.

The text for the map tip is taken from the IActiveView::TipText property that examines the data layers to find a layer that can return map tips. Map tips are typically a field value, like a features name. For performace reasons ensure that layers that return map tips have a spatial index.

Specified by:
isShowMapTips in interface IMapControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.

getKeyIntercept

public int getKeyIntercept()
                    throws java.io.IOException
Description copied from interface: IMapControlDefault
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.

Description

Returns or sets keys on the keyboard that will be intercepted by the MapControl, triggering the OnKeyDown and OnKeyUp events when pressed. These keys are often hidden from the MapControl by the development environment container. By default the KeyIntercept is set to esriKeyInterceptNone.

Many development environment containers use the up, down, left and right arrow keys to change control focus on a form. These keys can also be useful for navigating around the display. To intercept the arrow keys and the Tab key combine the enum values using a logical OR operation (esriKeyInterceptArrowKeys OR esriKeyInterceptTabKey, which is 1 OR 4 = 5).

Specified by:
getKeyIntercept in interface IMapControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.

setKeyIntercept

public void setKeyIntercept(int key)
                     throws java.io.IOException
Description copied from interface: IMapControlDefault
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:
key - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.

getBackColor

public int getBackColor()
                 throws java.io.IOException
Description copied from interface: IMapControlDefault
Background color of the MapControl.

Description

Returns or sets the Background Color of the MapControl. Internally the OLE_Color is stored as a long integer where the value may be calculated for any RGB combination as follows:

OLE_Color = (Red) + (Green * 256) + (Blue * 256 * 256)

Where Red, Green and Blue are Long Integers within the range 0 - 255.

Specified by:
getBackColor in interface IMapControlDefault
Returns:
The returnValue (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.

setBackColor

public void setBackColor(int rhs1)
                  throws java.io.IOException
Description copied from interface: IMapControlDefault
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.

setDocumentFilename

public void setDocumentFilename(java.lang.String filename)
                         throws java.io.IOException
Description copied from interface: IMapControlDefault
The filename of the last map document loaded into the control.

Specified by:
setDocumentFilename in interface IMapControlDefault
Parameters:
filename - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.

getDocumentFilename

public java.lang.String getDocumentFilename()
                                     throws java.io.IOException
Description copied from interface: IMapControlDefault
The filename of the last map document loaded into the control.

Description

Returns the DocumentFilename of the last document loaded into the MapControl with the LoadMxFile method. An empty string will be returned if no document is loaded.

Specified by:
getDocumentFilename in interface IMapControlDefault
Returns:
The returnValue
Throws:
java.io.IOException - If there are interop problems.

getAsIMapControlDefault

public IMapControlDefault getAsIMapControlDefault()

getAsIMapControl2

public IMapControl2 getAsIMapControl2()

getAsIMapControl3

public IMapControl3 getAsIMapControl3()

getAsITOCBuddy

public ITOCBuddy getAsITOCBuddy()

getAsIToolbarBuddy

public IToolbarBuddy getAsIToolbarBuddy()

getAsIMxdContents

public IMxdContents getAsIMxdContents()

getAsIConnectionPointContainer

public IConnectionPointContainer getAsIConnectionPointContainer()

getAsIPersistStreamInit

public IPersistStreamInit getAsIPersistStreamInit()

getAsIPersist

public IPersist getAsIPersist()

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

addIMapControlEvents2Listener

public void addIMapControlEvents2Listener(IMapControlEvents2Adapter theListener)
                                   throws java.io.IOException
Throws:
java.io.IOException

removeIMapControlEvents2Listener

public void removeIMapControlEvents2Listener(IMapControlEvents2Adapter theListener)
                                      throws java.io.IOException
Throws:
java.io.IOException

addITOCBuddyEventsListener

public void addITOCBuddyEventsListener(ITOCBuddyEventsAdapter theListener)
                                throws java.io.IOException
Throws:
java.io.IOException

removeITOCBuddyEventsListener

public void removeITOCBuddyEventsListener(ITOCBuddyEventsAdapter theListener)
                                   throws java.io.IOException
Throws:
java.io.IOException

setMapByRef

public void setMapByRef(IMap rhs1)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IMapControlDefault
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
Description copied from interface: IMapControlDefault
The Map contained by the MapControl.

Description

This is the Map CoClass contained within the MapControl. If the Map is replaced the IMapControlEvents2::OnMapReplaced event is triggered.

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
Description copied from interface: IMapControlDefault
The active view of the Map contained by the MapControl.

Description

This is the ActiveView on the Map contained within the MapControl.

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

getLayerCount

public int getLayerCount()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IMapControlDefault
Number of layers in the Map.

Description

Returns the number of layers in the Map that implement IDataLayer. This does not include ICompositeLayer objects.

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
Description copied from interface: IMapControlDefault
Layer at the supplied index.

Description

The Layer property is a shortcut to IMap::Layer and is used to access a particular layer in the Map. The Layer at the beginning or top of the collection with an index of 0 will be drawn last, whilst the Layer at the bottom of the collection will be drawn first.

Remarks

To loop through a Map's Layer collection use the Layer property in conjunction with the LayerCount property.

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

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IMapControlDefault
Current extent of the Map in map units.

Description

Returns or sets a new envelope which is represents the visible extent of the Map. Setting the Extent property will automatically cause the MapControl to refresh its display.

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

getObject

public java.lang.Object getObject()
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IMapControlDefault
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.

Description

In some development environments it is not possible to query interface directly on the control to other COM interfaces, beacuse the control is contained within a wrapper object. To get the real control use the Object property.

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.

getHWnd

public int getHWnd()
            throws java.io.IOException,
                   AutomationException
Description copied from interface: IMapControlDefault
Handle to the window associated with the MapControl.

Description

The operating environment identifies each window, form and control in an application by assigning it a handle, or hWnd. Many ArcObjects methods and Windows API calls require the hWnd as an argument.

Specified by:
getHWnd in interface IMapControlDefault
Returns:
The returnValue
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setExtent

public void setExtent(IEnvelope rhs1)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: IMapControlDefault
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
Description copied from interface: IMapControlDefault
Rectangular shape that encloses all features of all layers in the Map.

Description

Returns or sets a new envelope object representing the full extent of all the data layers in the Map. The FullExtent property is a shortcut to IDisplayTransformation::Bounds. Setting the FullExtent triggers the IMapControlEvents2::OnFullExtentUpdated event.

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

setFullExtent

public void setFullExtent(IEnvelope rhs1)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IMapControlDefault
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.

setVisibleRegion

public void setVisibleRegion(IGeometry rhs1)
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IMapControlDefault
The geometry specifying the visible region of the Map.

Description

Sets the MapControl's window to be the shape of the supplied geometry (in map units). Only the parts of the MapControl's layers that fall within the geometry specified will be seen.

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
Description copied from interface: IMapControlDefault
Spatial reference of the Map.

Description

This property is a shortcut to IMap::SpatialReference. The Map's SpatialReference will be set automatically to match the SpatialReference of the first  Layer added to its layer collection. If the first Layer added has no SpatialReference defined, the coordinates in the Layer will be analyzed. If the coordinates range from 0 - 180, the MapControl assumes the layers data is geographic (i.e. contains unprojected coordinates in latitude and longitude) and the SpatialReference will appear as "GCS_Assumed_Geographic_1". If the MapControl cannot determine that the data source is geographic, the current SpatialReference will be "Unknown". The SpatialReference is also "Unknown" if the MapControl contains no data.

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
Description copied from interface: IMapControlDefault
Spatial reference of the Map.

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

getCurrentTool

public ITool getCurrentTool()
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IMapControlDefault
Current active tool for the MapControl. Set to nothing to clear the tool.

Description

The CurrentTool is the Tool used to interact will the MapControl's display. Always check if a tool is enabled before setting it to the CurrentTool property, otherwise a user will be able to use a tool that is actually disabled.

Remarks

When the CurrentTool is set the following events occur:

  1. The ITool::Deactivate event is triggered on the 'old' CurrentTool if one was set. If this event returns false a trappable error ocurrs. If this event returns true the 'old' CurrentTool is removed and replaced.
  2. The ICommand::OnClick event is triggered on the 'new' CurrentTool and its cursor is picked up.

Within an ITool implementation it is recommended that the ITool::Deactivate event returns true. This allows a 'new' CurrentTool to be set, and allows the release of the CurrentTool when an application is shutting down.

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
Description copied from interface: IMapControlDefault
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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

addLayer

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

Description

When a Layer is added to the MapControl's layer collection and no index is specified, it is added to the beginning or top of the collection with an index of 0. The numeric index of any other layers in the layer collection increments by one.

When a Layer is added and an index is specified, the numeric index of any other layers in the layer collection will increment by one, except for those layers with an index less than the specified index. The index of these layers will remain the same.

Remarks

The Layer at the beginning or top of the collection with an index of 0 will be drawn last, whilst the Layer at the bottom of the collection will be drawn first.

Use the MoveLayerTo method to change the position of a Layer within the layer collection.

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
Description copied from interface: IMapControlDefault
Loads a layer file and adds it to the Map's collection of layers at the specified index position.

Description

When a layer file is added to the MapControl's layer collection and no index is specified, it is added to the beginning or top of the collection with an index of 0. The numeric index of any other layers in the layer collection increments by one.

When a layer file is added and an index is specified, the numeric index of any other layers in the layer collection will increment by one, except for those layers with an index less than the specified index. The index of these layers will remain the same.

Remarks

The Layer at the beginning or top of the collection with an index of 0 will be drawn last, whilst the Layer at the bottom of the collection will be drawn first.

Use the MoveLayerTo method to change the position of a Layer within the layer collection.

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
Description copied from interface: IMapControlDefault
Removes all layers from the Map.

Description

The method is a shortcut to IMap::ClearLayers and removes all layers from the Map. ClearLayers does not change or reset the map's SpatialReference. 

Specified by:
clearLayers in interface IMapControlDefault
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

deleteLayer

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

Description

This method is a shortcut to IMap::DeleteLayer.

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

moveLayerTo

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

Description

The Layer at the beginning or top of the collection with an index of 0 will be drawn last, whilst the Layer at the bottom of the collection will be drawn first.

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

loadMxFile

public void loadMxFile(java.lang.String mxPath,
                       java.lang.Object mapNameOrIndex,
                       java.lang.Object password)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IMapControlDefault
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.

Description

Loads an map document into the MapControl. The map document can be an ArcMap document, an ArcMap template or an ArcReader document. Use the CheckMxFile method to determine if the specified map document is a valid map document.

Remarks

When LoadMXfile is used the user may be prompted for a password; refer to the tables below to determine when this may occur. Additionally, password prompts may be given if accessing MapDocuments using either the MapControl's PropertyPage, ArcMap or ArcReader; the tables also show in what circumstances this will occur.

Loading Map Documents (*.mxd, *.mxt, *.pmf) which reference IMS Services (with and without security)

Application No Secure Services MXD/ MXT/ PMF files Secure Servcies MXD/ MXT/ PMF files Secure Servcies (password cached) MXD/ MXT files Secure Servcies (password cached) PMF files
MapControl (programmatically) No Prompt Prompt No Prompt Prompt
MapControl (property pages) No Prompt Prompt No Prompt Prompt
ArcMap No Prompt Prompt No Prompt Prompt
ArcReader (PMF files only) No Prompt Prompt N/A No Prompt

* The Connection to the Internet server must have the Save User/ Password setting enabled. This can be set, for example, when using Add Internet Server in the Add Layers Dialog. Additionally, in the case of PMF files the ArcPublisher Cache password in PMF file setting must be enabled.

Loading Published Map Files (*.pmf) (with and without password protection)

Application PMF with No Password PMF with Password
MapControl (programmatically) No Prompt Supply in Code
MapControl (property pages) No Prompt Prompt
ArcMap No Prompt Prompt
ArcReader No Prompt Prompt

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
Description copied from interface: IMapControlDefault
Redraws the Map, optionally just redraw specified phases or envelope.

Description

Use the Refresh method to redraw the display. If the Refresh method is used and no arguments are supplied the refresh is based upon the IActiveView::Refresh method.

In all other cases the refresh is based upon the IActiveView::PartialRefresh method. The Refresh method supports the esriViewDrawPhases given below:

0   :esriViewNone

1   :esriViewBackground

2   :esriViewGeography

4   :esriViewGeoSelection

8   :esriViewGraphics

16 :esriViewSelection

32 :esriViewForeground

If the Refresh method is used and no phase argument is supplied, but one of the other arguments is supplied then all phases will be refreshed and the phase value will be 65535. Always supply a phase whenever possible to increase efficiency.

Use the layerOrElement argument to refresh a particular layer or graphic element. Use the envelope argument to refresh only a particular region. For example, if a new graphic is added you may only want to refresh the area surrounding the graphic.

Remarks

Use the TrackCancel object to set whether users can stop drawing processes by using the escape or spacebar keys or by clicking the mouse.

When selecting features, Refresh must be called twice, once before and once after the selection operation.

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
Description copied from interface: IMapControlDefault
Tracks the mouse while panning the MapControl.

Description

Pan preserves the MapScale property, but changes the Extent property.

Remarks

Use the Pan method within the IMapControlEvents2::OnMouseDown event to allow the user to pan contents of the MapControl. The IMapControlEvents2::OnMouseMove event will be triggered during the pan, but no IMapControlEvents2::OnMouseUp event will occur. The ESC key on the keyboard can be used during panning to cancel the Pan.

Specified by:
pan in interface IMapControlDefault
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

centerAt

public void centerAt(IPoint centerPoint)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IMapControlDefault
Moves the center of the MapControl to the specified location.

Description

The CenterAt method positions the supplied point in the center of the MapControl. The Extent of the MapControl will change, but the scale will remain the same.

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

trackRectangle

public IEnvelope trackRectangle()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IMapControlDefault
Rubber-bands a rectangle on the MapControl.

Description

Use the TrackRectangle method within the IMapControlEvents2::OnMouseDown event to rubberband a user defined rectangle. The IMapControlEvents2::OnMouseMove event will be triggered during the track, but no IMapControlEvents2::OnMouseUp event will occur. The ESC key on the keyboard can be used during the track to cancel the TrackRectangle.

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
Description copied from interface: IMapControlDefault
Rubber-bands a polygon on the MapControl.

Description

TrackPolygon returns a geometry object that implements IPolygon.

Remarks

Use the TrackPolygon method within the IMapControlEvents2::OnMouseDown event to rubberband a user defined polygon. The IMapControlEvents2::OnMouseMove event will be triggered during the track, but no IMapControlEvents2::OnMouseUp event will occur. The ESC key on the keyboard can be used during the track to cancel the TrackPolygon.

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

trackLine

public IGeometry trackLine()
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IMapControlDefault
Rubber-bands a polyline on the MapControl.

Description

TrackLine returns a geometry object that implements IPolyline.

Remarks

Use the TrackLine method within the IMapControlEvents2::OnMouseDown event to rubberband a user defined line. The IMapControlEvents2::OnMouseMove event will be triggered during the track, but no IMapControlEvents2::OnMouseUp event will occur. The ESC key on the keyboard can be used during the track to cancel the TrackLine.

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

trackCircle

public IGeometry trackCircle()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IMapControlDefault
Rubber-bands a circle on the MapControl.

Description

TrackCircle returns a geometry object that implements IPolygon.

Remarks

Use the TrackCircle method within the IMapControlEvents2::OnMouseDown event to rubberband a user defined Circle. The IMapControlEvents2::OnMouseMove event will be triggered during the track, but no IMapControlEvents2::OnMouseUp event will occur. The ESC key on the keyboard can be used during the track to cancel the TrackCircle.

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

drawShape

public void drawShape(IGeometry shape,
                      java.lang.Object symbol)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: IMapControlDefault
Draws a geometry shape on the MapControl.

Description

DrawShape draws the supplied geometry onto the display. Use the DrawShape method within the esriViewForeground phase of the IMapControlEvents2::OnAfterDraw event.

Remarks

Geometry objects implementing IEnvelope, IMultiPatch, IMultiPoint, IPoint, IPolygon and IPolyline are supported. 

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
Description copied from interface: IMapControlDefault
Flashes a shape on the MapControl, duration is in milliseconds.

Description

FlashShape flashes the supplied geometry onto the display.

Remarks

Geometry objects implementing IEnvelope, IMultiPatch, IMultiPoint, IPoint, IPolygon and IPolyline are supported. 

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
Description copied from interface: IMapControlDefault
Converts a point on the Map (in map units) to device co-ordinates (typically pixels).

Description

The FromMapPoint method takes an input point in MapUnits, and populates two variables with the equivalent control coordinates in 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
Description copied from interface: IMapControlDefault
Converts a point in device co-ordinates (typically pixels) to a point on the Map (in map units).

Description

ToMapPoint converts a (X,Y) location in pixels to MapUnits.

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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

drawText

public void drawText(IGeometry pGeometry,
                     java.lang.String text,
                     java.lang.Object pSymbol)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IMapControlDefault
Draws text along the supplied geometry.

Description

DrawText draws a text string around a specified geometry. Use the DrawText method within the esriViewForeground phase of the IMapControlEvents2::OnAfterDraw event.

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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

checkMxFile

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

Description

Determines whether the specified map document (*.mxd, *.mxt, *.pmf) is a valid map document and can be loaded into the MapControl. The method verifies the file exists and verifies the file internals conform to an expected storage format. The method does not read and validate the entire contents of the file; use the LoadMxFile to do this.

Specified by:
checkMxFile in interface IMapControlDefault
Parameters:
fileName - The fileName (in)
Returns:
The returnValue
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

readMxMaps

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

Description

ReadMxMaps creates an array of Map objects from the specified Map Document (ArcMap document, ArcMap template or ArcReader document).

Remarks

When ReadMXMaps is used the user may be prompted for a password; refer to the tables below to determine when this may occur. Additionally, password prompts may be given if accessing MapDocuments using either the MapControl's PropertyPage, ArcMap or ArcReader; the tables also show in what circumstances this will occur.

Reading Map Documents (*.mxd, *.mxt, *.pmf) which reference IMS Services (with and without security)

Application No Secure Services MXD/ MXT/ PMF files Secure Servcies MXD/ MXT/ PMF files Secure Servcies (password cached) MXD/ MXT files Secure Servcies (password cached) PMF files
MapControl (programmatically) No Prompt Prompt No Prompt Prompt
MapControl (property pages) No Prompt Prompt No Prompt Prompt
ArcMap No Prompt Prompt No Prompt Prompt
ArcReader (PMF files only) No Prompt Prompt N/A No Prompt

* The Connection to the Internet server must have the Save User/ Password setting enabled. This can be set, for example, when using Add Internet Server in the Add Layers Dialog. Additionally, in the case of PMF files the ArcPublisher Cache password in PMF file setting must be enabled.

Reading Published Map Files (*.pmf) (with and without password protection)

Application PMF with No Password PMF with Password
MapControl (programmatically) No Prompt Supply in Code
MapControl (property pages) No Prompt Prompt
ArcMap No Prompt Prompt
ArcReader No Prompt Prompt

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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getTrackCancel

public ITrackCancel getTrackCancel()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IMapControlDefault
The object used by the MapControl to check if drawing has been aborted.

Description

Use the TrackCancel object to enable users to stop drawing processes by using the escape or spacebar keys.

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
Description copied from interface: IMapControlDefault
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
Description copied from interface: IMapControlDefault
A property to associate data with a control.

Description

Use the CustomProperty to associate any useful data with the MapControl. This is similar to a 'Tag' property, and can be use to store strings, numbers and objects.

Specified by:
getCustomProperty in interface IMapControlDefault
Returns:
A Variant
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setCustomProperty

public void setCustomProperty(java.lang.Object rhs1)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IMapControlDefault
A property to associate data with a control.

Specified by:
setCustomProperty in interface IMapControlDefault
Parameters:
rhs1 - A Variant (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

suppressResizeDrawing

public void suppressResizeDrawing(boolean suppressResize,
                                  int resizeHWnd)
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IMapControlDefault
Suppress full redraw of control during resize operations.

Description

If the MapControl contains a lot of data, redrawing this data during a resize event can be costly. To increase performance you can suppress the data redraw until the resizing is complete with the SuppressResizeDrawing method. During the resize a stretched bitmap will be drawn instead.

Passing the suppressResize value sets the IScreenDisplay::SuppressResize property on the ActiveView. Pass True to suppress normal drawing and draw a stretched bitmap when a resize event begins. During the resize the data is not refereshed and the captured image is stretched. As such, the image can appear pixelated when a small display area is resized to a large display area. Pass False to resume normal drawing when a resize event ends.

In development environments that do not trap the beginning and end of a resize event, the MapControl can 'watch' the hwnd supplied to the SuppressResizeDrawing method. When a form or container starts resizing the WM_ENTERSIZEMOVE windows messge is sent and the MapControl will set suppressResize to True. When windows sends the WM_EXITSIZEMOVE message the form or container is released from resizing and the the MapControl will set suppressResize to False. Pass the hwnd of the form or container to the SuppressResizeDrawing method when the form or container is initialized. Passing an hwnd of 0 will stop the MapControl watching the hwnd.

Specified by:
suppressResizeDrawing in interface IMapControlDefault
Parameters:
suppressResize - The suppressResize (in)
resizeHWnd - The resizeHWnd (in, optional, pass 0 if not required)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setTipDelay

public void setTipDelay(int rhs1)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IMapControlDefault
The delay before map tips are shown.

Specified by:
setTipDelay in interface IMapControlDefault
Parameters:
rhs1 - The rhs1 (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getTipDelay

public int getTipDelay()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IMapControlDefault
The delay before map tips are shown.

Description

Returns or sets the time delay in milliseconds before map tips are displayed. By default TipDelay is 500 milliseconds.

Specified by:
getTipDelay in interface IMapControlDefault
Returns:
The returnValue
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getScale

public double getScale(IBasicMap pBasicMap)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: ITOCBuddy
Returns the scale of the supplied BasicMap, this allows for objects that do not support IMap.

Description

The GetScale method returns scale of the supplied Map or Scene. If the scale is unknown the GetScale method returns 0.0.

Specified by:
getScale in interface ITOCBuddy
Parameters:
pBasicMap - A reference to a com.esri.arcgis.carto.IBasicMap (in)
Returns:
The dScale
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPageLayout

public IPageLayout getPageLayout()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IMxdContents
The PageLayout object.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPageLayout in interface IMxdContents
Returns:
A reference to a com.esri.arcgis.carto.IPageLayout
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IConnectionPointContainer

Supported Platforms

Windows, Solaris, Linux

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:
enumConnectionPoints in interface IConnectionPointContainer
Parameters:
ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IConnectionPointContainer

Supported Platforms

Windows, Solaris, Linux

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:
findConnectionPoint in interface IConnectionPointContainer
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
Description copied from interface: IPersistStreamInit

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStreamInit
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

load

public void load(IStream pStm)
          throws java.io.IOException,
                 AutomationException
Description copied from interface: IPersistStreamInit

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStreamInit
Parameters:
pStm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pStm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException
Description copied from interface: IPersistStreamInit

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStreamInit
Parameters:
pStm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pCbSize)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IPersistStreamInit

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStreamInit
Parameters:
pCbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

initNew

public void initNew()
             throws java.io.IOException,
                    AutomationException
Description copied from interface: IPersistStreamInit

Supported Platforms

Windows, Solaris, Linux

Specified by:
initNew in interface IPersistStreamInit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMouseIconByRef

public void setMouseIconByRef(Picture picture)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IMapControlDefault
Custom mouse icon used if MousePointer is 99.

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

getMouseIcon

public Picture getMouseIcon()
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IMapControlDefault
Custom mouse icon used if MousePointer is 99.

Description

The MouseIcon property provides a custom icon that is used when the MousePointer property is set to esriPointerArrowHourglass (99).

Remarks

In most development evironments the control's property pages can be used to load either a cursor (.cur) or icon (.ico) file. A cursor contains a custom 'hotspot' location and can be any size. The 'hotspot' location for an icon file defaults to the center of the icon. This property cannot be used to load animated cursor (.ani) files.

To programatically create an object implementing IPictureDisp there is the win32 function OleLoadPicture or helper methods depending on the development environment. 

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.

aboutBox

public void aboutBox()
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IMapControlDefault
Displays a dialog of information about the MapControl.

Description

The AboutBox method causes a modal dialog box to display on top of the MapControl, containing information about the version and creation date of the MapControl as well as listing relevant legal and copyright information from ESRI.

Specified by:
aboutBox in interface IMapControlDefault
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getJintegraDispatch

public Dispatch getJintegraDispatch()
Description copied from interface: RemoteObjRef
Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:
getJintegraDispatch in interface RemoteObjRef
Returns:
the COM object reference

release

public void release()
Description copied from interface: RemoteObjRef
Release this COM object reference

Specified by:
release in interface RemoteObjRef

getClassID

public void getClassID(GUID[] gUIDArray)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:
getClassID in interface IPersist
Parameters:
gUIDArray - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID gUID)
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
gUID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isAutoMouseWheel

public boolean isAutoMouseWheel()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IMapControlDefault
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.

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
Description copied from interface: IMapControlDefault
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
Description copied from interface: IMapControlDefault
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.

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
Description copied from interface: IMapControlDefault
Indicates whether keyboard scrolling is enabled.

Specified by:
setAutoKeyboardScrolling in interface IMapControlDefault
Parameters:
rhs1 - The rhs1 (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.