com.ca.commons.cbutil
Class CBListSelector

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--com.ca.commons.cbutil.CBDialog
                                      |
                                      +--com.ca.commons.cbutil.CBListSelector

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class CBListSelector

extends CBDialog

This class acts as a item selector. It sets up a dialog that lets you select items from one list and add them to another list. It also allows you to remove selected items from the list.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JDialog

javax.swing.JDialog.AccessibleJDialog

Nested classes inherited from class java.awt.Dialog

java.awt.Dialog.AccessibleAWTDialog

Nested classes inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

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

Fields inherited from class com.ca.commons.cbutil.CBDialog

buttonPanel, Cancel, display, Help, OK, owner

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

CBListSelector(java.awt.Frame owner, java.lang.String[] list, java.lang.String title)
Sets up a dialog with two lists.

Method Summary

void	add() Gets the selected item from the list on the left and adds it to the list on the right.
java.util.ArrayList	getSelectedValues() Returns a list of the values that the user has selected.
static java.util.ArrayList	getSelectedValues(java.awt.Frame owner, java.lang.String[] list, java.lang.String title) Static method that should be used rather than creating an object directly if you wish to get the user input after the user has finished making selections and has closed the window.
protected void	registerMouseListeners() Adds a double click mouse listener to both lists in this dialog.
void	remove() Removes the selected item from the list on the left.

Methods inherited from class com.ca.commons.cbutil.CBDialog

add, addln, doCancel, doOK, escKeyCheck, getDisplayPanel, makeHeavy, makeLight, makeWide, quit, setHelpLink, wasCancelled

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Dialog

addNotify, dispose, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CBListSelector

public CBListSelector(java.awt.Frame owner,
                      java.lang.String[] list,
                      java.lang.String title)

Sets up a dialog with two lists. The list on the left displays all available values that the user can select from. When the user selects a value it is displayed in the list on the right either by double clicking on the value or clicking the '>>' button. The user can also remove a value from the selection list either by double clicking on it or clicking the '<<' button.

Parameters:

owner - the parent frame (usally JXplorer).

list - the strings that are to appear in the list on the left of the dialog.

title - the words that will appear in the title bar of the dialog.

Method Detail

getSelectedValues

public static java.util.ArrayList getSelectedValues(java.awt.Frame owner,
                                                    java.lang.String[] list,
                                                    java.lang.String title)

Static method that should be used rather than creating an object directly if you wish to get the user input after the user has finished making selections and has closed the window.

This method creates a CBListSelector object and calls its 'show' method. When the user is finished with the dialog this method returns the user's selections.

Parameters:

owner - the parent frame (usally JXplorer).

list - the strings that are to appear in the list on the left of the dialog.

title - the words that will appear in the title bar of the dialog.

Returns:

a list of user selections.

registerMouseListeners

protected void registerMouseListeners()

Adds a double click mouse listener to both lists in this dialog. If the double click occurs in the list on the left, the 'add' method is called. If the double click occurs in the list on the right, the remove method is called.

add

public void add()

Gets the selected item from the list on the left and adds it to the list on the right. It uses a global array list to keep track of the selections in the right hand list.

remove

public void remove()

Removes the selected item from the list on the left. It uses a global array list to keep track of the selections in the right hand list.

getSelectedValues

public java.util.ArrayList getSelectedValues()

Returns a list of the values that the user has selected.

Returns:

a list of the values that the user has selected.