uk.ac.essex.common.wizard
Interface WizardFlow

All Known Implementing Classes:
DefaultWizardFlow

public interface 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
static java.lang.String CURRENT_PANEL_PROPERTY
          This property is changed when the panels change
 
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()
           
 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.List panelList)
           
 void updateComponents()
           
 

Field Detail

CURRENT_PANEL_PROPERTY

static final java.lang.String CURRENT_PANEL_PROPERTY
This property is changed when the panels change

See Also:
Constant Field Values
Method Detail

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

removePropertyChangeListener

void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

addWizardPanel

void addWizardPanel(WizardPanel panel)

addWizardPanel

void addWizardPanel(int index,
                    WizardPanel panel)

addWizardPanelAfter

void addWizardPanelAfter(WizardPanel panelToBePlacedAfter,
                         WizardPanel panel)

addWizardPanelBefore

void addWizardPanelBefore(WizardPanel panelToBePlacedBefore,
                          WizardPanel panel)

addWizardPanelAfterCurrent

void addWizardPanelAfterCurrent(WizardPanel panel)

removeWizardPanel

WizardPanel removeWizardPanel(WizardPanel panel)

removeWizardPanel

WizardPanel removeWizardPanel(int index)

removeWizardPanelAfter

WizardPanel removeWizardPanelAfter(WizardPanel panel)

removeWizardPanelBefore

WizardPanel removeWizardPanelBefore(WizardPanel panel)

getWizardPanel

WizardPanel getWizardPanel(int index)

getIndexOfPanel

int getIndexOfPanel(WizardPanel panel)

updateComponents

void updateComponents()

getCurrentPanel

WizardPanel getCurrentPanel()
                            throws java.lang.Exception
Throws:
java.lang.Exception

cancel

void cancel()

getCurrentIndex

int getCurrentIndex()

setCurrentIndex

void setCurrentIndex(int aCurrentIndex)

onLastPanel

boolean onLastPanel()

getWizardPanelList

java.util.List getWizardPanelList()

setWizardPanelList

void setWizardPanelList(java.util.List panelList)

getBackButton

javax.swing.JButton getBackButton()

setBackButton

void setBackButton(javax.swing.JButton aBackButton)

getNextButton

javax.swing.JButton getNextButton()

setNextButton

void setNextButton(javax.swing.JButton aNextButton)

getCancelButton

javax.swing.JButton getCancelButton()

setCancelButton

void setCancelButton(javax.swing.JButton aCancelButton)

getWizardPanelsContainer

javax.swing.JPanel getWizardPanelsContainer()

next

void next()

back

void back()

isNextEnabled

boolean isNextEnabled()

setNextEnabled

void setNextEnabled(boolean nextEnabled)

getFinishButton

javax.swing.JButton getFinishButton()
Used by users to close the wizard, by default this is disabled

Returns:

isFinishEnabled

boolean isFinishEnabled()

setFinishEnabled

void setFinishEnabled(boolean finishEnabled)