org.openbp.swing.components.wizard
Class WizardPage

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.openbp.swing.components.wizard.WizardPage

All Implemented Interfaces:

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

public abstract class WizardPage
extends javax.swing.JPanel
implements WizardValidator, WizardListener

Base class for wizard panels.

Author:

Heiko Erhardt

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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

boolean	canCancel Cancel status flag
boolean	canFinish Finish status flag
boolean	canMoveBackward Move backward status flag
boolean	canMoveForward Move forward status flag

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

WizardPage(Wizard wizard)
Default constructor.

WizardPage(Wizard wizard, java.lang.String title)
Default constructor.

WizardPage(Wizard wizard, java.lang.String title, java.lang.String description)
Default constructor.

WizardPage(Wizard wizard, java.lang.String title, java.lang.String description, javax.swing.ImageIcon wizardImage)
Constructor.

WizardPage(Wizard wizard, java.lang.String title, java.lang.String description, javax.swing.ImageIcon wizardImage, javax.swing.ImageIcon backgroundImage)
Constructor.

Method Summary

boolean	canCancel() Determines if we can cancel the wizard dialog at this point.
boolean	canFinish() Determines if we can finish the wizard dialog at this point.
boolean	canMoveBackward() Determines if we can return to the previous page.
boolean	canMoveForward() Determines if we can advance to the next page.
javax.swing.ImageIcon	getBackgroundImage() Gets the background image.
WizardDataModel	getDataModel() Gets the wizard's data model.
java.lang.String	getDescription() Gets the description text.
java.awt.Component	getFocusComponent() Returns the focus component of this plugin, i\.e\. the component that is to initially receive the focus.
SequenceManager	getSequenceManager() Gets the wizard's sequence manager.
java.lang.String	getTitle() Gets the title of the page.
Wizard	getWizard() Gets the wizard that owns the panel.
javax.swing.ImageIcon	getWizardImage() Gets the wizard image.
void	handleWizardEvent(WizardEvent event) Handles a wizard event caused by this wizard page.
void	setBackgroundImage(javax.swing.ImageIcon backgroundImage) Sets the background image.
void	setDescription(java.lang.String description) Sets the description text.
void	setTitle(java.lang.String title) Sets the title of the page.
void	setWizard(Wizard wizard) Sets the wizard that owns the panel.
void	setWizardImage(javax.swing.ImageIcon wizardImage) Sets the wizard image.
void	updateNavigator() Updates the navigation bar.

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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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

Field Detail

canMoveForward

public boolean canMoveForward

Move forward status flag

canMoveBackward

public boolean canMoveBackward

Move backward status flag

canFinish

public boolean canFinish

Finish status flag

canCancel

public boolean canCancel

Cancel status flag

Constructor Detail

WizardPage

public WizardPage(Wizard wizard)

Default constructor.

Parameters:

wizard - Wizard that owns the panel

WizardPage

public WizardPage(Wizard wizard,
                  java.lang.String title)

Default constructor.

Parameters:

wizard - Wizard that owns the panel

title - Title of the page

WizardPage

public WizardPage(Wizard wizard,
                  java.lang.String title,
                  java.lang.String description)

Default constructor.

Parameters:

wizard - Wizard that owns the panel

title - Title of the page

description - Description text

WizardPage

public WizardPage(Wizard wizard,
                  java.lang.String title,
                  java.lang.String description,
                  javax.swing.ImageIcon wizardImage)

Constructor.

Parameters:

wizard - Wizard that owns the panel

title - Title of the page

description - Description text

wizardImage - Wizard image

WizardPage

public WizardPage(Wizard wizard,
                  java.lang.String title,
                  java.lang.String description,
                  javax.swing.ImageIcon wizardImage,
                  javax.swing.ImageIcon backgroundImage)

Constructor.

Parameters:

wizard - Wizard that owns the panel

title - Title of the page

description - Description text

wizardImage - Wizard image

backgroundImage - Background image

Method Detail

updateNavigator

public void updateNavigator()

Updates the navigation bar. This method should be called if a page that does not make use of the wizard data model (see getDataModel()) has changed its status and wants to update the state of the navigation bar buttons accordingly.

getFocusComponent

public java.awt.Component getFocusComponent()

Returns the focus component of this plugin, i\.e\. the component that is to initially receive the focus.

Returns:

The return value defaults to the this page

handleWizardEvent

public void handleWizardEvent(WizardEvent event)

Handles a wizard event caused by this wizard page.

Specified by:

handleWizardEvent in interface WizardListener

Parameters:

event - Event to handle

canMoveForward

public boolean canMoveForward()

Determines if we can advance to the next page. Default: false.

Specified by:

canMoveForward in interface WizardValidator

canMoveBackward

public boolean canMoveBackward()

Determines if we can return to the previous page. Default: true.

Specified by:

canMoveBackward in interface WizardValidator

canFinish

public boolean canFinish()

Determines if we can finish the wizard dialog at this point. Default: false.

Specified by:

canFinish in interface WizardValidator

canCancel

public boolean canCancel()

Determines if we can cancel the wizard dialog at this point. Default: false.

Specified by:

canCancel in interface WizardValidator

getTitle

public java.lang.String getTitle()

Gets the title of the page.

setTitle

public void setTitle(java.lang.String title)

Sets the title of the page.

getDescription

public java.lang.String getDescription()

Gets the description text.

setDescription

public void setDescription(java.lang.String description)

Sets the description text.

getWizardImage

public javax.swing.ImageIcon getWizardImage()

Gets the wizard image.

setWizardImage

public void setWizardImage(javax.swing.ImageIcon wizardImage)

Sets the wizard image.

getBackgroundImage

public javax.swing.ImageIcon getBackgroundImage()

Gets the background image.

setBackgroundImage

public void setBackgroundImage(javax.swing.ImageIcon backgroundImage)

Sets the background image.

getWizard

public Wizard getWizard()

Gets the wizard that owns the panel.

setWizard

public void setWizard(Wizard wizard)

Sets the wizard that owns the panel.

getDataModel

public WizardDataModel getDataModel()

Gets the wizard's data model.

getSequenceManager

public SequenceManager getSequenceManager()

Gets the wizard's sequence manager.