allensoft.gui
Class WizardPage

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--allensoft.gui.WizardPage

All Implemented Interfaces:

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

Direct Known Subclasses:

BugReportWizard.BugDetailsPage, BugReportWizard.HowToReproducePage, BugReportWizard.SummaryPage, BugReportWizard.UserDetailsPage

public class WizardPage

extends javax.swing.JPanel

Defines one page in a Wizard dialog.

See Also:

Serialized Form

Inner classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Inner classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Inner classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent

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 empty wizard page.

WizardPage(java.awt.Component page)
Creates a new wizard page which displays the supplied component.

WizardPage(java.lang.String sMessage)
Creates a WizardPage that displays the supplied message at the top.

WizardPage(java.lang.String sMessage, java.awt.Component component)
Creates a WizardPage that displays the supplied message at the top and the suplied component at the bottom.

Method Summary

java.awt.Insets	getInsets()
protected WizardPage[]	getNextPages() If this page dynamically creates decides what pages should follow it in the wizard then this method should be overridden to return the pages that follow it.
Wizard	getWizard() Gets the wizard this page is displayed in.
protected boolean	isDynamicPage() If this wizard page dynamically decides what pages should follow it in the wizard then this method should be overridden to return true.
boolean	isPageValid() Checks if this page is valid before moving to another page in the wizard.
protected void	onChangePage() Called when the wizard moves off of this page.
protected void	onFinish() Called when the user clicks "Finish".
protected void	onRemove() Called when this page is removed from the wizard.
protected void	onSelectPage() Called when this page is made the current page in the wizard.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUIClassID, paramString, 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, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus

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 empty wizard page.

WizardPage

public WizardPage(java.awt.Component page)

Creates a new wizard page which displays the supplied component.

WizardPage

public WizardPage(java.lang.String sMessage)

Creates a WizardPage that displays the supplied message at the top. The layout is set to a vertical strip layout so any new components added will be below the message. The message can be in HTML format.

WizardPage

public WizardPage(java.lang.String sMessage,
                  java.awt.Component component)

Creates a WizardPage that displays the supplied message at the top and the suplied component at the bottom.

Method Detail

getInsets

public java.awt.Insets getInsets()

Overrides:

getInsets in class javax.swing.JComponent

getWizard

public Wizard getWizard()

Gets the wizard this page is displayed in.

isDynamicPage

protected boolean isDynamicPage()

If this wizard page dynamically decides what pages should follow it in the wizard then this method should be overridden to return true.

getNextPages

protected WizardPage[] getNextPages()

If this page dynamically creates decides what pages should follow it in the wizard then this method should be overridden to return the pages that follow it.

isPageValid

public boolean isPageValid()

Checks if this page is valid before moving to another page in the wizard. This can be used to validate user input for this page.

Returns:

true if this page is valid or false otherwise.

onSelectPage

protected void onSelectPage()

Called when this page is made the current page in the wizard.

onChangePage

protected void onChangePage()

Called when the wizard moves off of this page.

onRemove

protected void onRemove()

Called when this page is removed from the wizard.

onFinish

protected void onFinish()

Called when the user clicks "Finish". This is called for all pages not just the currently selected page in the wizard.