net.sf.juife
Class Wizard

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  net.sf.juife.Wizard

All Implemented Interfaces:

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

public class Wizard
extends javax.swing.JPanel

The main class for creating wizards that conforms to the wizard's guidelines provided in Java Look and Feel Design Guidelines: Advanced Topics book.

Note that by default the wizard is diplayed in modal dialog. Use setModal(java.lang.Boolean) to change the modal state of the wizard.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

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

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Wizard(java.awt.Dialog owner, java.lang.String title)
Creates a new wizard with the specified title and owner.

Wizard(java.awt.Dialog owner, java.lang.String title, WizardModel model)
Creates a new wizard with the specified title, owner and model.

Wizard(java.awt.Frame owner, java.lang.String title)
Creates a new wizard with the specified title and owner.

Wizard(java.awt.Frame owner, java.lang.String title, WizardModel model)
Creates a new wizard with the specified title, owner and model.

Method Summary

void	cancelWizard() Cancels the wizard.
void	closeWizard() Closes the wizard.
void	finishWizard() Finishes the wizard task.
WizardPage	getCurrentPage() Gets the current page in the Wizard.
WizardModel	getModel() Gets the model of this wizard.
WizardUI	getUI() Gets the L&F object that renders this component.
java.lang.String	getUIClassID() Gets a string that specifies the name of the L&F class that renders this component.
void	setModal(java.lang.Boolean modal) Specifies whether this wizard should be modal.
void	setModel(WizardModel model) Sets the model of this wizard.
void	setUI(WizardUI ui) Sets the L&F object that renders this component.
void	showWizard() Starts the Wizard.
void	updateUI() Resets the UI property to a value from the current look and feel.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, paramString, setUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

Wizard

public Wizard(java.awt.Frame owner,
              java.lang.String title)

Creates a new wizard with the specified title and owner.

Parameters:

owner - Specifies the Frame from which this wizard is displayed.

title - The text to be displayed in the wizard's title bar.

Wizard

public Wizard(java.awt.Frame owner,
              java.lang.String title,
              WizardModel model)

Creates a new wizard with the specified title, owner and model.

Parameters:

owner - Specifies the Frame from which this wizard is displayed.

title - The text to be displayed in the wizard's title bar.

model - The non-null model to be used by this wizard.

Throws:

java.lang.IllegalArgumentException - If model is null.

Wizard

public Wizard(java.awt.Dialog owner,
              java.lang.String title)

Creates a new wizard with the specified title and owner.

Parameters:

owner - Specifies the dialog from which this wizard is displayed.

title - The text to be displayed in the wizard's title bar.

Wizard

public Wizard(java.awt.Dialog owner,
              java.lang.String title,
              WizardModel model)

Creates a new wizard with the specified title, owner and model.

Parameters:

owner - Specifies the dialog from which this wizard is displayed.

title - The text to be displayed in the wizard's title bar.

model - The non-null model to be used by this wizard.

Throws:

java.lang.IllegalArgumentException - If model is null.

Method Detail

getUIClassID

public java.lang.String getUIClassID()

Gets a string that specifies the name of the L&F class that renders this component.

Overrides:

getUIClassID in class javax.swing.JPanel

Returns:

the string "NavigationPaneUI"

getUI

public WizardUI getUI()

Gets the L&F object that renders this component.

Overrides:

getUI in class javax.swing.JPanel

Returns:

The L&F object that renders this component.

setUI

public void setUI(WizardUI ui)

Sets the L&F object that renders this component.

Parameters:

ui - The new UI delegate.

updateUI

public void updateUI()

Resets the UI property to a value from the current look and feel.

Overrides:

updateUI in class javax.swing.JPanel

setModal

public void setModal(java.lang.Boolean modal)

Specifies whether this wizard should be modal.

Parameters:

modal - If true the wizard will be displayed in modal dialog.

getModel

public WizardModel getModel()

Gets the model of this wizard.

Returns:

The model of this wizard.

setModel

public void setModel(WizardModel model)

Sets the model of this wizard.

Parameters:

model - A non-null WizardModel instance.

Throws:

java.lang.IllegalArgumentException - If model is null.

closeWizard

public void closeWizard()

Closes the wizard.

cancelWizard

public void cancelWizard()

Cancels the wizard.

finishWizard

public void finishWizard()

Finishes the wizard task.

getCurrentPage

public WizardPage getCurrentPage()

Gets the current page in the Wizard.

Returns:

the current page in the Wizard.

showWizard

public void showWizard()

Starts the Wizard.