com.esri.arcgis.catalogUI
Class GxComBrowser

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

All Implemented Interfaces:

IGxCatalogEvents, IGxSelectionEvents, IGxBrowser, com.esri.arcgis.interop.RemoteObjRef, IComPropertySheetEvents, java.io.Serializable, java.util.EventListener

public class GxComBrowser
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxBrowser, IGxSelectionEvents, IGxCatalogEvents, IComPropertySheetEvents

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

Description 'Provides access to GX browser dialog.' 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.IGxBrowser

IID, IID86057a65_426a_4c04_ba66_cf73ebb70a9f, xxDummy

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

IID, IIDbdbbb3f9_d0b2_11d1_aed9_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.systemUI.IComPropertySheetEvents

IID, IID6b7b57f8_5765_11d0_92d9_00805f7c28b0, xxDummy

Constructor Summary

GxComBrowser()
Constructs a GxComBrowser using ArcGIS Engine.

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

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
int	getHWnd() The HWND of the Catalog window.
IGxCatalog	getInternalCatalog() The Catalog object used internally by the Catalog window.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IGxTreeView	getTreeView() The Catalog window's tree view.
IGxView	getView() The Catalog window's current view.
IUID	getViewClassID() The Catalog window's current view's class ID.
int	hashCode() the hashcode for this object
void	onApply(IComPropertySheetEventsOnApplyEvent theEvent) Occurs when changes are applied.
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	refresh() Refresh the Catalog window.
void	release() Release a GxComBrowser.
void	setViewClassID(IUID viewClassID) The Catalog window's current view's class ID.
void	show(int parentWindow, boolean show) Shows or hides the Catalog window.
void	terminate() Instruct the Catalog window to destroy itself.

Methods inherited from class java.lang.Object

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

Constructor Detail

GxComBrowser

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

Constructs a GxComBrowser using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GxComBrowser

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

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

Specified by:

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

getInternalCatalog

public IGxCatalog getInternalCatalog()
                              throws java.io.IOException,
                                     AutomationException

The Catalog object used internally by the Catalog window.

Specified by:

getInternalCatalog in interface IGxBrowser

Returns:

A reference to a com.esri.arcgis.catalog.IGxCatalog

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getView

public IGxView getView()
                throws java.io.IOException,
                       AutomationException

The Catalog window's current view.

Specified by:

getView in interface IGxBrowser

Returns:

A reference to a com.esri.arcgis.catalogUI.IGxView

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getViewClassID

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

The Catalog window's current view's class ID.

Specified by:

getViewClassID in interface IGxBrowser

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.

setViewClassID

public void setViewClassID(IUID viewClassID)
                    throws java.io.IOException,
                           AutomationException

The Catalog window's current view's class ID.

Specified by:

setViewClassID in interface IGxBrowser

Parameters:

viewClassID - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTreeView

public IGxTreeView getTreeView()
                        throws java.io.IOException,
                               AutomationException

The Catalog window's tree view.

Specified by:

getTreeView in interface IGxBrowser

Returns:

A reference to a com.esri.arcgis.catalogUI.IGxTreeView

Throws:

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

AutomationException - If the ArcObject component throws an exception.

show

public void show(int parentWindow,
                 boolean show)
          throws java.io.IOException,
                 AutomationException

Shows or hides the Catalog window.

Specified by:

show in interface IGxBrowser

Parameters:

parentWindow - The parentWindow (A COM typedef) (in)

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

terminate

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

Instruct the Catalog window to destroy itself.

Specified by:

terminate in interface IGxBrowser

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 HWND of the Catalog window.

Specified by:

getHWnd in interface IGxBrowser

Returns:

The pHwnd (A COM typedef)

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

Refresh the Catalog window.

Specified by:

refresh in interface IGxBrowser

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.

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.

onApply

public void onApply(IComPropertySheetEventsOnApplyEvent theEvent)
             throws java.io.IOException,
                    AutomationException

Occurs when changes are applied.

Specified by:

onApply in interface IComPropertySheetEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.