com.esri.arcgis.arcscene
Class TOCSxDisplayView

java.lang.Object
  extended by com.esri.arcgis.arcscene.TOCSxDisplayView
All Implemented Interfaces:
ISxContentsView, com.esri.arcgis.interop.RemoteObjRef, IComPropertySheetEvents, Serializable, EventListener

public class TOCSxDisplayView
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISxContentsView, IComPropertySheetEvents

Esri TOC Sx Display View.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

See Also:
Serialized Form

Constructor Summary
TOCSxDisplayView()
          Constructs a TOCSxDisplayView using ArcGIS Engine.
TOCSxDisplayView(Object obj)
          Construct a TOCSxDisplayView using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void activate(int parentHWnd, ISxDocument document)
          Activates the contents view.
 void addIActiveViewEventsListener(IActiveViewEvents theListener)
          addIActiveViewEventsListener.
 void addToSelectedItems(Object item)
          Adds to the selected items.
 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 whether to show lines 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 whether the view is currently responding to events.
 void setSelectedItem(Object item)
          The selected item (could be an enumerator).
 void setShowLines(boolean show)
          Indicates whether to show lines 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

TOCSxDisplayView

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

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

TOCSxDisplayView

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

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

getName

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

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
getName in interface ISxContentsView
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. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
getHWnd in interface ISxContentsView
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,
                     ISxDocument document)
              throws IOException,
                     AutomationException
Activates the contents view.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
activate in interface ISxContentsView
Parameters:
parentHWnd - The parentHWnd (A COM typedef) (in)
document - A reference to a com.esri.arcgis.arcscene.ISxDocument (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. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
deactivate in interface ISxContentsView
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. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
refresh in interface ISxContentsView
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).

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
getSelectedItem in interface ISxContentsView
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. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
setSelectedItem in interface ISxContentsView
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.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
addToSelectedItems in interface ISxContentsView
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.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
removeFromSelectedItems in interface ISxContentsView
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).

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
getContextItem in interface ISxContentsView
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. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
setContextItem in interface ISxContentsView
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 whether to show lines in the TOC tree.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
isShowLines in interface ISxContentsView
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 whether to show lines in the TOC tree.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
setShowLines in interface ISxContentsView
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. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
isVisible in interface ISxContentsView
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. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
setVisible in interface ISxContentsView
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 whether the view is currently responding to events.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
setProcessEvents in interface ISxContentsView
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.