org.eclipse.gef.palette
Class ToolEntry

java.lang.Object
  org.eclipse.gef.palette.PaletteEntry
      org.eclipse.gef.palette.ToolEntry

Direct Known Subclasses:

CreationToolEntry, MarqueeToolEntry, PanningSelectionToolEntry, SelectionToolEntry

public abstract class ToolEntry

extends PaletteEntry

A factory for returning Tools.

Field Summary

static java.lang.Object

PALETTE_TYPE_TOOL Type Identifier

Fields inherited from class org.eclipse.gef.palette.PaletteEntry

listeners, PALETTE_TYPE_UNKNOWN, PERMISSION_FULL_MODIFICATION, PERMISSION_HIDE_ONLY, PERMISSION_LIMITED_MODIFICATION, PERMISSION_NO_MODIFICATION, PROPERTY_DEFAULT, PROPERTY_DESCRIPTION, PROPERTY_LABEL, PROPERTY_LARGE_ICON, PROPERTY_PARENT, PROPERTY_SMALL_ICON, PROPERTY_TYPE, PROPERTY_VISIBLE

Constructor Summary

ToolEntry(java.lang.String label, java.lang.String shortDesc, org.eclipse.jface.resource.ImageDescriptor iconSmall, org.eclipse.jface.resource.ImageDescriptor iconLarge)
Creates a new ToolEntry.

Method Summary

abstract Tool

createTool() Handles the creation of a new Tool.

Methods inherited from class org.eclipse.gef.palette.PaletteEntry

addPropertyChangeListener, getDescription, getId, getLabel, getLargeIcon, getParent, getSmallIcon, getType, getUserModificationPermission, isVisible, removePropertyChangeListener, setDescription, setId, setLabel, setLargeIcon, setParent, setSmallIcon, setType, setUserModificationPermission, setVisible, toString

Methods inherited from class java.lang.Object

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

Field Detail

PALETTE_TYPE_TOOL

public static final java.lang.Object PALETTE_TYPE_TOOL

Type Identifier

Constructor Detail

ToolEntry

public ToolEntry(java.lang.String label,
                 java.lang.String shortDesc,
                 org.eclipse.jface.resource.ImageDescriptor iconSmall,
                 org.eclipse.jface.resource.ImageDescriptor iconLarge)

Creates a new ToolEntry. Any parameter can be null.

Parameters:

label - the entry's name

shortDesc - the entry's description

iconSmall - the entry's small icon

iconLarge - the entry's large icon

Method Detail

createTool

public abstract Tool createTool()

Handles the creation of a new Tool. Subclasses must implement.

Returns:

the new Tool