net.sf.juife.wizard
Class WizardPage

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  net.sf.juife.wizard.WizardPage

All Implemented Interfaces:

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

Direct Known Subclasses:

ConfirmationPage, OverviewPage, ProgressPage, SummaryPage, UserInputPage

public class WizardPage
extends javax.swing.JPanel

The base class for all types of wizard pages. Override this class if you want to create a custom wizard page of a specific type.

See Also:

WizardPage.Type, Serialized Form

Nested Class Summary

static class	WizardPage.OptionalButtons Represents the optional buttons to be shown in the wizard when the page becomes current.
static class	WizardPage.Type Represents the type of a wizard page.

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

WizardPage()
Creates a new WizardPage with null subtitle and description.

WizardPage(java.lang.String subtitle)
Creates a WizardPage with the specified subtitle and null description.

WizardPage(java.lang.String subtitle, java.lang.String description)
Creates a WizardPage with the specified subtitle and description.

WizardPage(java.lang.String subtitle, java.lang.String description, WizardPage.Type pageType)
Creates a WizardPage with the specified subtitle, description and page type.

WizardPage(java.lang.String subtitle, java.lang.String description, WizardPage.Type pageType, WizardPage.OptionalButtons optionalButtons)
Creates a WizardPage with the specified subtitle, description, page type and optional buttons.

Method Summary

java.lang.String	getDescription() Gets a brief description about this page.
WizardPage.OptionalButtons	getOptionalButtons() Determines the optional buttons that will be shown in the wizard when this page becomes current.
WizardPage.Type	getPageType() Gets the type of this page.
java.lang.String	getSubtitle() Gets the subtitle for this page.
boolean	mayCancel() Invoked when the user clicks the 'Cancel' button while this page is the current page of the wizard.
boolean	mayClose() Invoked when the user clicks the 'Close' button while this page is the current page of the wizard.
boolean	mayFinish() Invoked when the user clicks the 'Finish' button while this page is the current page of the wizard.
boolean	mayGoToLast() Invoked when the user clicks the 'Last' button while this page is the current page of the wizard.
boolean	mayGoToNext() Invoked when the user clicks the 'Next' button while this page is the current page of the wizard.
boolean	mayGoToPrevious() Invoked when the user clicks the 'Back' button while this page is the current page of the wizard.
void	setDescription(java.lang.String s) Sets a brief description about this page.
void	setOptionalButtons(WizardPage.OptionalButtons optionalButtons) Sets the optional buttons to be displayed in the wizard when this page becomes current.
void	setPageType(WizardPage.Type pageType) Sets the type of this page.
void	setSubtitle(java.lang.String subtitle) Sets the subtitle for this page.
void	showHelp() Invoked when the user clicks the Help button of the wizard.

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

Constructor Detail

WizardPage

public WizardPage()

Creates a new WizardPage with null subtitle and description.

WizardPage

public WizardPage(java.lang.String subtitle)

Creates a WizardPage with the specified subtitle and null description.

Parameters:

subtitle - The subtitle text to be shown in the wizard when this page becomes current.

WizardPage

public WizardPage(java.lang.String subtitle,
                  java.lang.String description)

Creates a WizardPage with the specified subtitle and description.

Parameters:

subtitle - The subtitle text to be shown in the wizard when this page becomes current.

description - A brief description of the page.

WizardPage

public WizardPage(java.lang.String subtitle,
                  java.lang.String description,
                  WizardPage.Type pageType)

Creates a WizardPage with the specified subtitle, description and page type.

Parameters:

subtitle - The subtitle text to be shown in the wizard when this page becomes current.

description - A brief description of the page.

pageType - Specifies the page type.

WizardPage

public WizardPage(java.lang.String subtitle,
                  java.lang.String description,
                  WizardPage.Type pageType,
                  WizardPage.OptionalButtons optionalButtons)

Creates a WizardPage with the specified subtitle, description, page type and optional buttons.

Parameters:

subtitle - The subtitle text to be shown in the wizard when this page becomes current.

description - A brief description of the page.

pageType - Specifies the page type.

optionalButtons - Specifies the optional buttons to be shown in the wizard when this wizard page becomes current.

Method Detail

getDescription

public java.lang.String getDescription()

Gets a brief description about this page.

Returns:

Returns a brief description about this page or null if this is not the first page in current step

setDescription

public void setDescription(java.lang.String s)

Sets a brief description about this page. This description is used by Wizard to create a list of steps in his Left Pane.

Notice that each step in the list can correspond to more than one wizard pages. To achieve this set the description text only in the first page and null in next pages of current step

getSubtitle

public java.lang.String getSubtitle()

Gets the subtitle for this page.

Returns:

the subtitle for this page.

setSubtitle

public void setSubtitle(java.lang.String subtitle)

Sets the subtitle for this page.

getPageType

public WizardPage.Type getPageType()

Gets the type of this page.

Returns:

The type of this page.

setPageType

public void setPageType(WizardPage.Type pageType)

Sets the type of this page.

Parameters:

pageType - The new type of this page.

getOptionalButtons

public WizardPage.OptionalButtons getOptionalButtons()

Determines the optional buttons that will be shown in the wizard when this page becomes current.

Returns:

An OptionalButtons instance specifying the optional buttons that will be shown in the wizard when this wizard page becomes current.

setOptionalButtons

public void setOptionalButtons(WizardPage.OptionalButtons optionalButtons)

Sets the optional buttons to be displayed in the wizard when this page becomes current.

Parameters:

optionalButtons - Specifies the optional buttons to be shown in the wizard when this wizard page becomes current.

mayGoToPrevious

public boolean mayGoToPrevious()

Invoked when the user clicks the 'Back' button while this page is the current page of the wizard. Override this method to cancel the movement to previous page, or to do some additional tasks before that. The return value determines whether the movement to previous page should be done. You should return true to allow the wizard to go to previous page, and false to cancel this operation.

Returns:

true

mayGoToNext

public boolean mayGoToNext()

Invoked when the user clicks the 'Next' button while this page is the current page of the wizard. Override this method to cancel the movement to next page, or to do some additional tasks before that. The return value determines whether the movement to next page should be done. You should return true to allow the wizard to go to next page, and false to cancel this operation.

Returns:

true

mayGoToLast

public boolean mayGoToLast()

Invoked when the user clicks the 'Last' button while this page is the current page of the wizard. Override this method to cancel the movement to last page, or to do some additional tasks before that. The return value determines whether the movement to last page should be done. You should return true to allow the wizard to go to last page, and false to cancel this operation.

Returns:

true

mayFinish

public boolean mayFinish()

Invoked when the user clicks the 'Finish' button while this page is the current page of the wizard. Override this method to cancel this operation, or to do some additional tasks before that. The return value determines whether this operation should be done. You should return true to allow the wizard to finish, and false to cancel this operation.

Returns:

true

mayCancel

public boolean mayCancel()

Invoked when the user clicks the 'Cancel' button while this page is the current page of the wizard. Override this method to cancel this operation, or to do some additional tasks before that. The return value determines whether this operation should be done. You should return true to allow the wizard to cancel, and false otherwise.

Returns:

true

mayClose

public boolean mayClose()

Invoked when the user clicks the 'Close' button while this page is the current page of the wizard. Override this method to cancel this operation, or to do some additional tasks before that. The return value determines whether this operation should be done. You should return true to allow the wizard to close, and false otherwise.

Returns:

true

showHelp

public void showHelp()

Invoked when the user clicks the Help button of the wizard. Override this method to show some additional help to the user about this page.