com.lf.commons.wizard

Class WizardDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

com.lf.commons.wizard.WizardDialog

All Implemented Interfaces:

ConfigurableUnit, java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

Direct Known Subclasses:

BackupCreateWizard, BackupRestoreWizard, JoomlaAccessWizard, PGPEncryptWizard, PGPExportWizard, PGPGenKeyWizard, PGPImportWizard

public class WizardDialog
extends javax.swing.JDialog
implements java.awt.event.ActionListener, ConfigurableUnit

Implements commonly used wizard functionality for applications.

Add a starting page and set the dialog visible. The next page is then acquired from the current page. Pages may build a static sequence that the user has to process, then the full overview is presented. If at least one page has multiple possible next pages then the mode is set to dynamic and the overview can only present the pages shown so far.

In order to avoid inifinite loops with recycled pages one single page may only be used once. If a page is provided multiple times as next page then an excepion is thrown.

Since:

1.6

Version:

$Revision: 1.12 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

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, java.awt.Window.Type

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

Modifier and Type	Field and Description
static int	BUTTON_BACK Placeholder for the "Back" button.
static int	BUTTON_CANCEL The user decided to cancel the button, also when escaped.
static int	BUTTON_FINISH The steps have been fully processed.
static int	BUTTON_NEXT Placeholder for the "Next" button.
protected javax.swing.JButton	buttonBack_I18N
protected javax.swing.JButton	buttonCancel_I18N
protected javax.swing.JButton	buttonFinish_I18N
protected javax.swing.JButton	buttonHelp
protected javax.swing.JButton	buttonNext_I18N
protected int	exitButton Remembers the exit button.
protected java.util.Hashtable<WizardPage,java.util.Vector<WizardPageListener>>	listeners Container holding page listeners for the pages.
protected int	mode Remembers the type of page sequence to be shown.
static int	MODE_DYNAMIC The page sequence is dynamic with overview for recently shown pages.
static int	MODE_STATIC The page sequence is fixed with a complete overview.
protected java.util.Vector<WizardPage>	sequence Cache for the page sequence when in static mode.
protected java.util.Stack<WizardPage>	stack Cache for the recently shown pages.
protected WizardPage	startingPage Remembers the starting page to be displayed first.
protected StatusBar	statusBar

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

Constructors

Constructor and Description
WizardDialog() Constructor method for the dialog (modeless).
WizardDialog(java.awt.Dialog owner) Constructor method for the dialog.
WizardDialog(java.awt.Frame owner) Constructor method for the dialog.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Reacts on component interaction.
void	addWizardPageListener(WizardPage page, WizardPageListener listener) Adds a listener reacting on page state changes (add, becomes shown etc.).
void	allowConfirmOnKeyStroke(int strokeval) Adds a keyboard action to click the "Next"/"Finish" button if enabled.
void	allowEscapeOnKeyStroke(int strokeval) Adds a keyboard action to escape (close) the dialog (e.g. on escape).
void	clickButton(int button) Clicks a wizard button.
void	configureUnit(java.lang.String id, Configuration config) Restores values from persistent data stores.
protected void	finalize() Clean-up method to help the gc.
WizardPage	getCurrentPage() Provides the currently displayed wizard page instance if available.
int	getExitButton() Provides the exit button.
WizardPage	getPreviousPage() Provides the previously displayed wizard page instance if available.
WizardPage[]	getPreviousPages() Provides the previously displayed wizard page instances if available.
StatusBar	getStatusBar() Provides the status bar component.
boolean	isButtonEnabled(int button) Provides the state of a wizard button.
void	removeLookAndFeelListener(WizardPage page, WizardPageListener listener) Removes a listener reacting on page state changes (add, becomes shown etc.).
void	setButtonEnabled(int button, boolean enabled) Sets the state of a wizard button.
void	setDividerLocation(int location) Adjusts the divider location.
void	setEnabledBack(boolean enabled) Enables/disables the "Back" button.
void	setEnabledCancel(boolean enabled) Enables/disables the "Cancel" button.
void	setEnabledFinish(boolean enabled) Enables/disables the "Finish" button.
void	setEnabledNext(boolean enabled) Enables/disables the "Next" button.
void	setHelpID(java.lang.String helpid) Sets the optional help link to call the help system.
void	setOverviewText(java.lang.String text) Sets the text of the overview list header.
void	setStartingPage(WizardPage page) Sets the starting page to be displayed first.
void	setVisible(boolean visible) Activates or deactivates the dialog.
protected void	showPage(WizardPage newpage, WizardPage oldpage) Starts the wizard by showing the initial page.
void	storeUnit(java.lang.String id, Configuration config) Stores the current configuration values persistently.
void	unitRegistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was registered with a model.
void	unitUnregistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was unregistered with a model.
protected void	updateOverview() Updates the overview labels based on the current stack.
void	updatePageIcon() The icon of the current page has changed.

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, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, 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, 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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, 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, 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, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

MODE_STATIC

public static final int MODE_STATIC

The page sequence is fixed with a complete overview.

See Also:

Constant Field Values

MODE_DYNAMIC

public static final int MODE_DYNAMIC

The page sequence is dynamic with overview for recently shown pages.

See Also:

Constant Field Values

BUTTON_FINISH

public static final int BUTTON_FINISH

The steps have been fully processed.

See Also:

Constant Field Values

BUTTON_CANCEL

public static final int BUTTON_CANCEL

The user decided to cancel the button, also when escaped.

See Also:

Constant Field Values

BUTTON_BACK

public static final int BUTTON_BACK

Placeholder for the "Back" button.

See Also:

Constant Field Values

BUTTON_NEXT

public static final int BUTTON_NEXT

Placeholder for the "Next" button.

See Also:

Constant Field Values

startingPage

protected WizardPage startingPage

Remembers the starting page to be displayed first.

stack

protected java.util.Stack<WizardPage> stack

Cache for the recently shown pages.

mode

protected int mode

Remembers the type of page sequence to be shown.

sequence

protected java.util.Vector<WizardPage> sequence

Cache for the page sequence when in static mode.

exitButton

protected int exitButton

Remembers the exit button.

listeners

protected java.util.Hashtable<WizardPage,java.util.Vector<WizardPageListener>> listeners

Container holding page listeners for the pages.

statusBar

protected StatusBar statusBar

buttonBack_I18N

protected javax.swing.JButton buttonBack_I18N

buttonNext_I18N

protected javax.swing.JButton buttonNext_I18N

buttonFinish_I18N

protected javax.swing.JButton buttonFinish_I18N

buttonCancel_I18N

protected javax.swing.JButton buttonCancel_I18N

buttonHelp

protected javax.swing.JButton buttonHelp

Constructor Detail

WizardDialog

public WizardDialog()

Constructor method for the dialog (modeless).

Since:

1.6

WizardDialog

public WizardDialog(java.awt.Frame owner)

Constructor method for the dialog.

Parameters:

owner - The owner frame

Since:

1.6

WizardDialog

public WizardDialog(java.awt.Dialog owner)

Constructor method for the dialog.

Parameters:

owner - The owner dialog

Since:

1.6

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Clean-up method to help the gc.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - Error indication

Since:

1.5

setStartingPage

public void setStartingPage(WizardPage page)

Sets the starting page to be displayed first.

Parameters:

page - The first page

Throws:

java.lang.NullPointerException - Error indication

java.lang.IllegalStateException - If implied page sequence is invalid

Since:

1.6

getCurrentPage

public WizardPage getCurrentPage()

Provides the currently displayed wizard page instance if available.

Returns:

The current page or null if not available

Since:

1.6

getPreviousPage

public WizardPage getPreviousPage()

Provides the previously displayed wizard page instance if available.

Returns:

The previous page or null if not available

Throws:

java.lang.NullPointerException - Error indication

Since:

1.6

getPreviousPages

public WizardPage[] getPreviousPages()

Provides the previously displayed wizard page instances if available.

The array index 0 is the previous page, the index n means the first page on stack.

Returns:

The previous pages or null if not available

Throws:

java.lang.NullPointerException - Error indication

Since:

1.6

setVisible

public void setVisible(boolean visible)

Activates or deactivates the dialog.

When made visible the dialog displays the first page speficied with setStartingPage().

Overrides:

setVisible in class java.awt.Dialog

Parameters:

visible - The state of the dialog

Throws:

java.lang.IllegalStateException - If no starting page is set

Since:

1.5

showPage

protected void showPage(WizardPage newpage,
            WizardPage oldpage)

Starts the wizard by showing the initial page.

Remember that the stack needs to be updated before this method is called.

Parameters:

newpage - The page to be shown

oldpage - The page to be removed

Since:

1.5

updateOverview

protected void updateOverview()

Updates the overview labels based on the current stack.

Since:

1.6

allowEscapeOnKeyStroke

public void allowEscapeOnKeyStroke(int strokeval)

Adds a keyboard action to escape (close) the dialog (e.g. on escape).

The dialog is not disposed here since it may be recycled by an application.

Parameters:

strokeval - The desired escape key stroke like KeyEvent.VK_ESCAPE

Since:

1.6

allowConfirmOnKeyStroke

public void allowConfirmOnKeyStroke(int strokeval)

Adds a keyboard action to click the "Next"/"Finish" button if enabled.

This functionality allows the user to process the steps quickly by confirming with ENTER.

Parameters:

strokeval - The desired escape key stroke like KeyEvent.VK_ESCAPE

Since:

1.6

setDividerLocation

public void setDividerLocation(int location)

Adjusts the divider location.

Parameters:

location - The divider location

Since:

1.6

setButtonEnabled

public void setButtonEnabled(int button,
                    boolean enabled)

Sets the state of a wizard button.

Parameters:

button - The target button

enabled - The new state

Since:

1.6

setEnabledBack

public void setEnabledBack(boolean enabled)

Enables/disables the "Back" button.

Parameters:

enabled - The button state

Since:

1.6

setEnabledNext

public void setEnabledNext(boolean enabled)

Enables/disables the "Next" button.

Parameters:

enabled - The button state

Since:

1.6

setEnabledFinish

public void setEnabledFinish(boolean enabled)

Enables/disables the "Finish" button.

Parameters:

enabled - The button state

Since:

1.6

setEnabledCancel

public void setEnabledCancel(boolean enabled)

Enables/disables the "Cancel" button.

Parameters:

enabled - The button state

Since:

1.6

getExitButton

public int getExitButton()

Provides the exit button.

Returns:

The exit button

Since:

1.6

configureUnit

public void configureUnit(java.lang.String id,
                 Configuration config)

Restores values from persistent data stores.

Specified by:

configureUnit in interface ConfigurableUnit

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

storeUnit

public void storeUnit(java.lang.String id,
             Configuration config)

Stores the current configuration values persistently.

Specified by:

storeUnit in interface ConfigurableUnit

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

unitRegistered

public void unitRegistered(ApplicationModel model,
                  java.lang.String id)

Informs the configurable unit that it was registered with a model.

Specified by:

unitRegistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

unitUnregistered

public void unitUnregistered(ApplicationModel model,
                    java.lang.String id)

Informs the configurable unit that it was unregistered with a model.

Specified by:

unitUnregistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

setOverviewText

public void setOverviewText(java.lang.String text)

Sets the text of the overview list header.

Parameters:

text - The overview text

Since:

1.6

clickButton

public void clickButton(int button)

Clicks a wizard button.

Parameters:

button - The target button

Since:

1.6

isButtonEnabled

public boolean isButtonEnabled(int button)

Provides the state of a wizard button.

Parameters:

button - The target button

Returns:

The enabled state

Throws:

java.lang.IllegalArgumentException - If button code is invalid

Since:

1.6

setHelpID

public void setHelpID(java.lang.String helpid)

Sets the optional help link to call the help system.

Parameters:

helpid - The help system link

Since:

1.6

getStatusBar

public StatusBar getStatusBar()

Provides the status bar component.

Returns:

The status bar

Since:

1.6

updatePageIcon

public void updatePageIcon()

The icon of the current page has changed.

Since:

1.6

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Reacts on component interaction.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - Event to be processed

Since:

1.6

addWizardPageListener

public void addWizardPageListener(WizardPage page,
                         WizardPageListener listener)

Adds a listener reacting on page state changes (add, becomes shown etc.).

Parameters:

page - The page

listener - The listener instance

Throws:

java.lang.NullPointerException - If parameter is null

Since:

1.6

removeLookAndFeelListener

public void removeLookAndFeelListener(WizardPage page,
                             WizardPageListener listener)

Removes a listener reacting on page state changes (add, becomes shown etc.).

Parameters:

page - The page

listener - The listener instance

Throws:

java.lang.NullPointerException - If parameter is null

Since:

1.6