org.barrelorgandiscovery.gui.wizard

Class Wizard

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.barrelorgandiscovery.gui.wizard.Wizard

All Implemented Interfaces:

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

public class Wizard
extends javax.swing.JPanel
implements Disposable

Wizard component, maintain the wizard gui, maintain the current step state, maintain the navigation logic

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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 javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor and Description
Wizard(java.util.List<Step> steps, java.io.Serializable initialState) Construct the wizard, with all the steps

Method Summary

Modifier and Type	Method and Description
boolean	canGoNext() signal we can move to the next step in wizard
void	changeFurtherStepList(java.util.List<Step> nextsSteps)
protected int	countAllSteps() count all steps, return the number of steps in the collection
void	defineLastStepLabelName(java.lang.String lastStepLabel) define the last step label name
void	dispose() Dispose the resources associated to an object
int	getCurrentStepIndex() return the current step index
java.io.Serializable	getCurrentWizardState()
java.io.Serializable	getPagesStates() get the state of the pages and user input
boolean	isTerminated()
void	moveNext() move next, if possible
void	reinit(java.io.Serializable initialState) init the wizard using the initial state in parameters
void	reloadStatesIfPossible(java.io.Serializable initialState, Step[] stepList) try to load steps
void	setFinishedListener(FinishedListener finishedListener) define the finished listener
void	setHelpUrl(java.lang.String helpurl) define the help url
void	setShowLastButton(boolean showLastButton)
void	setStepBeforeChanged(StepBeforeChanged stepBeforeChanged) define the listener of before step changed
void	setStepChanged(StepChanged stepChanged) define the listener
void	toFirst() Go on the first step, and activate the step

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, 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, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, 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, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, 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, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, 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, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

Wizard

public Wizard(java.util.List<Step> steps,
              java.io.Serializable initialState)
       throws java.lang.Exception

Construct the wizard, with all the steps

Parameters:

steps -

Throws:

java.lang.Exception

Method Detail

changeFurtherStepList

public void changeFurtherStepList(java.util.List<Step> nextsSteps)

defineLastStepLabelName

public void defineLastStepLabelName(java.lang.String lastStepLabel)

define the last step label name

Parameters:

lastStepLabel -

setShowLastButton

public void setShowLastButton(boolean showLastButton)

reinit

public void reinit(java.io.Serializable initialState)
            throws java.lang.Exception

init the wizard using the initial state in parameters

Parameters:

initialState -

Throws:

java.lang.Exception

reloadStatesIfPossible

public void reloadStatesIfPossible(java.io.Serializable initialState,
                                   Step[] stepList)
                            throws java.lang.Exception

try to load steps

Parameters:

initialState -

Throws:

java.lang.Exception

setHelpUrl

public void setHelpUrl(java.lang.String helpurl)

define the help url

Parameters:

helpurl -

setFinishedListener

public void setFinishedListener(FinishedListener finishedListener)

define the finished listener

Parameters:

finishedListener -

toFirst

public void toFirst()
             throws java.lang.Exception

Go on the first step, and activate the step

Throws:

java.lang.Exception

getCurrentWizardState

public java.io.Serializable getCurrentWizardState()

Returns:

countAllSteps

protected int countAllSteps()

count all steps, return the number of steps in the collection

Returns:

canGoNext

public boolean canGoNext()

signal we can move to the next step in wizard

Returns:

isTerminated

public boolean isTerminated()

Returns:

getCurrentStepIndex

public int getCurrentStepIndex()

return the current step index

Returns:

moveNext

public void moveNext()
              throws java.lang.Exception

move next, if possible

Throws:

java.lang.Exception

getPagesStates

public java.io.Serializable getPagesStates()

get the state of the pages and user input

Returns:

setStepChanged

public void setStepChanged(StepChanged stepChanged)

define the listener

Parameters:

stepChanged -

setStepBeforeChanged

public void setStepBeforeChanged(StepBeforeChanged stepBeforeChanged)

define the listener of before step changed

Parameters:

stepBeforeChanged -

dispose

public void dispose()

Description copied from interface: Disposable

Dispose the resources associated to an object

Specified by:

dispose in interface Disposable