org.gswing.components.common.gui
Class ListDisplay

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JInternalFrame
                  org.gswing.gui.GuiComponent
                      org.gswing.gui.ModalInternalFrame
                          org.gswing.components.common.gui.ListDisplay

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants, IComponent, IGuiComponent

Direct Known Subclasses:

RegionListDisplay

public class ListDisplay
extends ModalInternalFrame

Modal dialog box containing a list of strings, a message and an OK and cancel button. Once the OK button (or the return key) has been selected the current selection is assigned. The selected can be accessed with getSelection(). If there is no selected field or if cancel is selected getSelection() will return null.

See Also:

Serialized Form

Nested Class Summary

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

JInternalFrame.AccessibleJInternalFrame, JInternalFrame.JDesktopIcon

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.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected JPanel

buttonPanel Panel containing the displaye buttons

Fields inherited from class javax.swing.JInternalFrame

closable, CONTENT_PANE_PROPERTY, desktopIcon, FRAME_ICON_PROPERTY, frameIcon, GLASS_PANE_PROPERTY, iconable, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, isClosed, isIcon, isMaximum, isSelected, LAYERED_PANE_PROPERTY, maximizable, MENU_BAR_PROPERTY, resizable, ROOT_PANE_PROPERTY, rootPane, rootPaneCheckingEnabled, title, TITLE_PROPERTY

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

ListDisplay(IFramework framework, String title, String message, ListModel model)
Constructor for single selections in the list.

ListDisplay(IFramework framework, String title, String message, ListModel model, int selectionMode)
Constructor.

ListDisplay(IFramework framework, String title, String message, Object[] model)
Constructor for single selections in the list.

ListDisplay(IFramework framework, String title, String message, Vector model)
Constructor for single selections in the list.

ListDisplay(IFramework framework, String title, String message, Vector model, int selectionMode)
Constructor for multiple selections in the list.

Method Summary

Object	getSelectedValue() Gets the selected value.
Object[]	getSelectedValues() Gets the selected values.
protected void	init(String message, Object[] model, int selectionMode) Initialise the dialogue.
protected void	init(String message, Object model, int selectionMode) Initialise the dialogue.

Methods inherited from class org.gswing.gui.ModalInternalFrame

internalFrameClosing, setVisible

Methods inherited from class org.gswing.gui.GuiComponent

actionPerformed, getDesktopManager, getFocusedComponent, getFramework, initialise, initialise, setDefaultButton, setFocusedComponent

Methods inherited from class javax.swing.JInternalFrame

addImpl, addInternalFrameListener, createRootPane, dispose, doDefaultCloseAction, fireInternalFrameEvent, getAccessibleContext, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getFocusCycleRootAncestor, getFocusOwner, getFrameIcon, getGlassPane, getInternalFrameListeners, getJMenuBar, getLayer, getLayeredPane, getMenuBar, getMostRecentFocusOwner, getNormalBounds, getRootPane, getTitle, getUI, getUIClassID, getWarningString, hide, isClosable, isClosed, isFocusCycleRoot, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isRootPaneCheckingEnabled, isSelected, moveToBack, moveToFront, pack, paintComponent, paramString, remove, removeInternalFrameListener, reshape, restoreSubcomponentFocus, setClosable, setClosed, setContentPane, setDefaultCloseOperation, setDesktopIcon, setFocusCycleRoot, setFrameIcon, setGlassPane, setIcon, setIconifiable, setJMenuBar, setLayer, setLayer, setLayeredPane, setLayout, setMaximizable, setMaximum, setMenuBar, setNormalBounds, setResizable, setRootPane, setRootPaneCheckingEnabled, setSelected, setTitle, setUI, show, toBack, toFront, 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, 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, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, 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, 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, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, 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, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

buttonPanel

protected JPanel buttonPanel

Panel containing the displaye buttons

Constructor Detail

ListDisplay

public ListDisplay(IFramework framework,
                   String title,
                   String message,
                   ListModel model)

Constructor for single selections in the list.

Parameters:

framework - The main framework object.

title - The title of the dialogue.

message - The message in the dialogue.

model - The list of strings.

ListDisplay

public ListDisplay(IFramework framework,
                   String title,
                   String message,
                   Vector model)

Constructor for single selections in the list.

Parameters:

framework - The main framework object.

title - The title of the dialogue.

message - The message in the dialogue.

model - The list of strings.

ListDisplay

public ListDisplay(IFramework framework,
                   String title,
                   String message,
                   Vector model,
                   int selectionMode)

Constructor for multiple selections in the list.

Parameters:

framework - The main framework object.

title - The title of the dialogue.

message - The message in the dialogue.

model - The list of strings.

selectionMode - ListSelectionModel.MULTIPLE_INTERVAL_SELECTION, ListSelectionModel.SINGLE_INTERVAL_SELECTION or ListSelectionModel.SINGLE_SELECTION

ListDisplay

public ListDisplay(IFramework framework,
                   String title,
                   String message,
                   Object[] model)

Constructor for single selections in the list.

Parameters:

framework - The main framework object.

title - The title of the dialogue.

message - The message in the dialogue.

model - The list of strings.

ListDisplay

public ListDisplay(IFramework framework,
                   String title,
                   String message,
                   ListModel model,
                   int selectionMode)

Constructor.

Parameters:

framework - The main framework object.

title - The title of the dialogue.

message - The message in the dialogue.

model - The list of strings.

selectionMode - ListSelectionModel.MULTIPLE_INTERVAL_SELECTION, ListSelectionModel.SINGLE_INTERVAL_SELECTION or ListSelectionModel.SINGLE_SELECTION

Method Detail

init

protected void init(String message,
                    Object model,
                    int selectionMode)

Initialise the dialogue.

Parameters:

message - The dialogue message.

model - The tree model.

selectionMode - Determine whether single-item or multiple-item selections are allowed. @see JList.setSelectionMode()#.

init

protected void init(String message,
                    Object[] model,
                    int selectionMode)

Initialise the dialogue.

Parameters:

message - The dialogue message.

model - The tree model as an array.

selectionMode - Determine whether single-item or multiple-item selections are allowed. @see JList.setSelectionMode().

getSelectedValue

public Object getSelectedValue()

Gets the selected value. If there was no selected value or if cancel was entered, this will return null.

Returns:

Returns the selection.

getSelectedValues

public Object[] getSelectedValues()

Gets the selected values. If there was no selected value or if cancel was entered, this will return null.

Returns:

Returns the selection.