com.esri.arcgis.controls
Class ToolbarItem

java.lang.Object
  com.esri.arcgis.controls.ToolbarItem

All Implemented Interfaces:

IToolbarItem, IToolbarItem2, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class ToolbarItem
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IToolbarItem, IToolbarItem2, ISupportErrorInfo

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

Description 'ToolbarItems used by 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 =

See Also:

Serialized Form

Field Summary

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

IID, IID728f73d0_7556_407c_ad67_028050693a56, xxDummy

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

IIDd92bcf03_4308_11d6_aa0e_00104bb6fc1c

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

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

ToolbarItem(java.lang.Object obj)
Construct a ToolbarItem using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
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.
java.lang.Object	getItemObject() The Command, Tool, ToolControl, ToolbarMenu, ToolbarPalette or MultiItem used by the item.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IToolbarMenu	getMenu() If the item is a menu, this property is a ToolbarMenu object.
IMultiItem	getMultiItem() If the item is a multi-item, this property is a MultiItem object.
IToolbarPalette	getPalette() If the item is a palette, this property is a ToolbarPalette object.
int	getStyle() The style of the item.
int	getType() The type of item
IUID	getUID() The UID of the command used by the item, which may be empty.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isGroup() Indicates if a group separator exists to the left of the item on the ToolbarControl.
void	release() Release a ToolbarItem.
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ToolbarItem

public ToolbarItem(java.lang.Object obj)
            throws java.io.IOException

Construct a ToolbarItem using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ToolbarItem.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ToolbarItem o = (ToolbarItem)obj; // will not work

ToolbarItem o = new ToolbarItem(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems ToolbarItem theToolbarItem = (ToolbarItem) obj;

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode 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

release

public void release()

Release a ToolbarItem.

Specified by:

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

getCommand

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

The command used by the item.

Specified by:

getCommand in interface IToolbarItem

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

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

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

Specified by:

getUID in interface IToolbarItem

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

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

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

Specified by:

isGroup in interface IToolbarItem

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGroup

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

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

Specified by:

setGroup in interface IToolbarItem

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGroupSpacing

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

The width of the group separator in pixels if present.

Specified by:

getGroupSpacing in interface IToolbarItem

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGroupSpacing

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

The width of the group separator in pixels if present.

Specified by:

setGroupSpacing in interface IToolbarItem

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStyle

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

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

Specified by:

getStyle in interface IToolbarItem

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

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

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

Specified by:

setStyle in interface IToolbarItem

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

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

A property to associate data with an item.

Specified by:

getCustomProperty in interface IToolbarItem

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

A property to associate data with an item.

Specified by:

setCustomProperty in interface IToolbarItem

Parameters:

pVal - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMenu

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

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

Specified by:

getMenu in interface IToolbarItem

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.

getPalette

public IToolbarPalette getPalette()
                           throws java.io.IOException,
                                  AutomationException

If the item is a palette, this property is a ToolbarPalette object.

Specified by:

getPalette in interface IToolbarItem2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMultiItem

public IMultiItem getMultiItem()
                        throws java.io.IOException,
                               AutomationException

If the item is a multi-item, this property is a MultiItem object.

Specified by:

getMultiItem in interface IToolbarItem2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws java.io.IOException,
                   AutomationException

The type of item

Specified by:

getType in interface IToolbarItem2

Returns:

A com.esri.arcgis.controls.esriToolbarItemType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getItemObject

public java.lang.Object getItemObject()
                               throws java.io.IOException,
                                      AutomationException

The Command, Tool, ToolControl, ToolbarMenu, ToolbarPalette or MultiItem used by the item.

Specified by:

getItemObject in interface IToolbarItem2

Returns:

A reference to another Object (IUnknown)

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.