|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface defines the Model for wizards. It provides various methods for determining
the steps of the wizard along with the current traversal state of the wizard. The Wizard
monitors the model using a PropertyChangeListener
so all changes to the model properties
must fire PropertyChangeEvent
s.
Most users should subclass either StaticModel
or MultiPathModel
. Implementors
of more specialized models should consider extending AbstractWizardModel
as it provides
the basic methods and propery change management required by all models.
Method Summary | |
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener to this model. |
void |
addPropertyChangeListener(java.lang.String propertyName,
java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener to this model. |
WizardStep |
getActiveStep()
Gets the current active step the wizard should display. |
boolean |
isLastAvailable()
Checks if the last button should be enabled. |
boolean |
isLastStep(WizardStep step)
Checks if the specified step is the last step in the wizard. |
boolean |
isLastVisible()
Checks if the last button should be displayed. |
boolean |
isNextAvailable()
Checks if the next button should be enabled. |
boolean |
isPreviousAvailable()
Checks if the previous button should be enabled. |
void |
lastStep()
Takes the model to the last step in the wizard and fires the appropriate property change events. |
void |
nextStep()
Increments the model the the next step and fires the appropriate property change events. |
void |
previousStep()
Takes the model back to the previsou step and fires the appropriate property change events. |
void |
refreshModelState()
Called to request the model to update it current state. |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a PropertyChangeListener from this model. |
void |
removePropertyChangeListener(java.lang.String propertyName,
java.beans.PropertyChangeListener listener)
Removes a PropertyChangeListener from this model. |
void |
reset()
Takes the model back to the first step and fires the appropriate property change events. |
java.util.Iterator |
stepIterator()
Returns an iterator over all the steps in the model. |
Method Detail |
public boolean isPreviousAvailable()
public boolean isNextAvailable()
public boolean isLastAvailable()
isLastVisible()
public void nextStep()
isNextAvailable()
returns true.
public void previousStep()
isPreviousAvailable()
returns true.
public void lastStep()
isLastAvailable()
returns true.
public boolean isLastVisible()
isLastAvailable()
will return true at any point. Returning false will prevent
the last button from appearing on the wizard at all.
public void reset()
public WizardStep getActiveStep()
public boolean isLastStep(WizardStep step)
step
- the step to check
public java.util.Iterator stepIterator()
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
PropertyChangeListener
to this model.
listener
- the listener to add.public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
PropertyChangeListener
from this model.
listener
- the listener to remove.public void addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
PropertyChangeListener
to this model.
propertyName
- the property to listen to.listener
- the listener to add.public void removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
PropertyChangeListener
from this model.
propertyName
- the property to stop listening to.listener
- the listener to remove.public void refreshModelState()
WizardStep
to
force a refresh.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |