com.esri.arcgis.arcglobe
Class TOCGMxCatalogView

java.lang.Object
  com.esri.arcgis.arcglobe.TOCGMxCatalogView

All Implemented Interfaces:

IContentsView, IContentsView2, com.esri.arcgis.interop.RemoteObjRef, IComPropertySheetEvents, Serializable, EventListener

public class TOCGMxCatalogView
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IContentsView2, IComPropertySheetEvents

Esri TOC GMx Catalog View.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

TOCGMxCatalogView()
Constructs a TOCGMxCatalogView using ArcGIS Engine.

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

Method Summary

void	activate(int parentHWnd, IMxDocument document) Activates the contents view.
void	addIActiveViewEventsListener(IActiveViewEvents theListener) addIActiveViewEventsListener.
void	addToSelectedItems(Object item) Adds to the selected items.
void	basicActivate(int parentHWnd, IDocument document) Activates the contents view.
void	deactivate() Deactivates the contents view.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
Object	getContextItem() The context item (could be an enumerator).
int	getHWnd() The HWND of the contents view.
String	getName() The name of the contents view.
Object	getSelectedItem() The selected item (could be an enumerator).
int	hashCode() the hashcode for this object
boolean	isShowLines() Indicates if lines are shown in the TOC tree.
boolean	isVisible() Indicates if the view is visible.
void	onApply(IComPropertySheetEventsOnApplyEvent theEvent) Occurs when changes are applied.
void	refresh(Object item) Refreshes the contents view.
void	removeFromSelectedItems(Object item) Removes an item from the selected items.
void	removeIActiveViewEventsListener(IActiveViewEvents theListener) removeIActiveViewEventsListener.
void	setContextItem(Object item) The context item (could be an enumerator).
void	setProcessEvents(boolean rhs1) Indicates if the view is currently responding to events.
void	setSelectedItem(Object item) The selected item (could be an enumerator).
void	setShowLines(boolean show) Indicates if lines are shown in the TOC tree.
void	setVisible(boolean vis) Indicates if the view is visible.

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

TOCGMxCatalogView

public TOCGMxCatalogView()
                  throws IOException,
                         UnknownHostException

Constructs a TOCGMxCatalogView using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TOCGMxCatalogView

public TOCGMxCatalogView(Object obj)
                  throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems TOCGMxCatalogView theTOCGMxCatalogView = (TOCGMxCatalogView) 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

addIActiveViewEventsListener

public void addIActiveViewEventsListener(IActiveViewEvents theListener)
                                  throws IOException

addIActiveViewEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.IActiveViewEvents interface.

Throws:

IOException - If there are communications problems.

removeIActiveViewEventsListener

public void removeIActiveViewEventsListener(IActiveViewEvents theListener)
                                     throws IOException

removeIActiveViewEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.IActiveViewEvents interface.

Throws:

IOException - If there are communications problems.

basicActivate

public void basicActivate(int parentHWnd,
                          IDocument document)
                   throws IOException,
                          AutomationException

Activates the contents view.

Product Availability

Available with ArcGIS Desktop.

Specified by:

basicActivate in interface IContentsView2

Parameters:

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

document - A reference to a com.esri.arcgis.framework.IDocument (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 contents view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getName in interface IContentsView

Returns:

The name

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 contents view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getHWnd in interface IContentsView

Returns:

The hWnd (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

activate

public void activate(int parentHWnd,
                     IMxDocument document)
              throws IOException,
                     AutomationException

Activates the contents view.

Remarks

You can also activate a contents view by setting IMxDocument::CurrentContentsView (in ArcMap) or ISxDocument::CurrentContentsView (in ArcScene or ArcGlobe).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

activate in interface IContentsView

Parameters:

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

document - A reference to a com.esri.arcgis.arcmapui.IMxDocument (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 contents view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

deactivate in interface IContentsView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh(Object item)
             throws IOException,
                    AutomationException

Refreshes the contents view. If a non-null item is specified, it refreshes only that item and its children.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

refresh in interface IContentsView

Parameters:

item - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedItem

public Object getSelectedItem()
                       throws IOException,
                              AutomationException

The selected item (could be an enumerator).

Description

This property is not functional for TOCSelectionView. When working with a TOCDisplayView or TOCCatalogView this property has several usages:

1. The property can be a single object of any of the following types:

IMap
ILayer
ILegendGroup
IWorkspace (source view only)
IDataset (source view only)
IStandaloneTable (source view only)

2. The property can be a Set of items of the types listed in 1. Only multiple items of the same type can be selected simultaneously, so when setting this property using a Set, the Set should contain items of the same type.

3. The property can be an array where the contents of the array represent the hierarchical path to a single selected item. This is common when a single legend class is selected.

For example: If Array(0) = pMap, Array(1) = pLayer, Array(2) = pLegendGroup, and Array(3) = n, then the selected item is the nth legend class in pLegendGroup. When setting or adding to the selection, pass higher-level objects (in this case the IMap and ILayer objects) to improve peformance.

4. The property can be an array which contains an array of the structure explained in 3. This is common when multiple legend classes are selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSelectedItem in interface IContentsView

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectedItem

public void setSelectedItem(Object item)
                     throws IOException,
                            AutomationException

The selected item (could be an enumerator).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setSelectedItem in interface IContentsView

Parameters:

item - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addToSelectedItems

public void addToSelectedItems(Object item)
                        throws IOException,
                               AutomationException

Adds to the selected items.

Description

This method is not functional for TOCSelectionView. When working with a TOCDisplayView or TOCCatalogView the item parameter has several usages:

1. The parameter can be a single object of any of the following types:

IMap
ILayer
ILegendGroup
IWorkspace (source view only)
IDataset (source view only)
IStandaloneTable (source view only)

2. The parameter can be a Set of items of the types listed in 1. Only multiple items of the same type can be selected simultaneously, so the Set should contain items of the same type.

3. The parameter can be an array where the contents of the array represent the hierarchical path to a single selected item. Use this to add a single legend class to the selection.

For example: If Array(0) = pMap, Array(1) = pLayer, Array(2) = pLegendGroup, and Array(3) = n, then the method will add the nth legend class in pLegendGroup. When building the array, include higher-level objects (in this case the IMap and ILayer objects) to improve peformance.

4. The parameter can be an array which contains an array of the structure explained in 3. Use this to add multiple legend classes to the selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

addToSelectedItems in interface IContentsView

Parameters:

item - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeFromSelectedItems

public void removeFromSelectedItems(Object item)
                             throws IOException,
                                    AutomationException

Removes an item from the selected items.

Description

This method is not functional for TOCSelectionView. When working with a TOCDisplayView or TOCCatalogView the item parameter has several usages:

1. The parameter can be a single object of any of the following types:

IMap
ILayer
ILegendGroup
IWorkspace (source view only)
IDataset (source view only)
IStandaloneTable (source view only)

2. The parameter can be a Set of items of the types listed in 1. Only multiple items of the same type can be selected simultaneously, so the Set should contain items of the same type.

3. The parameter can be an array where the contents of the array represent the hierarchical path to a single selected item. Use this to remove a single legend class from the selection.

For example: If Array(0) = pMap, Array(1) = pLayer, Array(2) = pLegendGroup, and Array(3) = n, then the method will remove the nth legend class in pLegendGroup. When building the array, include higher-level objects (in this case the IMap and ILayer objects) to improve peformance.

4. The parameter can be an array which contains an array of the structure explained in 3. Use this to remove multiple legend classes from the selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

removeFromSelectedItems in interface IContentsView

Parameters:

item - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContextItem

public Object getContextItem()
                      throws IOException,
                             AutomationException

The context item (could be an enumerator).

Remarks

You need at least to write a minimalistic implementation of this property as shown here:

Private m_ContextItem as Variant

Private Property Let IContentsView_ContextItem(ByVal RHS As Variant)
m_ContextItem = RHS
End Property

Private Property Get IContentsView_ContextItem() As Variant
IContentsView_ContextItem = m_ContextItem
End Property

The ContextItem property will contain the item on which the user makes a right-click in the TOC and at this point a context menu may be shown.

At 9.0 a default context menu is shown when the user right-clicks in your custom TOC. If you need to get rid of this menu in order to implement your own you will find the Selectable Layers Tab example valuable.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getContextItem in interface IContentsView

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setContextItem

public void setContextItem(Object item)
                    throws IOException,
                           AutomationException

The context item (could be an enumerator).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setContextItem in interface IContentsView

Parameters:

item - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowLines

public boolean isShowLines()
                    throws IOException,
                           AutomationException

Indicates if lines are shown in the TOC tree.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isShowLines in interface IContentsView

Returns:

The show

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowLines

public void setShowLines(boolean show)
                  throws IOException,
                         AutomationException

Indicates if lines are shown in the TOC tree.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setShowLines in interface IContentsView

Parameters:

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the view is visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isVisible in interface IContentsView

Returns:

The vis

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean vis)
                throws IOException,
                       AutomationException

Indicates if the view is visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setVisible in interface IContentsView

Parameters:

vis - The vis (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProcessEvents

public void setProcessEvents(boolean rhs1)
                      throws IOException,
                             AutomationException

Indicates if the view is currently responding to events.

Remarks

This property allows you to temporarily suspend the processing of events by the contents view so that for instance, it doesn't unnecessarily refresh when some routine repeatitively modifies its content.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setProcessEvents in interface IContentsView

Parameters:

rhs1 - The rhs1 (in)

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.