com.esri.arcgis.controls
Class IToolbarItem2Proxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.controls.IToolbarItemProxy
          com.esri.arcgis.controls.IToolbarItem2Proxy

All Implemented Interfaces:

IToolbarItem, IToolbarItem2, Externalizable, Serializable

public class IToolbarItem2Proxy
extends IToolbarItemProxy
implements IToolbarItem2, Serializable

Provides access to members that control ToolbarControl items.

Description

A ToolbarItem represents a Command, Tool, ToolControl, MultiItem, Menu or Palette on the ToolbarControl.

Product Availability

Available with ArcGIS Engine.

See Also:

Serialized Form

Field Summary

boolean

noncastable

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IToolbarItem2Proxy()
	IToolbarItem2Proxy(Object obj)
protected	IToolbarItem2Proxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
Object	getItemObject() The Command, Tool, ToolControl, ToolbarMenu, ToolbarPalette or MultiItem used by the item.
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	getType() The type of item
void	removeListener(String iidStr, Object theListener)

Methods inherited from class com.esri.arcgis.controls.IToolbarItemProxy

getCommand, getCustomProperty, getGroupSpacing, getMenu, getStyle, getUID, isGroup, setCustomProperty, setGroup, setGroupSpacing, setStyle

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

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

getCommand, getCustomProperty, getGroupSpacing, getMenu, getStyle, getUID, isGroup, setCustomProperty, setGroup, setGroupSpacing, setStyle

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IToolbarItem2Proxy

public IToolbarItem2Proxy()

IToolbarItem2Proxy

public IToolbarItem2Proxy(Object obj)
                   throws IOException

Throws:

IOException

IToolbarItem2Proxy

protected IToolbarItem2Proxy(Object obj,
                             String iid)
                      throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class IToolbarItemProxy

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class IToolbarItemProxy

Throws:

IOException

getPalette

public IToolbarPalette getPalette()
                           throws IOException,
                                  AutomationException

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

Description

Returns the IToolbarPalette used by the item if the item represents a palette. If the item does not use a palette Nothing is returned.

Product Availability

Available with ArcGIS Engine.

Specified by:

getPalette in interface IToolbarItem2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMultiItem

public IMultiItem getMultiItem()
                        throws IOException,
                               AutomationException

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

Description

Returns the IMultiItem object used by the item if the item represents a multi-item. If the item does not use a multi-item Nothing is returned.

Product Availability

Available with ArcGIS Engine.

Specified by:

getMultiItem in interface IToolbarItem2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException

The type of item

Description

Returns the type of object returned by ItemObject.

Product Availability

Available with ArcGIS Engine.

Specified by:

getType in interface IToolbarItem2

Returns:

A com.esri.arcgis.controls.esriToolbarItemType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemObject

public Object getItemObject()
                     throws IOException,
                            AutomationException

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

Description

Returns the ICommand, ITool, IToolControl, IMultiItem, IToolbarMenu2 or IToolbarPalette object from the ToolbarItem. Use the Type property to determine the type of object to be returned before using the ItemObject property.

Product Availability

Available with ArcGIS Engine.

Specified by:

getItemObject in interface IToolbarItem2

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.