com.xmlmind.guiutil

Class ItemsSelector

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.xmlmind.guiutil.ItemsSelector

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ListSelectionListener

public class ItemsSelector
extends JPanel
implements ActionListener, ListSelectionListener

Panel which can be used to select multiple items from a list of objects.

Important the list of unselected objects is always automatically sorted, therefore such objects must implement interface Comparable. Note that the list of selected objects may be sorted by hand by the user.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected static Object[]	NO_ITEMS
protected JButton	selectButton
protected JList<Object>	selectedList
protected JButton	unselectButton
protected JList<Object>	unselectedList

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor and Description
ItemsSelector(int rows, int columns) Constructs a selector pane having specified size and options.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e) Not part of the public API.
protected static Object[]	appendItems(Object[] items, Object[] added)
protected void	cancelSelectable()
protected void	cancelUnselectable()
static Icon	getDefaultIcon() Returns the icon displayed by default by the selector dialog box.
Object[]	getItems() Returns the items contained in the the list of selected items.
protected static Object[]	getItems(JList<Object> list)
protected static Object[]	getItems(JList<Object> list, int[] indices)
protected void	itemsSelectable(int[] indices)
protected void	itemsUnselectable(int[] indices)
static String	joinItems(char separatorChar, Object... items) Equivalent to joinItems(Character.toString(separatorChar), items).
static String	joinItems(String separator, Object... items) Joins the string representations (that is, items[i].toString()) of the specified list items using specified separator.
protected static Object[]	removeItems(Object[] items, Object[] removed)
protected void	select()
static Object[]	selectItems(Component parentComponent, String title, ItemsSelector itemsSelector, Icon icon, String message) All lower-level alternative to selectItems(Component, String, Object[], Object[]).
static Object[]	selectItems(Component parentComponent, String title, Object[] allItems, Object[] selectedItems) Displays a dialog box containing a list of items.
void	setItems(Object[] allItems, Object[] selectedItems) Populates the selector pane with items.
void	setListCellRenderer(ListCellRenderer<Object> cellRenderer) Specifies a custom renderer for use by both the list of selected items and the list of unselected items.
protected static void	setListData(JList<Object> list, Object[] items)
protected void	unselect()
void	valueChanged(ListSelectionEvent e) Not part of the public API.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

selectedList

protected JList<Object> selectedList

selectButton

protected JButton selectButton

unselectButton

protected JButton unselectButton

unselectedList

protected JList<Object> unselectedList

NO_ITEMS

protected static final Object[] NO_ITEMS

Constructor Detail

ItemsSelector

public ItemsSelector(int rows,
                     int columns)

Constructs a selector pane having specified size and options.

Parameters:

rows - number of visible rows of both lists (that is, the list of selected items and the list of unselected items)

columns - number of visible columns of both lists

Method Detail

valueChanged

public void valueChanged(ListSelectionEvent e)

Not part of the public API.

Specified by:

valueChanged in interface ListSelectionListener

itemsSelectable

protected void itemsSelectable(int[] indices)

itemsUnselectable

protected void itemsUnselectable(int[] indices)

cancelUnselectable

protected void cancelUnselectable()

cancelSelectable

protected void cancelSelectable()

actionPerformed

public void actionPerformed(ActionEvent e)

Not part of the public API.

Specified by:

actionPerformed in interface ActionListener

select

protected void select()

setListData

protected static final void setListData(JList<Object> list,
                                        Object[] items)

getItems

protected static final Object[] getItems(JList<Object> list)

getItems

protected static final Object[] getItems(JList<Object> list,
                                         int[] indices)

removeItems

protected static final Object[] removeItems(Object[] items,
                                            Object[] removed)

appendItems

protected static final Object[] appendItems(Object[] items,
                                            Object[] added)

unselect

protected void unselect()

setListCellRenderer

public void setListCellRenderer(ListCellRenderer<Object> cellRenderer)

Specifies a custom renderer for use by both the list of selected items and the list of unselected items.

setItems

public void setItems(Object[] allItems,
                     Object[] selectedItems)

Populates the selector pane with items.

Parameters:

allItems - the list of items to choose from

selectedItems - suggested selection; may be null

getItems

public Object[] getItems()

Returns the items contained in the the list of selected items.

selectItems

public static Object[] selectItems(Component parentComponent,
                                   String title,
                                   Object[] allItems,
                                   Object[] selectedItems)

Displays a dialog box containing a list of items. Returns the items selected from this list.

Unlike ItemChooserDialog, this method can be used to select multiple items from a list.

Parameters:

parentComponent - the parent of dialog box

title - the title of the dialog box

allItems - the list of items to choose from

selectedItems - suggested selection; may be null

Returns:

selected items or null if operation has been canceled by user

getDefaultIcon

public static Icon getDefaultIcon()

Returns the icon displayed by default by the selector dialog box.

selectItems

public static Object[] selectItems(Component parentComponent,
                                   String title,
                                   ItemsSelector itemsSelector,
                                   Icon icon,
                                   String message)

All lower-level alternative to selectItems(Component, String, Object[], Object[]).

Parameters:

parentComponent - the parent of dialog box

title - the title of the dialog box

itemsSelector - a selector pane already configured and already populated with items

icon - an icon displayed at the left of itemsSelector. May be null.

message - a (possibly multi-line) message displayed at the top of itemsSelector. May be null.

Returns:

selected items or null if operation has been canceled by user

joinItems

public static String joinItems(char separatorChar,
                               Object... items)

Equivalent to joinItems(Character.toString(separatorChar), items).

joinItems

public static String joinItems(String separator,
                               Object... items)

Joins the string representations (that is, items[i].toString()) of the specified list items using specified separator.

Parameters:

separator - the string used to join items

items - the list of items to be joined

Returns:

a string where all list items have been joined