com.esri.arcgis.trackinganalyst
Class DocEventHandler

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

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

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

Description 'A collection of methods and properties to catch and process document and tracking analyst document events.' 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.ITxDocEventHandler2
IID, IID30e4c800_e876_4b55_a95d_9cabf196f9e0, xxDummy
 
Fields inherited from interface com.esri.arcgis.trackinganalyst.ITxDocEventHandler
IID51e14ff2_84f5_11d7_b877_00010265adc5
 
Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer
IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy
 
Constructor Summary
DocEventHandler()
          Constructs a DocEventHandler using ArcGIS Engine.
DocEventHandler(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DocEventHandler theDocEventHandler = (DocEventHandler) obj;
 
Method Summary
 void addITxDocumentEventsListener(ITxDocumentEvents theListener)
          addITxDocumentEventsListener.
 void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
          enumConnectionPoints
 boolean equals(java.lang.Object o)
          Compare this object with another
 void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)
          findConnectionPoint
static java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.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 release()
          Release a DocEventHandler.
 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
 

Constructor Detail

DocEventHandler

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

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

DocEventHandler

public DocEventHandler(java.lang.Object obj)
                throws java.io.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:
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

addITxDocumentEventsListener

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

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

removeITxDocumentEventsListener

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

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

release

public void release()
Release a DocEventHandler.

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

getParentDocument

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

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

isValid

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

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

isMapControl

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

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

isApplication

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

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

isRunningInCatalog

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

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

isRunningInArcMap

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

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

runningEnvironment

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

Specified by:
runningEnvironment in interface ITxDocEventHandler2
Returns:
A com.esri.arcgis.trackinganalyst.enumTrackingEnv constant
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.