com.esri.arcgis.beans.TOC
Class TOCBean

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.esri.arcgis.beans.TOC.TOCBean

All Implemented Interfaces:

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

public class TOCBean
extends javax.swing.JComponent
implements com.esri.arcgis.interop.RemoteObjRef, ITOCControlDefault, ITOCControl, IConnectionPointContainer, IPersistStreamInit, IPersist, ISupportErrorInfo

The TOCBean is a wrapper class of TOCControl to facilitate the use of TOCControl at the design time. Users could access the actual control by getTOCControl method.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

protected TOCControl

m_tocControl

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

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

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

TOCBean()
Default constructor

Method Summary

void	aboutBox() Displays a dialog of information about the TOCControl.
void	addITOCControlEventsListener(ITOCControlEventsAdapter theListener)
void	enumConnectionPoints(IEnumConnectionPoints[] iEnumConnectionPointsArray) enumConnectionPoints
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 gUID, IConnectionPoint[] iConnectionPointArray) 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.
BuddyControl	getBuddyControl()
void	getClassID(GUID[] gUIDArray) getClassID
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()
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[] intArray, IBasicMap[] iBasicMapArray, ILayer[] iLayerArray, java.lang.Object[] objectArray, java.lang.Object[] objectArray4) Returns the selected item in the TOCControl.
void	getSizeMax(_ULARGE_INTEGER[] _ULARGE_INTEGERArray) getSizeMax
TOCControl	getTOCControl() Returns the actual TOCControl;
void	hitTest(int _int, int _int1, int[] intArray, IBasicMap[] iBasicMapArray, ILayer[] iLayerArray, java.lang.Object[] objectArray, java.lang.Object[] objectArray6) Returns the item in the TOCControl at the specified coordinates.
void	initNew() initNew
void	interfaceSupportsErrorInfo(GUID gUID) interfaceSupportsErrorInfo
void	isDirty() isDirty
boolean	isEnableLayerDragDrop() Indicates if layers can be dragged and dropped in the control.
void	load(IStream pStm) load
void	paint(java.awt.Graphics g) Paints this component.
void	release()
void	removeITOCControlEventsListener(ITOCControlEventsAdapter theListener)
void	save(IStream pStm, int fClearDirty) save
void	selectItem(java.lang.Object object, java.lang.Object object1) Sets the selected item in the TOCControl.
void	setActiveView(IActiveView activeView) Sets the ActiveView used to populate the TOCControl.
void	setAppearance(int appearance) The appearance of the TOCControl.
void	setBorderStyle(int rhs1) The border style of the TOCControl.
void	setBuddyControl(BuddyControl buddy)
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 _boolean) Indicates if layers can be dragged and dropped in the control.
void	setKeyIntercept(int key) A property that specifies interception of key strokes that are normally handled by the container.
void	setLabelEdit(int label) Label editing state.
void	setLayerVisibilityEdit(int edit) Layer visibility editing state.
void	setLayout(java.awt.LayoutManager layout) Overrides the setLayout method of super class.
void	setMouseIconByRef(Picture picture) Custom mouse icon used if MousePointer is 99.
void	setMousePointer(int pointer) The mouse pointer displayed over the TOCControl.
void	update() Updates the contents of the TOCControl to match its ActiveView.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_tocControl

protected TOCControl m_tocControl

Constructor Detail

TOCBean

public TOCBean()

Default constructor

Method Detail

setLayout

public void setLayout(java.awt.LayoutManager layout)

Overrides the setLayout method of super class.

Overrides:

setLayout in class java.awt.Container

Parameters:

layout - LayoutManager - a LayoutManager object.

getTOCControl

public TOCControl getTOCControl()

Returns the actual TOCControl;

Returns:

TOCControl

paint

public void paint(java.awt.Graphics g)

Paints this component.

Overrides:

paint in class javax.swing.JComponent

Parameters:

g - the graphics context to use for painting

getAppearance

public int getAppearance()
                  throws java.io.IOException

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 appearance)
                   throws java.io.IOException

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.

getBorderStyle

public int getBorderStyle()
                   throws java.io.IOException

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.

setBorderStyle

public void setBorderStyle(int rhs1)
                    throws java.io.IOException

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.

getMousePointer

public int getMousePointer()
                    throws java.io.IOException

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.

setMousePointer

public void setMousePointer(int pointer)
                     throws java.io.IOException

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.

setLabelEdit

public void setLabelEdit(int label)
                  throws java.io.IOException

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.

getLabelEdit

public int getLabelEdit()
                 throws java.io.IOException

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.

setLayerVisibilityEdit

public void setLayerVisibilityEdit(int edit)
                            throws java.io.IOException

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.

getLayerVisibilityEdit

public int getLayerVisibilityEdit()
                           throws java.io.IOException

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.

esri_isEnabled

public boolean esri_isEnabled()
                       throws java.io.IOException

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.

esri_setEnabled

public void esri_setEnabled(boolean rhs1)
                     throws java.io.IOException

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.

getKeyIntercept

public int getKeyIntercept()
                    throws java.io.IOException

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 key)
                     throws java.io.IOException

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.

setBuddyControl

public void setBuddyControl(BuddyControl buddy)
                     throws java.io.IOException

Throws:

java.io.IOException

getBuddyControl

public BuddyControl getBuddyControl()

addITOCControlEventsListener

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

Throws:

java.io.IOException

removeITOCControlEventsListener

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

Throws:

java.io.IOException

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.

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.

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.

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.

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.

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.

getJintegraDispatch

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

Specified by:

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

release

public void release()

Specified by:

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

setMouseIconByRef

public void setMouseIconByRef(Picture picture)
                       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.

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.

hitTest

public void hitTest(int _int,
                    int _int1,
                    int[] intArray,
                    IBasicMap[] iBasicMapArray,
                    ILayer[] iLayerArray,
                    java.lang.Object[] objectArray,
                    java.lang.Object[] objectArray6)
             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.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] iEnumConnectionPointsArray)
                          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 gUID,
                                IConnectionPoint[] iConnectionPointArray)
                         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.

getClassID

public void getClassID(GUID[] gUIDArray)
                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 gUID)
                                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.

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.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] _ULARGE_INTEGERArray)
                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.

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 _boolean)
                            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[] intArray,
                            IBasicMap[] iBasicMapArray,
                            ILayer[] iLayerArray,
                            java.lang.Object[] objectArray,
                            java.lang.Object[] objectArray4)
                     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 object,
                       java.lang.Object object1)
                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.