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, Serializable, EventListener

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

Provides access to GX browser dialog.

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Constructor Summary

GxComBrowser()
Constructs a GxComBrowser using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getHWnd() The HWND of the Catalog window.
IGxCatalog	getInternalCatalog() The Catalog object used internally by the Catalog window.
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	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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

GxComBrowser

public GxComBrowser()
             throws IOException,
                    UnknownHostException

Constructs a GxComBrowser using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GxComBrowser

public GxComBrowser(Object obj)
             throws 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:

IOException - if there are interop problems GxComBrowser theGxComBrowser = (GxComBrowser) obj;

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

getInternalCatalog

public IGxCatalog getInternalCatalog()
                              throws IOException,
                                     AutomationException

The Catalog object used internally by the Catalog window.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getInternalCatalog in interface IGxBrowser

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getView

public IGxView getView()
                throws IOException,
                       AutomationException

The Catalog window's current view.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getView in interface IGxBrowser

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewClassID

public IUID getViewClassID()
                    throws IOException,
                           AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Specified by:

getViewClassID in interface IGxBrowser

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setViewClassID

public void setViewClassID(IUID viewClassID)
                    throws IOException,
                           AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Specified by:

setViewClassID in interface IGxBrowser

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTreeView

public IGxTreeView getTreeView()
                        throws IOException,
                               AutomationException

The Catalog window's tree view.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getTreeView in interface IGxBrowser

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

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

Shows or hides the Catalog window.

Product Availability

Available with ArcGIS Desktop.

Specified by:

show in interface IGxBrowser

Parameters:

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

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

terminate

public void terminate()
               throws IOException,
                      AutomationException

Instruct the Catalog window to destroy itself.

Product Availability

Available with ArcGIS Desktop.

Specified by:

terminate in interface IGxBrowser

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

public int getHWnd()
            throws IOException,
                   AutomationException

The HWND of the Catalog window.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getHWnd in interface IGxBrowser

Returns:

The pHwnd (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException

Refresh the Catalog window.

Product Availability

Available with ArcGIS Desktop.

Specified by:

refresh in interface IGxBrowser

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onSelectionChanged

public void onSelectionChanged(IGxSelectionEventsOnSelectionChangedEvent theEvent)
                        throws IOException,
                               AutomationException

Called when the selection contents have changed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onSelectionChanged in interface IGxSelectionEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onRefreshAll

public void onRefreshAll(IGxCatalogEventsOnRefreshAllEvent theEvent)
                  throws IOException,
                         AutomationException

Called when the whole catalog has changed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onRefreshAll in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onObjectAdded

public void onObjectAdded(IGxCatalogEventsOnObjectAddedEvent theEvent)
                   throws IOException,
                          AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onObjectAdded in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onObjectDeleted

public void onObjectDeleted(IGxCatalogEventsOnObjectDeletedEvent theEvent)
                     throws IOException,
                            AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onObjectDeleted in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onObjectChanged

public void onObjectChanged(IGxCatalogEventsOnObjectChangedEvent theEvent)
                     throws IOException,
                            AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onObjectChanged in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onObjectRefreshed

public void onObjectRefreshed(IGxCatalogEventsOnObjectRefreshedEvent theEvent)
                       throws IOException,
                              AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onObjectRefreshed in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onApply

public void onApply(IComPropertySheetEventsOnApplyEvent theEvent)
             throws IOException,
                    AutomationException

Occurs when changes are applied.

Description

Call OnApply to notify other parts of the application that the objects passed to the property sheet have been edited.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

onApply in interface IComPropertySheetEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.