Oracle JEWT 4.2.10

oracle.bali.ewt.wizard
Class Wizard

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--oracle.bali.ewt.painter.PaintContextComponent
                          |
                          +--oracle.bali.ewt.LWComponent
                                |
                                +--oracle.bali.ewt.wizard.BaseWizard
                                      |
                                      +--oracle.bali.ewt.wizard.Wizard
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable
Direct Known Subclasses:
DWizard

public class Wizard
extends BaseWizard

The Wizard class provides an implementation of a wizard with a simple, linear user interface.

The Wizard class also allows clients to enable and disable the "Finish" button by calling setMustFinish(). By default, the finish button is only enabled when the user has navigated to the last page (i.e., when getNextPage returns null). When the mustFinish property is set to false, the finish button is always enabled. (There is no way to disable the finish button on the last page.)

See Also:
BaseWizard, Serialized Form

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 oracle.bali.ewt.wizard.BaseWizard
MNEMONIC_APPLY, MNEMONIC_CANCEL, MNEMONIC_FINISH, MNEMONIC_HELP, MNEMONIC_NEXT, MNEMONIC_PREVIOUS
 
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
Wizard()
          Creates an empty wizard with default values.
 
Method Summary
 WizardPage addPage(WizardPage page, WizardPage beforeWhichPage)
          Adds a page to the wizard.
 void dispose()
          Dispose any memory associated with the Wizard.
 boolean getMustFinish()
          Checks whether the user can finish at any time, or must reach the last page before finishing.
protected  void pagePropertyChange(WizardPage page, java.beans.PropertyChangeEvent event)
          Called when any owned wizard page fires a PropertyChangeEvent.
 void removeAllPages()
          Removes all of the pages from the wizard.
 void removePage(WizardPage page)
          Removes a page from the wizard.
 void setMustFinish(boolean mustFinish)
          Sets whether the can finish at any time, or must reach the last page before finishing.
protected  void setSelectedPage(WizardPage page)
          Sets the selected page without delivering any events.
 void updateUI()
          Override to build the UI.
 
Methods inherited from class oracle.bali.ewt.wizard.BaseWizard
addCustomButton, addImpl, addNotify, addPage, addPageImpl, addPages, addWizardListener, disable, doApply, doCancel, doFinish, doHelp, doNext, doPrevious, enable, enableButtons, getAccessibleContext, getButtonMnemonic, getCanAdvance, getCanApply, getCanGoBack, getCurrentPageIndex, getFinishMnemonic, getFinishText, getNextPage, getPageAt, getPageCount, getPreferredSize, getPreviousPage, getReservedButtonSpaces, getSelectedPage, getUIClassID, isHelpAvailable, paramString, processEventImpl, processWizardEvent, removeCustomButton, removeWizardListener, resetFocus, restart, selectPage, selectPage, setCanApply, setCurrentPageIndex, setFinishMnemonic, setFinishText, setHelpAvailable, setLocale, setReservedButtonSpaces, updateReadingDirection, validateSelectedPage
 
Methods inherited from class oracle.bali.ewt.LWComponent
clipToParents, freezeRepaints, getActualAlignment, getActualReadingDirection, getAlignment, getBorderInsets, getDocumentSize, getFill, getPageBounds, getPrintPaintContext, isFocusTraversable, paintChildren, paintComponent, paintImmediateInterior, paintImmediateInterior, paintImmediately, paintOverChildren, printPage, processEvent, repaint, repaintInterior, repaintInterior, setAlignment, setFill, unfreezeRepaints
 
Methods inherited from class oracle.bali.ewt.painter.PaintContextComponent
getBorderContext, getPaintContext, getPaintData, getPaintState, getUIDefaults, setUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, 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, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, 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, 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

Wizard

public Wizard()
Creates an empty wizard with default values.

Defaults:

Method Detail

setMustFinish

public void setMustFinish(boolean mustFinish)
Sets whether the can finish at any time, or must reach the last page before finishing.
Parameters:
mustFinish - true to require the user to reach the last page, false to allow the user to finish at any time.

getMustFinish

public boolean getMustFinish()
Checks whether the user can finish at any time, or must reach the last page before finishing.
Overrides:
getMustFinish in class BaseWizard

addPage

public WizardPage addPage(WizardPage page,
                          WizardPage beforeWhichPage)
Adds a page to the wizard.
Overrides:
addPage in class BaseWizard
Parameters:
page - the page to be added.
beforeWhichPage - the page before which the new page should be added. If null, the page is added at the end.
Returns:
the added page.

removePage

public void removePage(WizardPage page)
Removes a page from the wizard.
Overrides:
removePage in class BaseWizard
Parameters:
page - the wizard page

removeAllPages

public void removeAllPages()
Removes all of the pages from the wizard.
Overrides:
removeAllPages in class BaseWizard

dispose

public void dispose()
Dispose any memory associated with the Wizard. Once this method is called the Wizard is unusable and clients should not call any methods on Wizard.
Overrides:
dispose in class BaseWizard

setSelectedPage

protected void setSelectedPage(WizardPage page)
Sets the selected page without delivering any events.
Overrides:
setSelectedPage in class BaseWizard

pagePropertyChange

protected void pagePropertyChange(WizardPage page,
                                  java.beans.PropertyChangeEvent event)
Called when any owned wizard page fires a PropertyChangeEvent. Subclassers must call super.pagePropertyChange().
Overrides:
pagePropertyChange in class BaseWizard
Parameters:
page - the WizardPage whose property's are changing
event - a PropertyChangeEvent

updateUI

public void updateUI()
Override to build the UI.
Overrides:
updateUI in class BaseWizard

Oracle JEWT 4.2.10