org.tn5250j.gui

Class Wizard

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.tn5250j.gui.Wizard

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class Wizard
extends JPanel

Class to create and manage a Wizard style framework. Create and add WizardPages and add WizardListener's for all your Wizard fun.

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionListener	cancelListener A listener on the "cancel" button that is implemented as an anonymous inner class that simply invokes the containing classes "cancel()" method.
protected CardLayout	cardLayout layout used
protected ContainerListener	containerListener Container listner that listens for new pages that are added, and adds listeners to the buttons of the children so that the container knows when to post the proper "Wizard" events.
protected ActionListener	finishListener A listener on the "finish" button that is implemented as an anonymous inner class that simply invokes the containing classes "finish()" method.
protected ActionListener	helpListener A listener on the "help" button that is implemented as an anonymous inner class that simply invokes the containing classes "help()" method.
protected Vector<WizardListener>	listeners list of wizard listeners registered with the bean
protected ActionListener	nextListener A listener on the "next" button that is implemented as an anonymous inner class that simply invokes the containing classes "next()" method.
protected ActionListener	previousListener A listener on the "previous" button that is implemented as an anonymous inner class that simply invokes the containing classes "previous()" method.

Fields inherited from class javax.swing.JComponent

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

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

Constructors

Constructor and Description
Wizard() Create a Wizard component.

Method Summary

Modifier and Type	Method and Description
Component	add(Component page) Adds a page child.
void	addWizardListener(WizardListener l) Adds a new WizardListener to the list.
boolean	cancel() Invokes the registered "cancel" action.
boolean	finish() Invokes the registered "finish" action.
void	first() Moves to the first page in the Wizard.
protected Component	getCurrentPage() Retrieves the current visible page.
void	help() Invokes the registered "help" action.
void	last() Moves to the last page in the Wizard.
boolean	next() Advance to the next page
boolean	previous() Move to the previous page
void	removeWizardListener(WizardListener l) Removes a ValidateListener from the list.
void	show(String name) Moves to the wizard page with the specified name.

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, getBaseline, getBaselineResizeBehavior, 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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, 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, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

cardLayout

protected CardLayout cardLayout

layout used

listeners

protected transient Vector<WizardListener> listeners

list of wizard listeners registered with the bean

nextListener

protected transient ActionListener nextListener

A listener on the "next" button that is implemented as an anonymous inner class that simply invokes the containing classes "next()" method.

previousListener

protected transient ActionListener previousListener

A listener on the "previous" button that is implemented as an anonymous inner class that simply invokes the containing classes "previous()" method.

finishListener

protected transient ActionListener finishListener

A listener on the "finish" button that is implemented as an anonymous inner class that simply invokes the containing classes "finish()" method.

cancelListener

protected transient ActionListener cancelListener

A listener on the "cancel" button that is implemented as an anonymous inner class that simply invokes the containing classes "cancel()" method.

helpListener

protected transient ActionListener helpListener

A listener on the "help" button that is implemented as an anonymous inner class that simply invokes the containing classes "help()" method.

containerListener

protected transient ContainerListener containerListener

Container listner that listens for new pages that are added, and adds listeners to the buttons of the children so that the container knows when to post the proper "Wizard" events.

Constructor Detail

Wizard

public Wizard()

Create a Wizard component.

Method Detail

show

public void show(String name)

Moves to the wizard page with the specified name.

Parameters:

name - Name of the page when it was added to the JCWizard.

See Also:

first(), last()

first

public void first()

Moves to the first page in the Wizard.

See Also:

last(), show(java.lang.String)

last

public void last()

Moves to the last page in the Wizard.

See Also:

first(), show(java.lang.String)

next

public boolean next()

Advance to the next page

Returns:

flag

previous

public boolean previous()

Move to the previous page

Returns:

flag

finish

public boolean finish()

Invokes the registered "finish" action.

Returns:

flag

cancel

public boolean cancel()

Invokes the registered "cancel" action.

Returns:

flag

help

public void help()

Invokes the registered "help" action.

getCurrentPage

protected Component getCurrentPage()

Retrieves the current visible page.

Returns:

component

addWizardListener

public void addWizardListener(WizardListener l)

Adds a new WizardListener to the list.

Parameters:

l - a listener

removeWizardListener

public void removeWizardListener(WizardListener l)

Removes a ValidateListener from the list.

Parameters:

l - a listener to remove

add

public Component add(Component page)

Adds a page child.

Overrides:

add in class Container

Parameters:

page - component

Returns:

component