com.esri.arcgis.trackinganalyst
Class DocEventHandler

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.DocEventHandler
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ITxDocEventHandler, ITxDocEventHandler2, Serializable

public class DocEventHandler
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITxDocEventHandler, ITxDocEventHandler2

A collection of methods and properties to catch and process document and tracking analyst document events.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

See Also:
Serialized Form

Constructor Summary
DocEventHandler()
          Constructs a DocEventHandler using ArcGIS Engine.
DocEventHandler(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DocEventHandler theDocEventHandler = (DocEventHandler) obj;
 
Method Summary
 void addITxDocumentEventsListener(ITxDocumentEvents theListener)
          addITxDocumentEventsListener.
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 Object getParentDocument()
          Parent document responsible for the document event handling.
 int hashCode()
          the hashcode for this object
 void isApplication()
          Indicates if this object is part of an application.
 void isMapControl()
          Indicates if this object is attached to a map control.
 void isRunningInArcMap()
          Indicates if this object is attached to ArcMap.
 void isRunningInCatalog()
          Indicates if this object is attached to ArcCatalog.
 boolean isValid()
          Indicates if this object is in a valid state.
 void removeITxDocumentEventsListener(ITxDocumentEvents theListener)
          removeITxDocumentEventsListener.
 int runningEnvironment()
          Identifies the client envirionment, e.g., ArcMap, ArcGlobe, Map Control, ...
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

DocEventHandler

public DocEventHandler()
                throws IOException,
                       UnknownHostException
Constructs a DocEventHandler using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

DocEventHandler

public DocEventHandler(Object obj)
                throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DocEventHandler theDocEventHandler = (DocEventHandler) obj;

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

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

getClsid

public static String getClsid()
getClsid.


equals

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

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

addITxDocumentEventsListener

public void addITxDocumentEventsListener(ITxDocumentEvents theListener)
                                  throws IOException
addITxDocumentEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.trackinganalyst.ITxDocumentEvents interface.
Throws:
IOException - If there are communications problems.

removeITxDocumentEventsListener

public void removeITxDocumentEventsListener(ITxDocumentEvents theListener)
                                     throws IOException
removeITxDocumentEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.trackinganalyst.ITxDocumentEvents interface.
Throws:
IOException - If there are communications problems.

getParentDocument

public Object getParentDocument()
                         throws IOException,
                                AutomationException
Parent document responsible for the document event handling.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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

isValid

public boolean isValid()
                throws IOException,
                       AutomationException
Indicates if this object is in a valid state.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isValid in interface ITxDocEventHandler
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isMapControl

public void isMapControl()
                  throws IOException,
                         AutomationException
Indicates if this object is attached to a map control.

Remarks

This method has been superseded by ITxDocEventHandler::RunningEnvironment.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isMapControl in interface ITxDocEventHandler
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isApplication

public void isApplication()
                   throws IOException,
                          AutomationException
Indicates if this object is part of an application.

Remarks

This method has been superseded by ITxDocEventHandler::RunningEnvironment.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isApplication in interface ITxDocEventHandler
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRunningInCatalog

public void isRunningInCatalog()
                        throws IOException,
                               AutomationException
Indicates if this object is attached to ArcCatalog.

Remarks

This method has been superseded by ITxDocEventHandler::RunningEnvironment.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isRunningInCatalog in interface ITxDocEventHandler
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRunningInArcMap

public void isRunningInArcMap()
                       throws IOException,
                              AutomationException
Indicates if this object is attached to ArcMap.

Remarks

This method has been superseded by ITxDocEventHandler::RunningEnvironment.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isRunningInArcMap in interface ITxDocEventHandler
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

runningEnvironment

public int runningEnvironment()
                       throws IOException,
                              AutomationException
Identifies the client envirionment, e.g., ArcMap, ArcGlobe, Map Control, ... with or without dynamic display.

Remarks

RunningEnvironment can be used to determine the client application that Tracking Analyst is running inside. This information can be useful when different operations need to be performed depending on the client hosting Tracking Analyst, i.e. a MapControl vs. a GlobeControl. This method supersedes IsMapControl, IsApplication, IsRunningInCatalog, and IsRunningInArcMap in ITxDocEventHandler.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
runningEnvironment in interface ITxDocEventHandler2
Returns:
A com.esri.arcgis.trackinganalyst.enumTrackingEnv constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.