Class WizardFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

ca.phon.ui.CommonModuleFrame

ca.phon.ui.wizard.WizardFrame

All Implemented Interfaces:

IExtendable, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

AnonymizeParticipantInfoWizard, BreadcrumbWizardFrame, DeriveSessionWizard, GitCommitWizard, ReportWizard

public class WizardFrame
extends CommonModuleFrame

A basic wizard implementation. Since Phon 2.2, this component includes a breadCrumb viewer which is not shown by default. To display the breadCrumb, use the setBreadcrumbVisible() method.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JFrame

JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow, Window.Type

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected JButton	btnBack
protected JButton	btnCancel
protected JButton	btnFinish
protected JButton	btnNext
protected JPanel	buttonPanel
protected JPanel	stepPanel

Fields inherited from class ca.phon.ui.CommonModuleFrame

DEFAULT_MACOS_ENABLE_FULLSCREEN, MACOS_ENABLE_FULLSCREEN, title

Fields inherited from class javax.swing.JFrame

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
WizardFrame(String title)

Method Summary

Modifier and Type	Method	Description
void	addListener(WizardListener listener)
void	addWizardStep(int idx, WizardStep ws)
void	addWizardStep(WizardStep ws)
WizardStep	addWizardStep(JComponent comp)
protected void	cancel()
protected void	finish()
void	fireWizardEvent(WizardEvent event)
WizardStep	getCurrentStep()
int	getCurrentStepIndex()
int	getStepIndex(WizardStep step)
WizardStep	getWizardStep(int idx)
void	gotoStep(int stepIndex)
protected void	next()
int	numberOfSteps()
protected void	prev()
void	removeAllSteps()
void	removeListener(WizardListener listener)
void	removeWizardStep(WizardStep ws)
protected void	setupButtons()
void	setVisible(boolean vis)
protected void	showBusyLabel(JComponent comp)
void	showWizard()
protected void	stopBusyLabel()

Methods inherited from class ca.phon.ui.CommonModuleFrame

addNewWindowListener, cascadeWindow, centerWindow, close, display, getCurrentFrame, getExtension, getExtensions, getOpenWindows, getParentFrame, getProjectWindows, getTitle, getUnsavedChangesMessage, getUnsavedChangesTitle, getWindowName, hasUnsavedChanges, hideStatusComponent, isShowInWindowMenu, placeTopRight, positionRelativeTo, putExtension, removeExtension, resetStatusComponent, saveAndClose, saveData, setModified, setParentFrame, setShowInWindowMenu, setUnsavedChangesMessage, setUnsavedChangesTitle, setWindowName, showErrorMessage, showMessageDialog, showOkCancelDialog, showOkDialog, showStatusMessage, showYesNoCancelDialog, showYesNoDialog

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Details

buttonPanel

protected JPanel buttonPanel

btnBack

protected JButton btnBack

btnNext

protected JButton btnNext

btnFinish

protected JButton btnFinish

btnCancel

protected JButton btnCancel

stepPanel

protected JPanel stepPanel

Constructor Details

WizardFrame

public WizardFrame(String title)

Method Details

getStepIndex

public int getStepIndex(WizardStep step)

getWizardStep

public WizardStep getWizardStep(int idx)

addWizardStep

public void addWizardStep(int idx,
 WizardStep ws)

addWizardStep

public void addWizardStep(WizardStep ws)

addWizardStep

public WizardStep addWizardStep(JComponent comp)

removeWizardStep

public void removeWizardStep(WizardStep ws)

removeAllSteps

public void removeAllSteps()

numberOfSteps

public int numberOfSteps()

gotoStep

public void gotoStep(int stepIndex)

setupButtons

protected void setupButtons()

next

protected void next()

prev

protected void prev()

finish

protected void finish()

cancel

protected void cancel()

setVisible

public void setVisible(boolean vis)

Overrides:

setVisible in class Window

getCurrentStep

public WizardStep getCurrentStep()

getCurrentStepIndex

public int getCurrentStepIndex()

showWizard

public void showWizard()

showBusyLabel

protected void showBusyLabel(JComponent comp)

stopBusyLabel

protected void stopBusyLabel()

addListener

public void addListener(WizardListener listener)

removeListener

public void removeListener(WizardListener listener)

fireWizardEvent

public void fireWizardEvent(WizardEvent event)