com.esri.arcgis.catalogUI
Class GxDocumentationView

java.lang.Object
  com.esri.arcgis.catalogUI.GxDocumentationView

All Implemented Interfaces:

IGxCatalogEvents, IGxSelectionEvents, IGxDocumentationView, IGxView, IGxViewPrint, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable, java.util.EventListener

public class GxDocumentationView
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxView, IGxDocumentationView, IGxCatalogEvents, IGxSelectionEvents, IGxViewPrint

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

Description 'GxView that represents the metadata 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.catalogUI.IGxView

IID, IIDb1de27ab_d892_11d1_aa81_064342000000, xxDummy

Fields inherited from interface com.esri.arcgis.catalogUI.IGxDocumentationView

IID, IIDda1862eb_95f8_11d2_af67_080009ec734b, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxCatalogEvents

IID, IIDbdbbb3f8_d0b2_11d1_aed9_080009ec734b, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxSelectionEvents

IID, IIDbdbbb3f9_d0b2_11d1_aed9_080009ec734b, xxDummy

Fields inherited from interface com.esri.arcgis.catalogUI.IGxViewPrint

IID, IIDa6164232_9140_41ad_b3f3_1da263c80d56, xxDummy

Constructor Summary

GxDocumentationView()
Constructs a GxDocumentationView using ArcGIS Engine.

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

Method Summary

void	activate(IGxApplication application, IGxCatalog catalog) Activates the view.
boolean	applies(IGxObject selection) Indicates if the view can display the given object.
void	deactivate() Deactivates the view.
void	edit() Opens the current metadata editor.
void	editProperties() Opens the Metadata Properties dialog box.
boolean	equals(java.lang.Object o) Compare this object with another
IUID	getClassID() The class ID of the view.
static java.lang.String	getClsid() getClsid.
IUID	getDefaultToolbarCLSID() The class ID of the view's default toolbar.
int	getHWnd() The view's window handle.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() The name of the view.
int	hashCode() the hashcode for this object
boolean	isPrintable() Indicates if the view can be printed.
boolean	isSupportsTools() Indicates if the view supports tools.
void	onObjectAdded(IGxCatalogEventsOnObjectAddedEvent theEvent) Called when an object has been added to some part of the catalog.
void	onObjectChanged(IGxCatalogEventsOnObjectChangedEvent theEvent) Called when an object in some part of the catalog has been changed.
void	onObjectDeleted(IGxCatalogEventsOnObjectDeletedEvent theEvent) Called when an object has been deleted from some part of the catalog.
void	onObjectRefreshed(IGxCatalogEventsOnObjectRefreshedEvent theEvent) Called when an object in some part of the catalog has been refreshed.
void	onRefreshAll(IGxCatalogEventsOnRefreshAllEvent theEvent) Called when the whole catalog has changed.
void	onSelectionChanged(IGxSelectionEventsOnSelectionChangedEvent theEvent) Called when the selection contents have changed.
void	print() Prints the view.
void	refresh() Refreshes the view.
void	release() Release a GxDocumentationView.
void	synchronize() Writes the current property values to the metadata.
void	systemSettingChanged(int flag, java.lang.String section) Informs the view that a system setting has changed.

Methods inherited from class java.lang.Object

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

Constructor Detail

GxDocumentationView

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

Constructs a GxDocumentationView using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GxDocumentationView

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems GxDocumentationView theGxDocumentationView = (GxDocumentationView) obj;

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

release

public void release()

Release a GxDocumentationView.

Specified by:

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

getName

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

The name of the view.

Specified by:

getName in interface IGxView

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

The class ID of the view.

Specified by:

getClassID in interface IGxView

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.

getHWnd

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

The view's window handle.

Specified by:

getHWnd in interface IGxView

Returns:

The window (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultToolbarCLSID

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

The class ID of the view's default toolbar. Not currently used.

Specified by:

getDefaultToolbarCLSID in interface IGxView

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.

isSupportsTools

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

Indicates if the view supports tools.

Specified by:

isSupportsTools in interface IGxView

Returns:

The supportsTools

Throws:

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

AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(IGxObject selection)
                throws java.io.IOException,
                       AutomationException

Indicates if the view can display the given object.

Specified by:

applies in interface IGxView

Parameters:

selection - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Returns:

The applies

Throws:

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

AutomationException - If the ArcObject component throws an exception.

activate

public void activate(IGxApplication application,
                     IGxCatalog catalog)
              throws java.io.IOException,
                     AutomationException

Activates the view.

Specified by:

activate in interface IGxView

Parameters:

application - A reference to a com.esri.arcgis.catalogUI.IGxApplication (in)

catalog - A reference to a com.esri.arcgis.catalog.IGxCatalog (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

Deactivates the view.

Specified by:

deactivate in interface IGxView

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

Refreshes the view.

Specified by:

refresh in interface IGxView

Throws:

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

AutomationException - If the ArcObject component throws an exception.

systemSettingChanged

public void systemSettingChanged(int flag,
                                 java.lang.String section)
                          throws java.io.IOException,
                                 AutomationException

Informs the view that a system setting has changed.

Specified by:

systemSettingChanged in interface IGxView

Parameters:

flag - The flag (in)

section - The section (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

edit

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

Opens the current metadata editor.

Specified by:

edit in interface IGxDocumentationView

Throws:

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

AutomationException - If the ArcObject component throws an exception.

editProperties

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

Opens the Metadata Properties dialog box.

Specified by:

editProperties in interface IGxDocumentationView

Throws:

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

AutomationException - If the ArcObject component throws an exception.

synchronize

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

Writes the current property values to the metadata.

Specified by:

synchronize in interface IGxDocumentationView

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onRefreshAll

public void onRefreshAll(IGxCatalogEventsOnRefreshAllEvent theEvent)
                  throws java.io.IOException,
                         AutomationException

Called when the whole catalog has changed.

Specified by:

onRefreshAll in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onObjectAdded

public void onObjectAdded(IGxCatalogEventsOnObjectAddedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Called when an object has been added to some part of the catalog.

Specified by:

onObjectAdded in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onObjectDeleted

public void onObjectDeleted(IGxCatalogEventsOnObjectDeletedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Called when an object has been deleted from some part of the catalog.

Specified by:

onObjectDeleted in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onObjectChanged

public void onObjectChanged(IGxCatalogEventsOnObjectChangedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Called when an object in some part of the catalog has been changed.

Specified by:

onObjectChanged in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onObjectRefreshed

public void onObjectRefreshed(IGxCatalogEventsOnObjectRefreshedEvent theEvent)
                       throws java.io.IOException,
                              AutomationException

Called when an object in some part of the catalog has been refreshed.

Specified by:

onObjectRefreshed in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onSelectionChanged

public void onSelectionChanged(IGxSelectionEventsOnSelectionChangedEvent theEvent)
                        throws java.io.IOException,
                               AutomationException

Called when the selection contents have changed.

Specified by:

onSelectionChanged in interface IGxSelectionEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPrintable

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

Indicates if the view can be printed.

Specified by:

isPrintable in interface IGxViewPrint

Returns:

The isPrintable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

print

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

Prints the view.

Specified by:

print in interface IGxViewPrint

Throws:

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

AutomationException - If the ArcObject component throws an exception.