org.PingOO.DLAI.lib.PWidget
Class ListViewer

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--org.PingOO.DLAI.lib.PWidget.PPanel
                                |
                                +--org.PingOO.DLAI.lib.PWidget.ListViewer

public class ListViewer
extends PPanel

Use internal frame to display a list for the final user.

Since:
PingOO 2.0
Version:
2.0
Author:
Fabrice Bouyé (bouye@cur-archamps.fr)
See Also:
PInternalFrame, Serialized Form

Inner Class Summary
protected  class ListViewer.ButtonActionListener
          Listener unsed whe one of the button is clicked.
protected  class ListViewer.ButtonListSelectionListener
          Selection listener used to activates the buttons whe the selection changes in the list.
 
Inner classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent, javax.swing.JComponent.IntVector, javax.swing.JComponent.KeyboardBinding, javax.swing.JComponent.KeyboardState
 
Inner classes inherited from class java.awt.Component
java.awt.Component.AWTTreeLock
 
Field Summary
protected  javax.swing.event.ListSelectionListener defaultSelectionListener
          The default list selection listener.
protected  PButton downButton
          Move the selected object bottomward.
protected  PList list
          The list used by this viewer.
private  PScrollPane scrollPane
          The scroll pane in which is displayed the list.
protected  PButton upButton
          Move the selected object upward.
 
Fields inherited from class org.PingOO.DLAI.lib.PWidget.PPanel
DEFAULT_LAYOUT, manager, module, toolTipKey
 
Fields inherited from class javax.swing.JPanel
defaultLayout, uiClassID
 
Fields inherited from class javax.swing.JComponent
_bounds, accessibleContext, alignmentX, alignmentY, ANCESTOR_USING_BUFFER, ancestorNotifier, autoscroller, border, changeSupport, clientProperties, flags, HAS_FOCUS, IS_DOUBLE_BUFFERED, IS_OPAQUE, IS_PAINTING_TILE, KEYBOARD_BINDINGS_KEY, listenerList, maximumSize, minimumSize, NEXT_FOCUS, paintImmediatelyClip, preferredSize, readObjectCallbacks, REQUEST_FOCUS_DISABLED, tmpRect, TOOL_TIP_TEXT_KEY, ui, uiClassID, UNDEFINED_CONDITION, vetoableChangeSupport, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Container
component, containerListener, containerSerializedDataVersion, dispatcher, layoutMgr, maxSize, ncomponents, serialVersionUID
 
Fields inherited from class java.awt.Component
actionListenerK, adjustmentListenerK, appContext, assert, background, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, changeSupport, componentListener, componentListenerK, componentOrientation, componentSerializedDataVersion, containerListenerK, cursor, dropTarget, enabled, eventMask, focusListener, focusListenerK, font, foreground, hasFocus, height, incRate, inputMethodListener, inputMethodListenerK, isInc, isPacked, itemListenerK, keyListener, keyListenerK, LEFT_ALIGNMENT, locale, LOCK, minSize, mouseListener, mouseListenerK, mouseMotionListener, mouseMotionListenerK, name, nameExplicitlySet, newEventsOnly, ownedWindowK, parent, peer, peerFont, popups, prefSize, RIGHT_ALIGNMENT, serialVersionUID, textListenerK, TOP_ALIGNMENT, valid, visible, width, windowListenerK, x, y
 
Constructor Summary
ListViewer(PList list)
          Creates a new instance of the list viewer.
ListViewer(PList list, boolean allowEditButtons)
          Creates a new instance of the list viewer.
ListViewer(java.lang.String tooltipKey, java.lang.String module)
          Creates a new instance of the list viewer with an empty list.
ListViewer(java.lang.String tooltipKey, java.lang.String module, PList list)
          Creates a new instance of the list viewer.
ListViewer(java.lang.String tooltipKey, java.lang.String module, PList list, boolean allowEditButtons)
          Creates a new instance of the list viewer.
 
Method Summary
 PList getList()
          Returns the list of this viewer.
 java.awt.Dimension getMaximumSize()
          Returns the maximum size of this component.
 java.awt.Dimension getMinimumSize()
          Returns the minimum size of this component.
 javax.swing.JViewport getViewport()
          Returns the viewport object that displays the scrollable contents.
private  void moveDown()
          Moves down the current selected item in the list.
private  void moveUp()
          Moves up the current selected item in the list.
 void removeList()
          Removes the list from this viewer.
 void setList(PList newList)
          Sets the list of this viewer.
 void setList(PList newList, boolean allowEditButtons)
          Sets the list of this viewer.
 
Methods inherited from class org.PingOO.DLAI.lib.PWidget.PPanel
getManager, getModule, getTextKey, getToolTipKey, setLocalizedText, setLocalizedToolTipText, setManager, setModule, updateFont, updateLanguage, updateLanguage
 
Methods inherited from class javax.swing.JPanel
, getAccessibleContext, getUIClassID, paramString, updateUI, writeObject
 
Methods inherited from class javax.swing.JComponent
_paintImmediately, addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, adjustPaintFlags, alwaysOnTop, bindingForKeyStroke, computeVisibleRect, computeVisibleRect, contains, createToolTip, enableSerialization, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperties, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getFlag, getGraphics, getHeight, getInsets, getInsets, getLocation, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, keyboardBindings, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paintWithBuffer, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyBindings, processKeyBindingsForAllComponents, processKeyEvent, processMouseMotionEvent, putClientProperty, readObject, rectangleIsObscured, registerKeyboardAction, registerKeyboardAction, registerWithKeyboardManager, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFlag, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, shouldDebugGraphics, superProcessMouseMotionEvent, unregisterKeyboardAction, unregisterWithKeyboardManager, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyOrientation, countComponents, deliverEvent, dispatchEventImpl, dispatchEventToSelf, doLayout, eventEnabled, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents_NoClientCode, getComponents, getLayout, getMouseEventTarget, getWindow, initIDs, insets, invalidate, invalidateTree, isAncestorOf, layout, lightweightPrint, list, list, locate, minimumSize, nextFocus, paintComponents, postProcessKeyEvent, postsOldMouseEvents, preferredSize, preProcessKeyEvent, print, printComponents, printOneComponent, processContainerEvent, processEvent, proxyEnableEvents, proxyRequestFocus, remove, remove, removeAll, removeContainerListener, setFocusOwner, setLayout, transferFocus, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, areInputMethodsEnabled, bounds, checkImage, checkImage, coalesceEvents, constructComponentName, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont_NoClientCode, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getNativeContainer, getParent_NoClientCode, getParent, getPeer, getSize, getToolkit, getToolkitImpl, getTreeLock, getWindowForObject, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, isEnabledImpl, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

scrollPane

private PScrollPane scrollPane
The scroll pane in which is displayed the list.

list

protected PList list
The list used by this viewer.

upButton

protected PButton upButton
Move the selected object upward.

downButton

protected PButton downButton
Move the selected object bottomward.

defaultSelectionListener

protected javax.swing.event.ListSelectionListener defaultSelectionListener
The default list selection listener.
Constructor Detail

ListViewer

public ListViewer(java.lang.String tooltipKey,
                  java.lang.String module)
Creates a new instance of the list viewer with an empty list.
Parameters:
tooltipKey - The key used to get the localized tool tip.
module - The module used to load localized resources.

ListViewer

public ListViewer(PList list)
Creates a new instance of the list viewer.
Parameters:
list - The list to add to this viewer.

ListViewer

public ListViewer(java.lang.String tooltipKey,
                  java.lang.String module,
                  PList list)
Creates a new instance of the list viewer.
Parameters:
tooltipKey - The key used to get the localized tool tip.
module - The module used to load localized resources.
list - The list to add to this viewer.

ListViewer

public ListViewer(PList list,
                  boolean allowEditButtons)
Creates a new instance of the list viewer.
Parameters:
list - The list to add to this viewer.
allowEditButtons - If true allows the up and down buttons to modify the order of the element in the list, if false the button will not appear.

ListViewer

public ListViewer(java.lang.String tooltipKey,
                  java.lang.String module,
                  PList list,
                  boolean allowEditButtons)
Creates a new instance of the list viewer.
Parameters:
tooltipKey - The key used to get the localized tool tip.
module - The module used to load localized resources.
list - The list to add to this viewer.
allowEditButtons - If true allows the up and down buttons to modify the order of the element in the list, if false the button will not appear.
Method Detail

getViewport

public javax.swing.JViewport getViewport()
Returns the viewport object that displays the scrollable contents.
Returns:
The viewport object that displays the scrollable contents.

getMaximumSize

public java.awt.Dimension getMaximumSize()
Returns the maximum size of this component.
Returns:
The maximum size of this component.
Overrides:
getMaximumSize in class javax.swing.JComponent

getMinimumSize

public java.awt.Dimension getMinimumSize()
Returns the minimum size of this component.
Returns:
The minimum size of this component.
Overrides:
getMinimumSize in class javax.swing.JComponent

setList

public void setList(PList newList)
Sets the list of this viewer.
Parameters:
newList - The new list to display.

setList

public void setList(PList newList,
                    boolean allowEditButtons)
Sets the list of this viewer.
Parameters:
newList - The new list to display.
allowEditButtons - If true allows the up and down buttons to modify the order of the element in the list, if false the button will not appear.

getList

public PList getList()
Returns the list of this viewer.
Returns:
The list of this viewer or null if this viewer has no list.

removeList

public void removeList()
Removes the list from this viewer.

moveUp

private final void moveUp()
Moves up the current selected item in the list.

moveDown

private final void moveDown()
Moves down the current selected item in the list.