com.tensegrity.gui.swing.dialog
Class OptionDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      com.tensegrity.gui.swing.dialog.BaseDialog
                          com.tensegrity.gui.swing.dialog.OptionDialog

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.event.ContainerListener, Evaluable, java.util.EventListener, java.awt.image.ImageObserver, java.awt.event.KeyListener, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class OptionDialog

extends BaseDialog

The OptionDialog class is a generic dialog implementation which enables you to quickly create a Dialog which lets users decide between several options.

Version:

$Id: OptionDialog.java,v 1.2 2004/07/21 14:56:22 GillesIachelini Exp $

Author:

GillesIachelini

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JDialog

javax.swing.JDialog.AccessibleJDialog

Nested classes inherited from class java.awt.Dialog

java.awt.Dialog.AccessibleAWTDialog

Nested classes inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, 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.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

Method Summary

static OptionDialog	createOptionDialog(UIManager uiManager, java.awt.Frame owner, java.lang.String keyTitle, java.lang.String keyDescription, java.lang.String header, java.lang.String[] options) Use this static method to create an OptionDialog.
static OptionDialog	createOptionDialog(UIManager uiManager, java.awt.Frame owner, java.lang.String keyTitle, java.lang.String keyDescription, java.lang.String header, java.lang.String[] options, java.lang.String dontAskAgain) Use this static method to create an OptionDialog.
boolean	dontAskAgain() Returns true if the user selects the "Don't ask this.." again option.
java.lang.String	getOption() Returns the current selected option.
protected void	init() Creates the basic panels for this dialog.
protected void	setDontAskAgain(java.lang.String text) Sets the text for the option to allow users to hide this option dialog in the future.
protected void	setHeader(java.lang.String header) Sets the header text for this dialog.
protected void	setOptions(java.lang.String[] options) Sets the options for this dialog.
boolean	wasCanceled() Returns true if the dialog was canceled.

Methods inherited from class com.tensegrity.gui.swing.dialog.BaseDialog

applyEvList, componentAdded, componentRemoved, dispose, getUIManager, installEvList, keyPressed, keyReleased, keyTyped, setDefaultResourceClassAndURL, setDescriptionText, setResourceClassAndURL, setTitleText, setVisible, show, show

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Dialog

addNotify, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, 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, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Method Detail

init

protected void init()

Creates the basic panels for this dialog. Those panels are initialized when setHeader(String) and setOptions(String[]) are called.

setHeader

protected void setHeader(java.lang.String header)

Sets the header text for this dialog. This is the text which appears right above the options.

Parameters:

header - the text to display as string.

setOptions

protected void setOptions(java.lang.String[] options)

Sets the options for this dialog. Options are specified by a list of String from which a user selects one.

Parameters:

options - the list of options.

getOption

public java.lang.String getOption()

Returns the current selected option. Note: This method doesn't return an index or constant identifier. It rather returns the string you previously used as option in the createOptionDialog(UIManager, Frame, String, String, String, String[]) call.

Returns:

the selected option string.

wasCanceled

public boolean wasCanceled()

Returns true if the dialog was canceled.

Returns:

a boolean to indicate whether the dialog was canceled.

dontAskAgain

public boolean dontAskAgain()

Returns true if the user selects the "Don't ask this.." again option.

Returns:

true if the option was selected.

setDontAskAgain

protected void setDontAskAgain(java.lang.String text)

Sets the text for the option to allow users to hide this option dialog in the future.

Parameters:

text - the text to use as a String.

createOptionDialog

public static OptionDialog createOptionDialog(UIManager uiManager,
                                              java.awt.Frame owner,
                                              java.lang.String keyTitle,
                                              java.lang.String keyDescription,
                                              java.lang.String header,
                                              java.lang.String[] options,
                                              java.lang.String dontAskAgain)

Use this static method to create an OptionDialog. Pass the required

Parameters:

uiManager - UIManager to obtain localized strings.

owner - the owner frame of the resulting dialog.

keyTitle - the GUI key for the dialog title.

keyDescription - the GUI key for the dialog description.

header - the header text to be placed above the options.

options - the list of options users can choose from.

dontAskAgain - In case you want CheckBox a la "Don't ask this again", "Use the selected option as default" or similar, you may pass a String for it.

Returns:

a new instance of OptionDialog.

createOptionDialog

public static OptionDialog createOptionDialog(UIManager uiManager,
                                              java.awt.Frame owner,
                                              java.lang.String keyTitle,
                                              java.lang.String keyDescription,
                                              java.lang.String header,
                                              java.lang.String[] options)

Use this static method to create an OptionDialog.

Parameters:

uiManager - UIManager to obtain localized strings.

owner - the owner frame of the resulting dialog.

keyTitle - the GUI key for the dialog title.

keyDescription - the GUI key for the dialog description.

header - the header text to be placed above the options.

options - the list of options users can choose from.

Returns:

a new instance of OptionDialog.