Extension SDK 10.1.2


oracle.ide.panels
Class FSMWizard

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byoracle.bali.ewt.painter.PaintContextComponent
                  extended byoracle.bali.ewt.LWComponent
                      extended byoracle.bali.ewt.wizard.BaseWizard
                          extended byoracle.bali.ewt.wizard.Wizard
                              extended byoracle.ide.panels.FSMWizard

All Implemented Interfaces:
javax.accessibility.Accessible, CommitNotifier, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

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

This class integrates the notion of an FSM-drive wizard with the support of the Bali Wizard framework.

See Also:
Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

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
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.
protected void doCancel()
protected void doFinish()
protected void doNext()
protected void doPrevious()
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.
void removeCommitListener(CommitListener commitListener)
Removes a previously added CommitListener so that it no longer receives notification when the user applies or cancels changes.
void setDialog(oracle.bali.ewt.wizard.WizardDialog dialog)
This method takes an instance of WizardDialog and associates it with the FSMWizard so that WizardCallback 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
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)
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, dispose, getMustFinish, pagePropertyChange, removeAllPages, removePage, setMustFinish, setSelectedPage, updateUI

Methods inherited from class oracle.bali.ewt.wizard.BaseWizard
addCustomButton, addImpl, addNotify, addPage, addPageImpl, addPages, addWizardListener, disable, doApply, doHelp, 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, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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)

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

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 WizardCallback 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.


doFinish

protected void doFinish()

doNext

protected void doNext()

doPrevious

protected void doPrevious()

doCancel

protected void doCancel()

Extension SDK


Copyright © 1997, 2004, Oracle. All rights reserved.