org.eclipse.gef.palette
Class CreationToolEntry

java.lang.Object
  extended byorg.eclipse.gef.palette.PaletteEntry
      extended byorg.eclipse.gef.palette.ToolEntry
          extended byorg.eclipse.gef.palette.CreationToolEntry
Direct Known Subclasses:
CombinedTemplateCreationEntry, ConnectionCreationToolEntry

public class CreationToolEntry
extends ToolEntry

A palette ToolEntry for a CreationTool.

Since:
2.1

Field Summary
protected  CreationFactory factory
          The creation factory used with the returned creation tool.
 
Fields inherited from class org.eclipse.gef.palette.ToolEntry
PALETTE_TYPE_TOOL
 
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
CreationToolEntry(java.lang.String label, java.lang.String shortDesc, CreationFactory factory, org.eclipse.jface.resource.ImageDescriptor iconSmall, org.eclipse.jface.resource.ImageDescriptor iconLarge)
          Constructor for CreationToolEntry.
 
Method Summary
 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

factory

protected final CreationFactory factory
The creation factory used with the returned creation tool.

Constructor Detail

CreationToolEntry

public CreationToolEntry(java.lang.String label,
                         java.lang.String shortDesc,
                         CreationFactory factory,
                         org.eclipse.jface.resource.ImageDescriptor iconSmall,
                         org.eclipse.jface.resource.ImageDescriptor iconLarge)
Constructor for CreationToolEntry.

Parameters:
label - the label
shortDesc - the description
factory - the CreationFactory
iconSmall - the small icon
iconLarge - the large icon
Method Detail

createTool

public Tool createTool()
Description copied from class: ToolEntry
Handles the creation of a new Tool. Subclasses must implement.

Specified by:
createTool in class ToolEntry
Returns:
the new Tool
See Also:
ToolEntry.createTool()