com.esri.arcgis.beans.toolbar
Class ToolItem

java.lang.Object
  com.esri.arcgis.beans.toolbar.ToolItem

public class ToolItem
extends Object

A virtual tool item used in the toolbar design time.

Field Summary

static String	PKG_CLASS_SEPARATOR
static String	SEPARATOR
static ImageIcon	TOOL_BLANK
static ImageIcon	TOOL_ICON
static ImageIcon	TOOL_ICONTEXT
static ImageIcon	TOOL_TEXT

Constructor Summary

ToolItem()

ToolItem(String itemString)

ToolItem(String name, String className, String icon)
Constructs a ToolItem

Method Summary

protected String	debugToString() seriallizes the item object into a string for readable format
int	getCategory() A category the item belongs to.
String	getClassName() Returns the class name
String	getIconName() Sets the icon name
ImageIcon	getImageIcon() Returns the icon image the item represented
int	getIndex() Returns the position of item in the toolbar.
String	getName() Gets the tool item name
String	getPackageName() Returns the package name
int	getStyle() Returns the enumeration stlye integer.
String	getSubType() Returns the subtype
boolean	isBeginGroup() Returns true if the toolbar would begin to group.
String	serializeToString() seriallizes the item object into a string.
void	setBeginGroup(boolean group) Sets if the toolbar begins to group from the item.
void	setCategory(int category) Assign the item to a category.
void	setIndex(int index) Sets the position of item in the toolbar.
void	setPackageName(String pkg) Sets the package name
void	setStyle(int style) Sets the item display style
void	setSubType(String type) Sets the subtype
String	toString() Returns the tool name;

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SEPARATOR

public static final String SEPARATOR

See Also:

Constant Field Values

PKG_CLASS_SEPARATOR

public static final String PKG_CLASS_SEPARATOR

See Also:

Constant Field Values

TOOL_ICON

public static ImageIcon TOOL_ICON

TOOL_TEXT

public static ImageIcon TOOL_TEXT

TOOL_ICONTEXT

public static ImageIcon TOOL_ICONTEXT

TOOL_BLANK

public static ImageIcon TOOL_BLANK

Constructor Detail

ToolItem

public ToolItem()

ToolItem

public ToolItem(String name,
                String className,
                String icon)

Constructs a ToolItem

Parameters:

name - String - descriptive name

className - String - class name

icon - String - icon name

ToolItem

public ToolItem(String itemString)

Parameters:

itemString - String

Method Detail

getName

public String getName()

Gets the tool item name

Returns:

String

getClassName

public String getClassName()

Returns the class name

Returns:

String

getIconName

public String getIconName()

Sets the icon name

Returns:

String

setSubType

public void setSubType(String type)

Sets the subtype

Parameters:

type - String

getSubType

public String getSubType()

Returns the subtype

Returns:

String

setPackageName

public void setPackageName(String pkg)

Sets the package name

Parameters:

pkg - String

getPackageName

public String getPackageName()

Returns the package name

Returns:

String

setStyle

public void setStyle(int style)

Sets the item display style

Parameters:

style - int - an enumeration integer

See Also:

esriCommandStyles

getStyle

public int getStyle()

Returns the enumeration stlye integer.

Returns:

int an enumeration integer

setBeginGroup

public void setBeginGroup(boolean group)

Sets if the toolbar begins to group from the item.

Parameters:

group - boolean true/false

isBeginGroup

public boolean isBeginGroup()

Returns true if the toolbar would begin to group.

Returns:

boolean - true/false

setIndex

public void setIndex(int index)

Sets the position of item in the toolbar.

Parameters:

index - int a valid integer

getIndex

public int getIndex()

Returns the position of item in the toolbar.

Returns:

int an integer.

getCategory

public int getCategory()

A category the item belongs to.

Returns:

int an integer

setCategory

public void setCategory(int category)

Assign the item to a category.

Parameters:

category - int an integer

See Also:

ToolbarBeanConstants

getImageIcon

public ImageIcon getImageIcon()

Returns the icon image the item represented

Returns:

ImageIcon

serializeToString

public String serializeToString()

seriallizes the item object into a string.

Returns:

String - a string to represent the item object

toString

public String toString()

Returns the tool name;

Overrides:

toString in class Object

Returns:

String

debugToString

protected String debugToString()

seriallizes the item object into a string for readable format

Returns:

String - a string to represent the item object