com.ozziefix.jlwizard.simple
Class SimpleWizard

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      com.ozziefix.jlwizard.Wizard
                          com.ozziefix.jlwizard.simple.SimpleWizard

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

Direct Known Subclasses:

WindowsWizard

public class SimpleWizard
extends Wizard

A Simple Wizard Dialog, consisting of a Panel with CardLayout which contains the pages, and a WindowsWizardNavigator.

Version:

$Revision: 1.1 $

Author:

Jurgen Lust

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

Nested classes/interfaces inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

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.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

Constructor Summary

SimpleWizard()
Creates a new SimpleWizard object.

SimpleWizard(java.awt.Dialog parent)
Creates a new SimpleWizard object.

SimpleWizard(java.awt.Frame parent)
Creates a new SimpleWizard object.

Method Summary

void	addPage(java.lang.String forwardName, WizardPage page) Add a page to the wizard
protected void	handleError(WizardException exception) Show an error message.
protected void	initComponents() initialize the components
void	removePage(java.lang.String forwardName) Remove a page from the wizard
void	setNavigator(WizardNavigator navigator) The WizardNavigator allows the user to navigate through the wizard.
protected void	showPage(PageForward forward) Show the specified WizardPage.
protected void	updateTitle(WizardPage page) update the titlebar

Methods inherited from class com.ozziefix.jlwizard.Wizard

addWizardListener, cancel, findPageForward, finish, getCancelAction, getDescription, getModel, getNavigator, getPage, getSelectedPage, getStartAction, getWizardName, perform, removeAllWizardListeners, removeWizardListener, setCancelAction, setDescription, setModel, setStartAction, setWizardName, start, start

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, show

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, 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, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, firePropertyChange, firePropertyChange, firePropertyChange, 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, 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, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleWizard

public SimpleWizard()
             throws java.awt.HeadlessException

Creates a new SimpleWizard object.

Throws:

java.awt.HeadlessException - HeadlessException if GraphicsEnvironment.isHeadless() returns true

SimpleWizard

public SimpleWizard(java.awt.Dialog parent)
             throws java.awt.HeadlessException

Creates a new SimpleWizard object.

Parameters:

parent - the parent dialog of this Wizard dialog

Throws:

java.awt.HeadlessException - HeadlessException if GraphicsEnvironment.isHeadless() returns true

SimpleWizard

public SimpleWizard(java.awt.Frame parent)
             throws java.awt.HeadlessException

Creates a new SimpleWizard object.

Parameters:

parent - the parent frame of this Wizard dialog

Throws:

java.awt.HeadlessException - HeadlessException if GraphicsEnvironment.isHeadless() returns true

Method Detail

setNavigator

public void setNavigator(WizardNavigator navigator)

Description copied from class: Wizard

The WizardNavigator allows the user to navigate through the wizard. Usually this is a button bar in the bottom of the wizard dialog.

Overrides:

setNavigator in class Wizard

Parameters:

navigator - The navigator to set.

See Also:

Wizard.setNavigator(com.ozziefix.jlwizard.navigation.WizardNavigator)

addPage

public void addPage(java.lang.String forwardName,
                    WizardPage page)
             throws WizardException

Description copied from class: Wizard

Add a page to the wizard

Overrides:

addPage in class Wizard

Parameters:

forwardName - the identifier of the page

page - the page to be added

Throws:

WizardException - when the forwardName is null

See Also:

Wizard.addPage(java.lang.String, com.ozziefix.jlwizard.WizardPage)

removePage

public void removePage(java.lang.String forwardName)

Description copied from class: Wizard

Remove a page from the wizard

Overrides:

removePage in class Wizard

Parameters:

forwardName - the identifier of the page

See Also:

Wizard.removePage(java.lang.String)

handleError

protected void handleError(WizardException exception)

Description copied from class: Wizard

Show an error message. The way this is done depends on the specific implementation of the Wizard, therefore this method is abstract.

Specified by:

handleError in class Wizard

Parameters:

exception - the error that should be displayed

See Also:

Wizard.handleError(com.ozziefix.jlwizard.exceptions.WizardException)

initComponents

protected void initComponents()

initialize the components

showPage

protected void showPage(PageForward forward)
                 throws ForwardException

Description copied from class: Wizard

Show the specified WizardPage. The way this is done depends on the specific implementation of the Wizard, therefore this method is abstract.

Specified by:

showPage in class Wizard

Parameters:

forward - the PageForward that refers to the WizardPage

Throws:

ForwardException - when the page cannot be shown

See Also:

com.ozziefix.jlwizard.Wizard#showPage(com.ozziefix.jlwizard.WizardPage)

updateTitle

protected void updateTitle(WizardPage page)

update the titlebar

Parameters:

page - the currently selected page