com.esri.arcgis.carto
Class Map

java.lang.Object
  extended by com.esri.arcgis.carto.Map
All Implemented Interfaces:
IActiveView, IBasicMap, IBasicMap2, IDynamicMap, IGraphicsContainer, IGraphicsContainerSelect, ILayerMasking, ILevelMasking, IMap, IMapAdmin, IMapAdmin2, IMapAdmin3, IMapAdmin4, IMapAutoExtentOptions, IMapBarriers, IMapBarriers2, IMapBookmarks, IMapBookmarks2, IMapCache, IMapClipOptions, IMapGeographicTransformations, IMapLayers, IMapLayers2, IMapOverposter, IMapTimeDisplay, IMapTimeDisplay2, IMxdContents, IRelationshipClassCollection, ISelectionEvents, IServiceLayerCredits, IStandaloneTableCollection, ITableCollection, IViewManager, IViewRefresh, IConnectionPointContainer, IDisplayAdmin, IDisplayEvents, ITransformEvents, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable, java.util.EventListener

public class Map
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMap, IBasicMap, IBasicMap2, IMapBarriers, IMapBarriers2, IActiveView, IViewManager, IViewRefresh, IGraphicsContainer, IGraphicsContainerSelect, IConnectionPointContainer, IPersistStream, IPersist, IMapBookmarks, IMapBookmarks2, ISelectionEvents, IDisplayEvents, ITransformEvents, ITableCollection, IStandaloneTableCollection, IDisplayAdmin, IMapAdmin, IMapAdmin2, IMapAdmin3, IMapAdmin4, IRelationshipClassCollection, IMapGeographicTransformations, IMapCache, ILayerMasking, ILevelMasking, IMxdContents, IMapOverposter, IMapLayers, IDynamicMap, IMapLayers2, IMapClipOptions, IMapAutoExtentOptions, IMapTimeDisplay, IMapTimeDisplay2, IServiceLayerCredits, java.io.Externalizable

COM Class 'Map'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'A container for the display and manipulation of map data.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.carto.IMap
IID, IIDe6bdaa75_4d35_11d0_98be_00805f7ced21, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IBasicMap
IID, IIDb9d60c9e_121e_11d4_ab6c_0008c73fd50c, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IBasicMap2
IID, IID47fa77fa_2f59_42b9_9048_7b139da3fe26, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapBarriers
IID, IID2c616e2f_b074_4119_868a_caa5115f5961, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapBarriers2
IID, IID77af76b1_b80a_ded2_331b_cb3f50e50f2a, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IActiveView
IID, IIDdd94d76b_836d_11d0_87ec_080009ec732a, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IViewManager
IID, IIDdd94d76c_836d_11d0_87ec_080009ec732a, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IViewRefresh
IID, IID5f78435a_7443_4195_beb2_caefa63433d8, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IGraphicsContainer
IID, IIDd09411d1_4bb4_11d1_b6cc_080009b996cc, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IGraphicsContainerSelect
IID, IIDd09411d2_4bb4_11d1_b6cc_080009b996cc, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer
IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Fields inherited from interface com.esri.arcgis.carto.IMapBookmarks
IID, IIDee53528f_41c9_11d1_880a_080009ec732a, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapBookmarks2
IID, IIDdec80b31_b4ba_48b2_84e1_9b80119f405e, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ISelectionEvents
IID, IID07e11311_d615_11d1_a21b_080009b6f22b, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IDisplayEvents
IID, IIDe6bdb003_4d35_11d0_98be_00805f7ced21, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.ITransformEvents
IID, IIDe6bdb001_4d35_11d0_98be_00805f7ced21, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ITableCollection
IID, IID7d931eab_d31f_11d2_9f40_00c04f6bc78e, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IStandaloneTableCollection
IID, IID3c2aceaa_e3dc_11d3_a096_00c04f6bc626, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IDisplayAdmin
IID, IID12e361f0_1907_11d3_80c7_0080c79f0371, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapAdmin
IID, IIDe34551db_eee2_11d2_b86f_00600802e603, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapAdmin2
IID, IID016c393a_7751_40e1_b6e9_f6b454a4493a, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapAdmin3
IID, IID14eddf51_9d91_4c9c_89c1_f862381e0fde, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapAdmin4
IID, IID900f7083_22ae_42b4_a00c_1776e316a910, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IRelationshipClassCollection
IID, IID741d6114_fb6b_11d3_adf5_00c04fa33a15, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapGeographicTransformations
IID, IID24420050_03fe_11d4_9fe9_00c04f6bc78e, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapCache
IID, IID6e57310f_c58d_4e49_b106_e52fcb51c55a, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ILayerMasking
IID, IID536427da_5354_491d_ae92_abebaa8bb05b, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ILevelMasking
IID, IIDa4b202d6_363f_455d_a581_c323834df4f7, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMxdContents
IID, IIDbe202904_9c7f_4d51_80b2_dbc960224e7f, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapOverposter
IID, IID7cf1a834_dca5_40df_9fa0_544fa3b09eff, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IDynamicMap
IID, IID92191b6f_d881_4829_8b75_ce846970f67b, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapLayers2
IID, IID6ccd973c_5309_4166_9f50_07a371179f0e, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapLayers
IID76da57e7_6a92_4090_8ca9_f5d9eca78353
 
Fields inherited from interface com.esri.arcgis.carto.IMapClipOptions
IID, IID49522374_ec8e_4c1a_ba3b_2a4cc963652c, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapAutoExtentOptions
IID, IIDe5461b30_c74f_47f0_bdf3_65898ac2b622, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapTimeDisplay2
IID, IID51d8ac4d_d2c5_4f89_87c8_09d8d23360a6, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapTimeDisplay
IID54bc9b6f_3a81_48d0_a07c_52238b28dc7a
 
Fields inherited from interface com.esri.arcgis.carto.IServiceLayerCredits
IID, IIDb52367cf_3b14_444d_b4fa_06a984d6ed15, xxDummy
 
Constructor Summary
Map()
          Constructs a Map using ArcGIS Engine.
Map(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Map theMap = (Map) obj;
 
Method Summary
 void activate(int hWnd)
          Gives this view control of the specified window.
 void addBookmark(ISpatialBookmark bookmark)
          Adds a bookmark to the collection.
 void addElement(IElement element, int zorder)
          Add a new graphic element to the layer.
 void addElements(IElementCollection elements, int zorder)
          Add new graphic elements to the layer.
 void addIActiveViewEventsListener(IActiveViewEvents theListener)
          addIActiveViewEventsListener.
 void addIDynamicMapEventsListener(IDynamicMapEvents theListener)
          addIDynamicMapEventsListener.
 void addIMapEventsListener(IMapEvents theListener)
          addIMapEventsListener.
 void addLayer(ILayer layer)
          Adds a layer to the map.
 void addLayers(IEnumLayer layers, boolean autoArrange)
          Adds multiple layers to the map, arranging them nicely if specified.
 void addMapSurround(IMapSurround mapSurround)
          Adds a map surround to the map.
 void addStandaloneTable(IStandaloneTable table)
          Adds a standalone table to the collection.
 void addTable(ITable table)
          Adds a table to the collection.
 void animationRefresh(int phase, java.lang.Object data, IEnvelope envelope)
          Use to quickly redraw a phase that has it's own cache, i.e., a tracking layer.
 void animationRefreshShape(int phase, java.lang.Object data, IGeometry geometry, double symbolSizePoints)
          Use to quickly redraw a phase that has it's own cache, i.e., a tracking layer.
 void boundsUpdated(ITransformEventsBoundsUpdatedEvent theEvent)
          Notifies clients when the bounds is updated.
 void bringForward(IEnumElement elements)
          Move the specified elements one step closer to the top of the stack of elements.
 void bringToFront(IEnumElement elements)
          Make the specified elements draw in front of all other elements.
 void buildCache()
          Build the spatial cache.
 void clear()
          Empties the view contents.
 void clearLayers()
          Removes all layers from the map.
 void clearMapSurrounds()
          Removes all map surrounds from the map.
 void clearMasking(ILayer layer)
          Clear masking layers on a layer.
 void clearSelection()
          Clears the map selection.
 boolean completeRedrawNeeded()
          Check if a complete redraw is needed.
 double computeDistance(IPoint p1, IPoint p2)
          Computes the distance between two points on the map and returns the result.
 ITimeExtent computeFullTimeExtent()
          Returns the full time extent of the time-enabled layers in the map.
 void contentsChanged()
          Called by clients when view objects are modified.
 IMapSurround createMapSurround(IUID cLSID, IMapSurround optionalStyle)
          Create and initialize a map surround.
 void deactivate()
          Another view takes over the associated window.
 void delayDrawing(boolean delay)
          Suspends drawing.
 void delayEvents(boolean delay)
          Used to batch operations together to minimize notifications.
 void deleteAllElements()
          Delete all the elements.
 void deleteElement(IElement element)
          Delete the given element.
 void deleteLayer(ILayer layer)
          Deletes a layer from the map.
 void deleteMapSurround(IMapSurround mapSurround)
          Deletes a map surround from the map.
 void deviceFrameUpdated(ITransformEventsDeviceFrameUpdatedEvent theEvent)
          Notifies clients when the device frame is updated.
 void displayFinished(IDisplayEventsDisplayFinishedEvent theEvent)
          Notifies clients when drawing completes.
 void displayInvalidated(IDisplayEventsDisplayInvalidatedEvent theEvent)
          Notifies clients when display is invalidated.
 void displayScrolled(IDisplayEventsDisplayScrolledEvent theEvent)
          Notifies clients when display is scrolled.
 void displayStarted(IDisplayEventsDisplayStartedEvent theEvent)
          Notifies clients when drawing starts.
 void draw(int hDC, ITrackCancel trackCancel)
          Draws the view to the specified device context.
 boolean elementSelected(IElement element)
          Indicates if the element is selected.
 void emptyCache()
          Empty the map cache.
 void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
          enumConnectionPoints
 boolean equals(java.lang.Object o)
          Compare this object with another
 void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)
          findConnectionPoint
 IFrameElement findFrame(java.lang.Object frameObject)
          Find the frame that contains the specified object.
 IEnumRelationshipClass findRelationshipClasses(IObjectClass objectClass, int role)
          Finds all relationship classes in the collection that reference the given object class in the specified role.
 void fireAfterDraw(int hDC)
          Fire AfterDraw(esriViewForeground) event.
 void fireChangeFeatureClass(IFeatureClass oldClass, IFeatureClass newClass)
          Notifies listeners that the a layer's class has changed.
 void fireChangeTable(ITable oldTable, ITable newTable)
          Notifies listeners that the a layer's class has changed.
 void fireChangeVersion(IVersion oldVersion, IVersion newVersion)
          Notifies listeners that a version in the map changed.
 void fireLayerAdded(ILayer layer)
          Notifies listeners that a layer has been added to the map.
 void fireLayerDeleted(ILayer layer)
          Notifies listeners that a layer has been removed from the map.
 void fireLayerReordered(ILayer layer, int toIndex)
          Notifies listeners that a layer has been reordered the map.
 void forceGraphicSelectionDraw()
          Call before using Output to cause graphic selection to be drawn.
 ILayer getActiveGraphicsLayer()
          The active graphics layer.
 IActiveView getActiveView()
          The Map object.
 IAnnotateMap getAnnotationEngine()
          The annotation (label) engine the map will use.
 IEnvelope getAutoExtentBounds()
          The bounds of the map displayed by the frame.
 IFeatureLayer getAutoExtentLayer()
          Auto extent features.
 IMap getAutoExtentMap()
          Auto extent map.
 double getAutoExtentMargin()
          Auto extent margin.
 int getAutoExtentMarginUnits()
          Auto extent margin units.
 double getAutoExtentScale()
          The scale at which the map should be displayed.
 int getAutoExtentType()
          The way in which the map extent of the frame is specified.
 IBarrierCollection getBarriers(IEnvelope pExtent)
          The list of barriers and their weight for labeling.
 IBarrierCollection getBarriers2(IEnvelope pExtent, ITrackCancel pTrackCancel)
          The list of barriers and their weight for labeling.
 IBarrierCollection getBarriers3(IEnvelope pExtent, double scale, ITrackCancel pTrackCancel)
          The list of barriers and their weight for labeling.
 IGraphicsLayer getBasicGraphicsLayer()
          The basic graphics layer.
 IEnumSpatialBookmark getBookmarks()
          The bookmarks.
 IEnvelope getCacheExtent()
          Current cache extent.
 void getClassID(GUID[] pClassID)
          getClassID
 IBorder getClipBorder()
          An optional border drawn around ClipGeometry.
 java.lang.Object getClipData()
          Sets or returns extended clip type data, i.e., other Map when type is esriMapClipMapExtent.
 ISet getClipFilter()
          Sets or returns the set of layers that will be excluded from clipping.
 IGeometry getClipGeometry()
          A shape that layers in the map are clipped to.
 int getClipType()
          Method used to clip layers in map.
static java.lang.String getClsid()
          getClsid.
 void getContextMenu(double x, double y, IUID[] clsidMenu)
          Called when a context menu should be displayed at the given xy location.
 java.lang.String getCopyrightText()
          Copyright information associated with the map.
 ITimeExtent getCurrentTimeExtent()
          The current time extent of the map.
 double getDefaultTimeInterval()
          The time interval to be used by the time slider to animate the map.
 int getDefaultTimeIntervalUnits()
          The time interval units to be used to animate the map.
 double getDefaultTimeWindow()
          The time window used to display the data in the map.
 java.lang.String getDescription()
          Description of the map.
 java.lang.String getDisplayDateFormat()
          The format of the date that is displayed on the time slider.
 int getDisplaySpeed()
          The speed of the slider on a scale of 1 to 10 with 10 being the fastest.
 java.lang.String getDisplayTimeFormat()
          The format of the time that is displayed on the time slider.
 int getDistanceUnits()
          The distance units for the map.
 ILayer getDomainDefiningLayer()
          Returns the layer which defines map domain, 0 if domain is the union of all layers.
 IElement getDominantElement()
          Dominant element.
 int getDynamicDrawRate()
          The Dynamic draw rate in milliseconds.
 java.lang.Object getElementOrder(IEnumElement elements)
          Private order object.
 ISelection getElementSelection()
          Object to use for element selection.
 int getElementSelectionCount()
          The number of selected elements.
 tagRECT getExportFrame()
          The device rectangle to export.
 IEnvelope getExtent()
          The visible extent rectangle.
 IExtentStack getExtentStack()
          The extent stack.
 ISelection getFeatureSelection()
          The feature selection for the map.
 IMap getFocusMap()
          The map that tools and controls act on.
 IEnvelope getFullExtent()
          The full extent rectangle.
 ITimeExtent getFullTimeExtent()
          Returns the full time extent of the time-enabled layers in the map.
 IGeoTransformationOperationSet getGeographicTransformations()
          On-the-fly geographic transformations.
 IGraphicsContainer getGraphicsContainer()
          The active graphics container.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 ILayer getLayer(int index)
          The layer at the given index.
 int getLayerCount()
          Number of layers in the map.
 IEnumLayer getLayers(IUID uid, boolean recursive)
          The layers in the map of the type specified in the uid.
 java.lang.String getLevelMasking(ILayer maskedLayer, ILayer maskingLayer)
          The symbol levels for which the masking applies.
 void getLockedPan(boolean[] flag)
          Check if the map can be panned.
 void getLockedZoom(boolean[] flag)
          Check if the map can be zoomed.
 IMap getMap()
          The Map object.
 double getMapScale()
          The scale of the map as a representative fraction.
 IMapSurround getMapSurround(int index)
          The map surround at the given index.
 int getMapSurroundCount()
          Number of map surrounds associated with the map.
 int getMapUnits()
          The units for the map.
 ISet getMaskedLayers()
          The set of layers that are being masked.
 ISet getMaskingLayers(ILayer layer)
          The masks for a layer.
 double getMaxScale()
          The maximum scale for the cache to be built.
 java.lang.String getName()
          Name of the map.
 IBackground getNonFrameBackground()
          Specify the background to use when drawing to destinations other than a frame.
 int getOutputBandSize()
          Size allocated for each band when banding output.
 IOverposterProperties getOverposterProperties()
          The overposter the map will use for labeling.
 IPageLayout getPageLayout()
          The PageLayout object.
 void getPageSize(double[] widthInches, double[] heightInches)
          Gets the page size for the map.
 int getPlayOption()
          The play option (Stop, Reverse, Repeat) used by the slider after the time visualization has been played once.
 double getReferenceScale()
          The reference scale of the map as a representative fraction.
 IEnumRelationshipClass getRelationshipClasses()
          The memory relationship classes.
 short getScreenCacheID(int phase, java.lang.Object data)
          The screen cache ID that is used to draw the specified phase.
 IScreenDisplay getScreenDisplay()
          The screen display used by the view.
 IEnumElement getSelectedElements()
          The selected elements.
 ISelection getSelection()
          The selection.
 IEnvelope getSelectionBounds(IDisplay display)
          The bounds of the selection.
 int getSelectionCount()
          Number of selected features.
 java.lang.String getServiceLayerCreditsText(java.lang.String separator)
          Get the service layer credits text.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 ISpatialReference getSpatialReference()
          The spatial reference of the map.
 IStandaloneTable getStandaloneTable(int index)
          The standalone table at the given index.
 int getStandaloneTableCount()
          Number of standalone tables.
 ITable getTable(int index)
          The table at the given index.
 int getTableCount()
          Number of tables.
 ILayer getTimeExtentDefinitionLayer()
          The time-enabled layer that defines the time extent of the map.
 int getTimeExtentOption()
          Indicates how the time extent of the map is defined.
 ITimeReference getTimeReference()
          The time reference (time zone information, daylight savings, etc.) associated with the map.
 int getTimeRelation()
          Time relation used with the time window for the map.
 ITimeValue getTimeValue()
          The time extent for which the data is displayed in the map.
 java.lang.String getTipText(double x, double y)
          The tip text to display at the given location.
 int getTopFilterIndex()
          Phase index that supplements TopFilterPhase.
 int getTopFilterPhase()
          The highest phase in the drawing order that uses a display filter.
 int hashCode()
          the hashcode for this object
 boolean hasTimeData()
          Indicates whether the map has a time-enabled layer.
 IMap hitTestMap(IPoint location)
          Returns any maps present in the view at the given location.
 void insertLayer(ILayer pLayer, boolean autoArrange, int position)
          Inserts a layer at the given position.
 void insertLayerInGroup(IGroupLayer pGroup, ILayer pLayer, boolean autoArrange, int position)
          Inserts a layer at a given index of the map's group layer.
 void insertLayers(IEnumLayer pLayers, boolean autoArrange, int position)
          Inserts layers at the given position.
 void insertLayersInGroup(IGroupLayer pGroup, IEnumLayer pLayer, boolean autoArrange, int position)
          Inserts layers at a given index of the map's group layer.
 boolean isActive()
          Indicates if view is active or not.
 boolean isAutoCacheActive()
          Indicates whether the autocache is active.
 boolean isCacheable()
          Indicates whether a map cache can be created.
 boolean isClipGridAndGraticules()
          Clip grids and grticules to data extent
 boolean isConserveMemory()
          Indicates whether to be conservative when allocating resources.
 boolean isDelayBackgroundDraw()
          Indicates if the background should draw immediately.
 void isDirty()
          isDirty
 boolean isDisplayEachTimestamp()
          Indicates whether data for each timestamp will be drawn when playing the time visualization.
 boolean isDrawing()
          Indicates whether the view is currently drawing or not.
 boolean isDynamicMapEnabled()
          Indicates if dynamic map is turned on or off.
 boolean isDynamicTimeRefresh()
          Indicates whether the data in the map refreshes when moving the time slider dynamically.
 boolean isExpanded()
          Indicates if the Map is expanded.
 boolean isExternalDrawing(int phase)
          Indicates if external clients are drawing in response to the specified phase.
 boolean isFramed()
          Indicates if map is drawn in a frame rather than on the whole window.
 boolean isHasLiveData()
          Indicates whether the map has a time-enabled layer that is being updated frequently with new data.
 boolean isLayerVisible(ILayer layer)
          Check if layer is visible.
 void isLayerVisibleEx(ILayer layer, boolean[] isLayerVisible, boolean[] isParentLayerVisible)
          Check if layer is visible.
 boolean isMapActivated()
          Indicates if the focus map is activated.
 boolean isProgressiveDrawing()
          Indicates whether the view should progressively update the window during drawing.
 boolean isScaleLimit()
          Indicates whether there is a scale limit.
 boolean isShowRulers()
          Indicates if rulers are visible.
 boolean isShowScrollBars()
          Indicates if scrollbars are visible.
 boolean isShowSelection()
          Indicates if selection is visible.
 boolean isShowTime()
          Indicates whether time is enabled on the map.
 boolean isShowTimeOnDisplay()
          Indicates whether time is displayed on the map.
 boolean isSimulateLayerEffectsInLegends()
          Indicates whether to simulate transparency and other effects in legends.
 boolean isSpatialReferenceLocked()
          Indicates whether the spatial reference is prevented from being changed.
 boolean isUseMasking()
          Indicates whether to use masking.
 boolean isUsesFilter()
          Indicates if the current object draws using a filter.
 boolean isUsesPageCoordinates()
          Indicates whether view uses page coordinates.
 boolean isUseSubPixelRendering()
          Indicates whether the dynamic map is rendered in Sub Pixels or Full Pixels (snap to the nearest discrete pixel).
 boolean isUseSymbolLevels()
          Indicates if the Map draws using symbol levels.
 boolean isVerboseEvents()
          Indicates whether to expand or limit the number of events that are fired.
 void load(IStream pstm)
          load
 IEnumElement locateElements(IPoint point, double tolerance)
          Returns the elements at the given coordinate.
 IEnumElement locateElementsByEnvelope(IEnvelope envelope)
          Returns the elements inside the given envelope.
 void moveBookmarkTo(ISpatialBookmark bookmark, int index)
          Moves a bookmark in the collection.
 void moveElementFromGroup(IGroupElement group, IElement element, int zorder)
          Move the element from the group to the container.
 void moveElementToGroup(IElement element, IGroupElement group)
          Move the element from the container to the group.
 void moveLayer(ILayer layer, int toIndex)
          Moves a layer to another position.
 void moveLayerEx(IGroupLayer pFromGroup, IGroupLayer pToGroup, ILayer pLayer, int newPosition)
          Moves the layer with in the map.
 IElement next()
          Returns the next graphic in the container.
 void onMessage(int msg, int wParam, int lParam)
          Call from your application's message loop to enable automatic resizing and keyboard accelerators.
 void output(int hDC, int dpi, tagRECT pixelBounds, IEnvelope visibleBounds, ITrackCancel trackCancel)
          Renders the view to the specified DC.
 void partialRefresh(int phase, java.lang.Object data, IEnvelope envelope)
          Draws the specified view phase.
 void partialRefreshShape(int phase, java.lang.Object data, IGeometry geometry, double symbolSizePoints)
          Refreshes the specified shape on the specified view phase.
 void printerChanged(IPrinter printer)
          Called by application when printer changes.
 void putElementOrder(java.lang.Object order)
          Private order object.
 void readExternal(java.io.ObjectInput in)
           
 void recalcFullExtent()
          Forces the full extent to be recalculated.
 void refresh()
          Causes the entire view to draw.
 void refreshAutoCache()
          Refresh the autocache.
 void refreshCaches()
          Reallocate the display caches.
 void refreshItem(java.lang.Object data)
          Use to redraw a specific item and the content above it.
 void release()
          Release a Map.
 void removeAllBookmarks()
          Removes all bookmarks.
 void removeAllStandaloneTables()
          Removes all standalone tables from the collection.
 void removeAllTables()
          Removes all tables from the collection.
 void removeBookmark(ISpatialBookmark bookmark)
          Removes a bookmark from the collection.
 void removeIActiveViewEventsListener(IActiveViewEvents theListener)
          removeIActiveViewEventsListener.
 void removeIDynamicMapEventsListener(IDynamicMapEvents theListener)
          removeIDynamicMapEventsListener.
 void removeIMapEventsListener(IMapEvents theListener)
          removeIMapEventsListener.
 void removeStandaloneTable(IStandaloneTable table)
          Removes the standalone table from the collection.
 void removeTable(ITable table)
          Removes a table from the collection.
 void reset()
          Reset internal cursor so that Next returns the first element.
 void resolutionUpdated(ITransformEventsResolutionUpdatedEvent theEvent)
          Notifies clients when the resolution is updated.
 void rotationUpdated(ITransformEventsRotationUpdatedEvent theEvent)
          Notifies clients when the rotation angle is updated.
 void save(IStream pstm, int fClearDirty)
          save
 void selectAllElements()
          Selects all elements.
 void selectByShape(IGeometry shape, ISelectionEnvironment env, boolean justOne)
          Selects features in the map given a shape and a selection environment (optional).
 IElement selectedElement(int index)
          Returns the nth selected element.
 void selectElement(IElement element)
          Selects the specified element.
 void selectElements(IEnumElement elements)
          Selects the specified elements.
 void selectFeature(ILayer layer, IFeature feature)
          Selects a feature.
 void selectionChanged(ISelectionEventsSelectionChangedEvent theEvent)
          Call this function to fire the selection changed event.
 ISelectionTracker selectionTracker(int index)
          Returns the tracker for the nth selected element.
 void sendBackward(IEnumElement elements)
          Move the specified elements one step closer to the bottom of the stack of elements.
 void sendToBack(IEnumElement elements)
          Make the specified elements draw behind all other elements.
 void setActiveGraphicsLayerByRef(ILayer graphicsLayer)
          The active graphics layer.
 void setAnnotationEngineByRef(IAnnotateMap annotateMap)
          The annotation (label) engine the map will use.
 void setAreaOfInterest(IEnvelope rhs1)
          Area of interest for the map.
 void setAutoCacheActive(boolean active)
          Indicates whether the autocache is active.
 void setAutoExtentBounds(IEnvelope bounds)
          The bounds of the map displayed by the frame.
 void setAutoExtentLayerByRef(IFeatureLayer layer)
          Auto extent features.
 void setAutoExtentMapByRef(IMap map)
          Auto extent map.
 void setAutoExtentMargin(double margin)
          Auto extent margin.
 void setAutoExtentMarginUnits(int units)
          Auto extent margin units.
 void setAutoExtentScale(double scale)
          The scale at which the map should be displayed.
 void setAutoExtentType(int type)
          The way in which the map extent of the frame is specified.
 void setClipBorder(IBorder border)
          An optional border drawn around ClipGeometry.
 void setClipBounds(IGeometry rhs1)
          Specify a boundary to clip to.
 void setClipData(java.lang.Object data)
          Sets or returns extended clip type data, i.e., other Map when type is esriMapClipMapExtent.
 void setClipFilter(ISet layers)
          Sets or returns the set of layers that will be excluded from clipping.
 void setClipGeometry(IGeometry clipGeometry)
          A shape that layers in the map are clipped to.
 void setClipGridAndGraticules(boolean pClipGridAndGraticules)
          Clip grids and grticules to data extent
 void setClipType(int type)
          Method used to clip layers in map.
 void setConserveMemory(boolean flag)
          Indicates whether to be conservative when allocating resources.
 void setCopyrightText(java.lang.String copyright)
          Copyright information associated with the map.
 void setCurrentTimeExtentByRef(ITimeExtent timeExtent)
          The current time extent of the map.
 void setDefaultTimeInterval(double interval)
          The time interval to be used by the time slider to animate the map.
 void setDefaultTimeIntervalUnits(int units)
          The time interval units to be used to animate the map.
 void setDefaultTimeWindow(double duration)
          The time window used to display the data in the map.
 void setDelayBackgroundDraw(boolean flag)
          Indicates if the background should draw immediately.
 void setDescription(java.lang.String descr)
          Description of the map.
 void setDisplayDateFormat(java.lang.String dateFormat)
          The format of the date that is displayed on the time slider.
 void setDisplayEachTimestamp(boolean value)
          Indicates whether data for each timestamp will be drawn when playing the time visualization.
 void setDisplaySpeed(int speed)
          The speed of the slider on a scale of 1 to 10 with 10 being the fastest.
 void setDisplayTimeFormat(java.lang.String timeFormat)
          The format of the time that is displayed on the time slider.
 void setDistanceUnits(int unitsCode)
          The distance units for the map.
 void setDomainDefiningLayer(ILayer layer)
          Returns the layer which defines map domain, 0 if domain is the union of all layers.
 void setDominantElementByRef(IElement dominantItem)
          Dominant element.
 void setDynamicDrawRate(int dynamicDrawRateMS)
          The Dynamic draw rate in milliseconds.
 void setDynamicMapEnabled(boolean isEnable)
          Indicates if dynamic map is turned on or off.
 void setDynamicTimeRefresh(boolean flag)
          Indicates whether the data in the map refreshes when moving the time slider dynamically.
 void setElementSelectionByRef(ISelection selectionObject)
          Object to use for element selection.
 void setExpanded(boolean expanded)
          Indicates if the Map is expanded.
 void setExtent(IEnvelope extent)
          The visible extent rectangle.
 void setExternalDrawing(int phase, boolean externalDrawing)
          Indicates if external clients are drawing in response to the specified phase.
 void setFeatureSelectionByRef(ISelection selection)
          The feature selection for the map.
 void setFocusMapByRef(IMap activeMap)
          The map that tools and controls act on.
 void setFullExtent(IEnvelope extent)
          The full extent rectangle.
 void setFullTimeExtentByRef(ITimeExtent timeExtent)
          Returns the full time extent of the time-enabled layers in the map.
 void setHasLiveData(boolean flag)
          Indicates whether the map has a time-enabled layer that is being updated frequently with new data.
 void setIsFramed(boolean flag)
          Indicates if map is drawn in a frame rather than on the whole window.
 void setIsMapActivated(boolean isMapActivated)
          Indicates if the focus map is activated.
 void setLevelMasking(ILayer maskedLayer, ILayer maskingLayer, java.lang.String pLevels)
          The symbol levels for which the masking applies.
 void setMapScale(double scaleRF)
          The scale of the map as a representative fraction.
 void setMapUnits(int unitsCode)
          The units for the map.
 void setMaskingLayers(ILayer layer, ISet maskingLayers)
          The masks for a layer.
 void setMaxScale(double pMaxScale)
          The maximum scale for the cache to be built.
 void setName(java.lang.String name)
          Name of the map.
 void setNonFrameBackgroundByRef(IBackground rhs1)
          The background to use when drawing to destinations other than a frame.
 void setOutputBandSize(int kilobytes)
          Size allocated for each band when banding output.
 void setOverposterPropertiesByRef(IOverposterProperties overposterProperties)
          The overposter the map will use for labeling.
 void setPageSize(double widthInches, double heightInches)
          Sets the page size for the map (optional).
 void setPlayOption(int option)
          The play option (Stop, Reverse, Repeat) used by the slider after the time visualization has been played once.
 void setProgressiveDrawing(boolean flag)
          Indicates whether the view should progressively update the window during drawing.
 void setReferenceScale(double scaleRF)
          The reference scale of the map as a representative fraction.
 void setScaleLimit(boolean limited)
          Indicates whether there is a scale limit.
 void setSelectionByRef(ISelection selection)
          The selection.
 void setShowRulers(boolean showRulers)
          Indicates if rulers are visible.
 void setShowScrollBars(boolean showScrollBars)
          Indicates if scrollbars are visible.
 void setShowSelection(boolean showRulers)
          Indicates if selection is visible.
 void setShowTime(boolean flag)
          Indicates whether time is enabled on the map.
 void setShowTimeOnDisplay(boolean flag)
          Indicates whether time is displayed on the map.
 void setSimulateLayerEffectsInLegends(boolean flag)
          Indicates whether to simulate transparency and other effects in legends.
 void setSpatialReferenceByRef(ISpatialReference spatialRef)
          The spatial reference of the map.
 void setSpatialReferenceLocked(boolean locked)
          Indicates whether the spatial reference is prevented from being changed.
 void setTimeExtentDefinitionLayerByRef(ILayer layer)
          The time-enabled layer that defines the time extent of the map.
 void setTimeExtentOption(int option)
          Indicates how the time extent of the map is defined.
 void setTimeReferenceByRef(ITimeReference timeReference)
          The time reference (time zone information, daylight savings, etc.) associated with the map.
 void setTimeRelation(int relation)
          Time relation used with the time window for the map.
 void setTimeValueByRef(ITimeValue time)
          The time extent for which the data is displayed in the map.
 void setTopFilterIndex(int phaseIndex)
          Phase index that supplements TopFilterPhase.
 void setTopFilterPhase(int phase)
          The highest phase in the drawing order that uses a display filter.
 void setUseMasking(boolean flag)
          Indicates whether to use masking.
 void setUseSubPixelRendering(boolean useSubPixelRendering)
          Indicates whether the dynamic map is rendered in Sub Pixels or Full Pixels (snap to the nearest discrete pixel).
 void setUseSymbolLevels(boolean flag)
          Indicates if the Map draws using symbol levels.
 void setVerboseEvents(boolean verboseEvents)
          Indicates whether to expand or limit the number of events that are fired.
 void sortBookmarks(boolean ascending)
          Adds a bookmark to the collection.
 void suppressForegroundDraw()
          Call before using Output to prevent AfterDraw(esriViewForeground) from being fired.
 void unitsUpdated(ITransformEventsUnitsUpdatedEvent theEvent)
          Notifies clients when the units are updated.
 void unselectAllElements()
          Unselects all elements.
 void unselectElement(IElement element)
          Unselects the specified element.
 void unselectElements(IEnumElement elements)
          Unselects the specified elements.
 void updateElement(IElement element)
          The graphic element's properties have changed.
 void visibleBoundsUpdated(ITransformEventsVisibleBoundsUpdatedEvent theEvent)
          Notifies clients when the visible bounds is updated.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

Map

public Map()
    throws java.io.IOException,
           java.net.UnknownHostException
Constructs a Map using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

Map

public Map(java.lang.Object obj)
    throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Map theMap = (Map) obj;

Construct a Map using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to Map.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

addIActiveViewEventsListener

public void addIActiveViewEventsListener(IActiveViewEvents theListener)
                                  throws java.io.IOException
addIActiveViewEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.carto.IActiveViewEvents interface.
Throws:
java.io.IOException - If there are communications problems.

removeIActiveViewEventsListener

public void removeIActiveViewEventsListener(IActiveViewEvents theListener)
                                     throws java.io.IOException
removeIActiveViewEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.carto.IActiveViewEvents interface.
Throws:
java.io.IOException - If there are communications problems.

addIMapEventsListener

public void addIMapEventsListener(IMapEvents theListener)
                           throws java.io.IOException
addIMapEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.carto.IMapEvents interface.
Throws:
java.io.IOException - If there are communications problems.

removeIMapEventsListener

public void removeIMapEventsListener(IMapEvents theListener)
                              throws java.io.IOException
removeIMapEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.carto.IMapEvents interface.
Throws:
java.io.IOException - If there are communications problems.

addIDynamicMapEventsListener

public void addIDynamicMapEventsListener(IDynamicMapEvents theListener)
                                  throws java.io.IOException
addIDynamicMapEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.display.IDynamicMapEvents interface.
Throws:
java.io.IOException - If there are communications problems.

removeIDynamicMapEventsListener

public void removeIDynamicMapEventsListener(IDynamicMapEvents theListener)
                                     throws java.io.IOException
removeIDynamicMapEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.display.IDynamicMapEvents interface.
Throws:
java.io.IOException - If there are communications problems.

release

public void release()
Release a Map.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Name of the map.

Specified by:
getName in interface IBasicMap
Specified by:
getName in interface IBasicMap2
Specified by:
getName in interface IMap
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException
Name of the map.

Specified by:
setName in interface IBasicMap
Specified by:
setName in interface IBasicMap2
Specified by:
setName in interface IMap
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException
Description of the map.

Specified by:
getDescription in interface IBasicMap
Specified by:
getDescription in interface IBasicMap2
Specified by:
getDescription in interface IMap
Returns:
The descr
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String descr)
                    throws java.io.IOException,
                           AutomationException
Description of the map.

Specified by:
setDescription in interface IBasicMap
Specified by:
setDescription in interface IBasicMap2
Specified by:
setDescription in interface IMap
Parameters:
descr - The descr (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAreaOfInterest

public void setAreaOfInterest(IEnvelope rhs1)
                       throws java.io.IOException,
                              AutomationException
Area of interest for the map.

Specified by:
setAreaOfInterest in interface IBasicMap
Specified by:
setAreaOfInterest in interface IBasicMap2
Specified by:
setAreaOfInterest in interface IMap
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.

getLayerCount

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

Specified by:
getLayerCount in interface IBasicMap
Specified by:
getLayerCount in interface IBasicMap2
Specified by:
getLayerCount in interface IMap
Specified by:
getLayerCount in interface IMapLayers
Returns:
The count
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
The layer at the given index.

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

getLayers

public IEnumLayer getLayers(IUID uid,
                            boolean recursive)
                     throws java.io.IOException,
                            AutomationException
The layers in the map of the type specified in the uid. If recursive is true it will return layers in group layers.

Specified by:
getLayers in interface IBasicMap
Specified by:
getLayers in interface IBasicMap2
Specified by:
getLayers in interface IMap
Specified by:
getLayers in interface IMapLayers
Parameters:
uid - A reference to a com.esri.arcgis.system.IUID (in, optional, pass 0 if not required)
recursive - The recursive (in, optional, pass true if not required)
Returns:
A reference to a com.esri.arcgis.carto.IEnumLayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapSurroundCount

public int getMapSurroundCount()
                        throws java.io.IOException,
                               AutomationException
Number of map surrounds associated with the map.

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

getMapSurround

public IMapSurround getMapSurround(int index)
                            throws java.io.IOException,
                                   AutomationException
The map surround at the given index.

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

getMapUnits

public int getMapUnits()
                throws java.io.IOException,
                       AutomationException
The units for the map.

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

setMapUnits

public void setMapUnits(int unitsCode)
                 throws java.io.IOException,
                        AutomationException
The units for the map.

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

getDistanceUnits

public int getDistanceUnits()
                     throws java.io.IOException,
                            AutomationException
The distance units for the map.

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

setDistanceUnits

public void setDistanceUnits(int unitsCode)
                      throws java.io.IOException,
                             AutomationException
The distance units for the map.

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

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException
The spatial reference of the map.

Specified by:
getSpatialReference in interface IBasicMap
Specified by:
getSpatialReference in interface IBasicMap2
Specified by:
getSpatialReference in interface IMap
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 spatialRef)
                              throws java.io.IOException,
                                     AutomationException
The spatial reference of the map.

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

getMapScale

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

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

setMapScale

public void setMapScale(double scaleRF)
                 throws java.io.IOException,
                        AutomationException
The scale of the map as a representative fraction.

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

getReferenceScale

public double getReferenceScale()
                         throws java.io.IOException,
                                AutomationException
The reference scale of the map as a representative fraction.

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

setReferenceScale

public void setReferenceScale(double scaleRF)
                       throws java.io.IOException,
                              AutomationException
The reference scale of the map as a representative fraction.

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

isFramed

public boolean isFramed()
                 throws java.io.IOException,
                        AutomationException
Indicates if map is drawn in a frame rather than on the whole window.

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

setIsFramed

public void setIsFramed(boolean flag)
                 throws java.io.IOException,
                        AutomationException
Indicates if map is drawn in a frame rather than on the whole window.

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

getClipGeometry

public IGeometry getClipGeometry()
                          throws java.io.IOException,
                                 AutomationException
A shape that layers in the map are clipped to.

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

setClipGeometry

public void setClipGeometry(IGeometry clipGeometry)
                     throws java.io.IOException,
                            AutomationException
A shape that layers in the map are clipped to.

Specified by:
setClipGeometry in interface IMap
Specified by:
setClipGeometry in interface IMapClipOptions
Parameters:
clipGeometry - 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.

addLayer

public void addLayer(ILayer layer)
              throws java.io.IOException,
                     AutomationException
Adds a layer to the map.

Specified by:
addLayer in interface IBasicMap
Specified by:
addLayer in interface IBasicMap2
Specified by:
addLayer in interface IMap
Specified by:
addLayer in interface IMapLayers
Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addLayers

public void addLayers(IEnumLayer layers,
                      boolean autoArrange)
               throws java.io.IOException,
                      AutomationException
Adds multiple layers to the map, arranging them nicely if specified.

Specified by:
addLayers in interface IBasicMap
Specified by:
addLayers in interface IBasicMap2
Specified by:
addLayers in interface IMap
Specified by:
addLayers in interface IMapLayers
Parameters:
layers - A reference to a com.esri.arcgis.carto.IEnumLayer (in)
autoArrange - The autoArrange (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteLayer

public void deleteLayer(ILayer layer)
                 throws java.io.IOException,
                        AutomationException
Deletes a layer from the map.

Specified by:
deleteLayer in interface IBasicMap
Specified by:
deleteLayer in interface IBasicMap2
Specified by:
deleteLayer in interface IMap
Specified by:
deleteLayer in interface IMapLayers
Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

moveLayer

public void moveLayer(ILayer layer,
                      int toIndex)
               throws java.io.IOException,
                      AutomationException
Moves a layer to another position.

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

clearLayers

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

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

createMapSurround

public IMapSurround createMapSurround(IUID cLSID,
                                      IMapSurround optionalStyle)
                               throws java.io.IOException,
                                      AutomationException
Create and initialize a map surround. An optional style from the style gallery may be specified.

Specified by:
createMapSurround in interface IMap
Parameters:
cLSID - A reference to a com.esri.arcgis.system.IUID (in)
optionalStyle - A reference to a com.esri.arcgis.carto.IMapSurround (in)
Returns:
A reference to a com.esri.arcgis.carto.IMapSurround
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addMapSurround

public void addMapSurround(IMapSurround mapSurround)
                    throws java.io.IOException,
                           AutomationException
Adds a map surround to the map.

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

deleteMapSurround

public void deleteMapSurround(IMapSurround mapSurround)
                       throws java.io.IOException,
                              AutomationException
Deletes a map surround from the map.

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

clearMapSurrounds

public void clearMapSurrounds()
                       throws java.io.IOException,
                              AutomationException
Removes all map surrounds from the map.

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

computeDistance

public double computeDistance(IPoint p1,
                              IPoint p2)
                       throws java.io.IOException,
                              AutomationException
Computes the distance between two points on the map and returns the result.

Specified by:
computeDistance in interface IMap
Parameters:
p1 - A reference to a com.esri.arcgis.geometry.IPoint (in)
p2 - A reference to a com.esri.arcgis.geometry.IPoint (in)
Returns:
The distance
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBasicGraphicsLayer

public IGraphicsLayer getBasicGraphicsLayer()
                                     throws java.io.IOException,
                                            AutomationException
The basic graphics layer.

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

getActiveGraphicsLayer

public ILayer getActiveGraphicsLayer()
                              throws java.io.IOException,
                                     AutomationException
The active graphics layer. If no graphic layers exist a basic memory graphics layer will be created.

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

setActiveGraphicsLayerByRef

public void setActiveGraphicsLayerByRef(ILayer graphicsLayer)
                                 throws java.io.IOException,
                                        AutomationException
The active graphics layer. If no graphic layers exist a basic memory graphics layer will be created.

Specified by:
setActiveGraphicsLayerByRef in interface IBasicMap
Specified by:
setActiveGraphicsLayerByRef in interface IBasicMap2
Specified by:
setActiveGraphicsLayerByRef in interface IMap
Parameters:
graphicsLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClipBorder

public IBorder getClipBorder()
                      throws java.io.IOException,
                             AutomationException
An optional border drawn around ClipGeometry.

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

setClipBorder

public void setClipBorder(IBorder border)
                   throws java.io.IOException,
                          AutomationException
An optional border drawn around ClipGeometry.

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

selectFeature

public void selectFeature(ILayer layer,
                          IFeature feature)
                   throws java.io.IOException,
                          AutomationException
Selects a feature.

Specified by:
selectFeature in interface IMap
Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectionCount

public int getSelectionCount()
                      throws java.io.IOException,
                             AutomationException
Number of selected features.

Specified by:
getSelectionCount in interface IBasicMap
Specified by:
getSelectionCount in interface IBasicMap2
Specified by:
getSelectionCount in interface IMap
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearSelection

public void clearSelection()
                    throws java.io.IOException,
                           AutomationException
Clears the map selection.

Specified by:
clearSelection in interface IBasicMap
Specified by:
clearSelection in interface IBasicMap2
Specified by:
clearSelection in interface IMap
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureSelection

public ISelection getFeatureSelection()
                               throws java.io.IOException,
                                      AutomationException
The feature selection for the map.

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

setFeatureSelectionByRef

public void setFeatureSelectionByRef(ISelection selection)
                              throws java.io.IOException,
                                     AutomationException
The feature selection for the map.

Specified by:
setFeatureSelectionByRef in interface IBasicMap
Specified by:
setFeatureSelectionByRef in interface IBasicMap2
Specified by:
setFeatureSelectionByRef in interface IMap
Parameters:
selection - A reference to a com.esri.arcgis.carto.ISelection (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

selectByShape

public void selectByShape(IGeometry shape,
                          ISelectionEnvironment env,
                          boolean justOne)
                   throws java.io.IOException,
                          AutomationException
Selects features in the map given a shape and a selection environment (optional).

Specified by:
selectByShape in interface IBasicMap
Specified by:
selectByShape in interface IBasicMap2
Specified by:
selectByShape in interface IMap
Parameters:
shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
env - A reference to a com.esri.arcgis.carto.ISelectionEnvironment (in)
justOne - The justOne (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delayEvents

public void delayEvents(boolean delay)
                 throws java.io.IOException,
                        AutomationException
Used to batch operations together to minimize notifications.

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

setPageSize

public void setPageSize(double widthInches,
                        double heightInches)
                 throws java.io.IOException,
                        AutomationException
Sets the page size for the map (optional).

Specified by:
setPageSize in interface IMap
Parameters:
widthInches - The widthInches (in)
heightInches - The heightInches (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPageSize

public void getPageSize(double[] widthInches,
                        double[] heightInches)
                 throws java.io.IOException,
                        AutomationException
Gets the page size for the map.

Specified by:
getPageSize in interface IMap
Parameters:
widthInches - The widthInches (out: use single element array)
heightInches - The heightInches (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBarriers

public IBarrierCollection getBarriers(IEnvelope pExtent)
                               throws java.io.IOException,
                                      AutomationException
The list of barriers and their weight for labeling.

Specified by:
getBarriers in interface IMap
Parameters:
pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Returns:
A reference to a com.esri.arcgis.carto.IBarrierCollection
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseSymbolLevels

public void setUseSymbolLevels(boolean flag)
                        throws java.io.IOException,
                               AutomationException
Indicates if the Map draws using symbol levels.

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

isUseSymbolLevels

public boolean isUseSymbolLevels()
                          throws java.io.IOException,
                                 AutomationException
Indicates if the Map draws using symbol levels.

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

setExpanded

public void setExpanded(boolean expanded)
                 throws java.io.IOException,
                        AutomationException
Indicates if the Map is expanded.

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

isExpanded

public boolean isExpanded()
                   throws java.io.IOException,
                          AutomationException
Indicates if the Map is expanded.

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

setAnnotationEngineByRef

public void setAnnotationEngineByRef(IAnnotateMap annotateMap)
                              throws java.io.IOException,
                                     AutomationException
The annotation (label) engine the map will use.

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

getAnnotationEngine

public IAnnotateMap getAnnotationEngine()
                                 throws java.io.IOException,
                                        AutomationException
The annotation (label) engine the map will use.

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

recalcFullExtent

public void recalcFullExtent()
                      throws java.io.IOException,
                             AutomationException
Forces the full extent to be recalculated.

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

delayDrawing

public void delayDrawing(boolean delay)
                  throws java.io.IOException,
                         AutomationException
Suspends drawing.

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

setSpatialReferenceLocked

public void setSpatialReferenceLocked(boolean locked)
                               throws java.io.IOException,
                                      AutomationException
Indicates whether the spatial reference is prevented from being changed.

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

isSpatialReferenceLocked

public boolean isSpatialReferenceLocked()
                                 throws java.io.IOException,
                                        AutomationException
Indicates whether the spatial reference is prevented from being changed.

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

getCopyrightText

public java.lang.String getCopyrightText()
                                  throws java.io.IOException,
                                         AutomationException
Copyright information associated with the map.

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

setCopyrightText

public void setCopyrightText(java.lang.String copyright)
                      throws java.io.IOException,
                             AutomationException
Copyright information associated with the map.

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

getBarriers2

public IBarrierCollection getBarriers2(IEnvelope pExtent,
                                       ITrackCancel pTrackCancel)
                                throws java.io.IOException,
                                       AutomationException
The list of barriers and their weight for labeling.

Specified by:
getBarriers2 in interface IMapBarriers
Parameters:
pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.carto.IBarrierCollection
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBarriers3

public IBarrierCollection getBarriers3(IEnvelope pExtent,
                                       double scale,
                                       ITrackCancel pTrackCancel)
                                throws java.io.IOException,
                                       AutomationException
The list of barriers and their weight for labeling.

Specified by:
getBarriers3 in interface IMapBarriers2
Parameters:
pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
scale - The scale (in)
pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.carto.IBarrierCollection
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
The full extent rectangle.

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

setFullExtent

public void setFullExtent(IEnvelope extent)
                   throws java.io.IOException,
                          AutomationException
The full extent rectangle.

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

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException
The visible extent rectangle.

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

setExtent

public void setExtent(IEnvelope extent)
               throws java.io.IOException,
                      AutomationException
The visible extent rectangle.

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

getScreenDisplay

public IScreenDisplay getScreenDisplay()
                                throws java.io.IOException,
                                       AutomationException
The screen display used by the view.

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

getGraphicsContainer

public IGraphicsContainer getGraphicsContainer()
                                        throws java.io.IOException,
                                               AutomationException
The active graphics container.

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

getFocusMap

public IMap getFocusMap()
                 throws java.io.IOException,
                        AutomationException
The map that tools and controls act on.

Specified by:
getFocusMap in interface IActiveView
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.

setFocusMapByRef

public void setFocusMapByRef(IMap activeMap)
                      throws java.io.IOException,
                             AutomationException
The map that tools and controls act on.

Specified by:
setFocusMapByRef in interface IActiveView
Parameters:
activeMap - 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.

isMapActivated

public boolean isMapActivated()
                       throws java.io.IOException,
                              AutomationException
Indicates if the focus map is activated.

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

setIsMapActivated

public void setIsMapActivated(boolean isMapActivated)
                       throws java.io.IOException,
                              AutomationException
Indicates if the focus map is activated.

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

getSelection

public ISelection getSelection()
                        throws java.io.IOException,
                               AutomationException
The selection.

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

setSelectionByRef

public void setSelectionByRef(ISelection selection)
                       throws java.io.IOException,
                              AutomationException
The selection.

Specified by:
setSelectionByRef in interface IActiveView
Parameters:
selection - A reference to a com.esri.arcgis.carto.ISelection (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTipText

public java.lang.String getTipText(double x,
                                   double y)
                            throws java.io.IOException,
                                   AutomationException
The tip text to display at the given location.

Specified by:
getTipText in interface IActiveView
Parameters:
x - The x (in)
y - The y (in)
Returns:
The tipText
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExportFrame

public tagRECT getExportFrame()
                       throws java.io.IOException,
                              AutomationException
The device rectangle to export.

Specified by:
getExportFrame in interface IActiveView
Returns:
A Structure: com.esri.arcgis.system.tagRECT
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowScrollBars

public boolean isShowScrollBars()
                         throws java.io.IOException,
                                AutomationException
Indicates if scrollbars are visible.

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

setShowScrollBars

public void setShowScrollBars(boolean showScrollBars)
                       throws java.io.IOException,
                              AutomationException
Indicates if scrollbars are visible.

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

isShowRulers

public boolean isShowRulers()
                     throws java.io.IOException,
                            AutomationException
Indicates if rulers are visible.

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

setShowRulers

public void setShowRulers(boolean showRulers)
                   throws java.io.IOException,
                          AutomationException
Indicates if rulers are visible.

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

isShowSelection

public boolean isShowSelection()
                        throws java.io.IOException,
                               AutomationException
Indicates if selection is visible.

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

setShowSelection

public void setShowSelection(boolean showRulers)
                      throws java.io.IOException,
                             AutomationException
Indicates if selection is visible.

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

getExtentStack

public IExtentStack getExtentStack()
                            throws java.io.IOException,
                                   AutomationException
The extent stack.

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

getScreenCacheID

public short getScreenCacheID(int phase,
                              java.lang.Object data)
                       throws java.io.IOException,
                              AutomationException
The screen cache ID that is used to draw the specified phase.

Specified by:
getScreenCacheID in interface IActiveView
Parameters:
phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in)
data - A reference to another Object (IUnknown) (in)
Returns:
The cacheID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hitTestMap

public IMap hitTestMap(IPoint location)
                throws java.io.IOException,
                       AutomationException
Returns any maps present in the view at the given location. Return value may be zero if there are no maps or the coordinate is not over a map.

Specified by:
hitTestMap in interface IActiveView
Parameters:
location - A reference to a com.esri.arcgis.geometry.IPoint (in)
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.

isActive

public boolean isActive()
                 throws java.io.IOException,
                        AutomationException
Indicates if view is active or not.

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

activate

public void activate(int hWnd)
              throws java.io.IOException,
                     AutomationException
Gives this view control of the specified window.

Specified by:
activate in interface IActiveView
Parameters:
hWnd - The hWnd (A COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deactivate

public void deactivate()
                throws java.io.IOException,
                       AutomationException
Another view takes over the associated window.

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

draw

public void draw(int hDC,
                 ITrackCancel trackCancel)
          throws java.io.IOException,
                 AutomationException
Draws the view to the specified device context.

Specified by:
draw in interface IActiveView
Parameters:
hDC - The hDC (A COM typedef) (in)
trackCancel - 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.

output

public void output(int hDC,
                   int dpi,
                   tagRECT pixelBounds,
                   IEnvelope visibleBounds,
                   ITrackCancel trackCancel)
            throws java.io.IOException,
                   AutomationException
Renders the view to the specified DC.

Specified by:
output in interface IActiveView
Parameters:
hDC - The hDC (A COM typedef) (in)
dpi - The dpi (in)
pixelBounds - A Structure: com.esri.arcgis.system.tagRECT (in)
visibleBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
trackCancel - 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.

refresh

public void refresh()
             throws java.io.IOException,
                    AutomationException
Causes the entire view to draw.

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

partialRefresh

public void partialRefresh(int phase,
                           java.lang.Object data,
                           IEnvelope envelope)
                    throws java.io.IOException,
                           AutomationException
Draws the specified view phase. Use an envelope of zero to draw the entire phase.

Specified by:
partialRefresh in interface IActiveView
Specified by:
partialRefresh in interface IViewRefresh
Parameters:
phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in)
data - A reference to another Object (IUnknown) (in)
envelope - 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.

clear

public void clear()
           throws java.io.IOException,
                  AutomationException
Empties the view contents.

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

printerChanged

public void printerChanged(IPrinter printer)
                    throws java.io.IOException,
                           AutomationException
Called by application when printer changes.

Specified by:
printerChanged in interface IActiveView
Parameters:
printer - A reference to a com.esri.arcgis.output.IPrinter (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

contentsChanged

public void contentsChanged()
                     throws java.io.IOException,
                            AutomationException
Called by clients when view objects are modified.

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

onMessage

public void onMessage(int msg,
                      int wParam,
                      int lParam)
               throws java.io.IOException,
                      AutomationException
Call from your application's message loop to enable automatic resizing and keyboard accelerators.

Specified by:
onMessage in interface IActiveView
Parameters:
msg - The msg (in)
wParam - The wParam (A COM typedef) (in)
lParam - The lParam (A COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getContextMenu

public void getContextMenu(double x,
                           double y,
                           IUID[] clsidMenu)
                    throws java.io.IOException,
                           AutomationException
Called when a context menu should be displayed at the given xy location. Return menu that should be displayed.

Specified by:
getContextMenu in interface IActiveView
Parameters:
x - The x (in)
y - The y (in)
clsidMenu - A reference to a com.esri.arcgis.system.IUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setElementSelectionByRef

public void setElementSelectionByRef(ISelection selectionObject)
                              throws java.io.IOException,
                                     AutomationException
Object to use for element selection.

Specified by:
setElementSelectionByRef in interface IViewManager
Parameters:
selectionObject - A reference to a com.esri.arcgis.carto.ISelection (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElementSelection

public ISelection getElementSelection()
                               throws java.io.IOException,
                                      AutomationException
Object to use for element selection.

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

setConserveMemory

public void setConserveMemory(boolean flag)
                       throws java.io.IOException,
                              AutomationException
Indicates whether to be conservative when allocating resources.

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

isConserveMemory

public boolean isConserveMemory()
                         throws java.io.IOException,
                                AutomationException
Indicates whether to be conservative when allocating resources.

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

setTopFilterPhase

public void setTopFilterPhase(int phase)
                       throws java.io.IOException,
                              AutomationException
The highest phase in the drawing order that uses a display filter. Clients should set this when they draw in response to AfterDraw and they use a display filter.

Specified by:
setTopFilterPhase in interface IViewManager
Parameters:
phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTopFilterPhase

public int getTopFilterPhase()
                      throws java.io.IOException,
                             AutomationException
The highest phase in the drawing order that uses a display filter. Clients should set this when they draw in response to AfterDraw and they use a display filter.

Specified by:
getTopFilterPhase in interface IViewManager
Returns:
A com.esri.arcgis.carto.esriViewDrawPhase constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTopFilterIndex

public void setTopFilterIndex(int phaseIndex)
                       throws java.io.IOException,
                              AutomationException
Phase index that supplements TopFilterPhase. Clients should set the item index here if they draw in response to AfterDrawItem and they use a display filter. TopFilterPhase must also be specified.

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

getTopFilterIndex

public int getTopFilterIndex()
                      throws java.io.IOException,
                             AutomationException
Phase index that supplements TopFilterPhase. Clients should set the item index here if they draw in response to AfterDrawItem and they use a display filter. TopFilterPhase must also be specified.

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

setOutputBandSize

public void setOutputBandSize(int kilobytes)
                       throws java.io.IOException,
                              AutomationException
Size allocated for each band when banding output.

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

getOutputBandSize

public int getOutputBandSize()
                      throws java.io.IOException,
                             AutomationException
Size allocated for each band when banding output.

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

isUsesPageCoordinates

public boolean isUsesPageCoordinates()
                              throws java.io.IOException,
                                     AutomationException
Indicates whether view uses page coordinates.

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

isVerboseEvents

public boolean isVerboseEvents()
                        throws java.io.IOException,
                               AutomationException
Indicates whether to expand or limit the number of events that are fired. The following events are not fired if VerboseEvents is false: AfterItemDraw.

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

setVerboseEvents

public void setVerboseEvents(boolean verboseEvents)
                      throws java.io.IOException,
                             AutomationException
Indicates whether to expand or limit the number of events that are fired. The following events are not fired if VerboseEvents is false: AfterItemDraw.

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

isDelayBackgroundDraw

public boolean isDelayBackgroundDraw()
                              throws java.io.IOException,
                                     AutomationException
Indicates if the background should draw immediately. Set to true to eliminate flashing during animation.

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

setDelayBackgroundDraw

public void setDelayBackgroundDraw(boolean flag)
                            throws java.io.IOException,
                                   AutomationException
Indicates if the background should draw immediately. Set to true to eliminate flashing during animation.

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

isExternalDrawing

public boolean isExternalDrawing(int phase)
                          throws java.io.IOException,
                                 AutomationException
Indicates if external clients are drawing in response to the specified phase.

Specified by:
isExternalDrawing in interface IViewManager
Parameters:
phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in)
Returns:
The externalDrawing
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExternalDrawing

public void setExternalDrawing(int phase,
                               boolean externalDrawing)
                        throws java.io.IOException,
                               AutomationException
Indicates if external clients are drawing in response to the specified phase.

Specified by:
setExternalDrawing in interface IViewManager
Parameters:
phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in)
externalDrawing - The externalDrawing (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDrawing

public boolean isDrawing()
                  throws java.io.IOException,
                         AutomationException
Indicates whether the view is currently drawing or not.

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

isProgressiveDrawing

public boolean isProgressiveDrawing()
                             throws java.io.IOException,
                                    AutomationException
Indicates whether the view should progressively update the window during drawing. False means just update the window once when all rendering is complete.

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

setProgressiveDrawing

public void setProgressiveDrawing(boolean flag)
                           throws java.io.IOException,
                                  AutomationException
Indicates whether the view should progressively update the window during drawing. False means just update the window once when all rendering is complete.

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

partialRefreshShape

public void partialRefreshShape(int phase,
                                java.lang.Object data,
                                IGeometry geometry,
                                double symbolSizePoints)
                         throws java.io.IOException,
                                AutomationException
Refreshes the specified shape on the specified view phase. Use symbolSizePoints to indicate point and line sizes.

Specified by:
partialRefreshShape in interface IViewRefresh
Parameters:
phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in)
data - A reference to another Object (IUnknown) (in)
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
symbolSizePoints - The symbolSizePoints (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

animationRefresh

public void animationRefresh(int phase,
                             java.lang.Object data,
                             IEnvelope envelope)
                      throws java.io.IOException,
                             AutomationException
Use to quickly redraw a phase that has it's own cache, i.e., a tracking layer. Tradeoffs are made to ensure fast redrawing at the expense of quality.

Specified by:
animationRefresh in interface IViewRefresh
Parameters:
phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in)
data - A reference to another Object (IUnknown) (in)
envelope - 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.

animationRefreshShape

public void animationRefreshShape(int phase,
                                  java.lang.Object data,
                                  IGeometry geometry,
                                  double symbolSizePoints)
                           throws java.io.IOException,
                                  AutomationException
Use to quickly redraw a phase that has it's own cache, i.e., a tracking layer. Tradeoffs are made to ensure fast redrawing at the expense of quality. See PartialRefreshShape for more info.

Specified by:
animationRefreshShape in interface IViewRefresh
Parameters:
phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in)
data - A reference to another Object (IUnknown) (in)
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
symbolSizePoints - The symbolSizePoints (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refreshItem

public void refreshItem(java.lang.Object data)
                 throws java.io.IOException,
                        AutomationException
Use to redraw a specific item and the content above it. When adding items to the view (i.e., layers or graphics). Refresh can be optimized by only drawing the newly added items.

Specified by:
refreshItem in interface IViewRefresh
Parameters:
data - A reference to another Object (IUnknown) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refreshCaches

public void refreshCaches()
                   throws java.io.IOException,
                          AutomationException
Reallocate the display caches. Causes a full redraw. Normally caches are automatically maintained. Use this sparingly when programatically changing attributes that affect caching such as ILayer::Cached flag.

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

next

public IElement next()
              throws java.io.IOException,
                     AutomationException
Returns the next graphic in the container.

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

reset

public void reset()
           throws java.io.IOException,
                  AutomationException
Reset internal cursor so that Next returns the first element.

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

addElement

public void addElement(IElement element,
                       int zorder)
                throws java.io.IOException,
                       AutomationException
Add a new graphic element to the layer.

Specified by:
addElement in interface IGraphicsContainer
Parameters:
element - A reference to a com.esri.arcgis.carto.IElement (in)
zorder - The zorder (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addElements

public void addElements(IElementCollection elements,
                        int zorder)
                 throws java.io.IOException,
                        AutomationException
Add new graphic elements to the layer.

Specified by:
addElements in interface IGraphicsContainer
Parameters:
elements - A reference to a com.esri.arcgis.carto.IElementCollection (in)
zorder - The zorder (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteElement

public void deleteElement(IElement element)
                   throws java.io.IOException,
                          AutomationException
Delete the given element.

Specified by:
deleteElement in interface IGraphicsContainer
Parameters:
element - A reference to a com.esri.arcgis.carto.IElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteAllElements

public void deleteAllElements()
                       throws java.io.IOException,
                              AutomationException
Delete all the elements.

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

moveElementToGroup

public void moveElementToGroup(IElement element,
                               IGroupElement group)
                        throws java.io.IOException,
                               AutomationException
Move the element from the container to the group.

Specified by:
moveElementToGroup in interface IGraphicsContainer
Parameters:
element - A reference to a com.esri.arcgis.carto.IElement (in)
group - A reference to a com.esri.arcgis.carto.IGroupElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

moveElementFromGroup

public void moveElementFromGroup(IGroupElement group,
                                 IElement element,
                                 int zorder)
                          throws java.io.IOException,
                                 AutomationException
Move the element from the group to the container.

Specified by:
moveElementFromGroup in interface IGraphicsContainer
Parameters:
group - A reference to a com.esri.arcgis.carto.IGroupElement (in)
element - A reference to a com.esri.arcgis.carto.IElement (in)
zorder - The zorder (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

locateElements

public IEnumElement locateElements(IPoint point,
                                   double tolerance)
                            throws java.io.IOException,
                                   AutomationException
Returns the elements at the given coordinate.

Specified by:
locateElements in interface IGraphicsContainer
Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
tolerance - The tolerance (in)
Returns:
A reference to a com.esri.arcgis.carto.IEnumElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

locateElementsByEnvelope

public IEnumElement locateElementsByEnvelope(IEnvelope envelope)
                                      throws java.io.IOException,
                                             AutomationException
Returns the elements inside the given envelope.

Specified by:
locateElementsByEnvelope in interface IGraphicsContainer
Parameters:
envelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Returns:
A reference to a com.esri.arcgis.carto.IEnumElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findFrame

public IFrameElement findFrame(java.lang.Object frameObject)
                        throws java.io.IOException,
                               AutomationException
Find the frame that contains the specified object.

Specified by:
findFrame in interface IGraphicsContainer
Parameters:
frameObject - A Variant (in)
Returns:
A reference to a com.esri.arcgis.carto.IFrameElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateElement

public void updateElement(IElement element)
                   throws java.io.IOException,
                          AutomationException
The graphic element's properties have changed.

Specified by:
updateElement in interface IGraphicsContainer
Parameters:
element - A reference to a com.esri.arcgis.carto.IElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElementOrder

public java.lang.Object getElementOrder(IEnumElement elements)
                                 throws java.io.IOException,
                                        AutomationException
Private order object. Used to undo ordering operations.

Specified by:
getElementOrder in interface IGraphicsContainer
Parameters:
elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putElementOrder

public void putElementOrder(java.lang.Object order)
                     throws java.io.IOException,
                            AutomationException
Private order object. Used to undo ordering operations.

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

bringToFront

public void bringToFront(IEnumElement elements)
                  throws java.io.IOException,
                         AutomationException
Make the specified elements draw in front of all other elements.

Specified by:
bringToFront in interface IGraphicsContainer
Parameters:
elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

sendToBack

public void sendToBack(IEnumElement elements)
                throws java.io.IOException,
                       AutomationException
Make the specified elements draw behind all other elements.

Specified by:
sendToBack in interface IGraphicsContainer
Parameters:
elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

sendBackward

public void sendBackward(IEnumElement elements)
                  throws java.io.IOException,
                         AutomationException
Move the specified elements one step closer to the bottom of the stack of elements.

Specified by:
sendBackward in interface IGraphicsContainer
Parameters:
elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

bringForward

public void bringForward(IEnumElement elements)
                  throws java.io.IOException,
                         AutomationException
Move the specified elements one step closer to the top of the stack of elements.

Specified by:
bringForward in interface IGraphicsContainer
Parameters:
elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

selectElement

public void selectElement(IElement element)
                   throws java.io.IOException,
                          AutomationException
Selects the specified element.

Specified by:
selectElement in interface IGraphicsContainerSelect
Parameters:
element - A reference to a com.esri.arcgis.carto.IElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

selectElements

public void selectElements(IEnumElement elements)
                    throws java.io.IOException,
                           AutomationException
Selects the specified elements.

Specified by:
selectElements in interface IGraphicsContainerSelect
Parameters:
elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

selectAllElements

public void selectAllElements()
                       throws java.io.IOException,
                              AutomationException
Selects all elements.

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

unselectElement

public void unselectElement(IElement element)
                     throws java.io.IOException,
                            AutomationException
Unselects the specified element.

Specified by:
unselectElement in interface IGraphicsContainerSelect
Parameters:
element - A reference to a com.esri.arcgis.carto.IElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

unselectElements

public void unselectElements(IEnumElement elements)
                      throws java.io.IOException,
                             AutomationException
Unselects the specified elements.

Specified by:
unselectElements in interface IGraphicsContainerSelect
Parameters:
elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

unselectAllElements

public void unselectAllElements()
                         throws java.io.IOException,
                                AutomationException
Unselects all elements.

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

getSelectedElements

public IEnumElement getSelectedElements()
                                 throws java.io.IOException,
                                        AutomationException
The selected elements.

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

getElementSelectionCount

public int getElementSelectionCount()
                             throws java.io.IOException,
                                    AutomationException
The number of selected elements.

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

selectedElement

public IElement selectedElement(int index)
                         throws java.io.IOException,
                                AutomationException
Returns the nth selected element. Use Selection count to get the number of selected elements.

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

selectionTracker

public ISelectionTracker selectionTracker(int index)
                                   throws java.io.IOException,
                                          AutomationException
Returns the tracker for the nth selected element. Use Selection count to get the number of selected elements.

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

elementSelected

public boolean elementSelected(IElement element)
                        throws java.io.IOException,
                               AutomationException
Indicates if the element is selected.

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

getDominantElement

public IElement getDominantElement()
                            throws java.io.IOException,
                                   AutomationException
Dominant element.

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

setDominantElementByRef

public void setDominantElementByRef(IElement dominantItem)
                             throws java.io.IOException,
                                    AutomationException
Dominant element.

Specified by:
setDominantElementByRef in interface IGraphicsContainerSelect
Parameters:
dominantItem - A reference to a com.esri.arcgis.carto.IElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectionBounds

public IEnvelope getSelectionBounds(IDisplay display)
                             throws java.io.IOException,
                                    AutomationException
The bounds of the selection.

Specified by:
getSelectionBounds in interface IGraphicsContainerSelect
Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
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.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException
enumConnectionPoints

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
findConnectionPoint

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

isDirty

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

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

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
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
save

Specified by:
save in interface IPersistStream
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
getSizeMax

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

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException
getClassID

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

getBookmarks

public IEnumSpatialBookmark getBookmarks()
                                  throws java.io.IOException,
                                         AutomationException
The bookmarks.

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

addBookmark

public void addBookmark(ISpatialBookmark bookmark)
                 throws java.io.IOException,
                        AutomationException
Adds a bookmark to the collection.

Specified by:
addBookmark in interface IMapBookmarks
Parameters:
bookmark - A reference to a com.esri.arcgis.carto.ISpatialBookmark (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeBookmark

public void removeBookmark(ISpatialBookmark bookmark)
                    throws java.io.IOException,
                           AutomationException
Removes a bookmark from the collection.

Specified by:
removeBookmark in interface IMapBookmarks
Parameters:
bookmark - A reference to a com.esri.arcgis.carto.ISpatialBookmark (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAllBookmarks

public void removeAllBookmarks()
                        throws java.io.IOException,
                               AutomationException
Removes all bookmarks.

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

moveBookmarkTo

public void moveBookmarkTo(ISpatialBookmark bookmark,
                           int index)
                    throws java.io.IOException,
                           AutomationException
Moves a bookmark in the collection.

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

sortBookmarks

public void sortBookmarks(boolean ascending)
                   throws java.io.IOException,
                          AutomationException
Adds a bookmark to the collection.

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

selectionChanged

public void selectionChanged(ISelectionEventsSelectionChangedEvent theEvent)
                      throws java.io.IOException,
                             AutomationException
Call this function to fire the selection changed event.

Specified by:
selectionChanged in interface ISelectionEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

displayStarted

public void displayStarted(IDisplayEventsDisplayStartedEvent theEvent)
                    throws java.io.IOException,
                           AutomationException
Notifies clients when drawing starts.

Specified by:
displayStarted in interface IDisplayEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

displayFinished

public void displayFinished(IDisplayEventsDisplayFinishedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException
Notifies clients when drawing completes.

Specified by:
displayFinished in interface IDisplayEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

displayInvalidated

public void displayInvalidated(IDisplayEventsDisplayInvalidatedEvent theEvent)
                        throws java.io.IOException,
                               AutomationException
Notifies clients when display is invalidated.

Specified by:
displayInvalidated in interface IDisplayEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

displayScrolled

public void displayScrolled(IDisplayEventsDisplayScrolledEvent theEvent)
                     throws java.io.IOException,
                            AutomationException
Notifies clients when display is scrolled.

Specified by:
displayScrolled in interface IDisplayEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

boundsUpdated

public void boundsUpdated(ITransformEventsBoundsUpdatedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException
Notifies clients when the bounds is updated.

Specified by:
boundsUpdated in interface ITransformEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

visibleBoundsUpdated

public void visibleBoundsUpdated(ITransformEventsVisibleBoundsUpdatedEvent theEvent)
                          throws java.io.IOException,
                                 AutomationException
Notifies clients when the visible bounds is updated.

Specified by:
visibleBoundsUpdated in interface ITransformEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deviceFrameUpdated

public void deviceFrameUpdated(ITransformEventsDeviceFrameUpdatedEvent theEvent)
                        throws java.io.IOException,
                               AutomationException
Notifies clients when the device frame is updated.

Specified by:
deviceFrameUpdated in interface ITransformEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resolutionUpdated

public void resolutionUpdated(ITransformEventsResolutionUpdatedEvent theEvent)
                       throws java.io.IOException,
                              AutomationException
Notifies clients when the resolution is updated.

Specified by:
resolutionUpdated in interface ITransformEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

rotationUpdated

public void rotationUpdated(ITransformEventsRotationUpdatedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException
Notifies clients when the rotation angle is updated.

Specified by:
rotationUpdated in interface ITransformEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

unitsUpdated

public void unitsUpdated(ITransformEventsUnitsUpdatedEvent theEvent)
                  throws java.io.IOException,
                         AutomationException
Notifies clients when the units are updated.

Specified by:
unitsUpdated in interface ITransformEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTableCount

public int getTableCount()
                  throws java.io.IOException,
                         AutomationException
Number of tables.

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

getTable

public ITable getTable(int index)
                throws java.io.IOException,
                       AutomationException
The table at the given index.

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

addTable

public void addTable(ITable table)
              throws java.io.IOException,
                     AutomationException
Adds a table to the collection.

Specified by:
addTable in interface ITableCollection
Parameters:
table - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeTable

public void removeTable(ITable table)
                 throws java.io.IOException,
                        AutomationException
Removes a table from the collection.

Specified by:
removeTable in interface ITableCollection
Parameters:
table - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAllTables

public void removeAllTables()
                     throws java.io.IOException,
                            AutomationException
Removes all tables from the collection.

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

getStandaloneTableCount

public int getStandaloneTableCount()
                            throws java.io.IOException,
                                   AutomationException
Number of standalone tables.

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

getStandaloneTable

public IStandaloneTable getStandaloneTable(int index)
                                    throws java.io.IOException,
                                           AutomationException
The standalone table at the given index.

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

addStandaloneTable

public void addStandaloneTable(IStandaloneTable table)
                        throws java.io.IOException,
                               AutomationException
Adds a standalone table to the collection.

Specified by:
addStandaloneTable in interface IStandaloneTableCollection
Parameters:
table - A reference to a com.esri.arcgis.carto.IStandaloneTable (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeStandaloneTable

public void removeStandaloneTable(IStandaloneTable table)
                           throws java.io.IOException,
                                  AutomationException
Removes the standalone table from the collection.

Specified by:
removeStandaloneTable in interface IStandaloneTableCollection
Parameters:
table - A reference to a com.esri.arcgis.carto.IStandaloneTable (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAllStandaloneTables

public void removeAllStandaloneTables()
                               throws java.io.IOException,
                                      AutomationException
Removes all standalone tables from the collection.

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

isUsesFilter

public boolean isUsesFilter()
                     throws java.io.IOException,
                            AutomationException
Indicates if the current object draws using a filter.

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

setNonFrameBackgroundByRef

public void setNonFrameBackgroundByRef(IBackground rhs1)
                                throws java.io.IOException,
                                       AutomationException
The background to use when drawing to destinations other than a frame.

Specified by:
setNonFrameBackgroundByRef in interface IMapAdmin
Specified by:
setNonFrameBackgroundByRef in interface IMapAdmin2
Specified by:
setNonFrameBackgroundByRef in interface IMapAdmin3
Parameters:
rhs1 - A reference to a com.esri.arcgis.carto.IBackground (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClipBounds

public void setClipBounds(IGeometry rhs1)
                   throws java.io.IOException,
                          AutomationException
Specify a boundary to clip to. Frame uses this to clip to border.

Specified by:
setClipBounds in interface IMapAdmin
Specified by:
setClipBounds in interface IMapAdmin2
Specified by:
setClipBounds in interface IMapAdmin3
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.

fireAfterDraw

public void fireAfterDraw(int hDC)
                   throws java.io.IOException,
                          AutomationException
Fire AfterDraw(esriViewForeground) event.

Specified by:
fireAfterDraw in interface IMapAdmin
Specified by:
fireAfterDraw in interface IMapAdmin2
Specified by:
fireAfterDraw in interface IMapAdmin3
Parameters:
hDC - The hDC (A COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

fireChangeVersion

public void fireChangeVersion(IVersion oldVersion,
                              IVersion newVersion)
                       throws java.io.IOException,
                              AutomationException
Notifies listeners that a version in the map changed.

Specified by:
fireChangeVersion in interface IMapAdmin
Specified by:
fireChangeVersion in interface IMapAdmin2
Specified by:
fireChangeVersion in interface IMapAdmin3
Parameters:
oldVersion - A reference to a com.esri.arcgis.geodatabase.IVersion (in)
newVersion - A reference to a com.esri.arcgis.geodatabase.IVersion (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

fireChangeFeatureClass

public void fireChangeFeatureClass(IFeatureClass oldClass,
                                   IFeatureClass newClass)
                            throws java.io.IOException,
                                   AutomationException
Notifies listeners that the a layer's class has changed.

Specified by:
fireChangeFeatureClass in interface IMapAdmin
Specified by:
fireChangeFeatureClass in interface IMapAdmin2
Specified by:
fireChangeFeatureClass in interface IMapAdmin3
Parameters:
oldClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
newClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNonFrameBackground

public IBackground getNonFrameBackground()
                                  throws java.io.IOException,
                                         AutomationException
Specify the background to use when drawing to destinations other than a frame.

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

fireChangeTable

public void fireChangeTable(ITable oldTable,
                            ITable newTable)
                     throws java.io.IOException,
                            AutomationException
Notifies listeners that the a layer's class has changed.

Specified by:
fireChangeTable in interface IMapAdmin2
Specified by:
fireChangeTable in interface IMapAdmin3
Parameters:
oldTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
newTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

completeRedrawNeeded

public boolean completeRedrawNeeded()
                             throws java.io.IOException,
                                    AutomationException
Check if a complete redraw is needed.

Specified by:
completeRedrawNeeded in interface IMapAdmin2
Specified by:
completeRedrawNeeded in interface IMapAdmin3
Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

forceGraphicSelectionDraw

public void forceGraphicSelectionDraw()
                               throws java.io.IOException,
                                      AutomationException
Call before using Output to cause graphic selection to be drawn.

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

suppressForegroundDraw

public void suppressForegroundDraw()
                            throws java.io.IOException,
                                   AutomationException
Call before using Output to prevent AfterDraw(esriViewForeground) from being fired.

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

fireLayerDeleted

public void fireLayerDeleted(ILayer layer)
                      throws java.io.IOException,
                             AutomationException
Notifies listeners that a layer has been removed from the map.

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

fireLayerAdded

public void fireLayerAdded(ILayer layer)
                    throws java.io.IOException,
                           AutomationException
Notifies listeners that a layer has been added to the map.

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

fireLayerReordered

public void fireLayerReordered(ILayer layer,
                               int toIndex)
                        throws java.io.IOException,
                               AutomationException
Notifies listeners that a layer has been reordered the map.

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

getDomainDefiningLayer

public ILayer getDomainDefiningLayer()
                              throws java.io.IOException,
                                     AutomationException
Returns the layer which defines map domain, 0 if domain is the union of all layers.

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

setDomainDefiningLayer

public void setDomainDefiningLayer(ILayer layer)
                            throws java.io.IOException,
                                   AutomationException
Returns the layer which defines map domain, 0 if domain is the union of all layers.

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

isSimulateLayerEffectsInLegends

public boolean isSimulateLayerEffectsInLegends()
                                        throws java.io.IOException,
                                               AutomationException
Indicates whether to simulate transparency and other effects in legends.

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

setSimulateLayerEffectsInLegends

public void setSimulateLayerEffectsInLegends(boolean flag)
                                      throws java.io.IOException,
                                             AutomationException
Indicates whether to simulate transparency and other effects in legends.

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

getRelationshipClasses

public IEnumRelationshipClass getRelationshipClasses()
                                              throws java.io.IOException,
                                                     AutomationException
The memory relationship classes.

Specified by:
getRelationshipClasses in interface IRelationshipClassCollection
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumRelationshipClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findRelationshipClasses

public IEnumRelationshipClass findRelationshipClasses(IObjectClass objectClass,
                                                      int role)
                                               throws java.io.IOException,
                                                      AutomationException
Finds all relationship classes in the collection that reference the given object class in the specified role.

Specified by:
findRelationshipClasses in interface IRelationshipClassCollection
Parameters:
objectClass - A reference to a com.esri.arcgis.geodatabase.IObjectClass (in)
role - A com.esri.arcgis.geodatabase.esriRelRole constant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumRelationshipClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeographicTransformations

public IGeoTransformationOperationSet getGeographicTransformations()
                                                            throws java.io.IOException,
                                                                   AutomationException
On-the-fly geographic transformations.

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

buildCache

public void buildCache()
                throws java.io.IOException,
                       AutomationException
Build the spatial cache.

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

setMaxScale

public void setMaxScale(double pMaxScale)
                 throws java.io.IOException,
                        AutomationException
The maximum scale for the cache to be built.

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

getMaxScale

public double getMaxScale()
                   throws java.io.IOException,
                          AutomationException
The maximum scale for the cache to be built.

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

isCacheable

public boolean isCacheable()
                    throws java.io.IOException,
                           AutomationException
Indicates whether a map cache can be created.

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

isAutoCacheActive

public boolean isAutoCacheActive()
                          throws java.io.IOException,
                                 AutomationException
Indicates whether the autocache is active.

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

setAutoCacheActive

public void setAutoCacheActive(boolean active)
                        throws java.io.IOException,
                               AutomationException
Indicates whether the autocache is active.

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

isScaleLimit

public boolean isScaleLimit()
                     throws java.io.IOException,
                            AutomationException
Indicates whether there is a scale limit.

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

setScaleLimit

public void setScaleLimit(boolean limited)
                   throws java.io.IOException,
                          AutomationException
Indicates whether there is a scale limit.

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

getCacheExtent

public IEnvelope getCacheExtent()
                         throws java.io.IOException,
                                AutomationException
Current cache extent.

Specified by:
getCacheExtent in interface IMapCache
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.

emptyCache

public void emptyCache()
                throws java.io.IOException,
                       AutomationException
Empty the map cache.

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

refreshAutoCache

public void refreshAutoCache()
                      throws java.io.IOException,
                             AutomationException
Refresh the autocache.

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

setUseMasking

public void setUseMasking(boolean flag)
                   throws java.io.IOException,
                          AutomationException
Indicates whether to use masking.

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

isUseMasking

public boolean isUseMasking()
                     throws java.io.IOException,
                            AutomationException
Indicates whether to use masking.

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

setMaskingLayers

public void setMaskingLayers(ILayer layer,
                             ISet maskingLayers)
                      throws java.io.IOException,
                             AutomationException
The masks for a layer.

Specified by:
setMaskingLayers in interface ILayerMasking
Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
maskingLayers - A reference to a com.esri.arcgis.system.ISet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaskingLayers

public ISet getMaskingLayers(ILayer layer)
                      throws java.io.IOException,
                             AutomationException
The masks for a layer.

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

clearMasking

public void clearMasking(ILayer layer)
                  throws java.io.IOException,
                         AutomationException
Clear masking layers on a layer.

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

getMaskedLayers

public ISet getMaskedLayers()
                     throws java.io.IOException,
                            AutomationException
The set of layers that are being masked.

Specified by:
getMaskedLayers in interface ILayerMasking
Returns:
A reference to a com.esri.arcgis.system.ISet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLevelMasking

public void setLevelMasking(ILayer maskedLayer,
                            ILayer maskingLayer,
                            java.lang.String pLevels)
                     throws java.io.IOException,
                            AutomationException
The symbol levels for which the masking applies.

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

getLevelMasking

public java.lang.String getLevelMasking(ILayer maskedLayer,
                                        ILayer maskingLayer)
                                 throws java.io.IOException,
                                        AutomationException
The symbol levels for which the masking applies.

Specified by:
getLevelMasking in interface ILevelMasking
Parameters:
maskedLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
maskingLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:
The pLevels
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
The PageLayout object.

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.

getMap

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

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

getActiveView

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

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

getOverposterProperties

public IOverposterProperties getOverposterProperties()
                                              throws java.io.IOException,
                                                     AutomationException
The overposter the map will use for labeling.

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

setOverposterPropertiesByRef

public void setOverposterPropertiesByRef(IOverposterProperties overposterProperties)
                                  throws java.io.IOException,
                                         AutomationException
The overposter the map will use for labeling.

Specified by:
setOverposterPropertiesByRef in interface IMapOverposter
Parameters:
overposterProperties - A reference to a com.esri.arcgis.carto.IOverposterProperties (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLayerVisible

public boolean isLayerVisible(ILayer layer)
                       throws java.io.IOException,
                              AutomationException
Check if layer is visible.

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

insertLayer

public void insertLayer(ILayer pLayer,
                        boolean autoArrange,
                        int position)
                 throws java.io.IOException,
                        AutomationException
Inserts a layer at the given position.

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

insertLayers

public void insertLayers(IEnumLayer pLayers,
                         boolean autoArrange,
                         int position)
                  throws java.io.IOException,
                         AutomationException
Inserts layers at the given position.

Specified by:
insertLayers in interface IMapLayers
Parameters:
pLayers - A reference to a com.esri.arcgis.carto.IEnumLayer (in)
autoArrange - The autoArrange (in)
position - The position (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertLayerInGroup

public void insertLayerInGroup(IGroupLayer pGroup,
                               ILayer pLayer,
                               boolean autoArrange,
                               int position)
                        throws java.io.IOException,
                               AutomationException
Inserts a layer at a given index of the map's group layer.

Specified by:
insertLayerInGroup in interface IMapLayers
Parameters:
pGroup - A reference to a com.esri.arcgis.carto.IGroupLayer (in)
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
autoArrange - The autoArrange (in)
position - The position (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertLayersInGroup

public void insertLayersInGroup(IGroupLayer pGroup,
                                IEnumLayer pLayer,
                                boolean autoArrange,
                                int position)
                         throws java.io.IOException,
                                AutomationException
Inserts layers at a given index of the map's group layer.

Specified by:
insertLayersInGroup in interface IMapLayers
Parameters:
pGroup - A reference to a com.esri.arcgis.carto.IGroupLayer (in)
pLayer - A reference to a com.esri.arcgis.carto.IEnumLayer (in)
autoArrange - The autoArrange (in)
position - The position (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

moveLayerEx

public void moveLayerEx(IGroupLayer pFromGroup,
                        IGroupLayer pToGroup,
                        ILayer pLayer,
                        int newPosition)
                 throws java.io.IOException,
                        AutomationException
Moves the layer with in the map.

Specified by:
moveLayerEx in interface IMapLayers
Parameters:
pFromGroup - A reference to a com.esri.arcgis.carto.IGroupLayer (in)
pToGroup - A reference to a com.esri.arcgis.carto.IGroupLayer (in)
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
newPosition - The newPosition (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDynamicMapEnabled

public boolean isDynamicMapEnabled()
                            throws java.io.IOException,
                                   AutomationException
Indicates if dynamic map is turned on or off.

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

setDynamicMapEnabled

public void setDynamicMapEnabled(boolean isEnable)
                          throws java.io.IOException,
                                 AutomationException
Indicates if dynamic map is turned on or off.

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

getDynamicDrawRate

public int getDynamicDrawRate()
                       throws java.io.IOException,
                              AutomationException
The Dynamic draw rate in milliseconds.

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

setDynamicDrawRate

public void setDynamicDrawRate(int dynamicDrawRateMS)
                        throws java.io.IOException,
                               AutomationException
The Dynamic draw rate in milliseconds.

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

isUseSubPixelRendering

public boolean isUseSubPixelRendering()
                               throws java.io.IOException,
                                      AutomationException
Indicates whether the dynamic map is rendered in Sub Pixels or Full Pixels (snap to the nearest discrete pixel).

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

setUseSubPixelRendering

public void setUseSubPixelRendering(boolean useSubPixelRendering)
                             throws java.io.IOException,
                                    AutomationException
Indicates whether the dynamic map is rendered in Sub Pixels or Full Pixels (snap to the nearest discrete pixel).

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

isLayerVisibleEx

public void isLayerVisibleEx(ILayer layer,
                             boolean[] isLayerVisible,
                             boolean[] isParentLayerVisible)
                      throws java.io.IOException,
                             AutomationException
Check if layer is visible.

Specified by:
isLayerVisibleEx in interface IMapLayers2
Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
isLayerVisible - The isLayerVisible (out: use single element array)
isParentLayerVisible - The isParentLayerVisible (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClipType

public int getClipType()
                throws java.io.IOException,
                       AutomationException
Method used to clip layers in map.

Specified by:
getClipType in interface IMapClipOptions
Returns:
A com.esri.arcgis.carto.esriMapClipType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClipType

public void setClipType(int type)
                 throws java.io.IOException,
                        AutomationException
Method used to clip layers in map.

Specified by:
setClipType in interface IMapClipOptions
Parameters:
type - A com.esri.arcgis.carto.esriMapClipType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClipData

public java.lang.Object getClipData()
                             throws java.io.IOException,
                                    AutomationException
Sets or returns extended clip type data, i.e., other Map when type is esriMapClipMapExtent.

Specified by:
getClipData in interface IMapClipOptions
Returns:
A reference to another Object (IUnknown)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClipData

public void setClipData(java.lang.Object data)
                 throws java.io.IOException,
                        AutomationException
Sets or returns extended clip type data, i.e., other Map when type is esriMapClipMapExtent.

Specified by:
setClipData in interface IMapClipOptions
Parameters:
data - A reference to another Object (IUnknown) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClipFilter

public ISet getClipFilter()
                   throws java.io.IOException,
                          AutomationException
Sets or returns the set of layers that will be excluded from clipping.

Specified by:
getClipFilter in interface IMapClipOptions
Returns:
A reference to a com.esri.arcgis.system.ISet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClipFilter

public void setClipFilter(ISet layers)
                   throws java.io.IOException,
                          AutomationException
Sets or returns the set of layers that will be excluded from clipping.

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

setClipGridAndGraticules

public void setClipGridAndGraticules(boolean pClipGridAndGraticules)
                              throws java.io.IOException,
                                     AutomationException
Clip grids and grticules to data extent

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

isClipGridAndGraticules

public boolean isClipGridAndGraticules()
                                throws java.io.IOException,
                                       AutomationException
Clip grids and grticules to data extent

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

getAutoExtentType

public int getAutoExtentType()
                      throws java.io.IOException,
                             AutomationException
The way in which the map extent of the frame is specified.

Specified by:
getAutoExtentType in interface IMapAutoExtentOptions
Returns:
A com.esri.arcgis.carto.esriExtentTypeEnum constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAutoExtentType

public void setAutoExtentType(int type)
                       throws java.io.IOException,
                              AutomationException
The way in which the map extent of the frame is specified.

Specified by:
setAutoExtentType in interface IMapAutoExtentOptions
Parameters:
type - A com.esri.arcgis.carto.esriExtentTypeEnum constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAutoExtentScale

public double getAutoExtentScale()
                          throws java.io.IOException,
                                 AutomationException
The scale at which the map should be displayed.

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

setAutoExtentScale

public void setAutoExtentScale(double scale)
                        throws java.io.IOException,
                               AutomationException
The scale at which the map should be displayed.

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

getAutoExtentBounds

public IEnvelope getAutoExtentBounds()
                              throws java.io.IOException,
                                     AutomationException
The bounds of the map displayed by the frame.

Specified by:
getAutoExtentBounds in interface IMapAutoExtentOptions
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.

setAutoExtentBounds

public void setAutoExtentBounds(IEnvelope bounds)
                         throws java.io.IOException,
                                AutomationException
The bounds of the map displayed by the frame.

Specified by:
setAutoExtentBounds in interface IMapAutoExtentOptions
Parameters:
bounds - 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.

getAutoExtentMap

public IMap getAutoExtentMap()
                      throws java.io.IOException,
                             AutomationException
Auto extent map. Derive extent from the extent of another map. See esriExtentTypeEnum.

Specified by:
getAutoExtentMap in interface IMapAutoExtentOptions
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.

setAutoExtentMapByRef

public void setAutoExtentMapByRef(IMap map)
                           throws java.io.IOException,
                                  AutomationException
Auto extent map. Derive extent from the extent of another map. See esriExtentTypeEnum.

Specified by:
setAutoExtentMapByRef in interface IMapAutoExtentOptions
Parameters:
map - 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.

getAutoExtentMargin

public double getAutoExtentMargin()
                           throws java.io.IOException,
                                  AutomationException
Auto extent margin. Specified in AutoExtentMarginUnits. See esriExtentTypeEnum.

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

setAutoExtentMargin

public void setAutoExtentMargin(double margin)
                         throws java.io.IOException,
                                AutomationException
Auto extent margin. Specified in AutoExtentMarginUnits. See esriExtentTypeEnum.

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

getAutoExtentMarginUnits

public int getAutoExtentMarginUnits()
                             throws java.io.IOException,
                                    AutomationException
Auto extent margin units. See esriExtentTypeEnum.

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

setAutoExtentMarginUnits

public void setAutoExtentMarginUnits(int units)
                              throws java.io.IOException,
                                     AutomationException
Auto extent margin units. See esriExtentTypeEnum.

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

getAutoExtentLayer

public IFeatureLayer getAutoExtentLayer()
                                 throws java.io.IOException,
                                        AutomationException
Auto extent features. See esriExtentTypeEnum.

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

setAutoExtentLayerByRef

public void setAutoExtentLayerByRef(IFeatureLayer layer)
                             throws java.io.IOException,
                                    AutomationException
Auto extent features. See esriExtentTypeEnum.

Specified by:
setAutoExtentLayerByRef in interface IMapAutoExtentOptions
Parameters:
layer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLockedZoom

public void getLockedZoom(boolean[] flag)
                   throws java.io.IOException,
                          AutomationException
Check if the map can be zoomed.

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

getLockedPan

public void getLockedPan(boolean[] flag)
                  throws java.io.IOException,
                         AutomationException
Check if the map can be panned.

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

hasTimeData

public boolean hasTimeData()
                    throws java.io.IOException,
                           AutomationException
Indicates whether the map has a time-enabled layer.

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

getDefaultTimeInterval

public double getDefaultTimeInterval()
                              throws java.io.IOException,
                                     AutomationException
The time interval to be used by the time slider to animate the map.

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

setDefaultTimeInterval

public void setDefaultTimeInterval(double interval)
                            throws java.io.IOException,
                                   AutomationException
The time interval to be used by the time slider to animate the map.

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

getDefaultTimeIntervalUnits

public int getDefaultTimeIntervalUnits()
                                throws java.io.IOException,
                                       AutomationException
The time interval units to be used to animate the map.

Specified by:
getDefaultTimeIntervalUnits in interface IMapTimeDisplay
Returns:
A com.esri.arcgis.system.esriTimeUnits constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultTimeIntervalUnits

public void setDefaultTimeIntervalUnits(int units)
                                 throws java.io.IOException,
                                        AutomationException
The time interval units to be used to animate the map.

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

getDefaultTimeWindow

public double getDefaultTimeWindow()
                            throws java.io.IOException,
                                   AutomationException
The time window used to display the data in the map.

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

setDefaultTimeWindow

public void setDefaultTimeWindow(double duration)
                          throws java.io.IOException,
                                 AutomationException
The time window used to display the data in the map.

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

getFullTimeExtent

public ITimeExtent getFullTimeExtent()
                              throws java.io.IOException,
                                     AutomationException
Returns the full time extent of the time-enabled layers in the map.

Specified by:
getFullTimeExtent in interface IMapTimeDisplay
Returns:
A reference to a com.esri.arcgis.system.ITimeExtent
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFullTimeExtentByRef

public void setFullTimeExtentByRef(ITimeExtent timeExtent)
                            throws java.io.IOException,
                                   AutomationException
Returns the full time extent of the time-enabled layers in the map.

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

getCurrentTimeExtent

public ITimeExtent getCurrentTimeExtent()
                                 throws java.io.IOException,
                                        AutomationException
The current time extent of the map.

Specified by:
getCurrentTimeExtent in interface IMapTimeDisplay
Returns:
A reference to a com.esri.arcgis.system.ITimeExtent
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentTimeExtentByRef

public void setCurrentTimeExtentByRef(ITimeExtent timeExtent)
                               throws java.io.IOException,
                                      AutomationException
The current time extent of the map.

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

getTimeValue

public ITimeValue getTimeValue()
                        throws java.io.IOException,
                               AutomationException
The time extent for which the data is displayed in the map.

Specified by:
getTimeValue in interface IMapTimeDisplay
Returns:
A reference to a com.esri.arcgis.system.ITimeValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeValueByRef

public void setTimeValueByRef(ITimeValue time)
                       throws java.io.IOException,
                              AutomationException
The time extent for which the data is displayed in the map.

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

getTimeReference

public ITimeReference getTimeReference()
                                throws java.io.IOException,
                                       AutomationException
The time reference (time zone information, daylight savings, etc.) associated with the map.

Specified by:
getTimeReference in interface IMapTimeDisplay
Returns:
A reference to a com.esri.arcgis.system.ITimeReference
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeReferenceByRef

public void setTimeReferenceByRef(ITimeReference timeReference)
                           throws java.io.IOException,
                                  AutomationException
The time reference (time zone information, daylight savings, etc.) associated with the map.

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

getDisplayDateFormat

public java.lang.String getDisplayDateFormat()
                                      throws java.io.IOException,
                                             AutomationException
The format of the date that is displayed on the time slider.

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

setDisplayDateFormat

public void setDisplayDateFormat(java.lang.String dateFormat)
                          throws java.io.IOException,
                                 AutomationException
The format of the date that is displayed on the time slider.

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

getDisplayTimeFormat

public java.lang.String getDisplayTimeFormat()
                                      throws java.io.IOException,
                                             AutomationException
The format of the time that is displayed on the time slider.

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

setDisplayTimeFormat

public void setDisplayTimeFormat(java.lang.String timeFormat)
                          throws java.io.IOException,
                                 AutomationException
The format of the time that is displayed on the time slider.

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

isDisplayEachTimestamp

public boolean isDisplayEachTimestamp()
                               throws java.io.IOException,
                                      AutomationException
Indicates whether data for each timestamp will be drawn when playing the time visualization.

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

setDisplayEachTimestamp

public void setDisplayEachTimestamp(boolean value)
                             throws java.io.IOException,
                                    AutomationException
Indicates whether data for each timestamp will be drawn when playing the time visualization.

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

getDisplaySpeed

public int getDisplaySpeed()
                    throws java.io.IOException,
                           AutomationException
The speed of the slider on a scale of 1 to 10 with 10 being the fastest.

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

setDisplaySpeed

public void setDisplaySpeed(int speed)
                     throws java.io.IOException,
                            AutomationException
The speed of the slider on a scale of 1 to 10 with 10 being the fastest.

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

getPlayOption

public int getPlayOption()
                  throws java.io.IOException,
                         AutomationException
The play option (Stop, Reverse, Repeat) used by the slider after the time visualization has been played once.

Specified by:
getPlayOption in interface IMapTimeDisplay
Returns:
A com.esri.arcgis.carto.esriMapTimePlayOption constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPlayOption

public void setPlayOption(int option)
                   throws java.io.IOException,
                          AutomationException
The play option (Stop, Reverse, Repeat) used by the slider after the time visualization has been played once.

Specified by:
setPlayOption in interface IMapTimeDisplay
Parameters:
option - A com.esri.arcgis.carto.esriMapTimePlayOption constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeExtentOption

public int getTimeExtentOption()
                        throws java.io.IOException,
                               AutomationException
Indicates how the time extent of the map is defined.

Specified by:
getTimeExtentOption in interface IMapTimeDisplay
Returns:
A com.esri.arcgis.carto.esriMapTimeExtentOption constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeExtentOption

public void setTimeExtentOption(int option)
                         throws java.io.IOException,
                                AutomationException
Indicates how the time extent of the map is defined.

Specified by:
setTimeExtentOption in interface IMapTimeDisplay
Parameters:
option - A com.esri.arcgis.carto.esriMapTimeExtentOption constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeExtentDefinitionLayer

public ILayer getTimeExtentDefinitionLayer()
                                    throws java.io.IOException,
                                           AutomationException
The time-enabled layer that defines the time extent of the map.

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

setTimeExtentDefinitionLayerByRef

public void setTimeExtentDefinitionLayerByRef(ILayer layer)
                                       throws java.io.IOException,
                                              AutomationException
The time-enabled layer that defines the time extent of the map.

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

isDynamicTimeRefresh

public boolean isDynamicTimeRefresh()
                             throws java.io.IOException,
                                    AutomationException
Indicates whether the data in the map refreshes when moving the time slider dynamically.

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

setDynamicTimeRefresh

public void setDynamicTimeRefresh(boolean flag)
                           throws java.io.IOException,
                                  AutomationException
Indicates whether the data in the map refreshes when moving the time slider dynamically.

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

isShowTime

public boolean isShowTime()
                   throws java.io.IOException,
                          AutomationException
Indicates whether time is enabled on the map.

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

setShowTime

public void setShowTime(boolean flag)
                 throws java.io.IOException,
                        AutomationException
Indicates whether time is enabled on the map.

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

computeFullTimeExtent

public ITimeExtent computeFullTimeExtent()
                                  throws java.io.IOException,
                                         AutomationException
Returns the full time extent of the time-enabled layers in the map.

Specified by:
computeFullTimeExtent in interface IMapTimeDisplay
Returns:
A reference to a com.esri.arcgis.system.ITimeExtent
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasLiveData

public boolean isHasLiveData()
                      throws java.io.IOException,
                             AutomationException
Indicates whether the map has a time-enabled layer that is being updated frequently with new data.

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

setHasLiveData

public void setHasLiveData(boolean flag)
                    throws java.io.IOException,
                           AutomationException
Indicates whether the map has a time-enabled layer that is being updated frequently with new data.

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

getTimeRelation

public int getTimeRelation()
                    throws java.io.IOException,
                           AutomationException
Time relation used with the time window for the map.

Specified by:
getTimeRelation in interface IMapTimeDisplay2
Returns:
A com.esri.arcgis.system.esriTimeRelation constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeRelation

public void setTimeRelation(int relation)
                     throws java.io.IOException,
                            AutomationException
Time relation used with the time window for the map.

Specified by:
setTimeRelation in interface IMapTimeDisplay2
Parameters:
relation - A com.esri.arcgis.system.esriTimeRelation constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowTimeOnDisplay

public boolean isShowTimeOnDisplay()
                            throws java.io.IOException,
                                   AutomationException
Indicates whether time is displayed on the map.

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

setShowTimeOnDisplay

public void setShowTimeOnDisplay(boolean flag)
                          throws java.io.IOException,
                                 AutomationException
Indicates whether time is displayed on the map.

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

getServiceLayerCreditsText

public java.lang.String getServiceLayerCreditsText(java.lang.String separator)
                                            throws java.io.IOException,
                                                   AutomationException
Get the service layer credits text.

Specified by:
getServiceLayerCreditsText in interface IServiceLayerCredits
Parameters:
separator - The separator (in)
Returns:
The credits
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException