Package org.eclipse.gef.palette
Class PaletteContainer
java.lang.Object
org.eclipse.gef.palette.PaletteEntry
org.eclipse.gef.palette.PaletteContainer
- Direct Known Subclasses:
PaletteDrawer
,PaletteGroup
,PaletteRoot
,PaletteStack
,PaletteToolbar
Default implementation of PaletteContainer
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected List<PaletteEntry>
This container's contentsstatic final String
Property name indicating that this PaletteContainer's children have changedFields 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
ConstructorsModifierConstructorDescriptionprotected
PaletteContainer
(String label, String desc, ImageDescriptor icon, Object type) Constructor -
Method Summary
Modifier and TypeMethodDescriptionboolean
acceptsType
(Object type) Returns true if this type can be a child of this container.void
add
(int index, PaletteEntry entry) Adds the given PaletteEntry at positionindex
.void
add
(PaletteEntry entry) Adds the given entry to the end of this PaletteContainervoid
addAll
(List<PaletteEntry> list) Adds the list ofPaletteEntry
objects to this PaletteContainer.void
appendToSection
(String id, PaletteEntry entry) Appends the given entry after the entry with the given id, but before the next separator.boolean
moveDown
(PaletteEntry entry) Moves the given entry down, if possible.boolean
moveUp
(PaletteEntry entry) Moves the given entry up, if possible.void
remove
(PaletteEntry entry) Removes the given PaletteEntry from this PaletteContainervoid
setChildren
(List<PaletteEntry> list) Sets the children of this PaletteContainer to the given list ofPaletteEntry
objects.toString()
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
-
Field Details
-
PROPERTY_CHILDREN
Property name indicating that this PaletteContainer's children have changed- See Also:
-
children
This container's contents
-
-
Constructor Details
-
PaletteContainer
ConstructorAny parameter can be
null
.- Parameters:
label
- The container's namedesc
- The container's descriptionicon
- The small icon to represent this containertype
- The container's type
-
-
Method Details
-
acceptsType
Returns true if this type can be a child of this container.- Parameters:
type
- the type being requested- Returns:
- true if this can be a child of this container
-
add
Adds the given entry to the end of this PaletteContainer- Parameters:
entry
- the PaletteEntry to add
-
add
Adds the given PaletteEntry at positionindex
.- Parameters:
index
- position to add the PaletteEntryentry
- the PaletteEntry to add
-
addAll
Adds the list ofPaletteEntry
objects to this PaletteContainer.- Parameters:
list
- a list of PaletteEntry objects to add to this PaletteContainer
-
appendToSection
Appends the given entry after the entry with the given id, but before the next separator.- Parameters:
id
- the id of the entry to append afterentry
- the entry to add
-
getChildren
- Returns:
- the children of this container
-
moveDown
Moves the given entry down, if possible. This method only handles moving the child within this container.- Parameters:
entry
- The entry to be moved- Returns:
true
if the given entry was successfully moved down
-
moveUp
Moves the given entry up, if possible. This method only handles moving the child within this container.- Parameters:
entry
- The entry to be moved- Returns:
true
if the given entry was successfully moved up
-
remove
Removes the given PaletteEntry from this PaletteContainer- Parameters:
entry
- the PaletteEntry to remove
-
setChildren
Sets the children of this PaletteContainer to the given list ofPaletteEntry
objects.- Parameters:
list
- the list of children
-
toString
- Overrides:
toString
in classPaletteEntry
- See Also:
-