qflib 0.99

de.qfs.lib.option
Class WizardDialog

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Window
              extended byjava.awt.Dialog
                  extended byjavax.swing.JDialog
                      extended byde.qfs.lib.gui.ModalDialog
                          extended byde.qfs.lib.option.OptionDialog
                              extended byde.qfs.lib.option.WizardDialog
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants, java.awt.event.WindowListener

public class WizardDialog
extends OptionDialog

This specialized OptionDialog is used to to display a sequence of Option panes which the user can travers with a "Next" and a "Back" button. To be useful at all, the main group of the dialog must be a WizardOptionGroup. By default the WizardDialog provides the buttons "Back", "Next" and "Cancel". If the first pane is displayed, the "Back" button is disabled and on the final pane the "Next" button changes to "Finish". The resources names for the "Back" and "Next" buttons are wizard.back and wizard.next. If you use custom buttons other than these you must* implement all the pane switching yourself. Please see the documentation of the OptionDialog and ModalDialog classes for the resources used.

Since:
0.99.0
Author:
Gregor Schmid
See Also:
Serialized Form

Nested Class Summary
protected  class WizardDialog.BackHandler
          Default ActionListener for the "Back" burron.
protected  class WizardDialog.NextHandler
          Default ActionListener for the "Next" burron.
 
Nested classes inherited from class de.qfs.lib.option.OptionDialog
OptionDialog.OptionButtonData
 
Nested classes inherited from class de.qfs.lib.gui.ModalDialog
ModalDialog.ButtonData
 
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
protected static java.lang.String[] wizardButtons
          The default button names.
 
Fields inherited from class de.qfs.lib.option.OptionDialog
optionGroup, options, parent, root
 
Fields inherited from class de.qfs.lib.gui.ModalDialog
buttons, CANCEL_OPTION, CLOSED_OPTION, defaultButtons, layout, mainComponent, mainPanel, minHeight, minWidth, name, NO_OPTION, OK_OPTION, panel, retval, YES_OPTION
 
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
 
Constructor Summary
WizardDialog(java.lang.String name, java.awt.Dialog parent, OptionSet options, java.lang.String root)
          Create a new WizardDialog.
WizardDialog(java.lang.String name, java.awt.Frame parent, OptionSet options, java.lang.String root)
          Create a new WizardDialog.
 
Method Summary
protected  java.awt.event.ActionListener createBackHandler()
          Create an action listener for the "Back" button.
protected  java.awt.event.ActionListener createNextHandler()
          Create an action listener for the "Next" button.
protected  void enableButtons()
          Enable/disable the buttons and update their labels according to the current pane.
 void init(MapResourceBundle rb)
          Initialize the dialog and the buttons.
protected  java.lang.String[] initButtonNames(MapResourceBundle rb)
          Get the names of the dialog's buttons.
 
Methods inherited from class de.qfs.lib.option.OptionDialog
actionPerformed, doModal, getGroup, getResult, initButton, initComponent, readValues, setParent, update
 
Methods inherited from class de.qfs.lib.gui.ModalDialog
buttonResName, doModal, findButton, fixSize, getButton, getButton, getButtonCount, resName, setInitialFocusTarget, setMainComponent, setResult, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened
 
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, dispose, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show
 
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, setVisible, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

wizardButtons

protected static final java.lang.String[] wizardButtons
The default button names.

Constructor Detail

WizardDialog

public WizardDialog(java.lang.String name,
                    java.awt.Frame parent,
                    OptionSet options,
                    java.lang.String root)
Create a new WizardDialog.

Parameters:
name - The resource name of the dialog.
parent - The parent Frame.
options - The Options to edit.
root - The resource name of the root of the OptionGroups. If null, the configurable name of the OptionSet will be used.
Since:
0.98.0

WizardDialog

public WizardDialog(java.lang.String name,
                    java.awt.Dialog parent,
                    OptionSet options,
                    java.lang.String root)
Create a new WizardDialog.

Parameters:
name - The resource name of the dialog.
parent - The parent Dialog.
options - The Options to edit.
root - The resource name of the root of the OptionGroups. If null, the configurable name of the OptionSet will be used.
Since:
0.98.0
Method Detail

init

public void init(MapResourceBundle rb)
Description copied from class: ModalDialog
Initialize the dialog and the buttons. This method is not called directly by the constructor to give the constructor of a derived class the chance to run first.

Overrides:
init in class ModalDialog
Parameters:
rb - The resources to use.

initButtonNames

protected java.lang.String[] initButtonNames(MapResourceBundle rb)
Get the names of the dialog's buttons. The default action is to read the names from the resources.

Overrides:
initButtonNames in class ModalDialog
Parameters:
rb - The resources to use.
Returns:
The button names.

createNextHandler

protected java.awt.event.ActionListener createNextHandler()
Create an action listener for the "Next" button.

Returns:
An action listener for the "Next" button.

createBackHandler

protected java.awt.event.ActionListener createBackHandler()
Create an action listener for the "Back" button.

Returns:
An action listener for the "Back" button.

enableButtons

protected void enableButtons()
Enable/disable the buttons and update their labels according to the current pane.


qflib 0.99