| org.apache.wicket.extensions.wizard.IWizardModel
All known Subclasses: org.apache.wicket.extensions.wizard.AbstractWizardModel,
| IWizardModel | | public interface IWizardModel extends IClusterable(Code) | | This interface defines the model for wizards. This model knows about the
wizard's steps and the transitions between them, and it holds a reference to
the currently active step. It might function as a generic state holder for
the wizard too, though you might find it more convenient to use the wizard
component itself for that, or even an external model.
IWizardModelListener wizard model listeners can be registered to be
notified of important events (changing the active step) using the
IWizardModel.addListener(IWizardModelListener) add listener method.
Typically, you would use
WizardModel the default implementation of this interface , but if you
need to do more sophisticated stuff, like branching etc, you can consider
creating your own implementation. In that case, it is recommended you start
by extending from
AbstractWizardModel .
Swing Wizard Framework
served as a valuable source of inspiration.
See Also: AbstractWizardModel
See Also: WizardModel
author:
Eelco Hillenius |
| addListener | | void addListener(IWizardModelListener listener)(Code) | | Adds a wizard model listener.
Parameters:
listener - The wizard model listener to add |
| cancel | | void cancel()(Code) | | Cancels further processing. Implementations may clean up and reset the
model. Implementations should notify the registered
IWizardModelListener.onCancel model listeners .
|
| finish | | void finish()(Code) | | Instructs the wizard to finish succesfully. Typically, implementations
check whether this option is available at all. Implementations may clean
up and reset the model. Implementations should notify the registered
IWizardModelListener.onFinish model listeners .
|
| getActiveStep | | IWizardStep getActiveStep()(Code) | | Gets the current active step the wizard should display.
the active step. |
| isCancelVisible | | boolean isCancelVisible()(Code) | | Gets whether the cancel button should be displayed.
True if the cancel button should be displayed |
| isLastAvailable | | boolean isLastAvailable()(Code) | | Checks if the last button should be enabled.
true if the last button should be enabled,false otherwise.
See Also: IWizardModel.isLastVisible |
| isLastStep | | boolean isLastStep(IWizardStep step)(Code) | | Gets whether the specified step is the last step in the wizard.
Parameters:
step - the step to check True if its the final step in the wizard, false< otherwise. |
| isLastVisible | | boolean isLastVisible()(Code) | | Gets whether the last button should be displayed. This method should only
return true if the
IWizardModel.isLastAvailable will return true at any
point. Returning false will prevent the last button from appearing on the
wizard at all.
True if the last button should be displayed, False otherwise. |
| isNextAvailable | | boolean isNextAvailable()(Code) | | Gets whether the next button should be enabled.
True if the next button should be enabled, false otherwise. |
| isPreviousAvailable | | boolean isPreviousAvailable()(Code) | | Gets whether the previous button should be enabled.
True if the previous button should be enabled, false otherwise. |
| removeListener | | void removeListener(IWizardModelListener listener)(Code) | | Removes a wizard model listener.
Parameters:
listener - The listener to remove |
| stepIterator | | Iterator stepIterator()(Code) | | Returns an iterator over all the steps in the model. The iteration order
is not guarenteed to the be the order of traversal. This is an optional
operation; dynamic models can just return null, and should call init the
first time a step is encountered right before rendering it.
an iterator over all the steps of the model or null if the wizardmodel is not static |
|
|