com.esri.arcgis.controls
Interface IToolbarItem

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IToolbarItem2

All Known Implementing Classes:

IToolbarItem2Proxy, IToolbarItemProxy, ToolbarItem

public interface IToolbarItem
extends java.io.Serializable

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

Description: 'Provides access to members that control ToolbarControl items.' 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	IID Deprecated. Internal use only
static int	IIDd92bcf03_4308_11d6_aa0e_00104bb6fc1c
static int	xxDummy Deprecated. Internal use only

Method Summary

ICommand	getCommand() The command used by the item.
java.lang.Object	getCustomProperty() A property to associate data with an item.
int	getGroupSpacing() The width of the group separator in pixels if present.
IToolbarMenu	getMenu() If the item is a menu, this property is a ToolbarMenu object.
int	getStyle() The style of the item.
IUID	getUID() The UID of the command used by the item, which may be empty.
boolean	isGroup() Indicates if a group separator exists to the left of the item on the ToolbarControl.
void	setCustomProperty(java.lang.Object pVal) A property to associate data with an item.
void	setGroup(boolean pVal) Indicates if a group separator exists to the left of the item on the ToolbarControl.
void	setGroupSpacing(int pVal) The width of the group separator in pixels if present.
void	setStyle(int pVal) The style of the item.

Field Detail

IIDd92bcf03_4308_11d6_aa0e_00104bb6fc1c

static final int IIDd92bcf03_4308_11d6_aa0e_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

Method Detail

getCommand

ICommand getCommand()
                    throws java.io.IOException,
                           AutomationException

The command used by the item.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUID

IUID getUID()
            throws java.io.IOException,
                   AutomationException

The UID of the command used by the item, which may be empty.

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isGroup

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

Indicates if a group separator exists to the left of the item on the ToolbarControl.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGroup

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

Indicates if a group separator exists to the left of the item 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.

getGroupSpacing

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

The width of the group separator in pixels if present.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGroupSpacing

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

The width of the group separator in pixels if present.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStyle

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

The style of the item. Displays a combination of text caption and bitmap.

Returns:

A com.esri.arcgis.systemUI.esriCommandStyles constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStyle

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

The style of the item. Displays a combination of text caption and bitmap.

Parameters:

pVal - A com.esri.arcgis.systemUI.esriCommandStyles constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

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

A property to associate data with an item.

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 an item.

Parameters:

pVal - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMenu

IToolbarMenu getMenu()
                     throws java.io.IOException,
                            AutomationException

If the item is a menu, this property is a ToolbarMenu object.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.