com.esri.arcgis.trackinganalyst
Class TADynamicDisplayRefreshController

java.lang.Object
  com.esri.arcgis.trackinganalyst.TADynamicDisplayRefreshController

All Implemented Interfaces:

IActiveViewEvents, IDisplayEvents, IDynamicMapEvents, IGlobeDisplayEvents, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, ITAUpdateControl, ITxActiveTrack, ITxDocumentEvents, ITxHighlightSettings, java.io.Serializable, java.util.EventListener

public class TADynamicDisplayRefreshController
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITAUpdateControl, IActiveViewEvents, ISupportErrorInfo, IGlobeDisplayEvents, IDynamicMapEvents, ITxDocumentEvents, IDisplayEvents, ITxActiveTrack, ITxHighlightSettings

COM Class 'TADynamicDisplayRefreshController'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description 'Manages all dynamic updates to all of ArcMap's maps, both in the map view and the page layout view.' 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

Fields inherited from interface com.esri.arcgis.trackinganalyst.ITAUpdateControl

IID, IIDcc018a63_24fb_11d4_b34c_00104ba2abcc, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IActiveViewEvents

IID, IIDe79c5940_52dd_11d0_98be_00805f7ced21, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Fields inherited from interface com.esri.arcgis.globecore.IGlobeDisplayEvents

IID, IIDe4e37ac7_6f8a_4f4a_b7c3_db44375e8c5b, xxDummy

Fields inherited from interface com.esri.arcgis.display.IDynamicMapEvents

IID, IID5ea97c5f_e7ab_4eb0_8881_f2182924df52, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.ITxDocumentEvents

IID, IID5e90b920_8560_11d7_b877_00010265adc5, xxDummy

Fields inherited from interface com.esri.arcgis.display.IDisplayEvents

IID, IIDe6bdb003_4d35_11d0_98be_00805f7ced21, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.ITxActiveTrack

IID, IID97801c2b_6eda_446e_88a9_1ed1450313f6, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.ITxHighlightSettings

IID, IIDda25491e_f52b_4639_a4de_d0933580eccc, xxDummy

Constructor Summary

TADynamicDisplayRefreshController(java.lang.Object obj)
Construct a TADynamicDisplayRefreshController using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	activeViewChanged(ITxDocumentEventsActiveViewChangedEvent theEvent) Fired when the active view changes.
void	activeViewerChanged(IGlobeDisplayEventsActiveViewerChangedEvent theEvent) Fired when the active viewer changes.
void	addLayer(ILayer piLayer) Obsolete Method that is unsupported.
void	afterDraw(IActiveViewEventsAfterDrawEvent theEvent) Fired after the specified phase is drawn.
void	afterDraw(IGlobeDisplayEventsAfterDrawEvent theEvent) Fired when drawing finishes.
void	afterDynamicDraw(IDynamicMapEventsAfterDynamicDrawEvent theEvent) Fired after the specified phase is drawn.
void	afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent) Fired after an individual view item is drawn.
void	batchTileGenerationStarted(IGlobeDisplayEventsBatchTileGenerationStartedEvent theEvent) Fired when data preparation starts.
void	batchTileGenerationStopped(IGlobeDisplayEventsBatchTileGenerationStoppedEvent theEvent) Fired when data preparation stops.
boolean	beforeCloseDocument(ITxDocumentEventsBeforeCloseDocumentEvent theEvent) Fired before a document is closed.
boolean	beforeDraw(IGlobeDisplayEventsBeforeDrawEvent theEvent) Fired when drawing starts.
void	beforeDynamicDraw(IDynamicMapEventsBeforeDynamicDrawEvent theEvent) Fired before the specified phase is drawn.
void	closeDocument(ITxDocumentEventsCloseDocumentEvent theEvent) Fired when a document is closed.
void	contentsChanged(IActiveViewEventsContentsChangedEvent theEvent) Fired when the contents of the view changes.
void	contentsCleared(IActiveViewEventsContentsClearedEvent theEvent) Fired when the contents of the view is cleared.
void	displayFinished(IDisplayEventsDisplayFinishedEvent theEvent) Notifies clients when drawing completes.
void	displayInvalidated(IDisplayEventsDisplayInvalidatedEvent theEvent) Notifies clients when display is invalidated.
void	displayScrolled(IDisplayEventsDisplayScrolledEvent theEvent) Notifies clients when display is scrolled.
void	displayStarted(IDisplayEventsDisplayStartedEvent theEvent) Notifies clients when drawing starts.
void	dynamicMapFinished(IDynamicMapEventsDynamicMapFinishedEvent theEvent) Fired when the dynamic map finishes.
void	dynamicMapStarted(IDynamicMapEventsDynamicMapStartedEvent theEvent) Fired when the dynamic map starts.
boolean	equals(java.lang.Object o) Compare this object with another
void	focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent) Fired when a new map is made active.
ILayer	getActiveTrack(java.lang.String[] activeTrackName, IMap[] map) The Layer containing the active track and the track name on a given map.
void	getFollowPlaybackRate(double[] playbackRate, int[] units) The playback time between periodic recentering of the most current feature in the active track.
IPoint	getFollowPoint() The most recent follow location.
double	getFollowRate() The time between periodic recentering of the most current feature in the active track.
ISymbol	getFollowSymbol() The symbol used to mark the position of the most current feature in the active track.
double	getFollowThreshold() The percent of visible area to keep the followed feature within.
IColor	getHighlightFeatureColor() The highlight color drawn for highlighted features.
IColor	getHighlightTrackFeatureColor() The highlight color drawn for features in highlighted tracks.
IColor	getHighlightTrackLineColor() The highlight color drawn for track-lines in highlighted tracks.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
double	getMaxUpdateRate() Indicates the minimum duration between which the map display updates, as defined in the dynamic update controller.
double	getRefreshRate() Indicates the maximum duration between map display refreshes, as defined in the dynamic update controller.
java.lang.String	getStatistics() Various statistics about dynamic display processing.
int	getUpdateMethod() Defines how the display refresh is determined: by number of points or CPU usage.
int	getUpdateValue() Indicates the number of points or percentage of CPU usage used as the threshold for a map display refresh.
int	hashCode() the hashcode for this object
void	interactionStopped(IGlobeDisplayEventsInteractionStoppedEvent theEvent) Fired when interaction stops.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isAutoRefresh() Indicates whether or not the map display will refresh automatically when no new data has been received.
boolean	isFollow() Indicates whether or not the display should stay centered on the active track.
boolean	isManualUpdate() Indicates whether or not map display must be updated manually when new data is received.
boolean	isUseFollowRate() Indicates whether or not to follow based on elapsed time.
void	itemAdded(IActiveViewEventsItemAddedEvent theEvent) Fired when an item is added to the view.
void	itemDeleted(IActiveViewEventsItemDeletedEvent theEvent) Fired when an item is deleted from the view.
void	itemReordered(IActiveViewEventsItemReorderedEvent theEvent) Fired when a view item is reordered.
void	mapsChanged(ITxDocumentEventsMapsChangedEvent theEvent) Fired when a change is made to the map collection.
void	newDocument(ITxDocumentEventsNewDocumentEvent theEvent) Fired when a new document is created.
void	onContextMenu(ITxDocumentEventsOnContextMenuEvent theEvent) Indicates if a context menu should be displayed at the given xy location.
void	openDocument(ITxDocumentEventsOpenDocumentEvent theEvent) Fired when a document is opened.
boolean	recenter() Center the active view around the most current feature of the active track.
void	refreshDisplay(int enumUpdateType) Refreshes the map display in ArcMap.
void	release() Release a TADynamicDisplayRefreshController.
void	removeLayer(ILayer piLayer) Obsolete Method that is unsupported.
void	selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent) Call this function to fire the selection changed event.
void	setActiveTrack(java.lang.String activeTrackName, IMap map, ILayer layer) The Layer containing the active track and the track name on a given map.
void	setAutoRefresh(boolean pVal) Indicates whether or not the map display will refresh automatically when no new data has been received.
void	setFollow(boolean follow) Indicates whether or not the display should stay centered on the active track.
void	setFollowPlaybackRate(double playbackRate, int units) The playback time between periodic recentering of the most current feature in the active track.
void	setFollowRate(double followRate) The time between periodic recentering of the most current feature in the active track.
void	setFollowSymbol(ISymbol followSymbol) The symbol used to mark the position of the most current feature in the active track.
void	setFollowThreshold(double screenPercent) The percent of visible area to keep the followed feature within.
void	setHighlightFeatureColor(IColor color) The highlight color drawn for highlighted features.
void	setHighlightTrackFeatureColor(IColor color) The highlight color drawn for features in highlighted tracks.
void	setHighlightTrackLineColor(IColor color) The highlight color drawn for track-lines in highlighted tracks.
void	setManualUpdate(boolean pVal) Indicates whether or not map display must be updated manually when new data is received.
void	setMaxUpdateRate(double pVal) Indicates the minimum duration between which the map display updates, as defined in the dynamic update controller.
void	setRefreshRate(double pVal) Indicates the maximum duration between map display refreshes, as defined in the dynamic update controller.
void	setUpdateMethod(int pVal) Defines how the display refresh is determined: by number of points or CPU usage.
void	setUpdateValue(int pVal) Indicates the number of points or percentage of CPU usage used as the threshold for a map display refresh.
void	setUseFollowRate(boolean useFollowRate) Indicates whether or not to follow based on elapsed time.
void	spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent) Fired when the spatial reference is changed.
void	tileOverflow(IGlobeDisplayEventsTileOverflowEvent theEvent) Fired when there is an overflow of vector tiles in a layer.
void	vectorOverflow(IGlobeDisplayEventsVectorOverflowEvent theEvent) Fired when there is an overflow of vector features in a tile.
void	viewerAdded(IGlobeDisplayEventsViewerAddedEvent theEvent) Fired when a new viewer is added.
void	viewerRemoved(IGlobeDisplayEventsViewerRemovedEvent theEvent) Fired when a viewer is removed.
void	viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent) Fired when view is refreshed before draw happens.

Methods inherited from class java.lang.Object

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

Constructor Detail

TADynamicDisplayRefreshController

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

Construct a TADynamicDisplayRefreshController using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TADynamicDisplayRefreshController.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
TADynamicDisplayRefreshController o = (TADynamicDisplayRefreshController)obj; // will not work

TADynamicDisplayRefreshController o = new TADynamicDisplayRefreshController(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems TADynamicDisplayRefreshController theTADynamicDisplayRefreshController = (TADynamicDisplayRefreshController) obj;

Method Detail

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

release

public void release()

Release a TADynamicDisplayRefreshController.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

addLayer

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

Obsolete Method that is unsupported.

Specified by:

addLayer in interface ITAUpdateControl

Parameters:

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

removeLayer

public void removeLayer(ILayer piLayer)
                 throws java.io.IOException,
                        AutomationException

Obsolete Method that is unsupported.

Specified by:

removeLayer in interface ITAUpdateControl

Parameters:

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

getRefreshRate

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

Indicates the maximum duration between map display refreshes, as defined in the dynamic update controller.

Specified by:

getRefreshRate in interface ITAUpdateControl

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRefreshRate

public void setRefreshRate(double pVal)
                    throws java.io.IOException,
                           AutomationException

Indicates the maximum duration between map display refreshes, as defined in the dynamic update controller.

Specified by:

setRefreshRate in interface ITAUpdateControl

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxUpdateRate

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

Indicates the minimum duration between which the map display updates, as defined in the dynamic update controller.

Specified by:

getMaxUpdateRate in interface ITAUpdateControl

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxUpdateRate

public void setMaxUpdateRate(double pVal)
                      throws java.io.IOException,
                             AutomationException

Indicates the minimum duration between which the map display updates, as defined in the dynamic update controller.

Specified by:

setMaxUpdateRate in interface ITAUpdateControl

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refreshDisplay

public void refreshDisplay(int enumUpdateType)
                    throws java.io.IOException,
                           AutomationException

Refreshes the map display in ArcMap.

Specified by:

refreshDisplay in interface ITAUpdateControl

Parameters:

enumUpdateType - A com.esri.arcgis.trackinganalyst.enumScreenUpdateType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUpdateMethod

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

Defines how the display refresh is determined: by number of points or CPU usage.

Specified by:

getUpdateMethod in interface ITAUpdateControl

Returns:

A com.esri.arcgis.trackinganalyst.enumScreenUpdateThresholdType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUpdateMethod

public void setUpdateMethod(int pVal)
                     throws java.io.IOException,
                            AutomationException

Defines how the display refresh is determined: by number of points or CPU usage.

Specified by:

setUpdateMethod in interface ITAUpdateControl

Parameters:

pVal - A com.esri.arcgis.trackinganalyst.enumScreenUpdateThresholdType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUpdateValue

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

Indicates the number of points or percentage of CPU usage used as the threshold for a map display refresh.

Specified by:

getUpdateValue in interface ITAUpdateControl

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUpdateValue

public void setUpdateValue(int pVal)
                    throws java.io.IOException,
                           AutomationException

Indicates the number of points or percentage of CPU usage used as the threshold for a map display refresh.

Specified by:

setUpdateValue in interface ITAUpdateControl

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStatistics

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

Various statistics about dynamic display processing.

Specified by:

getStatistics in interface ITAUpdateControl

Returns:

The pbstrXMLData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isManualUpdate

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

Indicates whether or not map display must be updated manually when new data is received.

Specified by:

isManualUpdate in interface ITAUpdateControl

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setManualUpdate

public void setManualUpdate(boolean pVal)
                     throws java.io.IOException,
                            AutomationException

Indicates whether or not map display must be updated manually when new data is received.

Specified by:

setManualUpdate in interface ITAUpdateControl

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAutoRefresh

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

Indicates whether or not the map display will refresh automatically when no new data has been received.

Specified by:

isAutoRefresh in interface ITAUpdateControl

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAutoRefresh

public void setAutoRefresh(boolean pVal)
                    throws java.io.IOException,
                           AutomationException

Indicates whether or not the map display will refresh automatically when no new data has been received.

Specified by:

setAutoRefresh in interface ITAUpdateControl

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

contentsChanged

public void contentsChanged(IActiveViewEventsContentsChangedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when the contents of the view changes.

Specified by:

contentsChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

contentsCleared

public void contentsCleared(IActiveViewEventsContentsClearedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when the contents of the view is cleared.

Specified by:

contentsCleared in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

itemAdded

public void itemAdded(IActiveViewEventsItemAddedEvent theEvent)
               throws java.io.IOException,
                      AutomationException

Fired when an item is added to the view.

Specified by:

itemAdded in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

itemDeleted

public void itemDeleted(IActiveViewEventsItemDeletedEvent theEvent)
                 throws java.io.IOException,
                        AutomationException

Fired when an item is deleted from the view.

Specified by:

itemDeleted in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

itemReordered

public void itemReordered(IActiveViewEventsItemReorderedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired when a view item is reordered.

Specified by:

itemReordered in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

selectionChanged

public void selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent)
                      throws java.io.IOException,
                             AutomationException

Call this function to fire the selection changed event.

Specified by:

selectionChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

viewRefreshed

public void viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired when view is refreshed before draw happens.

Specified by:

viewRefreshed in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

afterDraw

public void afterDraw(IActiveViewEventsAfterDrawEvent theEvent)
               throws java.io.IOException,
                      AutomationException

Fired after the specified phase is drawn.

Specified by:

afterDraw in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

afterItemDraw

public void afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired after an individual view item is drawn. Example: view items include layers in a map or elements in a page layout.

Specified by:

afterItemDraw in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

focusMapChanged

public void focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when a new map is made active.

Specified by:

focusMapChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

spatialReferenceChanged

public void spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)
                             throws java.io.IOException,
                                    AutomationException

Fired when the spatial reference is changed.

Specified by:

spatialReferenceChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

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.

activeViewerChanged

public void activeViewerChanged(IGlobeDisplayEventsActiveViewerChangedEvent theEvent)
                         throws java.io.IOException,
                                AutomationException

Fired when the active viewer changes.

Specified by:

activeViewerChanged in interface IGlobeDisplayEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

viewerAdded

public void viewerAdded(IGlobeDisplayEventsViewerAddedEvent theEvent)
                 throws java.io.IOException,
                        AutomationException

Fired when a new viewer is added.

Specified by:

viewerAdded in interface IGlobeDisplayEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

viewerRemoved

public void viewerRemoved(IGlobeDisplayEventsViewerRemovedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired when a viewer is removed.

Specified by:

viewerRemoved in interface IGlobeDisplayEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interactionStopped

public void interactionStopped(IGlobeDisplayEventsInteractionStoppedEvent theEvent)
                        throws java.io.IOException,
                               AutomationException

Fired when interaction stops.

Specified by:

interactionStopped in interface IGlobeDisplayEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

batchTileGenerationStarted

public void batchTileGenerationStarted(IGlobeDisplayEventsBatchTileGenerationStartedEvent theEvent)
                                throws java.io.IOException,
                                       AutomationException

Fired when data preparation starts.

Specified by:

batchTileGenerationStarted in interface IGlobeDisplayEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

batchTileGenerationStopped

public void batchTileGenerationStopped(IGlobeDisplayEventsBatchTileGenerationStoppedEvent theEvent)
                                throws java.io.IOException,
                                       AutomationException

Fired when data preparation stops.

Specified by:

batchTileGenerationStopped in interface IGlobeDisplayEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

beforeDraw

public boolean beforeDraw(IGlobeDisplayEventsBeforeDrawEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired when drawing starts.

Specified by:

beforeDraw in interface IGlobeDisplayEvents

Parameters:

theEvent - The event

Returns:

The pbHandled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

afterDraw

public void afterDraw(IGlobeDisplayEventsAfterDrawEvent theEvent)
               throws java.io.IOException,
                      AutomationException

Fired when drawing finishes.

Specified by:

afterDraw in interface IGlobeDisplayEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

vectorOverflow

public void vectorOverflow(IGlobeDisplayEventsVectorOverflowEvent theEvent)
                    throws java.io.IOException,
                           AutomationException

Fired when there is an overflow of vector features in a tile.

Specified by:

vectorOverflow in interface IGlobeDisplayEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

tileOverflow

public void tileOverflow(IGlobeDisplayEventsTileOverflowEvent theEvent)
                  throws java.io.IOException,
                         AutomationException

Fired when there is an overflow of vector tiles in a layer.

Specified by:

tileOverflow in interface IGlobeDisplayEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

dynamicMapStarted

public void dynamicMapStarted(IDynamicMapEventsDynamicMapStartedEvent theEvent)
                       throws java.io.IOException,
                              AutomationException

Fired when the dynamic map starts.

Specified by:

dynamicMapStarted in interface IDynamicMapEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

dynamicMapFinished

public void dynamicMapFinished(IDynamicMapEventsDynamicMapFinishedEvent theEvent)
                        throws java.io.IOException,
                               AutomationException

Fired when the dynamic map finishes.

Specified by:

dynamicMapFinished in interface IDynamicMapEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

beforeDynamicDraw

public void beforeDynamicDraw(IDynamicMapEventsBeforeDynamicDrawEvent theEvent)
                       throws java.io.IOException,
                              AutomationException

Fired before the specified phase is drawn.

Specified by:

beforeDynamicDraw in interface IDynamicMapEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

afterDynamicDraw

public void afterDynamicDraw(IDynamicMapEventsAfterDynamicDrawEvent theEvent)
                      throws java.io.IOException,
                             AutomationException

Fired after the specified phase is drawn.

Specified by:

afterDynamicDraw in interface IDynamicMapEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

activeViewChanged

public void activeViewChanged(ITxDocumentEventsActiveViewChangedEvent theEvent)
                       throws java.io.IOException,
                              AutomationException

Fired when the active view changes.

Specified by:

activeViewChanged in interface ITxDocumentEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

mapsChanged

public void mapsChanged(ITxDocumentEventsMapsChangedEvent theEvent)
                 throws java.io.IOException,
                        AutomationException

Fired when a change is made to the map collection.

Specified by:

mapsChanged in interface ITxDocumentEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onContextMenu

public void onContextMenu(ITxDocumentEventsOnContextMenuEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Indicates if a context menu should be displayed at the given xy location. Return true if handled.

Specified by:

onContextMenu in interface ITxDocumentEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

newDocument

public void newDocument(ITxDocumentEventsNewDocumentEvent theEvent)
                 throws java.io.IOException,
                        AutomationException

Fired when a new document is created.

Specified by:

newDocument in interface ITxDocumentEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openDocument

public void openDocument(ITxDocumentEventsOpenDocumentEvent theEvent)
                  throws java.io.IOException,
                         AutomationException

Fired when a document is opened.

Specified by:

openDocument in interface ITxDocumentEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

beforeCloseDocument

public boolean beforeCloseDocument(ITxDocumentEventsBeforeCloseDocumentEvent theEvent)
                            throws java.io.IOException,
                                   AutomationException

Fired before a document is closed. Return True to abort the close process.

Specified by:

beforeCloseDocument in interface ITxDocumentEvents

Parameters:

theEvent - The event

Returns:

The abortClose

Throws:

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

AutomationException - If the ArcObject component throws an exception.

closeDocument

public void closeDocument(ITxDocumentEventsCloseDocumentEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired when a document is closed.

Specified by:

closeDocument in interface ITxDocumentEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

displayStarted

public void displayStarted(IDisplayEventsDisplayStartedEvent theEvent)
                    throws java.io.IOException,
                           AutomationException

Notifies clients when drawing starts.

Specified by:

displayStarted in interface IDisplayEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

displayFinished

public void displayFinished(IDisplayEventsDisplayFinishedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Notifies clients when drawing completes.

Specified by:

displayFinished in interface IDisplayEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

displayInvalidated

public void displayInvalidated(IDisplayEventsDisplayInvalidatedEvent theEvent)
                        throws java.io.IOException,
                               AutomationException

Notifies clients when display is invalidated.

Specified by:

displayInvalidated in interface IDisplayEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

displayScrolled

public void displayScrolled(IDisplayEventsDisplayScrolledEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Notifies clients when display is scrolled.

Specified by:

displayScrolled in interface IDisplayEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActiveTrack

public ILayer getActiveTrack(java.lang.String[] activeTrackName,
                             IMap[] map)
                      throws java.io.IOException,
                             AutomationException

The Layer containing the active track and the track name on a given map.

Specified by:

getActiveTrack in interface ITxActiveTrack

Parameters:

activeTrackName - The activeTrackName (out: use single element array)

map - A reference to a com.esri.arcgis.carto.IMap (out: use single element array)

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.

setActiveTrack

public void setActiveTrack(java.lang.String activeTrackName,
                           IMap map,
                           ILayer layer)
                    throws java.io.IOException,
                           AutomationException

The Layer containing the active track and the track name on a given map.

Specified by:

setActiveTrack in interface ITxActiveTrack

Parameters:

activeTrackName - The activeTrackName (in)

map - A reference to a com.esri.arcgis.carto.IMap (in)

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.

isFollow

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

Indicates whether or not the display should stay centered on the active track.

Specified by:

isFollow in interface ITxActiveTrack

Returns:

The follow

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFollow

public void setFollow(boolean follow)
               throws java.io.IOException,
                      AutomationException

Indicates whether or not the display should stay centered on the active track.

Specified by:

setFollow in interface ITxActiveTrack

Parameters:

follow - The follow (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFollowSymbol

public ISymbol getFollowSymbol()
                        throws java.io.IOException,
                               AutomationException

The symbol used to mark the position of the most current feature in the active track.

Specified by:

getFollowSymbol in interface ITxActiveTrack

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFollowSymbol

public void setFollowSymbol(ISymbol followSymbol)
                     throws java.io.IOException,
                            AutomationException

The symbol used to mark the position of the most current feature in the active track.

Specified by:

setFollowSymbol in interface ITxActiveTrack

Parameters:

followSymbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFollowThreshold

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

The percent of visible area to keep the followed feature within.

Specified by:

getFollowThreshold in interface ITxActiveTrack

Returns:

The screenPercent

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFollowThreshold

public void setFollowThreshold(double screenPercent)
                        throws java.io.IOException,
                               AutomationException

The percent of visible area to keep the followed feature within.

Specified by:

setFollowThreshold in interface ITxActiveTrack

Parameters:

screenPercent - The screenPercent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFollowRate

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

The time between periodic recentering of the most current feature in the active track.

Specified by:

getFollowRate in interface ITxActiveTrack

Returns:

The followRate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFollowRate

public void setFollowRate(double followRate)
                   throws java.io.IOException,
                          AutomationException

The time between periodic recentering of the most current feature in the active track.

Specified by:

setFollowRate in interface ITxActiveTrack

Parameters:

followRate - The followRate (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseFollowRate

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

Indicates whether or not to follow based on elapsed time.

Specified by:

isUseFollowRate in interface ITxActiveTrack

Returns:

The useFollowRate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseFollowRate

public void setUseFollowRate(boolean useFollowRate)
                      throws java.io.IOException,
                             AutomationException

Indicates whether or not to follow based on elapsed time.

Specified by:

setUseFollowRate in interface ITxActiveTrack

Parameters:

useFollowRate - The useFollowRate (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFollowPlaybackRate

public void getFollowPlaybackRate(double[] playbackRate,
                                  int[] units)
                           throws java.io.IOException,
                                  AutomationException

The playback time between periodic recentering of the most current feature in the active track.

Specified by:

getFollowPlaybackRate in interface ITxActiveTrack

Parameters:

playbackRate - The playbackRate (out: use single element array)

units - A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFollowPlaybackRate

public void setFollowPlaybackRate(double playbackRate,
                                  int units)
                           throws java.io.IOException,
                                  AutomationException

The playback time between periodic recentering of the most current feature in the active track.

Specified by:

setFollowPlaybackRate in interface ITxActiveTrack

Parameters:

playbackRate - The playbackRate (in)

units - A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFollowPoint

public IPoint getFollowPoint()
                      throws java.io.IOException,
                             AutomationException

The most recent follow location.

Specified by:

getFollowPoint in interface ITxActiveTrack

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

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

AutomationException - If the ArcObject component throws an exception.

recenter

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

Center the active view around the most current feature of the active track.

Specified by:

recenter in interface ITxActiveTrack

Returns:

The wasCentered

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHighlightTrackFeatureColor

public void setHighlightTrackFeatureColor(IColor color)
                                   throws java.io.IOException,
                                          AutomationException

The highlight color drawn for features in highlighted tracks.

Specified by:

setHighlightTrackFeatureColor in interface ITxHighlightSettings

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHighlightTrackFeatureColor

public IColor getHighlightTrackFeatureColor()
                                     throws java.io.IOException,
                                            AutomationException

The highlight color drawn for features in highlighted tracks.

Specified by:

getHighlightTrackFeatureColor in interface ITxHighlightSettings

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHighlightTrackLineColor

public void setHighlightTrackLineColor(IColor color)
                                throws java.io.IOException,
                                       AutomationException

The highlight color drawn for track-lines in highlighted tracks.

Specified by:

setHighlightTrackLineColor in interface ITxHighlightSettings

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHighlightTrackLineColor

public IColor getHighlightTrackLineColor()
                                  throws java.io.IOException,
                                         AutomationException

The highlight color drawn for track-lines in highlighted tracks.

Specified by:

getHighlightTrackLineColor in interface ITxHighlightSettings

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHighlightFeatureColor

public void setHighlightFeatureColor(IColor color)
                              throws java.io.IOException,
                                     AutomationException

The highlight color drawn for highlighted features.

Specified by:

setHighlightFeatureColor in interface ITxHighlightSettings

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHighlightFeatureColor

public IColor getHighlightFeatureColor()
                                throws java.io.IOException,
                                       AutomationException

The highlight color drawn for highlighted features.

Specified by:

getHighlightFeatureColor in interface ITxHighlightSettings

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.