org.opends.guitools.controlpanel.ui.components

Class DoubleAddRemovePanel<T>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.opends.guitools.controlpanel.ui.components.DoubleAddRemovePanel<T>

Type Parameters:

T - the type of the objects in the list.

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class DoubleAddRemovePanel<T>
extends JPanel

This component displays three list (one available list and two selected lists) with some buttons to move the components of one list to the other.

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
static int	DISPLAY_ADD_ALL Mask used as display option.
static int	DISPLAY_REMOVE_ALL Mask used as display option.

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

Constructors

Constructor and Description
DoubleAddRemovePanel(Class<T> theClass) Constructor of the default double add remove panel (including 'Add All' and 'Remove All' buttons).
DoubleAddRemovePanel(int displayOptions, Class<T> theClass) Constructor of the double add remove panel allowing the user to provide some display options.

Method Summary

Methods

Modifier and Type	Method and Description
JLabel	getAvailableLabel() Returns the available label contained in the panel.
JList	getAvailableList() Returns the available list.
SortableListModel<T>	getAvailableListModel() Returns the list of elements in the available list.
JLabel	getSelectedLabel1() Returns the first selected label contained in the panel.
JLabel	getSelectedLabel2() Returns the second selected label contained in the panel.
JList<T>	getSelectedList1() Returns the first selected list.
JList<T>	getSelectedList2() Returns the second selected list.
SortableListModel<T>	getSelectedListModel1() Returns the list of elements in the first selected list.
SortableListModel<T>	getSelectedListModel2() Returns the list of elements in the second selected list.
void	setEnabled(boolean enable) Enables the state of the components in the panel.
void	setUnmovableItems(Collection<T> unmovableItems) Sets the list of items that cannot be moved from one list to the others.

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

DISPLAY_REMOVE_ALL

public static final int DISPLAY_REMOVE_ALL

Mask used as display option. If the provided display options contain this mask, the panel will display the remove all button.

See Also:

Constant Field Values

DISPLAY_ADD_ALL

public static final int DISPLAY_ADD_ALL

Mask used as display option. If the provided display options contain this mask, the panel will display the add all button.

See Also:

Constant Field Values

Constructor Detail

DoubleAddRemovePanel

public DoubleAddRemovePanel(Class<T> theClass)

Constructor of the default double add remove panel (including 'Add All' and 'Remove All' buttons). The class is required to avoid warnings in compilation.

Parameters:

theClass - the class of the objects in the panel.

DoubleAddRemovePanel

public DoubleAddRemovePanel(int displayOptions,
                    Class<T> theClass)

Constructor of the double add remove panel allowing the user to provide some display options. The class is required to avoid warnings in compilation.

Parameters:

displayOptions - the display options.

theClass - the class of the objects in the panel.

Method Detail

setEnabled

public void setEnabled(boolean enable)

Enables the state of the components in the panel.

Overrides:

setEnabled in class JComponent

Parameters:

enable - whether to enable the components in the panel or not.

getAvailableLabel

public JLabel getAvailableLabel()

Returns the available label contained in the panel.

Returns:

the available label contained in the panel.

getAvailableListModel

public SortableListModel<T> getAvailableListModel()

Returns the list of elements in the available list.

Returns:

the list of elements in the available list.

getSelectedLabel1

public JLabel getSelectedLabel1()

Returns the first selected label contained in the panel.

Returns:

the first selected label contained in the panel.

getSelectedListModel1

public SortableListModel<T> getSelectedListModel1()

Returns the list of elements in the first selected list.

Returns:

the list of elements in the first selected list.

getSelectedLabel2

public JLabel getSelectedLabel2()

Returns the second selected label contained in the panel.

Returns:

the second selected label contained in the panel.

getSelectedListModel2

public SortableListModel<T> getSelectedListModel2()

Returns the list of elements in the second selected list.

Returns:

the list of elements in the second selected list.

getAvailableList

public JList getAvailableList()

Returns the available list.

Returns:

the available list.

getSelectedList1

public JList<T> getSelectedList1()

Returns the first selected list.

Returns:

the first selected list.

getSelectedList2

public JList<T> getSelectedList2()

Returns the second selected list.

Returns:

the second selected list.

setUnmovableItems

public void setUnmovableItems(Collection<T> unmovableItems)

Sets the list of items that cannot be moved from one list to the others.

Parameters:

unmovableItems - the list of items that cannot be moved from one list to the others.