Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.arcmapui
Interface IContentsView

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
IContentsView2, IContentsView3
All Known Implementing Classes:
IContentsView2Proxy, IContentsView3Proxy, IContentsViewProxy, TOCCatalogView, TOCDisplayView, TOCGMxCatalogView, TOCGMxDisplayView, TOCGMxLegendSelectionView, TOCGMxTypeView, TOCLegendDisplayView, TOCLegendSelectionView, TOCSelectionView
public interface IContentsView
extends java.io.Serializable

COM Interface 'IContentsView'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriArcMapUI.olb'

Description: 'Provides access to members that control table of contents views.' 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 =

Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDfddb19ef_cb6f_11d2_9f38_00c04f6bc78e
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void activate(int parentHWnd, IMxDocument document)
          Activates the contents view.
 void addToSelectedItems(java.lang.Object item)
          Adds to the selected items.
 void deactivate()
          Deactivates the contents view.
 java.lang.Object getContextItem()
          The context item (could be an enumerator).
 int getHWnd()
          The HWND of the contents view.
 java.lang.String getName()
          The name of the contents view.
 java.lang.Object getSelectedItem()
          The selected item (could be an enumerator).
 boolean isShowLines()
          Indicates if lines are shown in the TOC tree.
 boolean isVisible()
          Indicates if the view is visible.
 void refresh(java.lang.Object item)
          Refreshes the contents view.
 void removeFromSelectedItems(java.lang.Object item)
          Removes an item from the selected items.
 void setContextItem(java.lang.Object item)
          The context item (could be an enumerator).
 void setProcessEvents(boolean rhs1)
          Indicates if the view is currently responding to events.
 void setSelectedItem(java.lang.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.
 

Field Detail

IIDfddb19ef_cb6f_11d2_9f38_00c04f6bc78e

static final int IIDfddb19ef_cb6f_11d2_9f38_00c04f6bc78e
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The name of the contents view.

Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHWnd

int getHWnd()
            throws java.io.IOException,
                   AutomationException
The HWND of the contents view.

Returns:
The hWnd (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

activate

void activate(int parentHWnd,
              IMxDocument document)
              throws java.io.IOException,
                     AutomationException
Activates the contents view.

Parameters:
parentHWnd - The parentHWnd (A COM typedef) (in)
document - A reference to a com.esri.arcgis.arcmapui.IMxDocument (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deactivate

void deactivate()
                throws java.io.IOException,
                       AutomationException
Deactivates the contents view.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refresh

void refresh(java.lang.Object item)
             throws java.io.IOException,
                    AutomationException
Refreshes the contents view. If a non-null item is specified, it refreshes only that item and its children.

Parameters:
item - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectedItem

java.lang.Object getSelectedItem()
                                 throws java.io.IOException,
                                        AutomationException
The selected item (could be an enumerator).

Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectedItem

void setSelectedItem(java.lang.Object item)
                     throws java.io.IOException,
                            AutomationException
The selected item (could be an enumerator).

Parameters:
item - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addToSelectedItems

void addToSelectedItems(java.lang.Object item)
                        throws java.io.IOException,
                               AutomationException
Adds to the selected items.

Parameters:
item - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeFromSelectedItems

void removeFromSelectedItems(java.lang.Object item)
                             throws java.io.IOException,
                                    AutomationException
Removes an item from the selected items.

Parameters:
item - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getContextItem

java.lang.Object getContextItem()
                                throws java.io.IOException,
                                       AutomationException
The context item (could be an enumerator).

Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setContextItem

void setContextItem(java.lang.Object item)
                    throws java.io.IOException,
                           AutomationException
The context item (could be an enumerator).

Parameters:
item - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowLines

boolean isShowLines()
                    throws java.io.IOException,
                           AutomationException
Indicates if lines are shown in the TOC tree.

Returns:
The show
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowLines

void setShowLines(boolean show)
                  throws java.io.IOException,
                         AutomationException
Indicates if lines are shown in the TOC tree.

Parameters:
show - The show (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isVisible

boolean isVisible()
                  throws java.io.IOException,
                         AutomationException
Indicates if the view is visible.

Returns:
The vis
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVisible

void setVisible(boolean vis)
                throws java.io.IOException,
                       AutomationException
Indicates if the view is visible.

Parameters:
vis - The vis (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProcessEvents

void setProcessEvents(boolean rhs1)
                      throws java.io.IOException,
                             AutomationException
Indicates if the view is currently responding to events.

Parameters:
rhs1 - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD