OME
Class CheckboxChooser

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--OME.CheckboxChooser
Direct Known Subclasses:
RadioButtonChooser

public class CheckboxChooser
extends javax.swing.JDialog

This class is a dialog which displays a ChoicePanel containing a list of Choices that can be presented to a user who can then choose which choices should be chosen.

If one wishes to use the default Choice Panel in this class, one should pass in a Collection of Choices upon instatiation of this class. Alternatively if one wishes to provide thier own Choice Panel, then one should instead extend this class and override the getChoicePanel method in order to provide the new choice panel.

See Also:
Choice, Serialized Form

Inner Class Summary
protected  class CheckboxChooser.CheckboxChoiceListener
          This class acts as a checkbox listener which toggles the state of the Choice associated with the checkbox when its state is toggled.
 
Inner classes inherited from class javax.swing.JDialog
javax.swing.JDialog.AccessibleJDialog
 
Field Summary
static int CANCEL
          Return value: the user pressed CANCEL to close the dialog.
static int CONTINUE
          Return value: the user pressed CONTINUE to close the dialog.
 
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Constructor Summary
CheckboxChooser(java.awt.Frame owner, java.lang.String title, boolean modal)
          This constructor should be used when extending this class in order to provide a new choice panel.
CheckboxChooser(java.awt.Frame owner, java.lang.String title, boolean modal, java.util.Collection choices)
          This constructor should be used when using the default choice panel.
 
Method Summary
protected  void constructDialogue(javax.swing.JPanel choicepanel)
          This method creates the dialog given the choice panel.
 int showDialog()
          Shows the dialogue.
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, processKeyEvent, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setLocationRelativeTo, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Dialog
addNotify, dispose, getTitle, hide, isModal, isResizable, setModal, setResizable, setTitle, show
 
Methods inherited from class java.awt.Window
addWindowListener, applyResourceBundle, applyResourceBundle, finalize, getFocusOwner, getInputContext, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, isShowing, pack, postEvent, processEvent, removeWindowListener, setCursor, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFont, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processInputMethodEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CANCEL

public static final int CANCEL
Return value: the user pressed CANCEL to close the dialog.

CONTINUE

public static final int CONTINUE
Return value: the user pressed CONTINUE to close the dialog.
Constructor Detail

CheckboxChooser

public CheckboxChooser(java.awt.Frame owner,
                       java.lang.String title,
                       boolean modal,
                       java.util.Collection choices)
This constructor should be used when using the default choice panel.
Parameters:
owner - the Frame the dialogue is associated with.
title - the title of the dialogue.
modal - whether the dialogue should be modal (hog focus).
choices - the collection of Choices to be presented to the user.

CheckboxChooser

public CheckboxChooser(java.awt.Frame owner,
                       java.lang.String title,
                       boolean modal)
This constructor should be used when extending this class in order to provide a new choice panel.
Parameters:
owner - the Frame the dialogue is associated with.
title - the title of the dialogue.
modal - whether the dialogue should be modal (hog focus).
Method Detail

constructDialogue

protected void constructDialogue(javax.swing.JPanel choicepanel)
This method creates the dialog given the choice panel.
Parameters:
choicepanel - the choice panel containing the choices to be displayed.

showDialog

public int showDialog()
Shows the dialogue. The users selection of checkboxes will be reflected in the Collection of Choices passed in at construction time.
Returns:
CANCEL or CONTINUE depending on which button the user pressed to close the dialogue. (Returns CANCEL if user closed the dialogue by other means).