Package docking.wizard

Class WizardManager

java.lang.Object

docking.DialogComponentProvider

docking.wizard.WizardManager

All Implemented Interfaces:

ActionContextProvider, WizardPanelListener, StatusListener, TaskListener

public class WizardManager
extends DialogComponentProvider
implements WizardPanelListener

A dialog that controls the panels for going to "Next" and "Previous" in some process that the user is being led through.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	BACK	Default text for the 'back' button
static java.lang.String	FINISH	Default text for the 'finish' button
static java.lang.String	NEXT	Default text for the 'next' button

Fields inherited from class docking.DialogComponentProvider

applyButton, buttonPanel, cancelButton, dismissButton, okButton, rootPanel

Constructor Summary

Constructors

Constructor	Description
WizardManager(java.lang.String title, boolean modal, PanelManager pmgr)	Constructor
WizardManager(java.lang.String title, boolean modal, PanelManager pmgr, javax.swing.Icon wizardIcon)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	back()	Programmatically move the wizard back one panel.
protected void	cancelCallback()	The callback method for when the "Cancel" button is pressed.
void	completed(boolean success)	Notification that the wizard process is complete.
void	disableNavigation()	Disable the back, next, finish, and cancel buttons.
void	dispose()
void	enableNavigation()	Enable the next, previous, and finish buttons according to the panel manager for this dialog.
boolean	finish()	Programmatically finished the wizard task.
void	focusFinish()	Places focus on the 'finish' button.
void	focusNext()	Places focus on the 'next' button.
WizardPanel	getCurrentWizardPanel()	Returns the current wizard panel.
java.lang.String	getStatusMessage()	Returns the current status message being displayed in this dialog.
boolean	next()	Programmatically move the wizard forward one panel.
void	setStatusMessage(java.lang.String msg)	Notification to set a status message.
void	showWizard()	Display this dialog.
void	showWizard(java.awt.Component parent)	Display this dialog and parent it to the given component.
void	validityChanged()	Notification that something on the panel changed.

Methods inherited from class docking.DialogComponentProvider

addAction, addApplyButton, addButton, addCancelButton, addDismissButton, addOKButton, addWorkPanel, alertMessage, alertMessage, applyCallback, cancelCurrentTask, clearScheduledTask, clearStatusText, close, dialogClosed, dialogShown, dismissCallback, doInitialize, escapeCallback, executeProgressTask, getActionContext, getActions, getBackground, getBounds, getComponent, getDefaultButton, getDefaultSize, getDialogSize, getFocusComponent, getGlassPane, getHelpLocatdion, getId, getIntialLocation, getLocationOnScreen, getParent, getPreferredSize, getRemberSize, getRememberLocation, getStatusColor, getStatusLabel, getStatusText, getTaskMonitorComponent, getTaskScheduler, getTitle, getUseSharedLocation, hideTaskMonitorComponent, isApplyEnabled, isCancelEnabled, isModal, isOKEnabled, isResizeable, isRunningTask, isShowing, isTransient, isVisible, notifyContextChanged, okCallback, removeAction, removeButton, removeWorkPanel, repack, setApplyEnabled, setApplyToolTip, setBackground, setCancelButtonText, setCancelEnabled, setCancelToolTip, setCursor, setDefaultButton, setDefaultSize, setDialogSize, setDismissToolTip, setFocusComponent, setGlassPane, setHelpLocation, setInitialLocation, setMinimumSize, setMinimumSize, setOkButtonText, setOkEnabled, setOkToolTip, setPreferredSize, setRememberLocation, setRememberSize, setResizable, setStatusJustification, setStatusText, setStatusText, setStatusText, setTitle, setTransient, setUseSharedLocation, showProgressBar, showTaskMonitorComponent, stopProgressTimer, taskCancelled, taskCompleted, toFront, toString, waitForCurrentTask

Methods inherited from class java.lang.Object

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

Field Detail

FINISH

public static final java.lang.String FINISH

Default text for the 'finish' button

See Also:

Constant Field Values

NEXT

public static final java.lang.String NEXT

Default text for the 'next' button

See Also:

Constant Field Values

BACK

public static final java.lang.String BACK

Default text for the 'back' button

See Also:

Constant Field Values

Constructor Detail

WizardManager

public WizardManager(java.lang.String title,
                     boolean modal,
                     PanelManager pmgr)

Constructor

Parameters:

title - title of the dialog

modal - true if the wizard should be modal

pmgr - object that knows about the next and previous panels

WizardManager

public WizardManager(java.lang.String title,
                     boolean modal,
                     PanelManager pmgr,
                     javax.swing.Icon wizardIcon)

Constructor

Parameters:

title - title of the dialog

modal - true if the wizard should be modal

pmgr - object that knows about the next and previous panels

wizardIcon - icon to use for this dialog

Method Detail

dispose

public void dispose()

Overrides:

dispose in class DialogComponentProvider

See Also:

Window.dispose()

validityChanged

public void validityChanged()

Description copied from interface: WizardPanelListener

Notification that something on the panel changed.

Specified by:

validityChanged in interface WizardPanelListener

See Also:

WizardPanelListener.validityChanged()

getStatusMessage

public java.lang.String getStatusMessage()

Returns the current status message being displayed in this dialog.

Returns:

the current status message being displayed in this dialog

setStatusMessage

public void setStatusMessage(java.lang.String msg)

Description copied from interface: WizardPanelListener

Notification to set a status message.

Specified by:

setStatusMessage in interface WizardPanelListener

Parameters:

msg - message

See Also:

WizardPanelListener.setStatusMessage(String)

showWizard

public void showWizard()

Display this dialog.

showWizard

public void showWizard(java.awt.Component parent)

Display this dialog and parent it to the given component.

Parameters:

parent - parent

completed

public void completed(boolean success)

Notification that the wizard process is complete.

Parameters:

success - status of the process

enableNavigation

public void enableNavigation()

Enable the next, previous, and finish buttons according to the panel manager for this dialog. The panel manager is the object that knows the steps in the process and what buttons should be enabled.

disableNavigation

public void disableNavigation()

Disable the back, next, finish, and cancel buttons.

cancelCallback

protected void cancelCallback()

Description copied from class: DialogComponentProvider

The callback method for when the "Cancel" button is pressed. The default behavior is to call setVisible(false) and dispose() on the dialog.

Overrides:

cancelCallback in class DialogComponentProvider

back

public boolean back()

Programmatically move the wizard back one panel. Simulates the user clicking on the 'back' button. Returns true if not on the first panel.

Returns:

true if not on the first panel

next

public boolean next()

Programmatically move the wizard forward one panel. Simulates the user clicking on the 'next' button. Returns true if not on the last panel.

Returns:

true if not on the last panel

focusNext

public void focusNext()

Places focus on the 'next' button.

focusFinish

public void focusFinish()

Places focus on the 'finish' button.

finish

public boolean finish()

Programmatically finished the wizard task. Returns true if the wizard can finish.

Returns:

true if the wizard can finish

getCurrentWizardPanel

public WizardPanel getCurrentWizardPanel()

Returns the current wizard panel.

Returns:

the current wizard panel