Globe (ArcObjects Java API 10.4)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.globecore
Class Globe

java.lang.Object
  com.esri.arcgis.globecore.Globe

All Implemented Interfaces:: IAnimationTracks, IBasicScene, IBasicScene2, IScene, ISceneBookmarks, ISceneBookmarks2, IAGAnimationContainer, IAGAnimationTracks, IActiveView, IBasicMap, IMap, IMapGeographicTransformations, IMapTimeDisplay, IMapTimeDisplay2, IRelationshipClassCollection, ISelectionEvents, IStandaloneTableCollection, ITableCollection, IConnectionPointContainer, IGlobe, IGlobe2, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, ISupportErrorInfo, java.io.Externalizable, java.io.Serializable, java.util.EventListener

public class Globe
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGlobe2, IScene, IBasicScene2, IActiveView, IBasicMap, IMap, ISelectionEvents, ITableCollection, IStandaloneTableCollection, IRelationshipClassCollection, ISceneBookmarks2, IAnimationTracks, IAGAnimationTracks, IAGAnimationContainer, ISupportErrorInfo, IConnectionPointContainer, IPersistStream, IMapGeographicTransformations, IMapTimeDisplay, IMapTimeDisplay2, java.io.Externalizable
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGlobe2, IScene, IBasicScene2, IActiveView, IBasicMap, IMap, ISelectionEvents, ITableCollection, IStandaloneTableCollection, IRelationshipClassCollection, ISceneBookmarks2, IAnimationTracks, IAGAnimationTracks, IAGAnimationContainer, ISupportErrorInfo, IConnectionPointContainer, IPersistStream, IMapGeographicTransformations, IMapTimeDisplay, IMapTimeDisplay2, java.io.Externalizable

COM Class 'Globe'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGlobeCore.olb'

Description 'A container for the display and manipulation of data in the Globe.' 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.globecore.IGlobe2
`IID, IID5e37ab7c_057c_470d_804a_abdd4f10b64c, xxDummy`

Fields inherited from interface com.esri.arcgis.globecore.IGlobe
`IID00b329b7_265e_11d6_b2b4_00508bcdde28`

Fields inherited from interface com.esri.arcgis.analyst3d.IScene
`IID, IID787f54e2_ba26_11d2_92f8_44d1f8c00000, xxDummy`

Fields inherited from interface com.esri.arcgis.analyst3d.IBasicScene2
`IID, IID020719a9_5b19_4835_ab76_47908247b6bc, xxDummy`

Fields inherited from interface com.esri.arcgis.analyst3d.IBasicScene
`IIDec4e4b1c_5a64_499d_a475_bc2ddc237838`

Fields inherited from interface com.esri.arcgis.carto.IActiveView
`IID, IIDdd94d76b_836d_11d0_87ec_080009ec732a, 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.IMap
`IID, IIDe6bdaa75_4d35_11d0_98be_00805f7ced21, xxDummy`

Fields inherited from interface com.esri.arcgis.carto.ISelectionEvents
`IID, IID07e11311_d615_11d1_a21b_080009b6f22b, 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.carto.IRelationshipClassCollection
`IID, IID741d6114_fb6b_11d3_adf5_00c04fa33a15, xxDummy`

Fields inherited from interface com.esri.arcgis.analyst3d.ISceneBookmarks2
`IID, IIDd530208f_48a9_45d0_b5c9_a1474987b113, xxDummy`

Fields inherited from interface com.esri.arcgis.analyst3d.ISceneBookmarks
`IIDbcdb3325_9afa_11d5_b29f_00508bcdde28`

Fields inherited from interface com.esri.arcgis.analyst3d.IAnimationTracks
`IID, IIDfa3dba5b_a879_11d5_b2a0_00508bcdde28, xxDummy`

Fields inherited from interface com.esri.arcgis.animation.IAGAnimationTracks
`IID, IIDb71421ea_e25e_49dd_a07e_40dc9d6bd575, xxDummy`

Fields inherited from interface com.esri.arcgis.animation.IAGAnimationContainer
`IID, IIDac5655cd_56cf_4c9f_a1c0_a9f80ba453ea, xxDummy`

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
`IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, 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.IMapGeographicTransformations
`IID, IID24420050_03fe_11d4_9fe9_00c04f6bc78e, 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`

Constructor Summary
`Globe()` Constructs a Globe using ArcGIS Engine.
`Globe(java.lang.Object obj)` Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. `Globe theGlobe = (Globe) obj;`

Method Summary
`void`	`activate(int hWnd)` Gives this view control of the specified window.
`void`	`addBookmark(IBookmark3D pBookmark)` Adds a bookmark to the collection.
`void`	`addIActiveViewEventsListener(IActiveViewEvents theListener)` addIActiveViewEventsListener.
`void`	`addLayer(ILayer pLayer)` Adds a layer to the map.
`void`	`addLayer(ILayer pLayer, boolean autoArrange)` Adds a layer to the scene.
`void`	`addLayers(IEnumLayer layers, boolean autoArrange)` Adds multiple layers to the scene, optionally arranging them automatically.
`void`	`addLayerType(ILayer pLayer, int layerType, boolean autoArrange)` Add layer to globe as specified type.
`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`	`addTrack(IAGAnimationTrack pTrack)` Adds a track to the collection.
`void`	`addTrack(IAnimationTrack pTrack)` Adds a track to the collection.
`boolean`	`applies(java.lang.Object object)` Indicates if the given object is supported by the scene.
`void`	`applyTracks(boolean bApplyToAllViewers, double time)` Uses the enabled animation tracks for the given time.
`void`	`applyTracks(ISceneViewer pViewer, double time, double duration)` Plays the enabled animation tracks in the given viewer (in all if null).
`void`	`changePriority(IAGAnimationTrack pTrack, boolean bAbsolute, boolean bInSameType, int changeInIndex)` Changes the priority (index) of the track.
`void`	`changePriority(IAnimationTrack pTrack, boolean bAbsolute, boolean bInSameType, int changeInIndex)` Changes the priority (index) of the track.
`void`	`clear()` Empties the view contents.
`void`	`clearLayers()` Removes all layers from the scene.
`void`	`clearMapSurrounds()` Removes all map surrounds from the map.
`void`	`clearSelection()` Clears the scene's selection.
`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.
`IAGAnimationTrack`	`createTrack(IAGAnimationType pType)` Creates a new track and adds it to the collection.
`void`	`deactivate()` Another view takes over the associated window.
`void`	`delayDrawing(boolean delay)` Suspends drawing.
`void`	`delayEvents(boolean delay)` Used to batch operations together in order to minimize system notifications.
`void`	`deleteLayer(ILayer layer)` Deletes a layer from the scene.
`void`	`deleteMapSurround(IMapSurround mapSurround)` Deletes a map surround from the map.
`void`	`detachObject(java.lang.Object pObject)` Detach an object from all tracks it is attached to.
`void`	`draw(int hDC, ITrackCancel trackCancel)` Draws the view to the specified device context.
`void`	`drawGraphsToDC(int hDC)` Draw datagraphs to specified device context.
`void`	`drawPageLayoutToDC(int hDC)` Draw the page layout to specified device context.
`void`	`enumConnectionPoints(IEnumConnectionPoints[] ppEnum)` enumConnectionPoints
`boolean`	`equals(java.lang.Object o)` Compare this object with another
`void`	`findBookmark(java.lang.String name, IBookmark3D[] ppBookmark)` Finds a bookmark by name.
`void`	`findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)` findConnectionPoint
`IEnumRelationshipClass`	`findRelationshipClasses(IObjectClass objectClass, int role)` Finds all relationship classes in the collection that reference the given object class in the specified role.
`void`	`findTrack(java.lang.String name, IAGAnimationTrack[] ppTrack)` Finds a track by name.
`void`	`findTrack(java.lang.String name, IAnimationTrack[] ppTrack)` Finds a track by name.
`ILayer`	`getActiveGraphicsLayer()` The active graphics layer.
`IArray`	`getAGTracks()` The animation tracks.
`IArray`	`getAllViews()` All the viewers.
`IAnimationExtension`	`getAnimationExtension()` The animation extension containing tracks and environment settings.
`java.lang.String`	`getAnimationFileExtension()` The extension for the animation files.
`java.lang.String`	`getAnimationFileFilter(boolean bAllVersions)` The filter for browing animation files.
`IAGAnimationContainer`	`getAnimationObjectContainer()` The container of the animation objects attached to the tracks.
`IArray`	`getAnimationTypes()` The objects that describe the registered types of animation.
`IAnnotateMap`	`getAnnotationEngine()` The annotation (label) engine the map will use.
`IEnvelope`	`getAreaOfInterest()` The area of interest for the scene.
`IBarrierCollection`	`getBarriers(IEnvelope pExtent)` The list of barriers and their weight for labeling.
`IViewers3D`	`getBasicDisplay()` The basic 3D display used by the scene.
`IGraphicsLayer`	`getBasicGraphicsLayer()` The basic graphics layer.
`int`	`getBookmarkCount()` The number of bookmarks.
`IArray`	`getBookmarks()` The bookmarks.
`void`	`getClassID(GUID[] pClassID)` getClassID
`IBorder`	`getClipBorder()` An optional border drawn around ClipGeometry.
`IGeometry`	`getClipGeometry()` A shape that layers in the map are clipped to.
`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.
`ITimeExtent`	`getCurrentTimeExtent()` The current time extent of the map.
`java.lang.Object`	`getCurrentView()` The current active viewer.
`int`	`getDanglingCachesCount()` Returns the count of globe caches which are not saved.
`void`	`getDefaultBackgroundColor(float[] red, float[] green, float[] blue)` Returns the default background color.
`void`	`getDefaultBackgTransitionDistances(float[] pLowAltitute, float[] pHighAltitude)` The altitude values in kilometers for the transition in the background color.
`int`	`getDefaultGlobeBackgroundOption()` The default background option.
`void`	`getDefaultHighBackgroundColor(float[] red, float[] green, float[] blue)` The default high altitude background color.
`void`	`getDefaultLowBackgroundColor(float[] red, float[] green, float[] blue)` The default low altitude background color.
`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()` The description of the scene.
`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.
`double`	`getExaggerationFactor()` The vertical exaggeration of the scene.
`tagRECT`	`getExportFrame()` The device rectangle to export.
`IEnvelope`	`getExtent()` The extent of the scene.
`IExtentStack`	`getExtentStack()` The extent stack.
`ISelection`	`getFeatureSelection()` The scene's feature selection.
`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.
`IGlobeDisplay`	`getGlobeDisplay()` The globe display.
`IEnumLayer`	`getGlobeLayers(IUID pUid, boolean bRecursive, boolean bInBaseGlobe, boolean bSortedByDrawingPriority)` The globe layers by UID and internal grouping.
`int`	`getGlobeUnits()` The linear units used in the globe.
`IGraphicsContainer`	`getGraphicsContainer()` The active graphics container.
`com.esri.arcgis.interop.Dispatch`	`getJintegraDispatch()` Deprecated. Internal use only.
`ILayer`	`getLayer(int index)` The layer corresponding to a given index.
`int`	`getLayerCount()` The number of layers in the scene.
`IEnumLayer`	`getLayers(IUID uid, boolean recursive)` The layers in the scene of the type specified in the UID.
`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.
`java.lang.String`	`getName()` The name of the scene.
`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.
`ISceneGraph`	`getSceneGraph()` The scene's scenegraph.
`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.
`ISelection`	`getSelection()` The selection.
`int`	`getSelectionCount()` The number of selected features.
`int`	`getShowGlobeTips()` Show globe tips.
`void`	`getSizeMax(_ULARGE_INTEGER[] pcbSize)` getSizeMax
`IArray`	`getSpatialBookmarks()` The spatial bookmarks that can be used to define animations.
`ISpatialReference`	`getSpatialReference()` The spatial reference of the scene.
`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`	`getTrackCount()` The number of tracks.
`IArray`	`getTracks()` The animation tracks.
`IArray`	`getTracksOfType(IAGAnimationType pType)` The animation tracks of a given type.
`IArray`	`getTracksOfType(IAnimationType pType)` The animation tracks of a given type.
`java.lang.Object`	`getViewController(java.lang.Object pViewer)` The controller object (Camera) of a viewer.
`int`	`getWindowHandle(java.lang.Object pView)` The window handle associated with the given view.
`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`	`interfaceSupportsErrorInfo(GUID riid)` interfaceSupportsErrorInfo
`boolean`	`isActive()` Indicates if view is active or not.
`void`	`isDirty()` isDirty
`boolean`	`isDisplayEachTimestamp()` Indicates whether data for each timestamp will be drawn when playing the time visualization.
`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`	`isFramed()` Indicates if map is drawn in a frame rather than on the whole window.
`boolean`	`isGestureEnabled()` Indicates if interactive gestures are enabled.
`boolean`	`isHasLiveData()` Indicates whether the map has a time-enabled layer that is being updated frequently with new data.
`boolean`	`isMapActivated()` Indicates if the focus map is activated.
`boolean`	`isReportLayersInDrawingOrder()` Controls if layers are reported in drawing order.
`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`	`isSpatialReferenceLocked()` Indicates whether the spatial reference is prevented from being changed.
`boolean`	`isUseSymbolLevels()` Indicates if the Map draws using symbol levels.
`void`	`load(IStream pstm)` load
`void`	`loadAnimation(java.lang.String pFilename)` Load the animation from a file.
`void`	`loadBookmarks(IStream pStm)` Load the bookmarks from a stream.
`void`	`loadTracks(IStream pStm)` Load the animation tracks from a stream.
`void`	`moveBookmarkTo(IBookmark3D bookmark, int index)` Moves a bookmark in the collection.
`void`	`moveLayer(ILayer layer, int toIndex)` Moves a layer to another position within the Table Of Contents.
`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`	`printerChanged(IPrinter printer)` Called by application when printer changes.
`void`	`proposeSpatialReference(ISpatialReference pProposedSR, boolean[] pbChanged)` Proposes a spatial reference for the scene.
`void`	`putIsAnimating(boolean bAnimating, boolean bFullQuality)` Indicates if the animation is active, and if full quality rendering is used (for video).
`void`	`readExternal(java.io.ObjectInput in)`
`void`	`recalcFullExtent()` Forces the full extent to be recalculated.
`void`	`recalculateExtent()` Forces the scene's extent to be recalculated.
`void`	`refresh()` Causes the entire view to draw.
`void`	`refreshAttachedObjects()` Detaches from the tracks those objects that no longer exist.
`void`	`refreshGroupLayer(ILayer pLayer)` Refresh globe group layer.
`void`	`refreshObject(java.lang.Object pObject)` Container-specific actions to refresh object.
`void`	`refreshViews(boolean bRefreshAllViewers)` Refresh the active viewer or all viewers.
`void`	`release()` Release a Globe.
`void`	`removeAllAnimationTimeStrings(IAGAnimationTracks pTracks)` Remove all animation time string from the display.
`void`	`removeAllBookmarks()` Removes all bookmarks.
`void`	`removeAllStandaloneTables()` Removes all standalone tables from the collection.
`void`	`removeAllTables()` Removes all tables from the collection.
`void`	`removeAllTracks()` Removes all tracks.
`void`	`removeBookmark(IBookmark3D bookmark)` Removes a bookmark from the collection.
`void`	`removeIActiveViewEventsListener(IActiveViewEvents theListener)` removeIActiveViewEventsListener.
`void`	`removeStandaloneTable(IStandaloneTable table)` Removes the standalone table from the collection.
`void`	`removeTable(ITable table)` Removes a table from the collection.
`void`	`removeTrack(IAGAnimationTrack pTrack)` Removes a track from the collection.
`void`	`removeTrack(IAnimationTrack pTrack)` Removes a track from the collection.
`void`	`removeTrackTimeDisplay(IAGAnimationTrack pTrack)` Remove a single animation track time string from the display.
`void`	`restoreViewerStates(boolean bApplyRestored)` Restore the current state of the viewers.
`void`	`save(IStream pstm, int fClearDirty)` save
`void`	`saveAnimation(java.lang.String pFilename)` Save the animation to a file.
`void`	`saveBookmarks(IStream pStm)` Save the bookmarks to a stream.
`void`	`saveTracks(IStream pStm)` Save the animation tracks to a stream.
`void`	`saveViewerStates()` Save the current state of the viewers.
`void`	`selectByShape(IGeometry shape, ISelectionEnvironment env, boolean justOne)` Selects features in the scene given a shape and an optional selection environment.
`void`	`selectFeature(ILayer layer, IFeature pFeature)` Selects a feature.
`void`	`selectionChanged(ISelectionEventsSelectionChangedEvent theEvent)` Call this function to fire the selection changed event.
`void`	`setActiveGraphicsLayerByRef(ILayer ppLayer)` The active graphics layer.
`void`	`setAnimationObjectContainerByRef(IAGAnimationContainer ppContainer)` The container of the animation objects attached to the tracks.
`void`	`setAnimationTime(IStringArray rhs1)` Provides access to the animation time string.
`void`	`setAnnotationEngineByRef(IAnnotateMap annotateMap)` The annotation (label) engine the map will use.
`void`	`setAreaOfInterest(IEnvelope aoi)` The area of interest for the scene.
`void`	`setClipBorder(IBorder border)` An optional border drawn around ClipGeometry.
`void`	`setClipGeometry(IGeometry clipGeometry)` A shape that layers in the map are clipped to.
`void`	`setCurrentTimeExtentByRef(ITimeExtent timeExtent)` The current time extent of the map.
`void`	`setDefaultBackgroundColor(float red, float green, float blue)` Sets the default background color.
`void`	`setDefaultBackgTransitionDistances(float lowAltitute, float highAltitude)` The altitude values in kilometers for the transition in the background color.
`void`	`setDefaultGlobeBackgroundOption(int pOption)` The default background option.
`void`	`setDefaultHighBackgroundColor(float red, float green, float blue)` The default high altitude background color.
`void`	`setDefaultLowBackgroundColor(float red, float green, float blue)` The default low altitude background color.
`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`	`setDescription(java.lang.String descr)` The description of the scene.
`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`	`setDynamicTimeRefresh(boolean flag)` Indicates whether the data in the map refreshes when moving the time slider dynamically.
`void`	`setExaggerationFactor(double exaggerationFactor)` The vertical exaggeration of the scene.
`void`	`setExpanded(boolean expanded)` Indicates if the Map is expanded.
`void`	`setExtent(IEnvelope extent)` The visible extent rectangle.
`void`	`setFeatureSelectionByRef(ISelection selection)` The scene's feature selection.
`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`	`setGlobeUnits(int pUnits)` The linear units used in the globe.
`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`	`setIsGestureEnabled(boolean pbGestureEnabled)` Indicates if interactive gestures are enabled.
`void`	`setIsMapActivated(boolean isMapActivated)` Indicates if the focus map is activated.
`void`	`setMapScale(double scaleRF)` The scale of the map as a representative fraction.
`void`	`setMapUnits(int unitsCode)` The units for the map.
`void`	`setName(java.lang.String name)` The name of the scene.
`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`	`setReferenceScale(double scaleRF)` The reference scale of the map as a representative fraction.
`void`	`setReportLayersInDrawingOrder(boolean bTyped)` Controls if layers are reported in drawing order.
`void`	`setSelectionByRef(ISelection selection)` The selection.
`void`	`setShowGlobeTips(int pTipsType)` Show globe tips.
`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`	`setSpatialReferenceByRef(ISpatialReference spatialRef)` The spatial reference of the scene.
`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`	`setUseSymbolLevels(boolean flag)` Indicates if the Map draws using symbol levels.
`void`	`sortBookmarks(boolean ascending)` Sorts bookmarks in the collection.
`void`	`suggestExaggerationFactor(double aspectRatio, double[] exaggerationFactor)` Returns the vertical exaggeration factor that achieves the aspect ratio for the scene's extent.
`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

Globe

public Globe()
      throws java.io.IOException,
             java.net.UnknownHostException

Constructs a Globe using ArcGIS Engine.

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

Globe

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Globe theGlobe = (Globe) obj;

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

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.

release

public void release()

Release a Globe.

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

refreshGroupLayer

public void refreshGroupLayer(ILayer pLayer)
                       throws java.io.IOException,
                              AutomationException

Refresh globe group layer.

Specified by:: refreshGroupLayer in interface IGlobe2

Parameters:: pLayer - 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.

setReportLayersInDrawingOrder

public void setReportLayersInDrawingOrder(boolean bTyped)
                                   throws java.io.IOException,
                                          AutomationException

Controls if layers are reported in drawing order.

Specified by:: setReportLayersInDrawingOrder in interface IGlobe2

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

isReportLayersInDrawingOrder

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

Controls if layers are reported in drawing order.

Specified by:: isReportLayersInDrawingOrder in interface IGlobe2

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

getDanglingCachesCount

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

Returns the count of globe caches which are not saved.

Specified by:: getDanglingCachesCount in interface IGlobe2

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

getGlobeLayers

public IEnumLayer getGlobeLayers(IUID pUid,
                                 boolean bRecursive,
                                 boolean bInBaseGlobe,
                                 boolean bSortedByDrawingPriority)
                          throws java.io.IOException,
                                 AutomationException

The globe layers by UID and internal grouping.

Specified by:: getGlobeLayers in interface IGlobe

Parameters:: pUid - A reference to a com.esri.arcgis.system.IUID (in); bRecursive - The bRecursive (in); bInBaseGlobe - The bInBaseGlobe (in); bSortedByDrawingPriority - The bSortedByDrawingPriority (in)
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.

getGlobeDisplay

public IGlobeDisplay getGlobeDisplay()
                              throws java.io.IOException,
                                     AutomationException

The globe display.

Specified by:: getGlobeDisplay in interface IGlobe

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

getDefaultGlobeBackgroundOption

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

The default background option.

Specified by:: getDefaultGlobeBackgroundOption in interface IGlobe

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

setDefaultGlobeBackgroundOption

public void setDefaultGlobeBackgroundOption(int pOption)
                                     throws java.io.IOException,
                                            AutomationException

The default background option.

Specified by:: setDefaultGlobeBackgroundOption in interface IGlobe

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

setDefaultHighBackgroundColor

public void setDefaultHighBackgroundColor(float red,
                                          float green,
                                          float blue)
                                   throws java.io.IOException,
                                          AutomationException

The default high altitude background color.

Specified by:: setDefaultHighBackgroundColor in interface IGlobe

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

getDefaultHighBackgroundColor

public void getDefaultHighBackgroundColor(float[] red,
                                          float[] green,
                                          float[] blue)
                                   throws java.io.IOException,
                                          AutomationException

The default high altitude background color.

Specified by:: getDefaultHighBackgroundColor in interface IGlobe

Parameters:: red - The red (out: use single element array); green - The green (out: use single element array); blue - The blue (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDefaultLowBackgroundColor

public void setDefaultLowBackgroundColor(float red,
                                         float green,
                                         float blue)
                                  throws java.io.IOException,
                                         AutomationException

The default low altitude background color.

Specified by:: setDefaultLowBackgroundColor in interface IGlobe

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

getDefaultLowBackgroundColor

public void getDefaultLowBackgroundColor(float[] red,
                                         float[] green,
                                         float[] blue)
                                  throws java.io.IOException,
                                         AutomationException

The default low altitude background color.

Specified by:: getDefaultLowBackgroundColor in interface IGlobe

Parameters:: red - The red (out: use single element array); green - The green (out: use single element array); blue - The blue (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDefaultBackgTransitionDistances

public void setDefaultBackgTransitionDistances(float lowAltitute,
                                               float highAltitude)
                                        throws java.io.IOException,
                                               AutomationException

The altitude values in kilometers for the transition in the background color.

Specified by:: setDefaultBackgTransitionDistances in interface IGlobe

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

getDefaultBackgTransitionDistances

public void getDefaultBackgTransitionDistances(float[] pLowAltitute,
                                               float[] pHighAltitude)
                                        throws java.io.IOException,
                                               AutomationException

The altitude values in kilometers for the transition in the background color.

Specified by:: getDefaultBackgTransitionDistances in interface IGlobe

Parameters:: pLowAltitute - The pLowAltitute (out: use single element array); pHighAltitude - The pHighAltitude (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setGlobeUnits

public void setGlobeUnits(int pUnits)
                   throws java.io.IOException,
                          AutomationException

The linear units used in the globe.

Specified by:: setGlobeUnits in interface IGlobe

Parameters:: pUnits - 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.

getGlobeUnits

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

The linear units used in the globe.

Specified by:: getGlobeUnits in interface IGlobe

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.

addLayerType

public void addLayerType(ILayer pLayer,
                         int layerType,
                         boolean autoArrange)
                  throws java.io.IOException,
                         AutomationException

Add layer to globe as specified type.

Specified by:: addLayerType in interface IGlobe

Parameters:: pLayer - A reference to a com.esri.arcgis.carto.ILayer (in); layerType - A com.esri.arcgis.globecore.esriGlobeLayerType constant (in); autoArrange - The autoArrange (in, optional, pass false if not required)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowGlobeTips

public void setShowGlobeTips(int pTipsType)
                      throws java.io.IOException,
                             AutomationException

Show globe tips.

Specified by:: setShowGlobeTips in interface IGlobe

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

getShowGlobeTips

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

Show globe tips.

Specified by:: getShowGlobeTips in interface IGlobe

Returns:: A com.esri.arcgis.globecore.esriGlobeTipsType constant
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 extent of the scene.

Specified by:: getExtent in interface IScene
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.

suggestExaggerationFactor

public void suggestExaggerationFactor(double aspectRatio,
                                      double[] exaggerationFactor)
                               throws java.io.IOException,
                                      AutomationException

Returns the vertical exaggeration factor that achieves the aspect ratio for the scene's extent.

Specified by:: suggestExaggerationFactor in interface IScene

Parameters:: aspectRatio - The aspectRatio (in); exaggerationFactor - The exaggerationFactor (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExaggerationFactor

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

The vertical exaggeration of the scene.

Specified by:: getExaggerationFactor in interface IScene

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

setExaggerationFactor

public void setExaggerationFactor(double exaggerationFactor)
                           throws java.io.IOException,
                                  AutomationException

The vertical exaggeration of the scene.

Specified by:: setExaggerationFactor in interface IScene

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

applies

public boolean applies(java.lang.Object object)
                throws java.io.IOException,
                       AutomationException

Indicates if the given object is supported by the scene.

Specified by:: applies in interface IScene

Parameters:: object - A reference to another Object (IUnknown) (in)
Returns:: The applies
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getName

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

The name of the scene.

Specified by:: getName in interface IScene
Specified by:: getName in interface IBasicMap
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

The name of the scene.

Specified by:: setName in interface IScene
Specified by:: setName in interface IBasicMap
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

The description of the scene.

Specified by:: getDescription in interface IScene
Specified by:: getDescription in interface IBasicMap
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

The description of the scene.

Specified by:: setDescription in interface IScene
Specified by:: setDescription in interface IBasicMap
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.

getAreaOfInterest

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

The area of interest for the scene.

Specified by:: getAreaOfInterest in interface IScene

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.

setAreaOfInterest

public void setAreaOfInterest(IEnvelope aoi)
                       throws java.io.IOException,
                              AutomationException

The area of interest for the scene.

Specified by:: setAreaOfInterest in interface IScene
Specified by:: setAreaOfInterest in interface IBasicMap
Specified by:: setAreaOfInterest in interface IMap

Parameters:: aoi - 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

The number of layers in the scene.

Specified by:: getLayerCount in interface IScene
Specified by:: getLayerCount in interface IBasicMap
Specified by:: getLayerCount in interface IMap

Returns:: The pcLayers
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 corresponding to a given index.

Specified by:: getLayer in interface IScene
Specified by:: getLayer in interface IBasicMap
Specified by:: getLayer in interface IMap

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 scene of the type specified in the UID. If 'recursive' is true, includes layers in group layers.

Specified by:: getLayers in interface IScene
Specified by:: getLayers in interface IBasicMap
Specified by:: getLayers in interface IMap

Parameters:: uid - A reference to a com.esri.arcgis.system.IUID (in, optional, pass null if not required); recursive - The recursive (in, optional, pass false 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.

addLayer

public void addLayer(ILayer pLayer,
                     boolean autoArrange)
              throws java.io.IOException,
                     AutomationException

Adds a layer to the scene.

Specified by:: addLayer in interface IScene

Parameters:: pLayer - A reference to a com.esri.arcgis.carto.ILayer (in); autoArrange - The autoArrange (in, optional, pass false if not required)
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 scene, optionally arranging them automatically.

Specified by:: addLayers in interface IScene
Specified by:: addLayers in interface IBasicMap
Specified by:: addLayers in interface IMap

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

Specified by:: deleteLayer in interface IScene
Specified by:: deleteLayer in interface IBasicMap
Specified by:: deleteLayer in interface IMap

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 within the Table Of Contents.

Specified by:: moveLayer in interface IScene
Specified by:: moveLayer in interface IMap

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

Specified by:: clearLayers in interface IScene
Specified by:: clearLayers in interface IBasicMap
Specified by:: clearLayers in interface IMap

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

Specified by:: getSpatialReference in interface IScene
Specified by:: getSpatialReference in interface IBasicMap
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 scene.

Specified by:: setSpatialReferenceByRef in interface IScene
Specified by:: setSpatialReferenceByRef in interface IBasicMap
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.

proposeSpatialReference

public void proposeSpatialReference(ISpatialReference pProposedSR,
                                    boolean[] pbChanged)
                             throws java.io.IOException,
                                    AutomationException

Proposes a spatial reference for the scene.

Specified by:: proposeSpatialReference in interface IScene

Parameters:: pProposedSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in); pbChanged - The pbChanged (out: use single element array)
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 IScene
Specified by:: getBasicGraphicsLayer in interface IBasicMap
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 IScene
Specified by:: getActiveGraphicsLayer in interface IBasicMap
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 ppLayer)
                                 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 IScene
Specified by:: setActiveGraphicsLayerByRef in interface IBasicMap
Specified by:: setActiveGraphicsLayerByRef in interface IMap

Parameters:: ppLayer - 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.

delayEvents

public void delayEvents(boolean delay)
                 throws java.io.IOException,
                        AutomationException

Used to batch operations together in order to minimize system notifications.

Specified by:: delayEvents in interface IScene
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.

getSelectionCount

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

The number of selected features.

Specified by:: getSelectionCount in interface IScene
Specified by:: getSelectionCount in interface IBasicMap
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.

selectFeature

public void selectFeature(ILayer layer,
                          IFeature pFeature)
                   throws java.io.IOException,
                          AutomationException

Selects a feature.

Specified by:: selectFeature in interface IScene
Specified by:: selectFeature in interface IMap

Parameters:: layer - A reference to a com.esri.arcgis.carto.ILayer (in); pFeature - 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.

clearSelection

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

Clears the scene's selection.

Specified by:: clearSelection in interface IScene
Specified by:: clearSelection in interface IBasicMap
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 scene's feature selection.

Specified by:: getFeatureSelection in interface IScene
Specified by:: getFeatureSelection in interface IBasicMap
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 scene's feature selection.

Specified by:: setFeatureSelectionByRef in interface IScene
Specified by:: setFeatureSelectionByRef in interface IBasicMap
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 scene given a shape and an optional selection environment.

Specified by:: selectByShape in interface IScene
Specified by:: selectByShape in interface IBasicMap
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.

recalculateExtent

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

Forces the scene's extent to be recalculated.

Specified by:: recalculateExtent in interface IScene

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

getSceneGraph

public ISceneGraph getSceneGraph()
                          throws java.io.IOException,
                                 AutomationException

The scene's scenegraph.

Specified by:: getSceneGraph in interface IScene

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

setDefaultBackgroundColor

public void setDefaultBackgroundColor(float red,
                                      float green,
                                      float blue)
                               throws java.io.IOException,
                                      AutomationException

Sets the default background color.

Specified by:: setDefaultBackgroundColor in interface IScene

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

getDefaultBackgroundColor

public void getDefaultBackgroundColor(float[] red,
                                      float[] green,
                                      float[] blue)
                               throws java.io.IOException,
                                      AutomationException

Returns the default background color.

Specified by:: getDefaultBackgroundColor in interface IScene

Parameters:: red - The red (out: use single element array); green - The green (out: use single element array); blue - The blue (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAnimationExtension

public IAnimationExtension getAnimationExtension()
                                          throws java.io.IOException,
                                                 AutomationException

The animation extension containing tracks and environment settings.

Specified by:: getAnimationExtension in interface IBasicScene2

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

getBasicDisplay

public IViewers3D getBasicDisplay()
                           throws java.io.IOException,
                                  AutomationException

The basic 3D display used by the scene.

Specified by:: getBasicDisplay in interface IBasicScene

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

saveAnimation

public void saveAnimation(java.lang.String pFilename)
                   throws java.io.IOException,
                          AutomationException

Save the animation to a file.

Specified by:: saveAnimation in interface IBasicScene

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

loadAnimation

public void loadAnimation(java.lang.String pFilename)
                   throws java.io.IOException,
                          AutomationException

Load the animation from a file.

Specified by:: loadAnimation in interface IBasicScene

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

getFullExtent

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

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.

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

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

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.

addLayer

public void addLayer(ILayer pLayer)
              throws java.io.IOException,
                     AutomationException

Adds a layer to the map.

Specified by:: addLayer in interface IBasicMap
Specified by:: addLayer in interface IMap

Parameters:: pLayer - 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.

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.

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

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

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.

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.

getClipBorder

public IBorder getClipBorder()
                      throws java.io.IOException,
                             AutomationException

An optional border drawn around ClipGeometry.

Specified by:: getClipBorder in interface IMap

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

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.

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.

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.

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.

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.

moveBookmarkTo

public void moveBookmarkTo(IBookmark3D bookmark,
                           int index)
                    throws java.io.IOException,
                           AutomationException

Moves a bookmark in the collection.

Specified by:: moveBookmarkTo in interface ISceneBookmarks2

Parameters:: bookmark - A reference to a com.esri.arcgis.analyst3d.IBookmark3D (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

Sorts bookmarks in the collection.

Specified by:: sortBookmarks in interface ISceneBookmarks2

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

getBookmarks

public IArray getBookmarks()
                    throws java.io.IOException,
                           AutomationException

The bookmarks.

Specified by:: getBookmarks in interface ISceneBookmarks

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

addBookmark

public void addBookmark(IBookmark3D pBookmark)
                 throws java.io.IOException,
                        AutomationException

Adds a bookmark to the collection.

Specified by:: addBookmark in interface ISceneBookmarks

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

findBookmark

public void findBookmark(java.lang.String name,
                         IBookmark3D[] ppBookmark)
                  throws java.io.IOException,
                         AutomationException

Finds a bookmark by name.

Specified by:: findBookmark in interface ISceneBookmarks

Parameters:: name - The name (in); ppBookmark - A reference to a com.esri.arcgis.analyst3d.IBookmark3D (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeBookmark

public void removeBookmark(IBookmark3D bookmark)
                    throws java.io.IOException,
                           AutomationException

Removes a bookmark from the collection.

Specified by:: removeBookmark in interface ISceneBookmarks

Parameters:: bookmark - A reference to a com.esri.arcgis.analyst3d.IBookmark3D (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 ISceneBookmarks

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

getBookmarkCount

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

The number of bookmarks.

Specified by:: getBookmarkCount in interface ISceneBookmarks

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

saveBookmarks

public void saveBookmarks(IStream pStm)
                   throws java.io.IOException,
                          AutomationException

Save the bookmarks to a stream.

Specified by:: saveBookmarks in interface ISceneBookmarks

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.

loadBookmarks

public void loadBookmarks(IStream pStm)
                   throws java.io.IOException,
                          AutomationException

Load the bookmarks from a stream.

Specified by:: loadBookmarks in interface ISceneBookmarks

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.

getAnimationTypes

public IArray getAnimationTypes()
                         throws java.io.IOException,
                                AutomationException

The objects that describe the registered types of animation.

Specified by:: getAnimationTypes in interface IAnimationTracks
Specified by:: getAnimationTypes in interface IAGAnimationContainer

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

getTrackCount

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

The number of tracks.

Specified by:: getTrackCount in interface IAnimationTracks
Specified by:: getTrackCount in interface IAGAnimationTracks

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

getTracks

public IArray getTracks()
                 throws java.io.IOException,
                        AutomationException

The animation tracks.

Specified by:: getTracks in interface IAnimationTracks

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

getTracksOfType

public IArray getTracksOfType(IAnimationType pType)
                       throws java.io.IOException,
                              AutomationException

The animation tracks of a given type.

Specified by:: getTracksOfType in interface IAnimationTracks

Parameters:: pType - A reference to a com.esri.arcgis.analyst3d.IAnimationType (in)
Returns:: A reference to a com.esri.arcgis.system.IArray
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addTrack

public void addTrack(IAnimationTrack pTrack)
              throws java.io.IOException,
                     AutomationException

Adds a track to the collection.

Specified by:: addTrack in interface IAnimationTracks

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

findTrack

public void findTrack(java.lang.String name,
                      IAnimationTrack[] ppTrack)
               throws java.io.IOException,
                      AutomationException

Finds a track by name.

Specified by:: findTrack in interface IAnimationTracks

Parameters:: name - The name (in); ppTrack - A reference to a com.esri.arcgis.analyst3d.IAnimationTrack (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeTrack

public void removeTrack(IAnimationTrack pTrack)
                 throws java.io.IOException,
                        AutomationException

Removes a track from the collection.

Specified by:: removeTrack in interface IAnimationTracks

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

removeAllTracks

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

Removes all tracks.

Specified by:: removeAllTracks in interface IAnimationTracks
Specified by:: removeAllTracks in interface IAGAnimationTracks

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

saveTracks

public void saveTracks(IStream pStm)
                throws java.io.IOException,
                       AutomationException

Save the animation tracks to a stream.

Specified by:: saveTracks in interface IAnimationTracks
Specified by:: saveTracks in interface IAGAnimationTracks

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.

loadTracks

public void loadTracks(IStream pStm)
                throws java.io.IOException,
                       AutomationException

Load the animation tracks from a stream.

Specified by:: loadTracks in interface IAnimationTracks
Specified by:: loadTracks in interface IAGAnimationTracks

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.

detachObject

public void detachObject(java.lang.Object pObject)
                  throws java.io.IOException,
                         AutomationException

Detach an object from all tracks it is attached to.

Specified by:: detachObject in interface IAnimationTracks
Specified by:: detachObject in interface IAGAnimationTracks

Parameters:: pObject - A reference to another Object (IUnknown) (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

refreshAttachedObjects

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

Detaches from the tracks those objects that no longer exist.

Specified by:: refreshAttachedObjects in interface IAnimationTracks
Specified by:: refreshAttachedObjects in interface IAGAnimationTracks

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

applyTracks

public void applyTracks(ISceneViewer pViewer,
                        double time,
                        double duration)
                 throws java.io.IOException,
                        AutomationException

Plays the enabled animation tracks in the given viewer (in all if null).

Specified by:: applyTracks in interface IAnimationTracks

Parameters:: pViewer - A reference to a com.esri.arcgis.analyst3d.ISceneViewer (in); time - The time (in); duration - The duration (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

changePriority

public void changePriority(IAnimationTrack pTrack,
                           boolean bAbsolute,
                           boolean bInSameType,
                           int changeInIndex)
                    throws java.io.IOException,
                           AutomationException

Changes the priority (index) of the track.

Specified by:: changePriority in interface IAnimationTracks

Parameters:: pTrack - A reference to a com.esri.arcgis.analyst3d.IAnimationTrack (in); bAbsolute - The bAbsolute (in); bInSameType - The bInSameType (in); changeInIndex - The changeInIndex (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAnimationObjectContainer

public IAGAnimationContainer getAnimationObjectContainer()
                                                  throws java.io.IOException,
                                                         AutomationException

The container of the animation objects attached to the tracks.

Specified by:: getAnimationObjectContainer in interface IAGAnimationTracks

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

setAnimationObjectContainerByRef

public void setAnimationObjectContainerByRef(IAGAnimationContainer ppContainer)
                                      throws java.io.IOException,
                                             AutomationException

The container of the animation objects attached to the tracks.

Specified by:: setAnimationObjectContainerByRef in interface IAGAnimationTracks

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

getAGTracks

public IArray getAGTracks()
                   throws java.io.IOException,
                          AutomationException

The animation tracks.

Specified by:: getAGTracks in interface IAGAnimationTracks

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

getTracksOfType

public IArray getTracksOfType(IAGAnimationType pType)
                       throws java.io.IOException,
                              AutomationException

The animation tracks of a given type.

Specified by:: getTracksOfType in interface IAGAnimationTracks

Parameters:: pType - A reference to a com.esri.arcgis.animation.IAGAnimationType (in)
Returns:: A reference to a com.esri.arcgis.system.IArray
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

createTrack

public IAGAnimationTrack createTrack(IAGAnimationType pType)
                              throws java.io.IOException,
                                     AutomationException

Creates a new track and adds it to the collection.

Specified by:: createTrack in interface IAGAnimationTracks

Parameters:: pType - A reference to a com.esri.arcgis.animation.IAGAnimationType (in)
Returns:: A reference to a com.esri.arcgis.animation.IAGAnimationTrack
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addTrack

public void addTrack(IAGAnimationTrack pTrack)
              throws java.io.IOException,
                     AutomationException

Adds a track to the collection.

Specified by:: addTrack in interface IAGAnimationTracks

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

findTrack

public void findTrack(java.lang.String name,
                      IAGAnimationTrack[] ppTrack)
               throws java.io.IOException,
                      AutomationException

Finds a track by name.

Specified by:: findTrack in interface IAGAnimationTracks

Parameters:: name - The name (in); ppTrack - A reference to a com.esri.arcgis.animation.IAGAnimationTrack (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeTrack

public void removeTrack(IAGAnimationTrack pTrack)
                 throws java.io.IOException,
                        AutomationException

Removes a track from the collection.

Specified by:: removeTrack in interface IAGAnimationTracks

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

applyTracks

public void applyTracks(boolean bApplyToAllViewers,
                        double time)
                 throws java.io.IOException,
                        AutomationException

Uses the enabled animation tracks for the given time.

Specified by:: applyTracks in interface IAGAnimationTracks

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

changePriority

public void changePriority(IAGAnimationTrack pTrack,
                           boolean bAbsolute,
                           boolean bInSameType,
                           int changeInIndex)
                    throws java.io.IOException,
                           AutomationException

Changes the priority (index) of the track.

Specified by:: changePriority in interface IAGAnimationTracks

Parameters:: pTrack - A reference to a com.esri.arcgis.animation.IAGAnimationTrack (in); bAbsolute - The bAbsolute (in); bInSameType - The bInSameType (in); changeInIndex - The changeInIndex (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCurrentView

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

The current active viewer.

Specified by:: getCurrentView in interface IAGAnimationContainer

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

getAllViews

public IArray getAllViews()
                   throws java.io.IOException,
                          AutomationException

All the viewers.

Specified by:: getAllViews in interface IAGAnimationContainer

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

getViewController

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

The controller object (Camera) of a viewer.

Specified by:: getViewController in interface IAGAnimationContainer

Parameters:: pViewer - A reference to another Object (IUnknown) (in)
Returns:: A reference to another Object (IUnknown)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

refreshViews

public void refreshViews(boolean bRefreshAllViewers)
                  throws java.io.IOException,
                         AutomationException

Refresh the active viewer or all viewers.

Specified by:: refreshViews in interface IAGAnimationContainer

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

refreshObject

public void refreshObject(java.lang.Object pObject)
                   throws java.io.IOException,
                          AutomationException

Container-specific actions to refresh object.

Specified by:: refreshObject in interface IAGAnimationContainer

Parameters:: pObject - A reference to another Object (IUnknown) (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

saveViewerStates

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

Save the current state of the viewers.

Specified by:: saveViewerStates in interface IAGAnimationContainer

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

restoreViewerStates

public void restoreViewerStates(boolean bApplyRestored)
                         throws java.io.IOException,
                                AutomationException

Restore the current state of the viewers.

Specified by:: restoreViewerStates in interface IAGAnimationContainer

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

putIsAnimating

public void putIsAnimating(boolean bAnimating,
                           boolean bFullQuality)
                    throws java.io.IOException,
                           AutomationException

Indicates if the animation is active, and if full quality rendering is used (for video).

Specified by:: putIsAnimating in interface IAGAnimationContainer

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

isGestureEnabled

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

Indicates if interactive gestures are enabled.

Specified by:: isGestureEnabled in interface IAGAnimationContainer

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

setIsGestureEnabled

public void setIsGestureEnabled(boolean pbGestureEnabled)
                         throws java.io.IOException,
                                AutomationException

Indicates if interactive gestures are enabled.

Specified by:: setIsGestureEnabled in interface IAGAnimationContainer

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

getWindowHandle

public int getWindowHandle(java.lang.Object pView)
                    throws java.io.IOException,
                           AutomationException

The window handle associated with the given view.

Specified by:: getWindowHandle in interface IAGAnimationContainer

Parameters:: pView - A reference to another Object (IUnknown) (in)
Returns:: The phWnd (A COM typedef)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getAnimationFileExtension

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

The extension for the animation files.

Specified by:: getAnimationFileExtension in interface IAGAnimationContainer

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

getAnimationFileFilter

public java.lang.String getAnimationFileFilter(boolean bAllVersions)
                                        throws java.io.IOException,
                                               AutomationException

The filter for browing animation files.

Specified by:: getAnimationFileFilter in interface IAGAnimationContainer

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

getSpatialBookmarks

public IArray getSpatialBookmarks()
                           throws java.io.IOException,
                                  AutomationException

The spatial bookmarks that can be used to define animations.

Specified by:: getSpatialBookmarks in interface IAGAnimationContainer

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

removeAllAnimationTimeStrings

public void removeAllAnimationTimeStrings(IAGAnimationTracks pTracks)
                                   throws java.io.IOException,
                                          AutomationException

Remove all animation time string from the display.

Specified by:: removeAllAnimationTimeStrings in interface IAGAnimationContainer

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

removeTrackTimeDisplay

public void removeTrackTimeDisplay(IAGAnimationTrack pTrack)
                            throws java.io.IOException,
                                   AutomationException

Remove a single animation track time string from the display.

Specified by:: removeTrackTimeDisplay in interface IAGAnimationContainer

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

setAnimationTime

public void setAnimationTime(IStringArray rhs1)
                      throws java.io.IOException,
                             AutomationException

Provides access to the animation time string.

Specified by:: setAnimationTime in interface IAGAnimationContainer

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

drawGraphsToDC

public void drawGraphsToDC(int hDC)
                    throws java.io.IOException,
                           AutomationException

Draw datagraphs to specified device context.

Specified by:: drawGraphsToDC in interface IAGAnimationContainer

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.

drawPageLayoutToDC

public void drawPageLayoutToDC(int hDC)
                        throws java.io.IOException,
                               AutomationException

Draw the page layout to specified device context.

Specified by:: drawPageLayoutToDC in interface IAGAnimationContainer

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.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:: interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:: riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
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.

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.

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.

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

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.globecore Class Globe

serialVersionUID

Globe

Globe

getClsid

equals

hashCode

getJintegraDispatch

addIActiveViewEventsListener

removeIActiveViewEventsListener

release

refreshGroupLayer

setReportLayersInDrawingOrder

isReportLayersInDrawingOrder

getDanglingCachesCount

getGlobeLayers

getGlobeDisplay

getDefaultGlobeBackgroundOption

setDefaultGlobeBackgroundOption

setDefaultHighBackgroundColor

getDefaultHighBackgroundColor

setDefaultLowBackgroundColor

getDefaultLowBackgroundColor

setDefaultBackgTransitionDistances

getDefaultBackgTransitionDistances

setGlobeUnits

getGlobeUnits

addLayerType

setShowGlobeTips

getShowGlobeTips

getExtent

suggestExaggerationFactor

getExaggerationFactor

setExaggerationFactor

applies

getName

setName

getDescription

setDescription

getAreaOfInterest

setAreaOfInterest

getLayerCount

getLayer

getLayers

addLayer

addLayers

deleteLayer

moveLayer

clearLayers

getSpatialReference

setSpatialReferenceByRef

proposeSpatialReference

getBasicGraphicsLayer

getActiveGraphicsLayer

setActiveGraphicsLayerByRef

delayEvents

getSelectionCount

selectFeature

clearSelection

getFeatureSelection

setFeatureSelectionByRef

selectByShape

recalculateExtent

getSceneGraph

setDefaultBackgroundColor

getDefaultBackgroundColor

getAnimationExtension

getBasicDisplay

saveAnimation

loadAnimation

getFullExtent

setFullExtent

setExtent

getScreenDisplay

getGraphicsContainer

getFocusMap

setFocusMapByRef

isMapActivated

setIsMapActivated

getSelection

com.esri.arcgis.globecore
Class Globe