Package org.eclipse.gef.palette
Class PaletteEntry
java.lang.Object
org.eclipse.gef.palette.PaletteEntry
- Direct Known Subclasses:
PaletteContainer
,PaletteSeparator
,PaletteTemplateEntry
,ToolEntry
Root class (statically) for the palette model.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected PropertyChangeSupport
PropertyChangeSupportstatic final String
Type unknownstatic final int
All modifications allowed.static final int
Entries with this permission level can only be hidden/shown.static final int
Any property of entries with this level of permission can be changed; however, they cannot be deleted from the palette.static final int
No changes can be made to a PaletteEntry with this permission level.static final String
Property name for the entry's default stausstatic final String
Property name for the entry's descriptionstatic final String
Property name for the entry's label (name)static final String
Property name for the entry's large iconstatic final String
Property name for the entry's parentstatic final String
Property name for the entry's small iconstatic final String
Property name for the entry's typestatic final String
Property name for the entry's hidden status -
Constructor Summary
ConstructorsConstructorDescriptionPaletteEntry
(String label, String shortDescription) ConstructorPaletteEntry
(String label, String shortDescription, Object type) ConstructorPaletteEntry
(String label, String shortDescription, ImageDescriptor iconSmall, ImageDescriptor iconLarge) ConstructorPaletteEntry
(String label, String shortDescription, ImageDescriptor iconSmall, ImageDescriptor iconLarge, Object type) ConstructorPaletteEntry
(String label, String shortDescription, ImageDescriptor smallIcon, ImageDescriptor largeIcon, Object type, String id) Constructor -
Method Summary
Modifier and TypeMethodDescriptionvoid
A listener can only be added once.getId()
Returns the id.getLabel()
getType()
int
Returned values are from amongst the following: PERMISSION_NO_MODIFICATION PERMISSION_HIDE_ONLY PERMISSION_LIMITED_MODIFICATION PERMISSION_FULL_MODIFICATIONboolean
void
void
Mutator method for descriptionvoid
Sets the id.void
Mutator method for labelvoid
setLargeIcon
(ImageDescriptor icon) Mutator method for large iconvoid
setParent
(PaletteContainer newParent) Sets the parent of this entryvoid
setSmallIcon
(ImageDescriptor icon) Mutator method for small iconvoid
Mutator method for typevoid
setUserModificationPermission
(int permission) Permissions are not checked before making modifications.void
setVisible
(boolean newVal) Makes this entry visible or invisible.toString()
-
Field Details
-
PROPERTY_SMALL_ICON
Property name for the entry's small icon- See Also:
-
PROPERTY_TYPE
Property name for the entry's type- See Also:
-
PROPERTY_LARGE_ICON
Property name for the entry's large icon- See Also:
-
PROPERTY_LABEL
Property name for the entry's label (name)- See Also:
-
PROPERTY_DESCRIPTION
Property name for the entry's description- See Also:
-
PROPERTY_VISIBLE
Property name for the entry's hidden status- See Also:
-
PROPERTY_DEFAULT
Property name for the entry's default staus- See Also:
-
PROPERTY_PARENT
Property name for the entry's parent- See Also:
-
PALETTE_TYPE_UNKNOWN
Type unknown- See Also:
-
PERMISSION_NO_MODIFICATION
public static final int PERMISSION_NO_MODIFICATIONNo changes can be made to a PaletteEntry with this permission level.- See Also:
-
PERMISSION_HIDE_ONLY
public static final int PERMISSION_HIDE_ONLYEntries with this permission level can only be hidden/shown.- See Also:
-
PERMISSION_LIMITED_MODIFICATION
public static final int PERMISSION_LIMITED_MODIFICATIONAny property of entries with this level of permission can be changed; however, they cannot be deleted from the palette. The children PaletteContainers with this permission level can be reordered within that container (however, cross-container moving is not allowed).- See Also:
-
PERMISSION_FULL_MODIFICATION
public static final int PERMISSION_FULL_MODIFICATIONAll modifications allowed.- See Also:
-
listeners
PropertyChangeSupport
-
-
Constructor Details
-
PaletteEntry
ConstructorAny parameter can be
null
- Parameters:
label
- The entry's nameshortDescription
- The entry's description
-
PaletteEntry
ConstructorAny parameter can be
null
- Parameters:
label
- The entry's nameshortDescription
- The entry's descriptiontype
- The entry's type
-
PaletteEntry
public PaletteEntry(String label, String shortDescription, ImageDescriptor iconSmall, ImageDescriptor iconLarge) ConstructorAny parameter can be
null
- Parameters:
label
- The entry's nameshortDescription
- The entry's descriptioniconSmall
- The small icon to represent this entryiconLarge
- The large icon to represent this entry
-
PaletteEntry
public PaletteEntry(String label, String shortDescription, ImageDescriptor iconSmall, ImageDescriptor iconLarge, Object type) ConstructorAny parameter can be
null
- Parameters:
label
- The entry's nameshortDescription
- The entry's descriptioniconSmall
- The small icon to represent this entryiconLarge
- The large icon to represent this entrytype
- The entry's type
-
PaletteEntry
public PaletteEntry(String label, String shortDescription, ImageDescriptor smallIcon, ImageDescriptor largeIcon, Object type, String id) ConstructorAny parameter can be
null
- Parameters:
label
- The entry's nameshortDescription
- The entry's descriptionsmallIcon
- The small icon to represent this entrylargeIcon
- The large icon to represent this entrytype
- The entry's typeid
- The entry's id (preferrably unique)
-
-
Method Details
-
addPropertyChangeListener
A listener can only be added once. Adding it more than once will do nothing.- Parameters:
listener
- the PropertyChangeListener that is to be notified of changes- See Also:
-
getDescription
- Returns:
- a short desecription describing this entry.
-
getId
Returns the id. If no ID has been set (or it isnull
), an empty String will be returned.- Returns:
- String id
-
getLabel
- Returns:
- the label for this entry.
-
getLargeIcon
- Returns:
- a large icon representing this entry.
-
getParent
- Returns:
- the parent container of this entry
-
getSmallIcon
- Returns:
- a small icon representing the entry.
-
getType
- Returns:
- the type of this entry. Useful for different interpretations of the palette model.
-
getUserModificationPermission
public int getUserModificationPermission()Returned values are from amongst the following:- PERMISSION_NO_MODIFICATION
- PERMISSION_HIDE_ONLY
- PERMISSION_LIMITED_MODIFICATION
- PERMISSION_FULL_MODIFICATION
- Returns:
- the permission level for this entry.
- See Also:
-
isVisible
public boolean isVisible()- Returns:
- whether or not this entry is visible. An entry that is not visible is not shown on the palette.
-
removePropertyChangeListener
- Parameters:
listener
- the PropertyChangeListener that is not to be notified anymore- See Also:
-
setDescription
Mutator method for description- Parameters:
s
- The new description
-
setId
Sets the id. Can benull
.- Parameters:
id
- The new id to be set
-
setLabel
Mutator method for label- Parameters:
s
- The new name
-
setLargeIcon
Mutator method for large icon- Parameters:
icon
- The large icon to represent this entry
-
setParent
Sets the parent of this entry- Parameters:
newParent
- The parent PaletteContainer
-
setSmallIcon
Mutator method for small icon- Parameters:
icon
- The new small icon to represent this entry
-
setType
Mutator method for type- Parameters:
newType
- The new type
-
setUserModificationPermission
public void setUserModificationPermission(int permission) Permissions are not checked before making modifications. Clients should check the permission before invoking a modification. Sub-classes may extend the set of permissions. Current set has:- PERMISSION_NO_MODIFICATION
- PERMISSION_HIDE_ONLY
- PERMISSION_LIMITED_MODIFICATION
- PERMISSION_FULL_MODIFICATION
PERMISSION_FULL_MODIFICATION
- Parameters:
permission
- One of the above-specified permission levels
-
setVisible
public void setVisible(boolean newVal) Makes this entry visible or invisible. An invisible entry does not show up on the palette.- Parameters:
newVal
- The new boolean indicating whether the entry is visible or not
-
toString
-