com.ozziefix.jlwizard
Class AbstractWizardPage

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.ozziefix.jlwizard.AbstractWizardPage

All Implemented Interfaces:

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

Direct Known Subclasses:

DemoEmployeeDetailsPage, DemoGeneralPage, SimpleWizardPage

public abstract class AbstractWizardPage
extends javax.swing.JPanel
implements WizardPage

The WizardPage constitutes (a part of) the view of a Wizard.

This is an abstract implementation of a WizardPage, in the form of a JPanel.

Version:

$Revision: 1.1 $

Author:

Jurgen Lust

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

AbstractWizardPage()

Method Summary

java.lang.String	getDescription() The description of the page.
WizardAction	getFinishAction() The action that should be executed when the finish button is clicked.
WizardAction	getHelpAction() The action that should be executed when the help button is clicked.
javax.swing.Icon	getIcon() The icon that represents this page.
WizardAction	getNextAction() The action that should be executed when the next button is clicked.
javax.swing.JComponent	getPageComponent() The JComponent that represents this page.
WizardAction	getPreviousAction() The action that should be executed when the previous button is clicked.
java.lang.String	getTitle() The title of this page.
Wizard	getWizard() Get the parent wizard
void	setDescription(java.lang.String description) The description of the page.
void	setFinishAction(WizardAction finishAction) The action that should be executed when the finish button is clicked.
void	setHelpAction(WizardAction helpAction) The action that should be executed when the help button is clicked.
void	setIcon(javax.swing.Icon icon) The icon that represents this page.
void	setNextAction(WizardAction nextAction) The action that should be executed when the next button is clicked.
void	setPreviousAction(WizardAction previousAction) The action that should be executed when the previous button is clicked.
void	setTitle(java.lang.String title) The title of this page.
void	setWizard(Wizard wizard) This method should only be called by JLWizard, when adding a page to it.

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

Methods inherited from interface com.ozziefix.jlwizard.WizardPage

load, store, validateInput

Constructor Detail

AbstractWizardPage

public AbstractWizardPage()

Method Detail

setDescription

public void setDescription(java.lang.String description)

The description of the page. This could be used in a wizard title bar.

Parameters:

description - the description of this page

getDescription

public java.lang.String getDescription()

Description copied from interface: WizardPage

The description of the page. This could be used in a wizard title bar.

Specified by:

getDescription in interface WizardPage

Returns:

The description

See Also:

WizardPage.getDescription()

setFinishAction

public void setFinishAction(WizardAction finishAction)

The action that should be executed when the finish button is clicked. If the finish button should be disabled on this page, set this to null.

Parameters:

finishAction - The finishAction to set.

getFinishAction

public WizardAction getFinishAction()

Description copied from interface: WizardPage

The action that should be executed when the finish button is clicked. If the finish button should be disabled on this page, then this must return null.

Specified by:

getFinishAction in interface WizardPage

Returns:

The FinishAction

See Also:

WizardPage.getFinishAction()

setHelpAction

public void setHelpAction(WizardAction helpAction)

The action that should be executed when the help button is clicked. If the help button should be disabled on this page, set this to null.

Parameters:

helpAction - The helpAction to set.

getHelpAction

public WizardAction getHelpAction()

Description copied from interface: WizardPage

The action that should be executed when the help button is clicked. If the help button should be disabled on this page, then this must return null.

Specified by:

getHelpAction in interface WizardPage

Returns:

The HelpAction

See Also:

WizardPage.getHelpAction()

setIcon

public void setIcon(javax.swing.Icon icon)

The icon that represents this page. This icon could be used is a wizard title bar.

Parameters:

icon - the icon

getIcon

public javax.swing.Icon getIcon()

Description copied from interface: WizardPage

The icon that represents this page. This icon could be used is a wizard title bar. This should be an 64x64 icon.

Specified by:

getIcon in interface WizardPage

Returns:

The icon

See Also:

WizardPage.getIcon()

setNextAction

public void setNextAction(WizardAction nextAction)

The action that should be executed when the next button is clicked. If the next button should be disabled on this page, set this to null.

Parameters:

nextAction - The nextAction to set.

getNextAction

public WizardAction getNextAction()

Description copied from interface: WizardPage

The action that should be executed when the next button is clicked. If the next button should be disabled on this page, then this must return null.

Specified by:

getNextAction in interface WizardPage

Returns:

The NextAction

See Also:

WizardPage.getNextAction()

getPageComponent

public javax.swing.JComponent getPageComponent()

Description copied from interface: WizardPage

The JComponent that represents this page.

Specified by:

getPageComponent in interface WizardPage

Returns:

the pageComponent

See Also:

WizardPage.getPageComponent()

setPreviousAction

public void setPreviousAction(WizardAction previousAction)

The action that should be executed when the previous button is clicked. If the previous button should be disabled on this page, set this to null.

Parameters:

previousAction - The previousAction to set.

getPreviousAction

public WizardAction getPreviousAction()

Description copied from interface: WizardPage

The action that should be executed when the previous button is clicked. If the previous button should be disabled on this page, then this must return null.

Specified by:

getPreviousAction in interface WizardPage

Returns:

the PreviousAction

See Also:

WizardPage.getPreviousAction()

setTitle

public void setTitle(java.lang.String title)

The title of this page. This could be used in the title bar of a wizard.

Parameters:

title - the title of the page

getTitle

public java.lang.String getTitle()

Description copied from interface: WizardPage

The title of this page. This could be used in the title bar of a wizard.

Specified by:

getTitle in interface WizardPage

Returns:

the title

See Also:

WizardPage.getTitle()

getWizard

public final Wizard getWizard()

Description copied from interface: WizardPage

Get the parent wizard

Specified by:

getWizard in interface WizardPage

Returns:

the wizard this page belongs to

See Also:

WizardPage.getWizard()

setWizard

public void setWizard(Wizard wizard)

Description copied from interface: WizardPage

This method should only be called by JLWizard, when adding a page to it.

Specified by:

setWizard in interface WizardPage

Parameters:

wizard - the wizard this page belongs to.

See Also:

WizardPage.setWizard(com.ozziefix.jlwizard.Wizard)