com.esri.arcgis.controls
Interface IToolbarControl

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IToolbarControl2

All Known Implementing Classes:

IToolbarControl2Proxy, IToolbarControlProxy, ToolbarBean, ToolbarControl

public interface IToolbarControl
extends java.io.Serializable

COM Interface 'IToolbarControl'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to members that control the ToolbarControl.' 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_NAME
static java.lang.String	DISPID_10_GET_NAME
static java.lang.String	DISPID_10_PUT_NAME
static java.lang.String	DISPID_11_GET_NAME
static java.lang.String	DISPID_11_PUT_NAME
static java.lang.String	DISPID_12_NAME
static java.lang.String	DISPID_13_GET_NAME
static java.lang.String	DISPID_13_PUTREF_NAME
static java.lang.String	DISPID_14_NAME
static java.lang.String	DISPID_15_GET_NAME
static java.lang.String	DISPID_15_PUT_NAME
static java.lang.String	DISPID_16_GET_NAME
static java.lang.String	DISPID_16_PUT_NAME
static java.lang.String	DISPID_17_GET_NAME
static java.lang.String	DISPID_17_PUT_NAME
static java.lang.String	DISPID_18_NAME
static java.lang.String	DISPID_19_NAME
static java.lang.String	DISPID_2_NAME
static java.lang.String	DISPID_20_NAME
static java.lang.String	DISPID_21_GET_NAME
static java.lang.String	DISPID_21_PUTREF_NAME
static java.lang.String	DISPID_22_GET_NAME
static java.lang.String	DISPID_22_PUT_NAME
static java.lang.String	DISPID_23_NAME
static java.lang.String	DISPID_24_GET_NAME
static java.lang.String	DISPID_24_PUT_NAME
static java.lang.String	DISPID_25_NAME
static java.lang.String	DISPID_26_GET_NAME
static java.lang.String	DISPID_27_GET_NAME
static java.lang.String	DISPID_27_PUT_NAME
static java.lang.String	DISPID_3_NAME
static java.lang.String	DISPID_4_NAME
static java.lang.String	DISPID_5_GET_NAME
static java.lang.String	DISPID_6_NAME
static java.lang.String	DISPID_7_GET_NAME
static java.lang.String	DISPID_8_GET_NAME
static java.lang.String	DISPID_8_PUTREF_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	IIDb7d4358d_3cbc_11d6_aa09_00104bb6fc1c
static int	xxDummy Deprecated. Internal use only

Method Summary

void	aboutBox() Displays a dialog of information about the ToolbarControl.
int	addItem(java.lang.Object item, int subType, int index, boolean beginGroup, int groupSpacing, int style) Adds an item to the ToolbarControl.
int	addMenuItem(java.lang.Object menu, int index, boolean beginGroup, int groupSpacing) Adds a menu item to the ToolbarControl.
int	addToolbarDef(java.lang.Object toolbarDef, int startIndex, boolean group, int groupSpacing, int style) Appends the contents of the toolbar definition, specified by Guid or ToolbarDef, to the toolbar control.
boolean	esri_isEnabled() Indicates whether the ToolbarControl can respond to user generated events.
void	esri_setEnabled(boolean pbool) Indicates whether the ToolbarControl can respond to user generated events.
int	find(java.lang.Object item) Returns the index of the first item containing the given command, menu or palette.
int	getAppearance() The appearance of the ToolbarControl.
int	getBorderStyle() The border style of the ToolbarControl.
java.lang.Object	getBuddy() The object that will have its current tool managed by the toolbar.
ICommandPool	getCommandPool() The command pool used by the ToolbarControl to manage command objects.
int	getCount() The number of items on the ToolbarControl.
ITool	getCurrentTool() The current tool of the buddy.
java.lang.Object	getCustomProperty() A property to associate data with a control.
int	getHWnd() Handle to the window associated with the ToolbarControl.
IToolbarItem	getItem(int index) Returns the item at the specified index from the ToolbarControl.
int	getItemAppearance() The appearance of the items on the ToolbarControl.
void	getItemRect(int index, int[] top, int[] left, int[] bottom, int[] right) Returns the dimensions of the item at the specified index.
int	getKeyIntercept() A property that specifies interception of key strokes that are normally handled by the container.
Picture	getMouseIcon() Custom mouse icon used if MousePointer is 99.
int	getMousePointer() The mouse pointer displayed over the ToolbarControl.
java.lang.Object	getObject() A property that returns the underlying control.
IOperationStack	getOperationStack() The operation stack used for undo and redo functionality.
int	getTextAlignment() The caption placement for all items on the ToolbarControl.
int	getUpdateInterval() The frequency in millisecs that update method is called on the ToolbarControl.
int	hitTest(int x, int y, boolean nearest) Returns the index of the item at the specified x and y coordinates.
boolean	isCustomize() Indicates if the ToolbarControl is in customize mode.
boolean	isLargeIcons() Indicates if large icons are shown on all items on the ToolbarControl.
boolean	isMenuTracking() Indicates if menu tracking is enabled on the ToolbarControl.
boolean	isToolTips() Indicates if the items tooltips are shown.
void	moveItem(int startIndex, int finalIndex) Moves an item from one index to another.
void	remove(int index) Removes the item at the specified index from the ToolbarControl.
void	removeAll() Removes all items from the ToolbarControl.
void	setAppearance(int pappearance) The appearance of the ToolbarControl.
void	setBorderStyle(int pstyle) The border style of the ToolbarControl.
void	setBuddyControl(java.lang.Object pToolbarBuddy) Sets a control to be a buddy of the toolbar, this control must support IToolbarBuddy.
void	setCommandPoolByRef(ICommandPool pVal) The command pool used by the ToolbarControl to manage command objects.
void	setCurrentToolByRef(ITool pVal) The current tool of the buddy.
void	setCustomize(boolean pVal) Indicates if the ToolbarControl is in customize mode.
void	setCustomProperty(java.lang.Object pVal) A property to associate data with a control.
void	setItemAppearance(int pappearance) The appearance of the items on the ToolbarControl.
void	setKeyIntercept(int pVal) A property that specifies interception of key strokes that are normally handled by the container.
void	setLargeIcons(boolean pVal) Indicates if large icons are shown on all items on the ToolbarControl.
void	setMenuTracking(boolean pVal) Indicates if menu tracking is enabled on the ToolbarControl.
void	setMouseIconByRef(Picture ppMouseIcon) Custom mouse icon used if MousePointer is 99.
void	setMousePointer(int ppointer) The mouse pointer displayed over the ToolbarControl.
void	setOperationStackByRef(IOperationStack operationStack) The operation stack used for undo and redo functionality.
void	setTextAlignment(int pVal) The caption placement for all items on the ToolbarControl.
void	setToolTips(boolean pVal) Indicates if the items tooltips are shown.
void	setUpdateInterval(int pVal) The frequency in millisecs that update method is called on the ToolbarControl.
void	update(int index, boolean fullUpdate) Updates the enabled state of the specified item or all items if an index of -1 is specified.

Field Detail

IIDb7d4358d_3cbc_11d6_aa09_00104bb6fc1c

static final int IIDb7d4358d_3cbc_11d6_aa09_00104bb6fc1c

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__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__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__520_PUT_NAME

static final java.lang.String DISPID__520_PUT_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__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__515_GET_NAME

static final java.lang.String DISPID__515_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_NAME

static final java.lang.String DISPID_1_NAME

See Also:

Constant Field Values

DISPID_2_NAME

static final java.lang.String DISPID_2_NAME

See Also:

Constant Field Values

DISPID_3_NAME

static final java.lang.String DISPID_3_NAME

See Also:

Constant Field Values

DISPID_4_NAME

static final java.lang.String DISPID_4_NAME

See Also:

Constant Field Values

DISPID_5_GET_NAME

static final java.lang.String DISPID_5_GET_NAME

See Also:

Constant Field Values

DISPID_6_NAME

static final java.lang.String DISPID_6_NAME

See Also:

Constant Field Values

DISPID_7_GET_NAME

static final java.lang.String DISPID_7_GET_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_PUTREF_NAME

static final java.lang.String DISPID_8_PUTREF_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_GET_NAME

static final java.lang.String DISPID_11_GET_NAME

See Also:

Constant Field Values

DISPID_11_PUT_NAME

static final java.lang.String DISPID_11_PUT_NAME

See Also:

Constant Field Values

DISPID_12_NAME

static final java.lang.String DISPID_12_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_PUTREF_NAME

static final java.lang.String DISPID_13_PUTREF_NAME

See Also:

Constant Field Values

DISPID_14_NAME

static final java.lang.String DISPID_14_NAME

See Also:

Constant Field Values

DISPID_15_GET_NAME

static final java.lang.String DISPID_15_GET_NAME

See Also:

Constant Field Values

DISPID_15_PUT_NAME

static final java.lang.String DISPID_15_PUT_NAME

See Also:

Constant Field Values

DISPID_16_GET_NAME

static final java.lang.String DISPID_16_GET_NAME

See Also:

Constant Field Values

DISPID_16_PUT_NAME

static final java.lang.String DISPID_16_PUT_NAME

See Also:

Constant Field Values

DISPID_17_GET_NAME

static final java.lang.String DISPID_17_GET_NAME

See Also:

Constant Field Values

DISPID_17_PUT_NAME

static final java.lang.String DISPID_17_PUT_NAME

See Also:

Constant Field Values

DISPID_18_NAME

static final java.lang.String DISPID_18_NAME

See Also:

Constant Field Values

DISPID_19_NAME

static final java.lang.String DISPID_19_NAME

See Also:

Constant Field Values

DISPID_20_NAME

static final java.lang.String DISPID_20_NAME

See Also:

Constant Field Values

DISPID_21_GET_NAME

static final java.lang.String DISPID_21_GET_NAME

See Also:

Constant Field Values

DISPID_21_PUTREF_NAME

static final java.lang.String DISPID_21_PUTREF_NAME

See Also:

Constant Field Values

DISPID_22_GET_NAME

static final java.lang.String DISPID_22_GET_NAME

See Also:

Constant Field Values

DISPID_22_PUT_NAME

static final java.lang.String DISPID_22_PUT_NAME

See Also:

Constant Field Values

DISPID_23_NAME

static final java.lang.String DISPID_23_NAME

See Also:

Constant Field Values

DISPID_24_GET_NAME

static final java.lang.String DISPID_24_GET_NAME

See Also:

Constant Field Values

DISPID_24_PUT_NAME

static final java.lang.String DISPID_24_PUT_NAME

See Also:

Constant Field Values

DISPID_25_NAME

static final java.lang.String DISPID_25_NAME

See Also:

Constant Field Values

DISPID_26_GET_NAME

static final java.lang.String DISPID_26_GET_NAME

See Also:

Constant Field Values

DISPID_27_GET_NAME

static final java.lang.String DISPID_27_GET_NAME

See Also:

Constant Field Values

DISPID_27_PUT_NAME

static final java.lang.String DISPID_27_PUT_NAME

See Also:

Constant Field Values

Method Detail

setBorderStyle

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

The border style of the ToolbarControl.

Parameters:

pstyle - 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 ToolbarControl.

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.

esri_setEnabled

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

Indicates whether the ToolbarControl can respond to user generated events.

Parameters:

pbool - The pbool (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 ToolbarControl can respond to user generated events.

Returns:

The pbool

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAppearance

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

The appearance of the ToolbarControl.

Parameters:

pappearance - 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.

getAppearance

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

The appearance of the ToolbarControl.

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.

setMousePointer

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

The mouse pointer displayed over the ToolbarControl.

Parameters:

ppointer - 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 ToolbarControl.

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

Custom mouse icon used if MousePointer is 99.

Parameters:

ppMouseIcon - 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.

getHWnd

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

Handle to the window associated with the ToolbarControl.

Returns:

The hWnd

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 ToolbarControl.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addItem

int addItem(java.lang.Object item,
            int subType,
            int index,
            boolean beginGroup,
            int groupSpacing,
            int style)
            throws java.io.IOException,
                   AutomationException

Adds an item to the ToolbarControl.

Parameters:

item - A Variant (in)

subType - The subType (in, optional, pass 0 if not required)

index - The index (in, optional, pass -1 if not required)

beginGroup - The beginGroup (in, optional, pass false if not required)

groupSpacing - The groupSpacing (in, optional, pass 0 if not required)

style - A com.esri.arcgis.systemUI.esriCommandStyles constant (in, optional, pass 1 if not required)

Returns:

The itemIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

remove

void remove(int index)
            throws java.io.IOException,
                   AutomationException

Removes the item at the specified index from the ToolbarControl.

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAll

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

Removes all items from the ToolbarControl.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getItem

IToolbarItem getItem(int index)
                     throws java.io.IOException,
                            AutomationException

Returns the item at the specified index from the ToolbarControl.

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.controls.IToolbarItem

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount

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

The number of items on the ToolbarControl.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

void update(int index,
            boolean fullUpdate)
            throws java.io.IOException,
                   AutomationException

Updates the enabled state of the specified item or all items if an index of -1 is specified. Specify fullUpdate to update the group, group spacing, style and bitmap properties.

Parameters:

index - The index (in, optional, pass -1 if not required)

fullUpdate - The fullUpdate (in, optional, pass false if not required)

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 that will have its current tool managed by the toolbar.

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.

getCurrentTool

ITool getCurrentTool()
                     throws java.io.IOException,
                            AutomationException

The current tool of the buddy.

Returns:

A reference to a com.esri.arcgis.systemUI.ITool

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCurrentToolByRef

void setCurrentToolByRef(ITool pVal)
                         throws java.io.IOException,
                                AutomationException

The current tool of the buddy.

Parameters:

pVal - A reference to a com.esri.arcgis.systemUI.ITool (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isToolTips

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

Indicates if the items tooltips are shown.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setToolTips

void setToolTips(boolean pVal)
                 throws java.io.IOException,
                        AutomationException

Indicates if the items tooltips are shown.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getItemAppearance

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

The appearance of the items on the ToolbarControl.

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.

setItemAppearance

void setItemAppearance(int pappearance)
                       throws java.io.IOException,
                              AutomationException

The appearance of the items on the ToolbarControl.

Parameters:

pappearance - 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.

getUpdateInterval

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

The frequency in millisecs that update method is called on the ToolbarControl.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUpdateInterval

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

The frequency in millisecs that update method is called on the ToolbarControl.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

find

int find(java.lang.Object item)
         throws java.io.IOException,
                AutomationException

Returns the index of the first item containing the given command, menu or palette. Returns -1 if the command is not found.

Parameters:

item - A Variant (in)

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCommandPool

ICommandPool getCommandPool()
                            throws java.io.IOException,
                                   AutomationException

The command pool used by the ToolbarControl to manage command objects. The command pool object maybe shared with other ToolbarControls and ToolbarMenus.

Returns:

A reference to a com.esri.arcgis.controls.ICommandPool

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCommandPoolByRef

void setCommandPoolByRef(ICommandPool pVal)
                         throws java.io.IOException,
                                AutomationException

The command pool used by the ToolbarControl to manage command objects. The command pool object maybe shared with other ToolbarControls and ToolbarMenus.

Parameters:

pVal - A reference to a com.esri.arcgis.controls.ICommandPool (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addToolbarDef

int addToolbarDef(java.lang.Object toolbarDef,
                  int startIndex,
                  boolean group,
                  int groupSpacing,
                  int style)
                  throws java.io.IOException,
                         AutomationException

Appends the contents of the toolbar definition, specified by Guid or ToolbarDef, to the toolbar control.

Parameters:

toolbarDef - A Variant (in)

startIndex - The startIndex (in, optional, pass -1 if not required)

group - The group (in, optional, pass false if not required)

groupSpacing - The groupSpacing (in, optional, pass 4 if not required)

style - A com.esri.arcgis.systemUI.esriCommandStyles constant (in, optional, pass 1 if not required)

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTextAlignment

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

The caption placement for all items on the ToolbarControl.

Returns:

A com.esri.arcgis.controls.esriToolbarTextAlignment constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTextAlignment

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

The caption placement for all items on the ToolbarControl.

Parameters:

pVal - A com.esri.arcgis.controls.esriToolbarTextAlignment constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLargeIcons

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

Indicates if large icons are shown on all items on the ToolbarControl.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLargeIcons

void setLargeIcons(boolean pVal)
                   throws java.io.IOException,
                          AutomationException

Indicates if large icons are shown on all items on the ToolbarControl.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCustomize

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

Indicates if the ToolbarControl is in customize mode.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomize

void setCustomize(boolean pVal)
                  throws java.io.IOException,
                         AutomationException

Indicates if the ToolbarControl is in customize mode.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

moveItem

void moveItem(int startIndex,
              int finalIndex)
              throws java.io.IOException,
                     AutomationException

Moves an item from one index to another.

Parameters:

startIndex - The startIndex (in)

finalIndex - The finalIndex (in, optional, pass -1 if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hitTest

int hitTest(int x,
            int y,
            boolean nearest)
            throws java.io.IOException,
                   AutomationException

Returns the index of the item at the specified x and y coordinates.

Parameters:

x - The x (in)

y - The y (in)

nearest - The nearest (in, optional, pass false if not required)

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getItemRect

void getItemRect(int index,
                 int[] top,
                 int[] left,
                 int[] bottom,
                 int[] right)
                 throws java.io.IOException,
                        AutomationException

Returns the dimensions of the item at the specified index.

Parameters:

index - The index (in)

top - The top (in/out: use single element array)

left - The left (in/out: use single element array)

bottom - The bottom (in/out: use single element array)

right - The right (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOperationStack

IOperationStack getOperationStack()
                                  throws java.io.IOException,
                                         AutomationException

The operation stack used for undo and redo functionality. If present commands can use it to store operations.

Returns:

A reference to a com.esri.arcgis.systemUI.IOperationStack

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOperationStackByRef

void setOperationStackByRef(IOperationStack operationStack)
                            throws java.io.IOException,
                                   AutomationException

The operation stack used for undo and redo functionality. If present commands can use it to store operations.

Parameters:

operationStack - A reference to a com.esri.arcgis.systemUI.IOperationStack (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 pVal)
                       throws java.io.IOException,
                              AutomationException

A property to associate data with a control.

Parameters:

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

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

Parameters:

pToolbarBuddy - 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.

isMenuTracking

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

Indicates if menu tracking is enabled on the ToolbarControl.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMenuTracking

void setMenuTracking(boolean pVal)
                     throws java.io.IOException,
                            AutomationException

Indicates if menu tracking is enabled on the ToolbarControl.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addMenuItem

int addMenuItem(java.lang.Object menu,
                int index,
                boolean beginGroup,
                int groupSpacing)
                throws java.io.IOException,
                       AutomationException

Adds a menu item to the ToolbarControl.

Parameters:

menu - A Variant (in)

index - The index (in, optional, pass -1 if not required)

beginGroup - The beginGroup (in, optional, pass false if not required)

groupSpacing - The groupSpacing (in, optional, pass 4 if not required)

Returns:

The itemIndex

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 pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setKeyIntercept

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

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

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.