com.esri.arcgis.catalogUI
Class GxTreeView

java.lang.Object
  extended by com.esri.arcgis.catalogUI.GxTreeView
All Implemented Interfaces:
IGxCatalogEvents, IGxSelectionEvents, IGxTreeView, IGxView, com.esri.arcgis.interop.RemoteObjRef, Serializable, EventListener

public class GxTreeView
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxCatalogEvents, IGxSelectionEvents, IGxTreeView, IGxView

GxView that represents the tree view.

Remarks

The tree view is represented by GxTreeView, and shows a hierarchical organization of your data holdings, as parents and children. It is unlikely you will need to interact programmatically with the tree view, other than to force it to reveal a particular GxObject (through the IGxTreeView::EnsureVisible method), or to initiate a renaming operation (through BeginRename).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:
Serialized Form

Constructor Summary
GxTreeView()
          Constructs a GxTreeView using ArcGIS Engine.
GxTreeView(Object obj)
          Construct a GxTreeView 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 beginRename()
          Starts a rename operation on the current selection.
 void deactivate()
          Deactivates the view.
 void ensureVisible(IGxObject object)
          Ensures that the current selection is visible, scrolling/expanding if necessary.
 boolean equals(Object o)
          Compare this object with another
 void expandSelection(IGxSelection selection)
          Instructs the tree view to expand the current selection.
 IUID getClassID()
          The class ID of the view.
static String getClsid()
          getClsid.
 IUID getDefaultToolbarCLSID()
          The class ID of the view's default toolbar.
 int getHWnd()
          The view's window handle.
 String getName()
          The name of the view.
 int hashCode()
          the hashcode for this object
 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 refresh()
          Refreshes the view.
 void systemSettingChanged(int flag, 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
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

GxTreeView

public GxTreeView()
           throws IOException,
                  UnknownHostException
Constructs a GxTreeView using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

GxTreeView

public GxTreeView(Object obj)
           throws IOException
Construct a GxTreeView using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GxTreeView.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems GxTreeView theGxTreeView = (GxTreeView) 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

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.

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.

expandSelection

public void expandSelection(IGxSelection selection)
                     throws IOException,
                            AutomationException
Instructs the tree view to expand the current selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
expandSelection in interface IGxTreeView
Parameters:
selection - A reference to a com.esri.arcgis.catalog.IGxSelection (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

beginRename

public void beginRename()
                 throws IOException,
                        AutomationException
Starts a rename operation on the current selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
beginRename in interface IGxTreeView
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

ensureVisible

public void ensureVisible(IGxObject object)
                   throws IOException,
                          AutomationException
Ensures that the current selection is visible, scrolling/expanding if necessary.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
ensureVisible in interface IGxTreeView
Parameters:
object - A reference to a com.esri.arcgis.catalog.IGxObject (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
The name of the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getName in interface IGxView
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws IOException,
                       AutomationException
The class ID of the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getClassID in interface IGxView
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.

getHWnd

public int getHWnd()
            throws IOException,
                   AutomationException
The view's window handle.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getHWnd in interface IGxView
Returns:
The window (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultToolbarCLSID

public IUID getDefaultToolbarCLSID()
                            throws IOException,
                                   AutomationException
The class ID of the view's default toolbar. Not currently used.

Remarks

DefaultToolbarCLSID provides a reference to the default toolbar for the particular view. The default toolbar for a view would contain tools that were appropriate for the current type of GxView.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getDefaultToolbarCLSID in interface IGxView
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.

isSupportsTools

public boolean isSupportsTools()
                        throws IOException,
                               AutomationException
Indicates if the view supports tools.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
isSupportsTools in interface IGxView
Returns:
The supportsTools
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(IGxObject selection)
                throws IOException,
                       AutomationException
Indicates if the view can display the given object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
applies in interface IGxView
Parameters:
selection - A reference to a com.esri.arcgis.catalog.IGxObject (in)
Returns:
The applies
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

activate

public void activate(IGxApplication application,
                     IGxCatalog catalog)
              throws IOException,
                     AutomationException
Activates the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deactivate

public void deactivate()
                throws IOException,
                       AutomationException
Deactivates the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
deactivate in interface IGxView
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException
Refreshes the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
refresh in interface IGxView
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

systemSettingChanged

public void systemSettingChanged(int flag,
                                 String section)
                          throws IOException,
                                 AutomationException
Informs the view that a system setting has changed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
systemSettingChanged in interface IGxView
Parameters:
flag - The flag (in)
section - The section (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.