Eclipse GEF
2.1

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

public class PaletteContainer
extends PaletteEntry

Default implementation of PaletteContainer


Field Summary
protected  List children
          This container's contents
static String PROPERTY_CHILDREN
          Property name indicating that this PaletteContainer's children have changed
 
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
protected PaletteContainer(String label, String desc, ImageDescriptor icon, Object type)
          Constructor that sets the container's label and small icon
 
Method Summary
 void add(int index, PaletteEntry entry)
          Adds the given PaletteEntry at position index.
 void add(PaletteEntry entry)
          Adds the given entry to the end of this PaletteContainer
 void addAll(List list)
          Adds the list of PaletteEntry objects to this PaletteContainer.
 List getChildren()
           
 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 PaletteContainer
 void setChildren(List list)
          Sets the children of this PaletteContainer to the given list of PaletteEntry objects.
 String toString()
           
 
Methods inherited from class org.eclipse.gef.palette.PaletteEntry
addPropertyChangeListener, getDescription, getLabel, getLargeIcon, getParent, getSmallIcon, getType, getUserModificationPermission, isVisible, removePropertyChangeListener, setDescription, setLabel, setLargeIcon, setParent, setSmallIcon, setType, setUserModificationPermission, setVisible
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PROPERTY_CHILDREN

public static final String PROPERTY_CHILDREN
Property name indicating that this PaletteContainer's children have changed

See Also:
Constant Field Values

children

protected List children
This container's contents

Constructor Detail

PaletteContainer

protected PaletteContainer(String label,
                           String desc,
                           ImageDescriptor icon,
                           Object type)
Constructor that sets the container's label and small icon

See Also:
PaletteEntry.PaletteEntry(String, String, ImageDescriptor, ImageDescriptor, Object)
Method Detail

add

public void add(PaletteEntry entry)
Adds the given entry to the end of this PaletteContainer

Parameters:
entry - the PaletteEntry to add

add

public void add(int index,
                PaletteEntry entry)
Adds the given PaletteEntry at position index.

Parameters:
index - position to add the PaletteEntry
entry - the PaletteEntry to add

addAll

public void addAll(List list)
Adds the list of PaletteEntry objects to this PaletteContainer.

Parameters:
list - a list of PaletteEntry objects to add to this PaletteContainer

getChildren

public List getChildren()
Returns:
the children of this container

moveDown

public boolean moveDown(PaletteEntry entry)
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

public boolean moveUp(PaletteEntry entry)
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

public void remove(PaletteEntry entry)
Removes the given PaletteEntry from this PaletteContainer

Parameters:
entry - the PaletteEntry to remove

setChildren

public void setChildren(List list)
Sets the children of this PaletteContainer to the given list of PaletteEntry objects.

Parameters:
list - the list of children

toString

public String toString()
Overrides:
toString in class PaletteEntry
See Also:
Object.toString()

Eclipse GEF
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.