Package org.eclipse.gef.palette
Class ToolEntry
- java.lang.Object
-
- org.eclipse.gef.palette.PaletteEntry
-
- org.eclipse.gef.palette.ToolEntry
-
- Direct Known Subclasses:
CreationToolEntry
,MarqueeToolEntry
,SelectionToolEntry
public abstract class ToolEntry extends PaletteEntry
A factory for returning Tools.
-
-
Field Summary
Fields Modifier and Type Field Description 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
Constructors Constructor Description ToolEntry(java.lang.String label, java.lang.String shortDesc, ImageDescriptor iconSmall, ImageDescriptor iconLarge)
Creates a new ToolEntry.ToolEntry(java.lang.String label, java.lang.String description, ImageDescriptor iconSmall, ImageDescriptor iconLarge, java.lang.Class tool)
Constructor to create a new ToolEntry.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Tool
createTool()
Creates the tool of the type specified bysetToolClass(Class)
for this ToolEntry.protected java.util.Map
getToolProperties()
java.lang.Object
getToolProperty(java.lang.Object key)
Returns the property value for the specified property key.void
setToolClass(java.lang.Class toolClass)
Sets the type of tool to be created.void
setToolProperty(java.lang.Object key, java.lang.Object value)
Clients can use this method to configure the associated tool without having to sub-class.-
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
-
-
-
-
Constructor Detail
-
ToolEntry
public ToolEntry(java.lang.String label, java.lang.String shortDesc, ImageDescriptor iconSmall, ImageDescriptor iconLarge)
Creates a new ToolEntry. Any parameter can benull
.- Parameters:
label
- the entry's nameshortDesc
- the entry's descriptioniconSmall
- the entry's small iconiconLarge
- the entry's large icon
-
ToolEntry
public ToolEntry(java.lang.String label, java.lang.String description, ImageDescriptor iconSmall, ImageDescriptor iconLarge, java.lang.Class tool)
Constructor to create a new ToolEntry. Any parameter can benull
.- Parameters:
label
- the entry's namedescription
- the entry's descriptioniconSmall
- the entry's small iconiconLarge
- the entry's large icontool
- the type of tool that this entry uses- Since:
- 3.1
-
-
Method Detail
-
createTool
public Tool createTool()
Creates the tool of the type specified bysetToolClass(Class)
for this ToolEntry. The tool is also configured with the properties set insetToolProperty(Object, Object)
. Sub-classes overriding this method should ensure that their tools are also configured with those properties.- Returns:
- the tool for this entry
-
getToolProperties
protected java.util.Map getToolProperties()
- Returns:
- the properties set in
setToolProperty(Object, Object)
- Since:
- 3.1
-
getToolProperty
public java.lang.Object getToolProperty(java.lang.Object key)
Returns the property value for the specified property key.- Parameters:
key
- the property key- Returns:
- the value for the requested property
- Since:
- 3.1
-
setToolClass
public void setToolClass(java.lang.Class toolClass)
Sets the type of tool to be created. This provides clients with a method of specifying a different type of tool to be created without having to sub-class. The provided class should have a default constructor for this to work successfully.- Parameters:
toolClass
- the type of tool to be created by this entry- Since:
- 3.1
-
setToolProperty
public void setToolProperty(java.lang.Object key, java.lang.Object value)
Clients can use this method to configure the associated tool without having to sub-class.- Parameters:
key
- the property namevalue
- a value of type associated with the given property- Since:
- 3.1
- See Also:
Tool.setProperties(Map)
-
-