com.esri.arcgis.arccatalog
Class GxDocument

java.lang.Object
  com.esri.arcgis.arccatalog.GxDocument

All Implemented Interfaces:

IDocument, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class GxDocument
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDocument

COM Class 'GxDocument'. Generated 3/19/2015 1:20:49 PM from 'C:\ArcGIS\COM\esriArcCatalog.olb'

Description 'Esri ArcCatalog Application Document.' 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.framework.IDocument

DISPID_0_GET_NAME, DISPID_1_GET_NAME, DISPID_2_GET_NAME, DISPID_4_GET_NAME, DISPID_5_GET_NAME, DISPID_6_GET_NAME, DISPID_7_GET_NAME, IID, IID3e927177_307a_11d2_94c9_080009eebecb, xxDummy

Constructor Summary

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

Method Summary

void	addIGxDocumentEventsDispListener(IGxDocumentEventsDisp theListener) addIGxDocumentEventsDispListener.
void	addIGxDocumentEventsListener(IGxDocumentEvents theListener) addIGxDocumentEventsListener.
boolean	equals(java.lang.Object o) Compare this object with another
IAcceleratorTable	getAccelerators() The accelerator table for this document.
ICommandBars	getCommandBars() The commandbars collection in this document.
IUID	getID() The unique id for this document.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IApplication	getParent() The application in which this document is open.
java.lang.String	getTitle() The title of this document.
int	getType() The type of this document.
java.lang.Object	getVBProject() The VBProject for this document.
int	hashCode() the hashcode for this object
void	release() Release a GxDocument.
void	removeIGxDocumentEventsDispListener(IGxDocumentEventsDisp theListener) removeIGxDocumentEventsDispListener.
void	removeIGxDocumentEventsListener(IGxDocumentEvents theListener) removeIGxDocumentEventsListener.

Methods inherited from class java.lang.Object

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

Constructor Detail

GxDocument

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

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

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

Throws:

java.io.IOException - if there are interop problems GxDocument theGxDocument = (GxDocument) 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

addIGxDocumentEventsDispListener

public void addIGxDocumentEventsDispListener(IGxDocumentEventsDisp theListener)
                                      throws java.io.IOException

addIGxDocumentEventsDispListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.arccatalog.IGxDocumentEventsDisp interface.

Throws:

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

removeIGxDocumentEventsDispListener

public void removeIGxDocumentEventsDispListener(IGxDocumentEventsDisp theListener)
                                         throws java.io.IOException

removeIGxDocumentEventsDispListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.arccatalog.IGxDocumentEventsDisp interface.

Throws:

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

addIGxDocumentEventsListener

public void addIGxDocumentEventsListener(IGxDocumentEvents theListener)
                                  throws java.io.IOException

addIGxDocumentEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.arccatalog.IGxDocumentEvents interface.

Throws:

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

removeIGxDocumentEventsListener

public void removeIGxDocumentEventsListener(IGxDocumentEvents theListener)
                                     throws java.io.IOException

removeIGxDocumentEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.arccatalog.IGxDocumentEvents interface.

Throws:

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

release

public void release()

Release a GxDocument.

Specified by:

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

getParent

public IApplication getParent()
                       throws java.io.IOException,
                              AutomationException

The application in which this document is open.

Specified by:

getParent in interface IDocument

Returns:

A reference to a com.esri.arcgis.framework.IApplication

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTitle

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

The title of this document.

Specified by:

getTitle in interface IDocument

Returns:

The title

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCommandBars

public ICommandBars getCommandBars()
                            throws java.io.IOException,
                                   AutomationException

The commandbars collection in this document.

Specified by:

getCommandBars in interface IDocument

Returns:

A reference to a com.esri.arcgis.framework.ICommandBars

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAccelerators

public IAcceleratorTable getAccelerators()
                                  throws java.io.IOException,
                                         AutomationException

The accelerator table for this document.

Specified by:

getAccelerators in interface IDocument

Returns:

A reference to a com.esri.arcgis.framework.IAcceleratorTable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getID

public IUID getID()
           throws java.io.IOException,
                  AutomationException

The unique id for this document.

Specified by:

getID in interface IDocument

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

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

The type of this document.

Specified by:

getType in interface IDocument

Returns:

A com.esri.arcgis.framework.esriDocumentType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVBProject

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

The VBProject for this document.

Specified by:

getVBProject in interface IDocument

Returns:

A reference to another Automation Object (IDispatch)

Throws:

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

AutomationException - If the ArcObject component throws an exception.