common.gui
Class SelectionListPanel

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended bycommon.gui.SelectionListPanel
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class SelectionListPanel
extends javax.swing.JPanel

A panel with two lists, allowing the user to move items between them. All methods ensure that an element cannot appear in both lists simultaneously.

Version:
$Revision: 1347 $ modified $Date: 2004-02-08 18:49:01 -0800 (Sun, 08 Feb 2004) $ by $Author: bemace $
Author:
mace
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
protected  ConstraintFactory cf
           
static int LEFT
          The constant referring to the left list
protected  ListPanel[] lists
           
protected  javax.swing.JButton moveLeft
           
protected  javax.swing.JButton moveRight
           
static int RIGHT
          The constant referring to the right list
protected  java.lang.String title
           
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
SelectionListPanel()
          Creates a basic panel.
 
Method Summary
protected  void addElement(int list, java.lang.Object element)
           
 java.lang.Object[] getSelectedValues(int list)
          Returns all selected values in the given list.
 java.lang.Object[] getValues(int list)
          Returns all values in the given list.
 void loadFromPropertyAsString(int list, java.lang.String propertyName)
           
protected  void moveElements(int srcList, int destList)
           
protected  int otherList(int list)
          Returns the list which is not the given list.
protected  boolean removeElement(int list, java.lang.Object element)
           
 void saveToPropertyAsString(int list, java.lang.String propertyName)
          Saves a list to a property array (first item stored in "propertyName.0").
 void setListContents(int list, java.lang.Object[] options)
          Sets the contents of a list to the given options.
 void setListLabel(int list, java.lang.String text)
          Sets the label for a list.
 void setTitle(java.lang.String text)
          Sets the title of the panel.
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

LEFT

public static final int LEFT
The constant referring to the left list

See Also:
Constant Field Values

RIGHT

public static final int RIGHT
The constant referring to the right list

See Also:
Constant Field Values

title

protected java.lang.String title

cf

protected ConstraintFactory cf

moveRight

protected javax.swing.JButton moveRight

moveLeft

protected javax.swing.JButton moveLeft

lists

protected ListPanel[] lists
Constructor Detail

SelectionListPanel

public SelectionListPanel()
Creates a basic panel. You will want to use the other methods to customize the panel before using it.

Method Detail

otherList

protected int otherList(int list)
Returns the list which is not the given list.


addElement

protected void addElement(int list,
                          java.lang.Object element)

removeElement

protected boolean removeElement(int list,
                                java.lang.Object element)

moveElements

protected void moveElements(int srcList,
                            int destList)

saveToPropertyAsString

public void saveToPropertyAsString(int list,
                                   java.lang.String propertyName)
Saves a list to a property array (first item stored in "propertyName.0"). All elements are treated as strings.

Parameters:
list - Description of the Parameter
propertyName - Description of the Parameter

loadFromPropertyAsString

public void loadFromPropertyAsString(int list,
                                     java.lang.String propertyName)

setTitle

public void setTitle(java.lang.String text)
Sets the title of the panel.

Parameters:
text - The new title value

setListLabel

public void setListLabel(int list,
                         java.lang.String text)
Sets the label for a list.

Parameters:
list - LEFT or RIGHT
text - The new list label

setListContents

public void setListContents(int list,
                            java.lang.Object[] options)
Sets the contents of a list to the given options.

Parameters:
list - LEFT or RIGHT
options - The new listContents value

getSelectedValues

public java.lang.Object[] getSelectedValues(int list)
Returns all selected values in the given list.

Parameters:
list - LEFT or RIGHT
Returns:
all selected values in the given list

getValues

public java.lang.Object[] getValues(int list)
Returns all values in the given list.

Parameters:
list - LEFT or RIGHT
Returns:
all values in the given list