com.esri.arcgis.controls
Class TOCControl

java.lang.Object
  java.awt.Component
      java.awt.Canvas
          com.esri.arcgis.interop.Ocx
              com.esri.arcgis.controls.TOCControl

All Implemented Interfaces:

ITOCControl, ITOCControl2, ITOCControlDefault, IConnectionPointContainer, IPersistStreamInit, com.esri.arcgis.interop.RemoteObjRef, IPersist, ISupportErrorInfo, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class TOCControl
extends com.esri.arcgis.interop.Ocx
implements com.esri.arcgis.interop.RemoteObjRef, ITOCControlDefault, ITOCControl, ITOCControl2, IConnectionPointContainer, IPersistStreamInit, IPersist, ISupportErrorInfo

COM Class 'TOCControl'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description 'Esri 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

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Canvas

java.awt.Canvas.AccessibleAWTCanvas

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

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

rootParentContainers, rootWindows

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

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, xxDummy

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

DISPID_14_GET_NAME, DISPID_14_PUT_NAME, DISPID_15_NAME, DISPID_16_NAME, IID, IIDf7b681c9_d60e_453d_915a_c878a2416b27, xxDummy

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

IID3b13323e_8cfc_46dc_bef9_34a95fd484f1

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IPersistStreamInit

IID, IID7fd52380_4e07_101b_ae2d_08002b2ec713, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

TOCControl()
Constructs a TOCControl using ArcGIS Engine.

TOCControl(java.lang.Object o)
Constructs a TOCControl.

Method Summary

void	aboutBox() Displays a dialog of information about the TOCControl.
void	addITOCControlEventsListener(ITOCControlEvents theListener) addITOCControlEventsListener.
void	addNotify()
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
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.
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
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.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.Object	getCustomProperty() A property to associate data with a control.
int	getHWnd() Handle to the window associated with the TOCControl.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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	getSizeMax(_ULARGE_INTEGER[] pCbSize) getSizeMax
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	initNew() initNew
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
boolean	isEnableLayerDragDrop() Indicates if layers can be dragged and dropped in the control.
void	load(IStream pStm) load
void	release() Release a TOCControl.
void	removeITOCControlEventsListener(ITOCControlEvents theListener) removeITOCControlEventsListener.
void	save(IStream pStm, int fClearDirty) save
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.Ocx

checkIfVisible, dispose, finalize, getCanvasWindowHandle, getControlWindowHandle, getMinimumSize, getObjRef, getPreferredSize, paint, removeNotify, setBounds, setBounds, setSize, setSize, zz_doQueuedSets, zz_get, zz_get, zz_get, zz_get, zz_get, zz_get, zz_get, zz_get, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet, zz_queueSet

Methods inherited from class java.awt.Canvas

createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy, update

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate

Methods inherited from class java.lang.Object

clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TOCControl

public TOCControl()

Constructs a TOCControl using ArcGIS Engine.

TOCControl

public TOCControl(java.lang.Object o)

Constructs a TOCControl.

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

getJintegraDispatch

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

Deprecated. Internal use only.

Specified by:

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

addITOCControlEventsListener

public void addITOCControlEventsListener(ITOCControlEvents theListener)
                                  throws java.io.IOException

addITOCControlEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.controls.ITOCControlEvents interface.

Throws:

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

removeITOCControlEventsListener

public void removeITOCControlEventsListener(ITOCControlEvents theListener)
                                     throws java.io.IOException

removeITOCControlEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.controls.ITOCControlEvents interface.

Throws:

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

addNotify

public void addNotify()

Overrides:

addNotify in class com.esri.arcgis.interop.Ocx

release

public void release()

Release a TOCControl.

Specified by:

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

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl

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 ITOCControl2

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 ITOCControl2

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 ITOCControl2

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 ITOCControl2

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.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException

findConnectionPoint

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStreamInit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pStm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStreamInit

Parameters:

pStm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pStm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStreamInit

Parameters:

pStm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pCbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStreamInit

Parameters:

pCbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

initNew

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

initNew

Specified by:

initNew in interface IPersistStreamInit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.