com.esri.arcgis.controls
Interface ITOCControlDefault

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ITOCControlDefaultProxy, TOCBean, TOCControl

public interface ITOCControlDefault
extends java.io.Serializable

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 =

Field Summary

static java.lang.String	DISPID__504_GET_NAME
static java.lang.String	DISPID__504_PUT_NAME
static java.lang.String	DISPID__514_GET_NAME
static java.lang.String	DISPID__514_PUT_NAME
static java.lang.String	DISPID__515_GET_NAME
static java.lang.String	DISPID__520_GET_NAME
static java.lang.String	DISPID__520_PUT_NAME
static java.lang.String	DISPID__521_GET_NAME
static java.lang.String	DISPID__521_PUT_NAME
static java.lang.String	DISPID__522_GET_NAME
static java.lang.String	DISPID__522_PUTREF_NAME
static java.lang.String	DISPID__552_NAME
static java.lang.String	DISPID_1_GET_NAME
static java.lang.String	DISPID_10_GET_NAME
static java.lang.String	DISPID_10_PUT_NAME
static java.lang.String	DISPID_11_NAME
static java.lang.String	DISPID_12_GET_NAME
static java.lang.String	DISPID_13_GET_NAME
static java.lang.String	DISPID_13_PUT_NAME
static java.lang.String	DISPID_14_GET_NAME
static java.lang.String	DISPID_14_PUT_NAME
static java.lang.String	DISPID_15_NAME
static java.lang.String	DISPID_16_NAME
static java.lang.String	DISPID_3_GET_NAME
static java.lang.String	DISPID_5_NAME
static java.lang.String	DISPID_6_NAME
static java.lang.String	DISPID_7_NAME
static java.lang.String	DISPID_8_GET_NAME
static java.lang.String	DISPID_8_PUT_NAME
static java.lang.String	DISPID_9_GET_NAME
static java.lang.String	DISPID_9_PUT_NAME
static java.lang.String	IID Deprecated. Internal use only
static int	IIDdaa3aece_0c15_42ba_a34d_0dfe38c68586
static int	xxDummy Deprecated. Internal use only

Method Summary

void	aboutBox() Displays a dialog of information about the TOCControl.
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	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.

Field Detail

IIDdaa3aece_0c15_42ba_a34d_0dfe38c68586

static final int IIDdaa3aece_0c15_42ba_a34d_0dfe38c68586

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

DISPID__514_PUT_NAME

static final java.lang.String DISPID__514_PUT_NAME

See Also:

Constant Field Values

DISPID__514_GET_NAME

static final java.lang.String DISPID__514_GET_NAME

See Also:

Constant Field Values

DISPID__515_GET_NAME

static final java.lang.String DISPID__515_GET_NAME

See Also:

Constant Field Values

DISPID__521_PUT_NAME

static final java.lang.String DISPID__521_PUT_NAME

See Also:

Constant Field Values

DISPID__521_GET_NAME

static final java.lang.String DISPID__521_GET_NAME

See Also:

Constant Field Values

DISPID__522_PUTREF_NAME

static final java.lang.String DISPID__522_PUTREF_NAME

See Also:

Constant Field Values

DISPID__522_GET_NAME

static final java.lang.String DISPID__522_GET_NAME

See Also:

Constant Field Values

DISPID__520_GET_NAME

static final java.lang.String DISPID__520_GET_NAME

See Also:

Constant Field Values

DISPID__520_PUT_NAME

static final java.lang.String DISPID__520_PUT_NAME

See Also:

Constant Field Values

DISPID__504_PUT_NAME

static final java.lang.String DISPID__504_PUT_NAME

See Also:

Constant Field Values

DISPID__504_GET_NAME

static final java.lang.String DISPID__504_GET_NAME

See Also:

Constant Field Values

DISPID__552_NAME

static final java.lang.String DISPID__552_NAME

See Also:

Constant Field Values

DISPID_1_GET_NAME

static final java.lang.String DISPID_1_GET_NAME

See Also:

Constant Field Values

DISPID_3_GET_NAME

static final java.lang.String DISPID_3_GET_NAME

See Also:

Constant Field Values

DISPID_5_NAME

static final java.lang.String DISPID_5_NAME

See Also:

Constant Field Values

DISPID_6_NAME

static final java.lang.String DISPID_6_NAME

See Also:

Constant Field Values

DISPID_7_NAME

static final java.lang.String DISPID_7_NAME

See Also:

Constant Field Values

DISPID_8_GET_NAME

static final java.lang.String DISPID_8_GET_NAME

See Also:

Constant Field Values

DISPID_8_PUT_NAME

static final java.lang.String DISPID_8_PUT_NAME

See Also:

Constant Field Values

DISPID_9_GET_NAME

static final java.lang.String DISPID_9_GET_NAME

See Also:

Constant Field Values

DISPID_9_PUT_NAME

static final java.lang.String DISPID_9_PUT_NAME

See Also:

Constant Field Values

DISPID_10_GET_NAME

static final java.lang.String DISPID_10_GET_NAME

See Also:

Constant Field Values

DISPID_10_PUT_NAME

static final java.lang.String DISPID_10_PUT_NAME

See Also:

Constant Field Values

DISPID_11_NAME

static final java.lang.String DISPID_11_NAME

See Also:

Constant Field Values

DISPID_12_GET_NAME

static final java.lang.String DISPID_12_GET_NAME

See Also:

Constant Field Values

DISPID_13_GET_NAME

static final java.lang.String DISPID_13_GET_NAME

See Also:

Constant Field Values

DISPID_13_PUT_NAME

static final java.lang.String DISPID_13_PUT_NAME

See Also:

Constant Field Values

DISPID_14_GET_NAME

static final java.lang.String DISPID_14_GET_NAME

See Also:

Constant Field Values

DISPID_14_PUT_NAME

static final java.lang.String DISPID_14_PUT_NAME

See Also:

Constant Field Values

DISPID_15_NAME

static final java.lang.String DISPID_15_NAME

See Also:

Constant Field Values

DISPID_16_NAME

static final java.lang.String DISPID_16_NAME

See Also:

Constant Field Values

Method Detail

esri_setEnabled

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

Indicates whether the TOCControl can respond to user generated events.

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_isEnabled

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

Indicates whether the TOCControl can respond to user generated events.

Returns:

The returnValue

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

Handle to the window associated with the TOCControl.

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMousePointer

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

The mouse pointer displayed over the TOCControl.

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

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

The mouse pointer displayed over the TOCControl.

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

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

Custom mouse icon used if MousePointer is 99.

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

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

Custom mouse icon used if MousePointer is 99.

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

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

The appearance of the TOCControl.

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

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

The appearance of the TOCControl.

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

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

The border style of the TOCControl.

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

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

The border style of the TOCControl.

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

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

Displays a dialog of information about the TOCControl.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActiveView

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

The ActiveView used to populate the TOCControl.

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

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

The object whose ActiveView is used to populate the TOCControl.

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

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.

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

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

Updates the contents of the TOCControl to match its ActiveView.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setActiveView

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

Sets the ActiveView used to populate the TOCControl.

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

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

Layer visibility editing state.

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

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

Layer visibility editing state.

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

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

Label editing state.

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

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

Label editing state.

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

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

A property to associate data with a control.

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

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

A property to associate data with a control.

Parameters:

rhs1 - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBuddyControl

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.

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

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.

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

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.

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setKeyIntercept

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.

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEnableLayerDragDrop

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

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

Returns:

The returnValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEnableLayerDragDrop

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

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

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectedItem

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.

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

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

Sets the selected item in the TOCControl.

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.