com.esri.arcgis.controls
Class ITOCControlDefaultProxy

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

All Implemented Interfaces:

ITOCControlDefault, java.io.Externalizable, java.io.Serializable

public class ITOCControlDefaultProxy
extends com.esri.arcgis.interop.Dispatch
implements ITOCControlDefault, java.io.Serializable

Internal use class Proxy for COM Interface 'ITOCControlDefault'. 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.ITOCControlDefault

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_14_GET_NAME, DISPID_14_PUT_NAME, DISPID_15_NAME, DISPID_16_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, IIDdaa3aece_0c15_42ba_a34d_0dfe38c68586

Constructor Summary

	ITOCControlDefaultProxy() For internal use only
	ITOCControlDefaultProxy(java.lang.Object obj)
protected	ITOCControlDefaultProxy(java.lang.Object obj, java.lang.String iid)
	ITOCControlDefaultProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	ITOCControlDefaultProxy(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 rhs1) 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	getSelectedItem(int[] itemType, IBasicMap[] basicMap, ILayer[] layer, java.lang.Object[] unk, java.lang.Object[] data) Returns the selected item in the TOCControl.
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.
boolean	isEnableLayerDragDrop() Indicates if layers can be dragged and dropped in the control.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener)
void	selectItem(java.lang.Object unk, java.lang.Object data) Sets the selected item in the TOCControl.
void	setActiveView(IActiveView activeView) Sets the ActiveView used to populate the TOCControl.
void	setAppearance(int rhs1) The appearance of the TOCControl.
void	setBorderStyle(int rhs1) 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 rhs1) A property to associate data with a control.
void	setEnableLayerDragDrop(boolean rhs1) Indicates if layers can be dragged and dropped in the control.
void	setKeyIntercept(int rhs1) A property that specifies interception of key strokes that are normally handled by the container.
void	setLabelEdit(int rhs1) Label editing state.
void	setLayerVisibilityEdit(int rhs1) Layer visibility editing state.
void	setMouseIconByRef(Picture rhs1) Custom mouse icon used if MousePointer is 99.
void	setMousePointer(int rhs1) 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

ITOCControlDefaultProxy

public ITOCControlDefaultProxy(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

ITOCControlDefaultProxy

public ITOCControlDefaultProxy()

For internal use only

ITOCControlDefaultProxy

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

Throws:

java.io.IOException

ITOCControlDefaultProxy

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

Throws:

java.io.IOException

ITOCControlDefaultProxy

protected ITOCControlDefaultProxy(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 rhs1)
                     throws java.io.IOException,
                            AutomationException

Indicates whether the TOCControl can respond to user generated events.

Specified by:

esri_setEnabled in interface ITOCControlDefault

Parameters:

rhs1 - The rhs1 (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 ITOCControlDefault

Returns:

The returnValue

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 ITOCControlDefault

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMousePointer

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

The mouse pointer displayed over the TOCControl.

Specified by:

setMousePointer in interface ITOCControlDefault

Parameters:

rhs1 - 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 ITOCControlDefault

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 rhs1)
                       throws java.io.IOException,
                              AutomationException

Custom mouse icon used if MousePointer is 99.

Specified by:

setMouseIconByRef in interface ITOCControlDefault

Parameters:

rhs1 - 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 ITOCControlDefault

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 ITOCControlDefault

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 rhs1)
                   throws java.io.IOException,
                          AutomationException

The appearance of the TOCControl.

Specified by:

setAppearance in interface ITOCControlDefault

Parameters:

rhs1 - 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 rhs1)
                    throws java.io.IOException,
                           AutomationException

The border style of the TOCControl.

Specified by:

setBorderStyle in interface ITOCControlDefault

Parameters:

rhs1 - 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 ITOCControlDefault

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 ITOCControlDefault

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 ITOCControlDefault

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 ITOCControlDefault

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 ITOCControlDefault

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 ITOCControlDefault

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 ITOCControlDefault

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 ITOCControlDefault

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 rhs1)
                            throws java.io.IOException,
                                   AutomationException

Layer visibility editing state.

Specified by:

setLayerVisibilityEdit in interface ITOCControlDefault

Parameters:

rhs1 - 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 ITOCControlDefault

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 rhs1)
                  throws java.io.IOException,
                         AutomationException

Label editing state.

Specified by:

setLabelEdit in interface ITOCControlDefault

Parameters:

rhs1 - 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 ITOCControlDefault

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 rhs1)
                       throws java.io.IOException,
                              AutomationException

A property to associate data with a control.

Specified by:

setCustomProperty in interface ITOCControlDefault

Parameters:

rhs1 - 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 ITOCControlDefault

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 ITOCControlDefault

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 ITOCControlDefault

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setKeyIntercept

public void setKeyIntercept(int rhs1)
                     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 ITOCControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEnableLayerDragDrop

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

Indicates if layers can be dragged and dropped in the control.

Specified by:

isEnableLayerDragDrop in interface ITOCControlDefault

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEnableLayerDragDrop

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

Indicates if layers can be dragged and dropped in the control.

Specified by:

setEnableLayerDragDrop in interface ITOCControlDefault

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectedItem

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

Returns the selected item in the TOCControl.

Specified by:

getSelectedItem in interface ITOCControlDefault

Parameters:

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.

selectItem

public void selectItem(java.lang.Object unk,
                       java.lang.Object data)
                throws java.io.IOException,
                       AutomationException

Sets the selected item in the TOCControl.

Specified by:

selectItem in interface ITOCControlDefault

Parameters:

unk - A reference to another Object (IUnknown) (in)

data - A Variant (in, optional, pass null if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.