net.javaprog.ui.wizard
Class Wizard

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      net.javaprog.ui.wizard.Wizard

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class Wizard
extends JDialog

The main component class.

Author:

Michael Rudolf

See Also:

Serialized Form

Nested Class Summary

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

JDialog.AccessibleJDialog

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

Dialog.AccessibleAWTDialog

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

Window.AccessibleAWTWindow

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static String	HELP_LISTENER_PROPERTY The property name for the help listener.
protected Icon	icon An icon representing the wizard.
static String	ICON_PROPERTY The property name for the icon.
protected WizardModel	model The wizard's model.
static String	MODEL_PROPERTY The property name for the wizard model.
static String	STEP_DESCRIPTION_RENDERER_PROPERTY The property name for the step description renderer.
static String	STEP_LIST_RENDERER_PROPERTY The property name for the step list renderer.
protected StepDescriptionRenderer	stepDescriptionRenderer The renderer for the step description.
protected StepListRenderer	stepListRenderer The renderer for the step list.

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

Wizard()
Creates a new wizard with a dummy model and the title string "Wizard".

Wizard(Frame parent, WizardModel model, String title)
Creates a new wizard from the given model with the given title.

Wizard(Frame parent, WizardModel model, String title, Icon icon)
Creates a new wizard from the given model with the given title and icon.

Wizard(WizardModel model, String title)
Creates a new wizard from the given model with the given title.

Wizard(WizardModel model, String title, Icon icon)
Creates a new wizard from the given model with the given title and icon.

Method Summary

void	enableHelp(ActionListener listener) Enables help using the given action listener.
Icon	getIcon() Returns the icon that is used to represent the wizard.
ImageIcon	getImageIcon() Deprecated. As of version 0.1.4 replaced by getIcon()
WizardModel	getModel() Returns the wizard's model.
StepDescriptionRenderer	getStepDescriptionRenderer() Returns the renderer for the step description.
StepListRenderer	getStepListRenderer() Returns the renderer for the step list.
void	setIcon(Icon icon) Sets the icon that is used to represent the wizard.
void	setModel(WizardModel model) Sets the wizard's model.
void	setStepDescriptionRenderer(StepDescriptionRenderer renderer) Overrides the step description renderer property.
void	setStepListRenderer(StepListRenderer renderer) Overrides the step list renderer property.

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

Field Detail

STEP_LIST_RENDERER_PROPERTY

public static final String STEP_LIST_RENDERER_PROPERTY

The property name for the step list renderer.

See Also:

setStepListRenderer(net.javaprog.ui.wizard.StepListRenderer), getStepListRenderer(), Constant Field Values

STEP_DESCRIPTION_RENDERER_PROPERTY

public static final String STEP_DESCRIPTION_RENDERER_PROPERTY

The property name for the step description renderer.

See Also:

setStepDescriptionRenderer(net.javaprog.ui.wizard.StepDescriptionRenderer), getStepDescriptionRenderer(), Constant Field Values

HELP_LISTENER_PROPERTY

public static final String HELP_LISTENER_PROPERTY

The property name for the help listener.

Since:

0.1.1

See Also:

enableHelp(ActionListener), Constant Field Values

ICON_PROPERTY

public static final String ICON_PROPERTY

The property name for the icon.

Since:

0.1.4

See Also:

setIcon(javax.swing.Icon), getIcon(), Constant Field Values

MODEL_PROPERTY

public static final String MODEL_PROPERTY

The property name for the wizard model.

Since:

0.1.4

See Also:

getModel(), setModel(net.javaprog.ui.wizard.WizardModel), Constant Field Values

model

protected WizardModel model

The wizard's model.

See Also:

getModel()

icon

protected Icon icon

An icon representing the wizard.

See Also:

getImageIcon()

stepListRenderer

protected StepListRenderer stepListRenderer

The renderer for the step list.

See Also:

getStepListRenderer(), setStepListRenderer(StepListRenderer)

stepDescriptionRenderer

protected StepDescriptionRenderer stepDescriptionRenderer

The renderer for the step description.

See Also:

getStepDescriptionRenderer(), setStepDescriptionRenderer(StepDescriptionRenderer)

Constructor Detail

Wizard

public Wizard()

Creates a new wizard with a dummy model and the title string "Wizard".

Since:

0.1.4

Wizard

public Wizard(WizardModel model,
              String title)

Creates a new wizard from the given model with the given title.

Parameters:

model - the wizard's step model

title - the string displayed in the dialog's title bar

Wizard

public Wizard(Frame parent,
              WizardModel model,
              String title)

Creates a new wizard from the given model with the given title.

Parameters:

parent - the wizard's parent frame.

model - the wizard's step model

title - the string displayed in the dialog's title bar

Wizard

public Wizard(WizardModel model,
              String title,
              Icon icon)

Creates a new wizard from the given model with the given title and icon.

Parameters:

model - the wizard's step model

title - the string displayed in the dialog's title bar

icon - the icon representing the wizard

See Also:

getModel(), getImageIcon()

Wizard

public Wizard(Frame parent,
              WizardModel model,
              String title,
              Icon icon)

Creates a new wizard from the given model with the given title and icon.

Parameters:

parent - the wizard's parent frame.

model - the wizard's step model

title - the string displayed in the dialog's title bar

icon - the icon representing the wizard

See Also:

getModel(), getIcon()

Method Detail

getModel

public WizardModel getModel()

Returns the wizard's model.

See Also:

setModel(net.javaprog.ui.wizard.WizardModel)

setModel

public void setModel(WizardModel model)

Sets the wizard's model.

Parameters:

model - the wizards model

Since:

0.1.4

See Also:

getModel()

getImageIcon

public ImageIcon getImageIcon()

Deprecated. As of version 0.1.4 replaced by getIcon()

Returns the image that is used to represent the wizard.

getIcon

public Icon getIcon()

Returns the icon that is used to represent the wizard.

setIcon

public void setIcon(Icon icon)

Sets the icon that is used to represent the wizard.

Parameters:

icon - the new icon for the wizard.

Since:

0.1.4

getStepListRenderer

public StepListRenderer getStepListRenderer()

Returns the renderer for the step list.

setStepListRenderer

public void setStepListRenderer(StepListRenderer renderer)

Overrides the step list renderer property.

Parameters:

renderer - the new object to render to step list

getStepDescriptionRenderer

public StepDescriptionRenderer getStepDescriptionRenderer()

Returns the renderer for the step description.

setStepDescriptionRenderer

public void setStepDescriptionRenderer(StepDescriptionRenderer renderer)

Overrides the step description renderer property.

Parameters:

renderer - the new object to renderer the step description

enableHelp

public void enableHelp(ActionListener listener)

Enables help using the given action listener. The listener will be notified if the help button or the F1 key is pressed. If you want to integrate JavaHelp, please see JavaHelpSupport.

Parameters:

listener - the ActionListener to notify on help requests

Since:

0.1.1