com.esri.arcgis.arcmapui
Class TOCLegendDisplayView

java.lang.Object
  com.esri.arcgis.arcmapui.TOCLegendDisplayView

All Implemented Interfaces:

IContentsView, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class TOCLegendDisplayView
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IContentsView

COM Class 'TOCLegendDisplayView'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriArcMapUI.olb'

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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.arcmapui.IContentsView

IID, IIDfddb19ef_cb6f_11d2_9f38_00c04f6bc78e, xxDummy

Constructor Summary

TOCLegendDisplayView()
Constructs a TOCLegendDisplayView using ArcGIS Engine.

TOCLegendDisplayView(java.lang.Object obj)
Construct a TOCLegendDisplayView 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	addToSelectedItems(java.lang.Object item) Adds to the selected items.
void	deactivate() Deactivates the contents view.
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
java.lang.Object	getContextItem() The context item (could be an enumerator).
int	getHWnd() The HWND of the contents view.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() The name of the contents view.
java.lang.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	refresh(java.lang.Object item) Refreshes the contents view.
void	release() Release a TOCLegendDisplayView.
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TOCLegendDisplayView

public TOCLegendDisplayView()
                     throws java.io.IOException,
                            java.net.UnknownHostException

Constructs a TOCLegendDisplayView using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TOCLegendDisplayView

public TOCLegendDisplayView(java.lang.Object obj)
                     throws java.io.IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems TOCLegendDisplayView theTOCLegendDisplayView = (TOCLegendDisplayView) obj;

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a TOCLegendDisplayView.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the contents view.

Specified by:

getName in interface IContentsView

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

public int getHWnd()
            throws java.io.IOException,
                   AutomationException

The HWND of the contents view.

Specified by:

getHWnd in interface IContentsView

Returns:

The hWnd (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

activate

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

Activates the contents view.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deactivate

public void deactivate()
                throws java.io.IOException,
                       AutomationException

Deactivates the contents view.

Specified by:

deactivate in interface IContentsView

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public 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.

Specified by:

refresh in interface IContentsView

Parameters:

item - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedItem

public java.lang.Object getSelectedItem()
                                 throws java.io.IOException,
                                        AutomationException

The selected item (could be an enumerator).

Specified by:

getSelectedItem in interface IContentsView

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectedItem

public void setSelectedItem(java.lang.Object item)
                     throws java.io.IOException,
                            AutomationException

The selected item (could be an enumerator).

Specified by:

setSelectedItem in interface IContentsView

Parameters:

item - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addToSelectedItems

public void addToSelectedItems(java.lang.Object item)
                        throws java.io.IOException,
                               AutomationException

Adds to the selected items.

Specified by:

addToSelectedItems in interface IContentsView

Parameters:

item - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeFromSelectedItems

public void removeFromSelectedItems(java.lang.Object item)
                             throws java.io.IOException,
                                    AutomationException

Removes an item from the selected items.

Specified by:

removeFromSelectedItems in interface IContentsView

Parameters:

item - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContextItem

public java.lang.Object getContextItem()
                                throws java.io.IOException,
                                       AutomationException

The context item (could be an enumerator).

Specified by:

getContextItem in interface IContentsView

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setContextItem

public void setContextItem(java.lang.Object item)
                    throws java.io.IOException,
                           AutomationException

The context item (could be an enumerator).

Specified by:

setContextItem in interface IContentsView

Parameters:

item - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowLines

public boolean isShowLines()
                    throws java.io.IOException,
                           AutomationException

Indicates if lines are shown in the TOC tree.

Specified by:

isShowLines in interface IContentsView

Returns:

The show

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowLines

public void setShowLines(boolean show)
                  throws java.io.IOException,
                         AutomationException

Indicates if lines are shown in the TOC tree.

Specified by:

setShowLines in interface IContentsView

Parameters:

show - The show (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws java.io.IOException,
                         AutomationException

Indicates if the view is visible.

Specified by:

isVisible in interface IContentsView

Returns:

The vis

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean vis)
                throws java.io.IOException,
                       AutomationException

Indicates if the view is visible.

Specified by:

setVisible in interface IContentsView

Parameters:

vis - The vis (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProcessEvents

public void setProcessEvents(boolean rhs1)
                      throws java.io.IOException,
                             AutomationException

Indicates if the view is currently responding to events.

Specified by:

setProcessEvents in interface IContentsView

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.