oracle.ide.wizard
Class FSMWizard

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
                              oracle.ide.wizard.FSMWizard

All Implemented Interfaces:

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

public final class FSMWizard
extends oracle.bali.ewt.wizard.Wizard
implements CommitNotifier

This class implements an FSM-driven sequence of pages hosted within a Bali Wizard.

See Also:

Serialized Form

Nested Class Summary

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

Fields inherited from class oracle.bali.ewt.wizard.BaseWizard

BILLBOARD, LARGE_SIZE, LARGE_SIZE2, MNEMONIC_APPLY, MNEMONIC_CANCEL, MNEMONIC_FINISH, MNEMONIC_HELP, MNEMONIC_NEXT, MNEMONIC_PREVIOUS, MNEMONIC_SAVE, PAGE_CONTAINER, SMALL_SIZE, SMALL_SIZE2, VALIDATION_MESSAGE

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

FSMWizard(FSM fsm, Namespace data)
Creates an instance of FSMWizard using the specified FSM to drive the sequence of panels and the specified Namespace as the backing storage for the TraversableContext that is passed to the panels in their onEntry(...) and onExit(...) methods.

FSMWizard(Step[] steps, Namespace data)
Creates a straight-through FSMWizard using the specified sequence of Steps.

Method Summary

void	addCommitListener(CommitListener commitListener) Adds an CommitListener that will be called when the user applies or cancels changes.
void	addFSMWizardListener(FSMWizardListener listener)
void	dispose() Dispose any memory associated with the Wizard.
protected void	doCancel() Override to fire ApplyEvent.
protected void	doFinish() This method only delegates to super.doFinish() if exiting the current panel succeeds.
protected void	doNext() Handles the user hitting the "Next" button.
protected void	doPrevious() Handles the user hitting the "Previous" button.
oracle.bali.ewt.wizard.WizardDialog	getDialog(java.awt.Dialog parent)
oracle.bali.ewt.wizard.WizardDialog	getDialog(java.awt.Frame parent) This method returns an instance of WizardDialog that is initialized to interact with the FSMWizard.
boolean	getShowStepNumber() Returns true if the FSMWizard has been set to show step numbers in the page title, false otherwise.
boolean	isDisposed()
void	removeCommitListener(CommitListener commitListener) Removes a previously added CommitListener so that it no longer receives notification when the user applies or cancels changes.
void	removeFSMWizardListener(FSMWizardListener listener)
void	reset() Resets the wizard.
protected void	selectPage(oracle.bali.ewt.wizard.WizardPage page, boolean doValidate)
void	setDialog(oracle.bali.ewt.wizard.WizardDialog dialog) This method takes an instance of WizardDialog and associates it with the FSMWizard so that WizardCallbacks messages coming from the individual panels will be routed to the WizardDialog.
void	setFinishPageAdded(boolean pageAdded) Sets whether or not a finish page has been added to the FSMWizard
protected void	setSelectedPage(oracle.bali.ewt.wizard.WizardPage page) Override to move to the correct panel.
void	setShowStepNumber(boolean showStepNumber)
void	setWelcomePageAdded(boolean pageAdded) Sets whether or not a welcome page has been added to the FSMWizard
void	setWizardTitle(java.lang.String wizardTitle) As per the spec, this title should be of the form: "Product or Wizard Name - Process Name"
void	updateImage(java.awt.Image newImage) Sets the large wizard image that is shown on the left side of the wizard.

Methods inherited from class oracle.bali.ewt.wizard.Wizard

addPage, getMustFinish, pagePropertyChange, removeAllPages, removePage, setMustFinish, updateUI

Methods inherited from class oracle.bali.ewt.wizard.BaseWizard

__setSplitterMode, addCustomButton, addImpl, addNotify, addPage, addPageImpl, addPages, addWizardListener, createDefaultWizardBackgroundHandler, disable, doApply, doClose, doHelp, doSave, enable, enableButtons, getAccessibleContext, getAuxiliaryPane, getAuxiliaryPaneHeight, getBackgroundHandler, getBillboard, getBottomContentMode, getButtonMnemonic, getCanAdvance, getCanApply, getCanGoBack, getCanSave, getCurrentPageIndex, getDefaultWizardSize, getEndOfProcessWizardPage, getFinishMnemonic, getFinishText, getHeaderGradientBackground, getLogoImage, getNextPage, getPageAt, getPageCount, getPreferredSize, getPreviousPage, getProgressWizardPage, getReservedButtonSpaces, getSelectedPage, getUIClassID, getValidationMessagePane, isAllLinksEnabled, isAllLinksEnabledOnFinish, isFlatLook, isHelpAvailable, isImageWizardPageSupported, isRoadmapVisible, isSplitterMode, isVisitedLinkEnabled, isWelcomeWizardPageVisible, loadWizardProperties, paramString, processEventImpl, processWizardEvent, removeCustomButton, removeWizardListener, resetFocus, restart, selectPage, setAllLinksEnabled, setAllLinksEnabledOnFinish, setAuxiliaryPane, setAuxiliaryPaneHeight, setBackgroundHandler, setBillboard, setBottomContentMode, setCanApply, setCanSave, setCurrentPageIndex, setDefaultWizardSize, setEndOfProcessWizardPage, setFinishMnemonic, setFinishText, setFlatLook, setHeaderGradientBackground, setHelpAvailable, setImageWizardPageSupported, setLocale, setLogoImage, setProgressWizardPage, setReservedButtonSpaces, setRoadmapVisible, setSplitterMode, setValidationMessagePane, setVisitedLinkEnabled, setWelcomeWizardPageVisible, 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, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, 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, 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, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

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

FSMWizard

public FSMWizard(Step[] steps,
                 Namespace data)

Creates a straight-through FSMWizard using the specified sequence of Steps.

FSMWizard

public FSMWizard(FSM fsm,
                 Namespace data)

Creates an instance of FSMWizard using the specified FSM to drive the sequence of panels and the specified Namespace as the backing storage for the TraversableContext that is passed to the panels in their onEntry(...) and onExit(...) methods.

Method Detail

setWizardTitle

public void setWizardTitle(java.lang.String wizardTitle)

As per the spec, this title should be of the form: "Product or Wizard Name - Process Name"

setShowStepNumber

public void setShowStepNumber(boolean showStepNumber)

getShowStepNumber

public boolean getShowStepNumber()

Returns true if the FSMWizard has been set to show step numbers in the page title, false otherwise.

setWelcomePageAdded

public void setWelcomePageAdded(boolean pageAdded)

Sets whether or not a welcome page has been added to the FSMWizard

setFinishPageAdded

public void setFinishPageAdded(boolean pageAdded)

Sets whether or not a finish page has been added to the FSMWizard

addCommitListener

public void addCommitListener(CommitListener commitListener)

Description copied from interface: CommitNotifier

Adds an CommitListener that will be called when the user applies or cancels changes.

Specified by:

addCommitListener in interface CommitNotifier

removeCommitListener

public void removeCommitListener(CommitListener commitListener)

Description copied from interface: CommitNotifier

Removes a previously added CommitListener so that it no longer receives notification when the user applies or cancels changes.

Specified by:

removeCommitListener in interface CommitNotifier

addFSMWizardListener

public void addFSMWizardListener(FSMWizardListener listener)

removeFSMWizardListener

public void removeFSMWizardListener(FSMWizardListener listener)

updateImage

public void updateImage(java.awt.Image newImage)

Sets the large wizard image that is shown on the left side of the wizard.

getDialog

public oracle.bali.ewt.wizard.WizardDialog getDialog(java.awt.Frame parent)

This method returns an instance of WizardDialog that is initialized to interact with the FSMWizard. This method will return the same WizardDialog instance on subsequent invocations, even if the specified Frame is different.

getDialog

public oracle.bali.ewt.wizard.WizardDialog getDialog(java.awt.Dialog parent)

setDialog

public void setDialog(oracle.bali.ewt.wizard.WizardDialog dialog)

This method takes an instance of WizardDialog and associates it with the FSMWizard so that WizardCallbacks messages coming from the individual panels will be routed to the WizardDialog. This method only needs to be used if the WizardDialog needs to be created or initialized in some custom way before displaying the FSMWizard.

If the specified WizardDialog is null, then any currently associated dialog will be unassociated.

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 oracle.bali.ewt.wizard.Wizard

isDisposed

public boolean isDisposed()

reset

public void reset()

Resets the wizard. Override to rest the fsm.

Overrides:

reset in class oracle.bali.ewt.wizard.BaseWizard

doPrevious

protected void doPrevious()

Handles the user hitting the "Previous" button. Overridden to validate FSM before moving to the previous page.

Overrides:

doPrevious in class oracle.bali.ewt.wizard.BaseWizard

doNext

protected void doNext()

Handles the user hitting the "Next" button. Overridden to validate FSM before moving to the previous page.

Overrides:

doNext in class oracle.bali.ewt.wizard.BaseWizard

doFinish

protected void doFinish()

This method only delegates to super.doFinish() if exiting the current panel succeeds.

Overrides:

doFinish in class oracle.bali.ewt.wizard.BaseWizard

doCancel

protected void doCancel()

Override to fire ApplyEvent.

Overrides:

doCancel in class oracle.bali.ewt.wizard.BaseWizard

selectPage

protected void selectPage(oracle.bali.ewt.wizard.WizardPage page,
                          boolean doValidate)

Overrides:

selectPage in class oracle.bali.ewt.wizard.BaseWizard

setSelectedPage

protected void setSelectedPage(oracle.bali.ewt.wizard.WizardPage page)

Override to move to the correct panel.

Overrides:

setSelectedPage in class oracle.bali.ewt.wizard.Wizard