public interface IWizardStep extends IClusterable
Typically, you would extend panel based wizard steps
and provide a custom
panel for the step instead of directly implementing this interface.
Swing Wizard Framework served as a valuable source of inspiration.
Modifier and Type | Method and Description |
---|---|
void |
applyState()
This method is called whenever the user presses next while this step is active.
|
Component |
getHeader(String id,
Component parent,
IWizard wizard)
Gets the header component for this step.
|
Component |
getView(String id,
Component parent,
IWizard wizard)
Returns the current view this step is displaying.
|
void |
init(IWizardModel wizardModel)
Initializes this step with the model it will belong to.
|
boolean |
isComplete()
Checks if this step is complete.
|
Component getHeader(String id, Component parent, IWizard wizard)
id
- The id that the component should be created withparent
- The parent component (for post 1.2)wizard
- The wizard component the header will be placed onComponent getView(String id, Component parent, IWizard wizard)
id
- The id that the component should be created withparent
- The parent component (for post 1.2)wizard
- The wizard component the header will be placed onvoid init(IWizardModel wizardModel)
wizardModel
- the owning wizard modelvoid applyState()
This method will only be called if IWizardModel.isNextAvailable()
returns true
.
boolean isComplete()
true
if the wizard can
proceed to the next step.true
if the wizard can proceed from this step, false
otherwise.Copyright © 2006–2021 Apache Software Foundation. All rights reserved.