Skip navigation links

com.essbase.eas.ui
Class ListMoverPanel

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
com.essbase.eas.ui.ListMoverPanel

All Implemented Interfaces:

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

public class ListMoverPanel

extends javax.swing.JPanel

extends the JPanel class to contain 2 (two) list boxes, provides mechanisms to move items between each of the list, retrieve the items in each list, items that were moved from list A to list B, and items moved from list B to list A.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

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

ListMoverPanel()

ListMoverPanel(int hgapBtwBtns, int vgapBtwBtns)

ListMoverPanel(javax.swing.JList sel, javax.swing.JList av)

ListMoverPanel(javax.swing.JList sel, javax.swing.JList av, int hgapBtwBtns, int vgapBtwBtns)

Method Summary

protected void	addAllToSelected()
protected void	addItemToModel(javax.swing.DefaultListModel m, java.lang.Object obj)
protected void	addToSelected()
void	dispose()
java.lang.Object[]	getAvailableItems() returns an array of all of the items in the available list.
javax.swing.JComponent[]	getFocusControls()
java.awt.Component	getInitialComponent() This method is used to determine the component that is the first one to receive focus.
boolean	getMassMoveAvailable()
java.lang.Object[]	getNewlyAvailableItems() returns an array of all the items in the available list that weren't originally there.
java.lang.Object[]	getNewlySelectedItems() returns an array of all the items in the selected list that weren't originally there.
java.lang.Object[]	getSelectedItems() returns an array containing all of the items in the selected list.
boolean	isItemMoved()
boolean	isModified() returns true if the lists don't contain exactly the same members they started with.
protected void	removeAllFromSelected()
protected void	removeFromSelected()
void	setAvailableItems(java.util.List list) sets the list of items that are "available".
void	setAvailableItems(java.lang.Object[] items)
void	setAvailableLabel(javax.swing.JLabel value) This method is used to set titles for the available, list.
void	setAvailableTitle(java.lang.String value) sets the title for the available list box.
void	setFocusToList(boolean selectedList) sets the focus to the available control if the parameter is true; to the selected control if the parameter is false.
void	setItemMoved(boolean value)
void	setItemsCollated(boolean value) sets whether items added are collated or not; if this is set to true, then item.toString() will be called to determine its collation order.
void	setMassMoveAvailable(boolean value) sets whether the "<<" and ">>" buttons should be available to the user.
void	setRenderer(javax.swing.ListCellRenderer cellRenderer) sets the renderer for both of the list boxes; we presume that the same renderer can be used for both sets of lists.
void	setSelectedItems(java.util.List list) sets the list of items that are "selected".
void	setSelectedItems(java.lang.Object[] items)
void	setSelectedLabel(javax.swing.JLabel value) This method is used to set titles for the selected, list.
void	setSelectedTitle(java.lang.String value) sets the title for the selected list box.
void	useCurrentListsAsOriginal() Copies the state of the current lists into the record of the old lists.

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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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, 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, hide, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

ListMoverPanel

public ListMoverPanel()

ListMoverPanel

public ListMoverPanel(javax.swing.JList sel,
                      javax.swing.JList av)

ListMoverPanel

public ListMoverPanel(int hgapBtwBtns,
                      int vgapBtwBtns)

ListMoverPanel

public ListMoverPanel(javax.swing.JList sel,
                      javax.swing.JList av,
                      int hgapBtwBtns,
                      int vgapBtwBtns)

Method Detail

addItemToModel

protected void addItemToModel(javax.swing.DefaultListModel m,
                              java.lang.Object obj)

getAvailableItems

public java.lang.Object[] getAvailableItems()

returns an array of all of the items in the available list.

getNewlyAvailableItems

public java.lang.Object[] getNewlyAvailableItems()

returns an array of all the items in the available list that weren't originally there. Note: Depending on how you are using this control, you may need to call useCurrentListsAsOriginal() to reset the recording of list changes.

getNewlySelectedItems

public java.lang.Object[] getNewlySelectedItems()

returns an array of all the items in the selected list that weren't originally there. Note: Depending on how you are using this control, you may need to call useCurrentListsAsOriginal() to reset the recording of list changes.

useCurrentListsAsOriginal

public void useCurrentListsAsOriginal()

Copies the state of the current lists into the record of the old lists. This effectively re-starts the record of list changes. In general, this method should be called after using the getNewlySelectedItems and getNewlyAvailableItems methods.

getSelectedItems

public java.lang.Object[] getSelectedItems()

returns an array containing all of the items in the selected list.

getMassMoveAvailable

public boolean getMassMoveAvailable()

isModified

public boolean isModified()

returns true if the lists don't contain exactly the same members they started with.

setMassMoveAvailable

public void setMassMoveAvailable(boolean value)

sets whether the "<<" and ">>" buttons should be available to the user.

setItemsCollated

public void setItemsCollated(boolean value)

sets whether items added are collated or not; if this is set to true, then item.toString() will be called to determine its collation order.

setSelectedItems

public void setSelectedItems(java.util.List list)

sets the list of items that are "selected".

setSelectedItems

public void setSelectedItems(java.lang.Object[] items)

setAvailableItems

public void setAvailableItems(java.util.List list)

sets the list of items that are "available".

setAvailableItems

public void setAvailableItems(java.lang.Object[] items)

setRenderer

public void setRenderer(javax.swing.ListCellRenderer cellRenderer)

sets the renderer for both of the list boxes; we presume that the same renderer can be used for both sets of lists. If this method isn't called, the ListMoverPanel will use the default renderer.

setAvailableTitle

public void setAvailableTitle(java.lang.String value)

sets the title for the available list box.

setAvailableLabel

public void setAvailableLabel(javax.swing.JLabel value)

This method is used to set titles for the available, list. This method is used to set the mnemonic correctly.

Parameters:

value -

setSelectedTitle

public void setSelectedTitle(java.lang.String value)

sets the title for the selected list box.

setSelectedLabel

public void setSelectedLabel(javax.swing.JLabel value)

This method is used to set titles for the selected, list. This method is used to set the mnemonic correctly.

Parameters:

value -

setFocusToList

public void setFocusToList(boolean selectedList)

sets the focus to the available control if the parameter is true; to the selected control if the parameter is false.

getFocusControls

public javax.swing.JComponent[] getFocusControls()

getInitialComponent

public java.awt.Component getInitialComponent()

This method is used to determine the component that is the first one to receive focus.

isItemMoved

public boolean isItemMoved()

setItemMoved

public void setItemMoved(boolean value)

addToSelected

protected void addToSelected()

addAllToSelected

protected void addAllToSelected()

removeFromSelected

protected void removeFromSelected()

removeAllFromSelected

protected void removeAllFromSelected()

dispose

public void dispose()

Skip navigation links