com.klg.jclass.swing
Class BaseWizard

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--com.klg.jclass.swing.BaseWizard

All Implemented Interfaces:

Accessible, ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

JCSplitWizard, JCWizard

public abstract class BaseWizard

extends JPanel

Base class for common code for JCSplitWizard and JCWizard.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected ActionListener	cancelListener A listener on the "cancel" button that is implemented as an anonymous inner class; it simply invokes the containing classes cancel() method.
protected CardLayout	cardLayout Layout used.
protected Container	cardOwner Handle for the container which has the cardlayout.
protected ActionListener	finishListener A listener on the "finish" button that is implemented as an anonymous inner class; it simply invokes the containing classes finish() method.
protected ActionListener	helpListener A listener on the "help" button that is implemented as an anonymous inner class; it simply invokes the containing classes help() method.
protected com.klg.jclass.util.JCListenerList	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; it simply invokes the containing classes next() method.
protected ActionListener	previousListener A listener on the "previous" button that is implemented as an anonymous inner class; it simply invokes the containing classes previous() method.

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

BaseWizard()
No argument constructor for the baseWizard, called by subclasses.

Method Summary

void	addWizardListener(com.klg.jclass.swing.JCWizardListener l) Adds a new WizardListener to the list.
abstract boolean	cancel() Invokes the registered "cancel" action.
abstract boolean	finish() Invokes the registered "finish" action
void	first() Moves to the first page in the Wizard.
String	getAbout() Returns vendor information.
protected abstract Component	getCurrentPage() Should return the last page.
abstract void	help() Invokes the registered "help" action.
boolean	isLastPage(Component comp) Returns true if the given component is the last page.
void	last() Moves to the last page in the Wizard.
abstract boolean	next() Advances to the next page.
abstract boolean	previous() Moves to the previous page.
void	removeWizardListener(com.klg.jclass.swing.JCWizardListener l) Removes a ValidateListener from the list.
void	setAbout(String s) Provided for Beans property editors - has no effect.
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, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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

Field Detail

cardLayout

protected CardLayout cardLayout

Layout used.

cardOwner

protected Container cardOwner

Handle for the container which has the cardlayout.

listeners

protected transient com.klg.jclass.util.JCListenerList 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; it simply invokes the containing classes next() method.

See Also:

next()

previousListener

protected transient ActionListener previousListener

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

See Also:

previous()

finishListener

protected transient ActionListener finishListener

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

See Also:

finish()

cancelListener

protected transient ActionListener cancelListener

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

See Also:

cancel()

helpListener

protected transient ActionListener helpListener

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

See Also:

help()

Constructor Detail

BaseWizard

public BaseWizard()

No argument constructor for the baseWizard, called by subclasses.

Method Detail

setAbout

public void setAbout(String s)

Provided for Beans property editors - has no effect.

Parameters:

s -

getAbout

public String getAbout()

Returns vendor information.

Returns:

vendor information

isLastPage

public boolean isLastPage(Component comp)

Returns true if the given component is the last page.

Parameters:

comp -

Returns:

whether or not the given component is the last page.

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

getCurrentPage

protected abstract Component getCurrentPage()

Should return the last page. Implemented by subclasses.

Returns:

the last page.

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 abstract boolean next()

Advances to the next page.

Returns:

whether or not the move to the next page was successful.

See Also:

previous(), finish(), cancel()

previous

public abstract boolean previous()

Moves to the previous page.

Returns:

whether or not the action was successful

See Also:

next(), finish(), cancel()

cancel

public abstract boolean cancel()

Invokes the registered "cancel" action.

Returns:

whether or not the action was successful

See Also:

next(), previous(), finish()

help

public abstract void help()

Invokes the registered "help" action.

See Also:

next(), previous(), finish(), cancel()

finish

public abstract boolean finish()

Invokes the registered "finish" action

Returns:

whether or not the action was successful

See Also:

next(), previous(), cancel()

addWizardListener

public void addWizardListener(com.klg.jclass.swing.JCWizardListener l)

Adds a new WizardListener to the list.

Parameters:

l -

removeWizardListener

public void removeWizardListener(com.klg.jclass.swing.JCWizardListener l)

Removes a ValidateListener from the list.

Parameters:

l -