|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.xwiki.gwt.user.client.ui.wizard.AbstractNavigationAwareWizardStep org.xwiki.gwt.user.client.ui.wizard.AbstractAutoSubmitWizardStep<T>
T
- the type of data processed by this wizard steppublic abstract class AbstractAutoSubmitWizardStep<T>
Abstract wizard step that is automatically submitted after it is initialized. This should be the base class for all
wizard steps that don't require user input, i.e. that are non-interactive. Derived classes should overwrite
onSubmit(AsyncCallback)
to process the input data.
Constructor Summary | |
---|---|
AbstractAutoSubmitWizardStep()
|
Method Summary | |
---|---|
com.google.gwt.user.client.ui.Widget |
display()
This method is called right after the wizard step has been successfully initialized. |
protected T |
getData()
|
Object |
getResult()
|
String |
getStepTitle()
|
void |
init(Object data,
com.google.gwt.user.client.rpc.AsyncCallback<?> cb)
Initializes the current wizard step, according to the passed data. |
boolean |
isAutoSubmit()
|
void |
onCancel()
Called before canceling the current wizard step. |
void |
onSubmit(com.google.gwt.user.client.rpc.AsyncCallback<Boolean> async)
Called before submitting the current wizard step. |
void |
setStepTitle(String stepTitle)
Sets the step title. |
Methods inherited from class org.xwiki.gwt.user.client.ui.wizard.AbstractNavigationAwareWizardStep |
---|
getDirectionName, getNextStep, getValidDirections, setDirectionName, setNextStep, setValidDirections |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractAutoSubmitWizardStep()
Method Detail |
---|
public final void init(Object data, com.google.gwt.user.client.rpc.AsyncCallback<?> cb)
WizardStep.getResult()
method of the previous step. The callback
parameter should
handle the asynchronous initialization of this wizard step.
Don't overwrite this method. Overwrite onSubmit(AsyncCallback)
instead and use getData()
.
data
- an object to pass to the wizard step, which can contain configuration datacb
- the object to be notified when the wizard step has finished initializingWizardStep.init(Object, AsyncCallback)
protected T getData()
public String getStepTitle()
public void setStepTitle(String stepTitle)
stepTitle
- the new step titlepublic final com.google.gwt.user.client.ui.Widget display()
WizardStep
public Object getResult()
WizardStep.getNextStep()
) or the previous in the navigation stack.public void onSubmit(com.google.gwt.user.client.rpc.AsyncCallback<Boolean> async)
Overwrite if you want to change the input data.
async
- the object to be notified when the submit is done; pass true
to notify that the submit
was successful and the wizard can move to the next step; pass false
if the user needs to
adjust the submitted dataWizardStep.onSubmit(AsyncCallback)
public final boolean isAutoSubmit()
true
if this step should be submitted automatically, false
otherwise; the
WizardStep.display()
method should return null
if the step is submitted automaticallypublic void onCancel()
WizardStep
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |