com.esri.arcgis.controls
Class ITOCControlProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.controls.ITOCControlProxy

All Implemented Interfaces:

ITOCControl, java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

ITOCControl2Proxy

public class ITOCControlProxy
extends com.esri.arcgis.interop.Dispatch
implements ITOCControl, java.io.Serializable

Internal use class Proxy for COM Interface 'ITOCControl'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to members that control the TOCControl.' 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

boolean	noncastable
static java.lang.Class	targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Fields inherited from interface com.esri.arcgis.controls.ITOCControl

DISPID__504_GET_NAME, DISPID__504_PUT_NAME, DISPID__514_GET_NAME, DISPID__514_PUT_NAME, DISPID__515_GET_NAME, DISPID__520_GET_NAME, DISPID__520_PUT_NAME, DISPID__521_GET_NAME, DISPID__521_PUT_NAME, DISPID__522_GET_NAME, DISPID__522_PUTREF_NAME, DISPID__552_NAME, DISPID_1_GET_NAME, DISPID_10_GET_NAME, DISPID_10_PUT_NAME, DISPID_11_NAME, DISPID_12_GET_NAME, DISPID_13_GET_NAME, DISPID_13_PUT_NAME, DISPID_3_GET_NAME, DISPID_5_NAME, DISPID_6_NAME, DISPID_7_NAME, DISPID_8_GET_NAME, DISPID_8_PUT_NAME, DISPID_9_GET_NAME, DISPID_9_PUT_NAME, IID, IID3b13323e_8cfc_46dc_bef9_34a95fd484f1

Constructor Summary

	ITOCControlProxy() For internal use only
	ITOCControlProxy(java.lang.Object obj)
protected	ITOCControlProxy(java.lang.Object obj, java.lang.String iid)
	ITOCControlProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	ITOCControlProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)

Method Summary

void	aboutBox() Displays a dialog of information about the TOCControl.
void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
boolean	esri_isEnabled() Indicates whether the TOCControl can respond to user generated events.
void	esri_setEnabled(boolean enabled) Indicates whether the TOCControl can respond to user generated events.
IActiveView	getActiveView() The ActiveView used to populate the TOCControl.
int	getAppearance() The appearance of the TOCControl.
int	getBorderStyle() The border style of the TOCControl.
java.lang.Object	getBuddy() The object whose ActiveView is used to populate the TOCControl.
java.lang.Object	getCustomProperty() A property to associate data with a control.
int	getHWnd() Handle to the window associated with the TOCControl.
int	getKeyIntercept() A property that specifies interception of key strokes that are normally handled by the container.
int	getLabelEdit() Label editing state.
int	getLayerVisibilityEdit() Layer visibility editing state.
Picture	getMouseIcon() Custom mouse icon used if MousePointer is 99.
int	getMousePointer() The mouse pointer displayed over the TOCControl.
java.lang.Object	getObject() A property that returns the underlying control.
void	hitTest(int x, int y, int[] itemType, IBasicMap[] basicMap, ILayer[] layer, java.lang.Object[] unk, java.lang.Object[] data) Returns the item in the TOCControl at the specified coordinates.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener)
void	setActiveView(IActiveView activeView) Sets the ActiveView used to populate the TOCControl.
void	setAppearance(int appearance) The appearance of the TOCControl.
void	setBorderStyle(int borderStyle) The border style of the TOCControl.
void	setBuddyControl(java.lang.Object pTOCBuddy) Sets a control to be a buddy of the toolbar, this control must support ITOCBuddy.
void	setCustomProperty(java.lang.Object pVal) A property to associate data with a control.
void	setKeyIntercept(int pVal) A property that specifies interception of key strokes that are normally handled by the container.
void	setLabelEdit(int labelEdit) Label editing state.
void	setLayerVisibilityEdit(int layerVisibilityEdit) Layer visibility editing state.
void	setMouseIconByRef(Picture mouseIcon) Custom mouse icon used if MousePointer is 99.
void	setMousePointer(int mousePointer) The mouse pointer displayed over the TOCControl.
void	update() Updates the contents of the TOCControl to match its ActiveView.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable

Constructor Detail

ITOCControlProxy

public ITOCControlProxy(java.lang.String CLSID,
                        java.lang.String host,
                        com.esri.arcgis.interop.AuthInfo authInfo)
                 throws java.net.UnknownHostException,
                        java.io.IOException

Throws:

java.net.UnknownHostException

java.io.IOException

ITOCControlProxy

public ITOCControlProxy()

For internal use only

ITOCControlProxy

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

Throws:

java.io.IOException

ITOCControlProxy

protected ITOCControlProxy(java.lang.Object obj,
                           java.lang.String iid)
                    throws java.io.IOException

Throws:

java.io.IOException

ITOCControlProxy

protected ITOCControlProxy(java.lang.String CLSID,
                           java.lang.String iid,
                           java.lang.String host,
                           com.esri.arcgis.interop.AuthInfo authInfo)
                    throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

esri_setEnabled

public void esri_setEnabled(boolean enabled)
                     throws java.io.IOException,
                            AutomationException

Indicates whether the TOCControl can respond to user generated events.

Specified by:

esri_setEnabled in interface ITOCControl

Parameters:

enabled - The enabled (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_isEnabled

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

Indicates whether the TOCControl can respond to user generated events.

Specified by:

esri_isEnabled in interface ITOCControl

Returns:

The enabled

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

Handle to the window associated with the TOCControl.

Specified by:

getHWnd in interface ITOCControl

Returns:

The hWnd

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMousePointer

public void setMousePointer(int mousePointer)
                     throws java.io.IOException,
                            AutomationException

The mouse pointer displayed over the TOCControl.

Specified by:

setMousePointer in interface ITOCControl

Parameters:

mousePointer - A com.esri.arcgis.controls.esriControlsMousePointer constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMousePointer

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

The mouse pointer displayed over the TOCControl.

Specified by:

getMousePointer in interface ITOCControl

Returns:

A com.esri.arcgis.controls.esriControlsMousePointer constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMouseIconByRef

public void setMouseIconByRef(Picture mouseIcon)
                       throws java.io.IOException,
                              AutomationException

Custom mouse icon used if MousePointer is 99.

Specified by:

setMouseIconByRef in interface ITOCControl

Parameters:

mouseIcon - A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMouseIcon

public Picture getMouseIcon()
                     throws java.io.IOException,
                            AutomationException

Custom mouse icon used if MousePointer is 99.

Specified by:

getMouseIcon in interface ITOCControl

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAppearance

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

The appearance of the TOCControl.

Specified by:

getAppearance in interface ITOCControl

Returns:

A com.esri.arcgis.controls.esriControlsAppearance constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAppearance

public void setAppearance(int appearance)
                   throws java.io.IOException,
                          AutomationException

The appearance of the TOCControl.

Specified by:

setAppearance in interface ITOCControl

Parameters:

appearance - A com.esri.arcgis.controls.esriControlsAppearance constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBorderStyle

public void setBorderStyle(int borderStyle)
                    throws java.io.IOException,
                           AutomationException

The border style of the TOCControl.

Specified by:

setBorderStyle in interface ITOCControl

Parameters:

borderStyle - A com.esri.arcgis.controls.esriControlsBorderStyle constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBorderStyle

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

The border style of the TOCControl.

Specified by:

getBorderStyle in interface ITOCControl

Returns:

A com.esri.arcgis.controls.esriControlsBorderStyle constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

aboutBox

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

Displays a dialog of information about the TOCControl.

Specified by:

aboutBox in interface ITOCControl

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActiveView

public IActiveView getActiveView()
                          throws java.io.IOException,
                                 AutomationException

The ActiveView used to populate the TOCControl.

Specified by:

getActiveView in interface ITOCControl

Returns:

A reference to a com.esri.arcgis.carto.IActiveView

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBuddy

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

The object whose ActiveView is used to populate the TOCControl.

Specified by:

getBuddy in interface ITOCControl

Returns:

A reference to another Automation Object (IDispatch)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hitTest

public void hitTest(int x,
                    int y,
                    int[] itemType,
                    IBasicMap[] basicMap,
                    ILayer[] layer,
                    java.lang.Object[] unk,
                    java.lang.Object[] data)
             throws java.io.IOException,
                    AutomationException

Returns the item in the TOCControl at the specified coordinates.

Specified by:

hitTest in interface ITOCControl

Parameters:

x - The x (in)

y - The y (in)

itemType - A com.esri.arcgis.controls.esriTOCControlItem constant (in/out: use single element array)

basicMap - A reference to a com.esri.arcgis.carto.IBasicMap (in/out: use single element array)

layer - A reference to a com.esri.arcgis.carto.ILayer (in/out: use single element array)

unk - A reference to another Object (IUnknown) (in/out: use single element array)

data - A Variant (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

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

Updates the contents of the TOCControl to match its ActiveView.

Specified by:

update in interface ITOCControl

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setActiveView

public void setActiveView(IActiveView activeView)
                   throws java.io.IOException,
                          AutomationException

Sets the ActiveView used to populate the TOCControl.

Specified by:

setActiveView in interface ITOCControl

Parameters:

activeView - A reference to a com.esri.arcgis.carto.IActiveView (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayerVisibilityEdit

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

Layer visibility editing state.

Specified by:

getLayerVisibilityEdit in interface ITOCControl

Returns:

A com.esri.arcgis.controls.esriTOCControlEdit constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLayerVisibilityEdit

public void setLayerVisibilityEdit(int layerVisibilityEdit)
                            throws java.io.IOException,
                                   AutomationException

Layer visibility editing state.

Specified by:

setLayerVisibilityEdit in interface ITOCControl

Parameters:

layerVisibilityEdit - A com.esri.arcgis.controls.esriTOCControlEdit constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelEdit

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

Label editing state.

Specified by:

getLabelEdit in interface ITOCControl

Returns:

A com.esri.arcgis.controls.esriTOCControlEdit constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelEdit

public void setLabelEdit(int labelEdit)
                  throws java.io.IOException,
                         AutomationException

Label editing state.

Specified by:

setLabelEdit in interface ITOCControl

Parameters:

labelEdit - A com.esri.arcgis.controls.esriTOCControlEdit constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

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

A property to associate data with a control.

Specified by:

getCustomProperty in interface ITOCControl

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(java.lang.Object pVal)
                       throws java.io.IOException,
                              AutomationException

A property to associate data with a control.

Specified by:

setCustomProperty in interface ITOCControl

Parameters:

pVal - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBuddyControl

public void setBuddyControl(java.lang.Object pTOCBuddy)
                     throws java.io.IOException,
                            AutomationException

Sets a control to be a buddy of the toolbar, this control must support ITOCBuddy.

Specified by:

setBuddyControl in interface ITOCControl

Parameters:

pTOCBuddy - A reference to another Automation Object (IDispatch) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getObject

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

A property that returns the underlying control. This can be used when the control is inside a wrapper object that has been added by a development environment.

Specified by:

getObject in interface ITOCControl

Returns:

A reference to another Automation Object (IDispatch)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getKeyIntercept

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

A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Specified by:

getKeyIntercept in interface ITOCControl

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setKeyIntercept

public void setKeyIntercept(int pVal)
                     throws java.io.IOException,
                            AutomationException

A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Specified by:

setKeyIntercept in interface ITOCControl

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.