org.browsecode.helpers.wizard
Class Wizard

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.browsecode.helpers.wizard.Wizard

All Implemented Interfaces:

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

public class Wizard
extends javax.swing.JPanel

If you use the default background (not setting any background image), we recommend setting the size of the Wizard to: (610, 400)

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()

Wizard(WizardListener listener)

Wizard(WizardListener listener, WizardCard firstCard)

Method Summary

void	cancelWizard()
void	finishWizard()
WizardCard	getCurrentCard() Get the currently displaying card.
java.lang.String	getFinishedButtonLabel()
java.lang.Object	getProperty(java.lang.String key) use this method to retrieve the named property
WizardListener	getWizardListener()
protected void	hideWindow()
void	lockCard() Locks the current card, preventing the user from navigating.
static void	main(java.lang.String[] args)
void	paintComponent(java.awt.Graphics g)
void	setBackgroundImage(javax.swing.ImageIcon backgroundImage)
void	setDisposeWindowWhenDone(boolean disposeWhenDone)
void	setEnableAllIndicators(boolean enableAllIndicators) Set whether all new card indicators (the radio buttons on the left) are enabled at the beginning.
void	setFinishedButtonLabel(java.lang.String string)
void	setFirstCard(WizardCard firstCard)
void	setNextEnabled(boolean enabled)
void	setProperty(java.lang.String key, java.lang.Object value) use this method to set a property for other cards to access the key must be unique in this wizard's set of slides
void	setWizardListener(WizardListener listener)
void	showCard(int cardIndex)
void	showInWindow(java.lang.String title)
void	showInWindow(java.lang.String title, java.awt.Dimension size)
void	showInWindow(java.lang.String title, java.awt.Image icon)
void	showInWindow(java.lang.String title, java.awt.Image icon, java.awt.Dimension size)
void	showNextCard()
void	showPreviousCard()
void	unlockCard() Unlocks the current card, negating the effect of a call to lock card.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, 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(WizardListener listener,
              WizardCard firstCard)

Wizard

public Wizard(WizardListener listener)

Wizard

public Wizard()

Method Detail

getWizardListener

public WizardListener getWizardListener()

Returns:

Returns the listener.

setWizardListener

public void setWizardListener(WizardListener listener)

Parameters:

listener - The listener to set.

getFinishedButtonLabel

public java.lang.String getFinishedButtonLabel()

Returns:

setFinishedButtonLabel

public void setFinishedButtonLabel(java.lang.String string)

Parameters:

string -

setFirstCard

public void setFirstCard(WizardCard firstCard)

setEnableAllIndicators

public void setEnableAllIndicators(boolean enableAllIndicators)

Set whether all new card indicators (the radio buttons on the left) are enabled at the beginning. Note that going backwards won't disable ones that have already been enabled.

Parameters:

enableAllIndicators -

setDisposeWindowWhenDone

public void setDisposeWindowWhenDone(boolean disposeWhenDone)

showInWindow

public void showInWindow(java.lang.String title)

showInWindow

public void showInWindow(java.lang.String title,
                         java.awt.Image icon)

showInWindow

public void showInWindow(java.lang.String title,
                         java.awt.Dimension size)

showInWindow

public void showInWindow(java.lang.String title,
                         java.awt.Image icon,
                         java.awt.Dimension size)

showNextCard

public void showNextCard()

getCurrentCard

public WizardCard getCurrentCard()

Get the currently displaying card.
This should be used mostly for making the Wizard jump to a particular card when it starts, for example, using showNextCard() and checking getCurrentCard() to see if it's the card you want to show.

Returns:

showPreviousCard

public void showPreviousCard()

showCard

public void showCard(int cardIndex)

lockCard

public void lockCard()

Locks the current card, preventing the user from navigating. Remember to unlock the card in a try..finally block to prevent trapping the user.

unlockCard

public void unlockCard()

Unlocks the current card, negating the effect of a call to lock card. This has no effect if the current card is not locked.

setNextEnabled

public void setNextEnabled(boolean enabled)

finishWizard

public void finishWizard()

hideWindow

protected void hideWindow()

cancelWizard

public void cancelWizard()

setBackgroundImage

public void setBackgroundImage(javax.swing.ImageIcon backgroundImage)

getProperty

public java.lang.Object getProperty(java.lang.String key)

use this method to retrieve the named property

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

use this method to set a property for other cards to access the key must be unique in this wizard's set of slides

paintComponent

public void paintComponent(java.awt.Graphics g)

Overrides:

paintComponent in class javax.swing.JComponent

main

public static final void main(java.lang.String[] args)