WizardManager (Alfresco 5.3.a-SNAPSHOT API)

java.lang.Object
- org.alfresco.web.bean.wizard.WizardManager

All Implemented Interfaces:

Serializable
```
public final class WizardManager
extends Object
implements Serializable
```
Bean that manages the wizard framework

Author:

gavinc

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String BEAN_NAME
public JSF bean name

Fields
Modifier and Type	Field and Description
`static String`	`BEAN_NAME` public JSF bean name

Constructor Summary

Constructors
Constructor and Description

WizardManager()

Constructors
Constructor and Description
`WizardManager()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`back()` Method handler called when the back button of the wizard is pressed
`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
`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
`String`	`getBackButtonLabel()` Returns the label to use for the back button
`IWizardBean`	`getBean()` Returns the current wizard bean being managed
`String`	`getCancelButtonLabel()` Returns the label to use for the cancel button
`int`	`getCurrentStep()` Returns the current step position
`String`	`getCurrentStepAsString()` Returns the current step position as a string for use in the UI
`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
`String`	`getDescription()` Returns the resolved description to use for the wizard
`String`	`getErrorMessage()` Returns the error message to use in error conditions
`boolean`	`getFinishButtonDisabled()` Determines whether the finish button on the wizard should be disabled
`String`	`getFinishButtonLabel()` Returns the label to use for the finish button
`String`	`getIcon()` Returns the icon to use for the current wizard
`boolean`	`getNextButtonDisabled()` Determines whether the next button on the wizard should be disabled
`String`	`getNextButtonLabel()` Returns the label to use for the next button
`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
`String`	`getStepDescription()` Returns the description of the current step
`String`	`getStepInstructions()` Returns the instructions for the current step
`List<UIListItem>`	`getStepItems()` Returns a list of UIListItems representing the steps of the wizard
`String`	`getStepTitle()` Returns the title of the current step
`String`	`getSubTitle()` Returns the resolved subtitle to use for the wizard
`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(ActionEvent event)` Action handler used to setup parameters for the wizard being launched
`void`	`setupParameters(Map<String,String> 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
  - BEAN_NAME
```
public static final String BEAN_NAME
```
    public JSF bean name
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WizardManager
```
public WizardManager()
```
- Method Detail
  - setupParameters
```
public void setupParameters(Map<String,String> params)
```
    Sets the parameters the next wizard will initialise with
    
    Parameters:
    
    params - The parameters
  - setupParameters
```
public void setupParameters(ActionEvent event)
```
    Action handler used to setup parameters for the wizard being launched
    
    Parameters:
    
    event - The event containing the parameters
  - setCurrentWizard
```
public void setCurrentWizard(WizardsConfigElement.WizardConfig config)
```
    Sets the current wizard
    
    Parameters:
    
    config - The configuration for the wizard to set
  - getState
```
public WizardState getState()
```
    Returns the state of the currently active wizard
    
    Returns:
    
    Current wizard's state
  - restoreState
```
public void restoreState(WizardState state)
```
    Restores the wizard represented by the given WizardState object. NOTE: The wizard's restored() method is also called during this method.
    
    Parameters:
    
    state - The WizardState for the wizard to restore
  - getCurrentWizard
```
public WizardsConfigElement.WizardConfig getCurrentWizard()
```
    Returns the config for the current wizard
    
    Returns:
    
    The current wizard config
  - getBean
```
public IWizardBean getBean()
```
    Returns the current wizard bean being managed
    
    Returns:
    
    The current managed bean
  - getIcon
```
public String getIcon()
```
    Returns the icon to use for the current wizard
    
    Returns:
    
    The icon
  - getErrorMessage
```
public String getErrorMessage()
```
    Returns the error message to use in error conditions
    
    Returns:
    
    The error message
  - getTitle
```
public String getTitle()
```
    Returns the resolved title to use for the wizard
    
    Returns:
    
    The title
  - getSubTitle
```
public String getSubTitle()
```
    Returns the resolved subtitle to use for the wizard
    
    Returns:
    
    The subtitle
  - getDescription
```
public String getDescription()
```
    Returns the resolved description to use for the wizard
    
    Returns:
    
    The description
  - getCurrentStep
```
public int getCurrentStep()
```
    Returns the current step position
    
    Returns:
    
    Current step position
  - getCurrentStepAsString
```
public String getCurrentStepAsString()
```
    Returns the current step position as a string for use in the UI
    
    Returns:
    
    Current step position as a string
  - getCurrentStepName
```
public 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.
    
    Returns:
    
    The name of the current step
  - getStepItems
```
public List<UIListItem> getStepItems()
```
    Returns a list of UIListItems representing the steps of the wizard
    
    Returns:
    
    List of steps to display in UI
  - getPage
```
public String getPage()
```
    Returns the current page of the wizard (depends on the current step position)
    
    Returns:
    
    The page
  - getStepTitle
```
public String getStepTitle()
```
    Returns the title of the current step
    
    Returns:
    
    The step title
  - getStepDescription
```
public String getStepDescription()
```
    Returns the description of the current step
    
    Returns:
    
    The step description
  - getStepInstructions
```
public String getStepInstructions()
```
    Returns the instructions for the current step
    
    Returns:
    
    The step instructions
  - getNextButtonLabel
```
public String getNextButtonLabel()
```
    Returns the label to use for the next button
    
    Returns:
    
    The next button label
  - getNextButtonDisabled
```
public boolean getNextButtonDisabled()
```
    Determines whether the next button on the wizard should be disabled
    
    Returns:
    
    true if the button should be disabled
  - getBackButtonLabel
```
public String getBackButtonLabel()
```
    Returns the label to use for the back button
    
    Returns:
    
    The back button label
  - getBackButtonDisabled
```
public boolean getBackButtonDisabled()
```
    Determines whether the back button on the wizard should be disabled
    
    Returns:
    
    true if the button should be disabled
  - getCancelButtonLabel
```
public String getCancelButtonLabel()
```
    Returns the label to use for the cancel button
    
    Returns:
    
    The cancel button label
  - getFinishButtonLabel
```
public String getFinishButtonLabel()
```
    Returns the label to use for the finish button
    
    Returns:
    
    The finish button label
  - getFinishButtonDisabled
```
public boolean getFinishButtonDisabled()
```
    Determines whether the finish button on the wizard should be disabled
    
    Returns:
    
    true if the button should be disabled
  - next
```
public void next()
```
    Method handler called when the next button of the wizard is pressed
  - back
```
public void back()
```
    Method handler called when the back button of the wizard is pressed
  - finish
```
public String finish()
```
    Method handler called when the finish button of the wizard is pressed
    
    Returns:
    
    The outcome
  - cancel
```
public String cancel()
```
    Method handler called when the cancel button of the wizard is pressed
    
    Returns:
    
    The outcome
  - determineCurrentPage
```
protected void determineCurrentPage()
```
    Sets up the current page to show in the wizard

Class WizardManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BEAN_NAME

Constructor Detail

WizardManager

Method Detail

setupParameters

setupParameters

setCurrentWizard

getState

restoreState

getCurrentWizard

getBean

getIcon

getErrorMessage

getTitle

getSubTitle

getDescription

getCurrentStep

getCurrentStepAsString

getCurrentStepName

getStepItems

getPage

getStepTitle

getStepDescription

getStepInstructions

getNextButtonLabel

getNextButtonDisabled

getBackButtonLabel

getBackButtonDisabled

getCancelButtonLabel

getFinishButtonLabel

getFinishButtonDisabled

next

back

finish

cancel

determineCurrentPage