|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.web.bean.wizard.WizardManager
public final class WizardManager
Bean that manages the wizard framework
Field Summary | |
---|---|
static java.lang.String |
BEAN_NAME
public JSF bean name |
Constructor Summary | |
---|---|
WizardManager()
|
Method Summary | |
---|---|
void |
back()
Method handler called when the back button of the wizard is pressed |
java.lang.String |
cancel()
Method handler called when the cancel button of the wizard is pressed |
protected void |
determineCurrentPage()
Sets up the current page to show in the wizard |
java.lang.String |
finish()
Method handler called when the finish button of the wizard is pressed |
boolean |
getBackButtonDisabled()
Determines whether the back button on the wizard should be disabled |
java.lang.String |
getBackButtonLabel()
Returns the label to use for the back button |
IWizardBean |
getBean()
Returns the current wizard bean being managed |
java.lang.String |
getCancelButtonLabel()
Returns the label to use for the cancel button |
int |
getCurrentStep()
Returns the current step position |
java.lang.String |
getCurrentStepAsString()
Returns the current step position as a string for use in the UI |
java.lang.String |
getCurrentStepName()
Returns the name of the current step, wizards should use the name of the step rather than the step number to discover the position as extra steps can be added via configuration. |
WizardsConfigElement.WizardConfig |
getCurrentWizard()
Returns the config for the current wizard |
java.lang.String |
getDescription()
Returns the resolved description to use for the wizard |
java.lang.String |
getErrorMessage()
Returns the error message to use in error conditions |
boolean |
getFinishButtonDisabled()
Determines whether the finish button on the wizard should be disabled |
java.lang.String |
getFinishButtonLabel()
Returns the label to use for the finish button |
java.lang.String |
getIcon()
Returns the icon to use for the current wizard |
boolean |
getNextButtonDisabled()
Determines whether the next button on the wizard should be disabled |
java.lang.String |
getNextButtonLabel()
Returns the label to use for the next button |
java.lang.String |
getPage()
Returns the current page of the wizard (depends on the current step position) |
WizardState |
getState()
Returns the state of the currently active wizard |
java.lang.String |
getStepDescription()
Returns the description of the current step |
java.lang.String |
getStepInstructions()
Returns the instructions for the current step |
java.util.List |
getStepItems()
Returns a list of UIListItems representing the steps of the wizard |
java.lang.String |
getStepTitle()
Returns the title of the current step |
java.lang.String |
getSubTitle()
Returns the resolved subtitle to use for the wizard |
java.lang.String |
getTitle()
Returns the resolved title to use for the wizard |
void |
next()
Method handler called when the next button of the wizard is pressed |
void |
restoreState(WizardState state)
Restores the wizard represented by the given WizardState object. |
void |
setCurrentWizard(WizardsConfigElement.WizardConfig config)
Sets the current wizard |
void |
setupParameters(javax.faces.event.ActionEvent event)
Action handler used to setup parameters for the wizard being launched |
void |
setupParameters(java.util.Map params)
Sets the parameters the next wizard will initialise with |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String BEAN_NAME
Constructor Detail |
---|
public WizardManager()
Method Detail |
---|
public void setupParameters(java.util.Map params)
params
- The parameterspublic void setupParameters(javax.faces.event.ActionEvent event)
event
- The event containing the parameterspublic void setCurrentWizard(WizardsConfigElement.WizardConfig config)
config
- The configuration for the wizard to setpublic WizardState getState()
public void restoreState(WizardState state)
state
- The WizardState for the wizard to restorepublic WizardsConfigElement.WizardConfig getCurrentWizard()
public IWizardBean getBean()
public java.lang.String getIcon()
public java.lang.String getErrorMessage()
public java.lang.String getTitle()
public java.lang.String getSubTitle()
public java.lang.String getDescription()
public int getCurrentStep()
public java.lang.String getCurrentStepAsString()
public java.lang.String getCurrentStepName()
public java.util.List getStepItems()
public java.lang.String getPage()
public java.lang.String getStepTitle()
public java.lang.String getStepDescription()
public java.lang.String getStepInstructions()
public java.lang.String getNextButtonLabel()
public boolean getNextButtonDisabled()
public java.lang.String getBackButtonLabel()
public boolean getBackButtonDisabled()
public java.lang.String getCancelButtonLabel()
public java.lang.String getFinishButtonLabel()
public boolean getFinishButtonDisabled()
public void next()
public void back()
public java.lang.String finish()
public java.lang.String cancel()
protected void determineCurrentPage()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |