org.opensourcephysics.controls
Class ListChooser

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Dialog
                  extended by javax.swing.JDialog
                      extended by org.opensourcephysics.controls.ListChooser
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class ListChooser
extends javax.swing.JDialog

This modal dialog lets the user choose any number of items from a supplied list. Items not selected are removed from the list.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JDialog
javax.swing.JDialog.AccessibleJDialog
 
Nested classes/interfaces inherited from class java.awt.Dialog
java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType
 
Nested classes/interfaces inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
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.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Dialog
DEFAULT_MODALITY_TYPE
 
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
ListChooser(java.lang.String title, java.lang.String text)
          Constructs a dialog with the specified title and text.
ListChooser(java.lang.String title, java.lang.String text, java.awt.Component owner)
          Constructs a dialog with the specified title, text and owner.
ListChooser(java.lang.String title, java.lang.String text, javax.swing.JDialog owner)
          Constructs a dialog with the specified title, text and owner.
 
Method Summary
 boolean choose(java.util.Collection<?> choices, java.util.Collection<java.lang.String> names)
          Allows the user to choose from the supplied list.
 boolean choose(java.util.Collection<?> choices, java.util.Collection<java.lang.String> names, java.util.Collection<?> values)
          Allows the user to choose from the supplied list.
 boolean choose(java.util.Collection<?> choices, java.util.Collection<java.lang.String> names, java.util.Collection<?> values, boolean[] selected)
          Allows the user to choose from the supplied list.
 boolean choose(java.util.Collection<?> choices, java.util.Collection<java.lang.String> names, java.util.Collection<?> values, boolean[] selected, boolean[] disabled)
          Allows the user to choose from the supplied list.
 void createGUI()
          Constructs a dialog with the specified title, text and owner.
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
 
Methods inherited from class java.awt.Dialog
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, setVisible, show, toBack
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ListChooser

public ListChooser(java.lang.String title,
                   java.lang.String text)
Constructs a dialog with the specified title and text.

Parameters:
title - the title of the dialog
text - the label text

ListChooser

public ListChooser(java.lang.String title,
                   java.lang.String text,
                   java.awt.Component owner)
Constructs a dialog with the specified title, text and owner.

Parameters:
title - the title of the dialog
text - the label text
owner - the component that owns the dialog (may be null)

ListChooser

public ListChooser(java.lang.String title,
                   java.lang.String text,
                   javax.swing.JDialog owner)
Constructs a dialog with the specified title, text and owner.

Parameters:
title - the title of the dialog
text - the label text
owner - the component that owns the dialog (may be null)
Method Detail

createGUI

public void createGUI()
Constructs a dialog with the specified title, text and owner.

Parameters:
title - the title of the dialog
text - the label text
owner - the component that owns the dialog (may be null)

choose

public boolean choose(java.util.Collection<?> choices,
                      java.util.Collection<java.lang.String> names)
Allows the user to choose from the supplied list. Items not selected are removed from the list.

Parameters:
choices - a collection of objects to choose from
names - an optional collection of descriptive names
Returns:
true if OK button was clicked

choose

public boolean choose(java.util.Collection<?> choices,
                      java.util.Collection<java.lang.String> names,
                      java.util.Collection<?> values)
Allows the user to choose from the supplied list. Items not selected are removed from the list.

Parameters:
choices - a collection of objects to choose from
names - an optional collection of descriptive names
values - an optional collection of values
Returns:
true if OK button was clicked

choose

public boolean choose(java.util.Collection<?> choices,
                      java.util.Collection<java.lang.String> names,
                      java.util.Collection<?> values,
                      boolean[] selected)
Allows the user to choose from the supplied list. Items not selected are removed from the list.

Parameters:
choices - a collection of objects to choose from
names - an optional collection of descriptive names
values - an optional collection of values
selected - an array of initially selected states
Returns:
true if OK button was clicked

choose

public boolean choose(java.util.Collection<?> choices,
                      java.util.Collection<java.lang.String> names,
                      java.util.Collection<?> values,
                      boolean[] selected,
                      boolean[] disabled)
Allows the user to choose from the supplied list. Items not selected are removed from the list.

Parameters:
choices - a collection of objects to choose from
names - an optional collection of descriptive names
values - an optional collection of values
selected - an array of initially selected states
disabled - an array of disabled states (true = disabled)
Returns:
true if OK button was clicked