com.esri.arcgis.systemUI
Class IToolPaletteProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.systemUI.IToolPaletteProxy

All Implemented Interfaces:

IToolPalette, Externalizable, Serializable

public class IToolPaletteProxy
extends com.esri.arcgis.interop.Dispatch
implements IToolPalette, Serializable

Tool palette.

Description

Tool palettes provide a compact way to group a related set of tools. The most recently used tool appears on the toolbar alongside a small drop-down button used to access other tools in the group. Like menus, tools that appear on tool palettes can come from built-in sources, add-in sources, or a combination of both.

When To Use

Use this interface to define the properties of a custom tool palette.

To create a tool palette, you need to implement the ICommand inteface and the IToolPalette interface in your class code.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

Fields inherited from interface com.esri.arcgis.systemUI.IToolPalette

IID, IID5678b14a_102b_493f_badb_1a83ae8a3830, xxDummy

Constructor Summary

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
int	getPaletteColumns() The Number of Columns to display
String	getPaletteItem(int pos) The CLSID for the item on this menu at the specified index.
int	getPaletteItemCount() The number of items in this menu.
boolean	isMenuStyle() The menu style
boolean	isTearOff() The tearoff style
void	removeListener(String iidStr, Object theListener)

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IToolPaletteProxy

public IToolPaletteProxy()

IToolPaletteProxy

public IToolPaletteProxy(Object obj)
                  throws IOException

Throws:

IOException

IToolPaletteProxy

protected IToolPaletteProxy(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 com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

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

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getPaletteItemCount

public int getPaletteItemCount()
                        throws IOException,
                               AutomationException

The number of items in this menu.

Specified by:

getPaletteItemCount in interface IToolPalette

Returns:

The numItems

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPaletteItem

public String getPaletteItem(int pos)
                      throws IOException,
                             AutomationException

The CLSID for the item on this menu at the specified index.

Specified by:

getPaletteItem in interface IToolPalette

Parameters:

pos - The pos (in)

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPaletteColumns

public int getPaletteColumns()
                      throws IOException,
                             AutomationException

The Number of Columns to display

Specified by:

getPaletteColumns in interface IToolPalette

Returns:

The columns

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMenuStyle

public boolean isMenuStyle()
                    throws IOException,
                           AutomationException

The menu style

Specified by:

isMenuStyle in interface IToolPalette

Returns:

The menu

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTearOff

public boolean isTearOff()
                  throws IOException,
                         AutomationException

The tearoff style

Specified by:

isTearOff in interface IToolPalette

Returns:

The tearOff

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.