uk.ac.essex.common.wizard
Class DefaultWizardFlow

java.lang.Object
  uk.ac.essex.common.wizard.DefaultWizardFlow

All Implemented Interfaces:

WizardFlow

public class DefaultWizardFlow
extends java.lang.Object
implements WizardFlow

Created Date: 11-Jan-2004

You should have received a copy of Lesser GNU public license with this code. If not please visit this site

Field Summary

Fields inherited from interface uk.ac.essex.common.wizard.WizardFlow

CURRENT_PANEL_PROPERTY

Constructor Summary

DefaultWizardFlow()
This class is the "bread and butter" of this framework.

Method Summary

void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void	addWizardPanel(int index, WizardPanel panel)
void	addWizardPanel(WizardPanel panel)
void	addWizardPanelAfter(WizardPanel panelToBePlacedAfter, WizardPanel panel)
void	addWizardPanelAfterCurrent(WizardPanel panel)
void	addWizardPanelBefore(WizardPanel panelToBePlacedBefore, WizardPanel panel)
void	back()
void	cancel() Override to allow custom cancel behaviour
javax.swing.JButton	getBackButton()
javax.swing.JButton	getCancelButton()
int	getCurrentIndex()
WizardPanel	getCurrentPanel()
javax.swing.JButton	getFinishButton() Used by users to close the wizard, by default this is disabled
int	getIndexOfPanel(WizardPanel panel)
javax.swing.JButton	getNextButton()
WizardPanel	getWizardPanel(int index)
java.util.List	getWizardPanelList()
javax.swing.JPanel	getWizardPanelsContainer()
boolean	isFinishEnabled()
boolean	isNextEnabled()
void	next()
boolean	onLastPanel()
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
WizardPanel	removeWizardPanel(int index)
WizardPanel	removeWizardPanel(WizardPanel panel)
WizardPanel	removeWizardPanelAfter(WizardPanel panel)
WizardPanel	removeWizardPanelBefore(WizardPanel panel)
void	setBackButton(javax.swing.JButton aBackButton)
void	setCancelButton(javax.swing.JButton aCancelButton)
void	setCurrentIndex(int aCurrentIndex)
void	setFinishEnabled(boolean finishEnabled)
void	setNextButton(javax.swing.JButton aNextButton)
void	setNextEnabled(boolean nextEnabled)
void	setWizardPanelList(java.util.ArrayList panelList)
void	setWizardPanelList(java.util.List panelList)
void	updateComponents() Updates the components that wrap the content of the wizard.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultWizardFlow

public DefaultWizardFlow()

This class is the "bread and butter" of this framework. All of these components can be used visually however you want, as shown in the frame and example packages, but all a developer really needs is this, and they can even instead implement JWizard and choose to do this portion any way they wish.

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface WizardFlow

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface WizardFlow

addWizardPanel

public void addWizardPanel(WizardPanel panel)

Specified by:

addWizardPanel in interface WizardFlow

addWizardPanel

public void addWizardPanel(int index,
                           WizardPanel panel)

Specified by:

addWizardPanel in interface WizardFlow

addWizardPanelAfter

public void addWizardPanelAfter(WizardPanel panelToBePlacedAfter,
                                WizardPanel panel)

Specified by:

addWizardPanelAfter in interface WizardFlow

addWizardPanelBefore

public void addWizardPanelBefore(WizardPanel panelToBePlacedBefore,
                                 WizardPanel panel)

Specified by:

addWizardPanelBefore in interface WizardFlow

addWizardPanelAfterCurrent

public void addWizardPanelAfterCurrent(WizardPanel panel)

Specified by:

addWizardPanelAfterCurrent in interface WizardFlow

removeWizardPanel

public WizardPanel removeWizardPanel(WizardPanel panel)

Specified by:

removeWizardPanel in interface WizardFlow

removeWizardPanel

public WizardPanel removeWizardPanel(int index)

Specified by:

removeWizardPanel in interface WizardFlow

removeWizardPanelAfter

public WizardPanel removeWizardPanelAfter(WizardPanel panel)

Specified by:

removeWizardPanelAfter in interface WizardFlow

removeWizardPanelBefore

public WizardPanel removeWizardPanelBefore(WizardPanel panel)

Specified by:

removeWizardPanelBefore in interface WizardFlow

getWizardPanel

public WizardPanel getWizardPanel(int index)

Specified by:

getWizardPanel in interface WizardFlow

getIndexOfPanel

public int getIndexOfPanel(WizardPanel panel)

Specified by:

getIndexOfPanel in interface WizardFlow

onLastPanel

public boolean onLastPanel()

Specified by:

onLastPanel in interface WizardFlow

getCurrentPanel

public WizardPanel getCurrentPanel()

Specified by:

getCurrentPanel in interface WizardFlow

cancel

public void cancel()

Override to allow custom cancel behaviour

Specified by:

cancel in interface WizardFlow

updateComponents

public void updateComponents()

Updates the components that wrap the content of the wizard. This includes the next, previous buttons etc..

Specified by:

updateComponents in interface WizardFlow

next

public void next()

Specified by:

next in interface WizardFlow

back

public void back()

Specified by:

back in interface WizardFlow

getWizardPanelsContainer

public javax.swing.JPanel getWizardPanelsContainer()

Specified by:

getWizardPanelsContainer in interface WizardFlow

Returns:

getWizardPanelList

public java.util.List getWizardPanelList()

Specified by:

getWizardPanelList in interface WizardFlow

setWizardPanelList

public void setWizardPanelList(java.util.ArrayList panelList)

getCurrentIndex

public int getCurrentIndex()

Specified by:

getCurrentIndex in interface WizardFlow

setCurrentIndex

public void setCurrentIndex(int aCurrentIndex)

Specified by:

setCurrentIndex in interface WizardFlow

getBackButton

public javax.swing.JButton getBackButton()

Specified by:

getBackButton in interface WizardFlow

setBackButton

public void setBackButton(javax.swing.JButton aBackButton)

Specified by:

setBackButton in interface WizardFlow

getNextButton

public javax.swing.JButton getNextButton()

Specified by:

getNextButton in interface WizardFlow

setNextButton

public void setNextButton(javax.swing.JButton aNextButton)

Specified by:

setNextButton in interface WizardFlow

getCancelButton

public javax.swing.JButton getCancelButton()

Specified by:

getCancelButton in interface WizardFlow

setCancelButton

public void setCancelButton(javax.swing.JButton aCancelButton)

Specified by:

setCancelButton in interface WizardFlow

setWizardPanelList

public void setWizardPanelList(java.util.List panelList)

Specified by:

setWizardPanelList in interface WizardFlow

isNextEnabled

public boolean isNextEnabled()

Specified by:

isNextEnabled in interface WizardFlow

setNextEnabled

public void setNextEnabled(boolean nextEnabled)

Specified by:

setNextEnabled in interface WizardFlow

isFinishEnabled

public boolean isFinishEnabled()

Specified by:

isFinishEnabled in interface WizardFlow

getFinishButton

public javax.swing.JButton getFinishButton()

Description copied from interface: WizardFlow

Used by users to close the wizard, by default this is disabled

Specified by:

getFinishButton in interface WizardFlow

Returns:

setFinishEnabled

public void setFinishEnabled(boolean finishEnabled)

Specified by:

setFinishEnabled in interface WizardFlow