AbstractWizardBean (Alfresco 5.3.a-SNAPSHOT API)

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

NewUserWizard
```
public abstract class AbstractWizardBean
extends Object
implements Serializable
```
Abstract bean used as the base class for all wizard backing beans.

Author:

gavinc

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected BrowseBean`	`browseBean`
`protected static String`	`CANCEL_OUTCOME`
`protected int`	`currentStep`
`protected static String`	`DEFAULT_INSTRUCTION_ID`
`protected boolean`	`editMode`
`protected static String`	`FINISH_OUTCOME`
`protected NavigationBean`	`navigator`
`protected static String`	`SUMMARY_DESCRIPTION_ID`
`protected static String`	`SUMMARY_TITLE_ID`

Constructor Summary

Constructors
Constructor and Description

AbstractWizardBean()

Constructors
Constructor and Description
`AbstractWizardBean()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`back()` Deals with the back button being pressed
`protected String`	`buildSummary(String[] labels, String[] values)` Build summary table from the specified list of Labels and Values
`String`	`cancel()` Handles the cancelling of the wizard
`protected abstract String`	`determineOutcomeForStep(int step)` Determines the outcome string for the given step number
`abstract String`	`finish()` Handles the finish button being pressed
`BrowseBean`	`getBrowseBean()`
`protected FileFolderService`	`getFileFolderService()`
`NavigationBean`	`getNavigator()`
`org.alfresco.service.cmr.repository.NodeService`	`getNodeService()`
`protected org.alfresco.service.cmr.search.SearchService`	`getSearchService()`
`abstract String`	`getStepDescription()`
`abstract String`	`getStepInstructions()`
`abstract String`	`getStepTitle()`
`abstract String`	`getWizardDescription()`
`abstract String`	`getWizardTitle()`
`void`	`init()` Initialises the wizard
`boolean`	`isInEditMode()` Determines whether the wizard is in edit mode
`String`	`next()` Deals with the next button being pressed
`void`	`populate()` Populates the wizard's values with the current values of the node about to be edited
`void`	`setBrowseBean(BrowseBean browseBean)`
`void`	`setFileFolderService(FileFolderService fileFolderService)`
`void`	`setNavigator(NavigationBean navigator)`
`void`	`setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)`
`void`	`setSearchService(org.alfresco.service.cmr.search.SearchService searchService)`
`void`	`startWizard(ActionEvent event)` Action listener called when the wizard is being launched allowing state to be setup
`void`	`startWizardForEdit(ActionEvent event)` Action listener called when the wizard is being launched for editing an existing node.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FINISH_OUTCOME
```
protected static final String FINISH_OUTCOME
```
    See Also:
    
    Constant Field Values
  - CANCEL_OUTCOME
```
protected static final String CANCEL_OUTCOME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_INSTRUCTION_ID
```
protected static final String DEFAULT_INSTRUCTION_ID
```
    See Also:
    
    Constant Field Values
  - SUMMARY_TITLE_ID
```
protected static final String SUMMARY_TITLE_ID
```
    See Also:
    
    Constant Field Values
  - SUMMARY_DESCRIPTION_ID
```
protected static final String SUMMARY_DESCRIPTION_ID
```
    See Also:
    
    Constant Field Values
  - currentStep
```
protected int currentStep
```
  - editMode
```
protected boolean editMode
```
  - navigator
```
protected NavigationBean navigator
```
  - browseBean
```
protected BrowseBean browseBean
```
- Constructor Detail
  - AbstractWizardBean
```
public AbstractWizardBean()
```
- Method Detail
  - getWizardDescription
```
public abstract String getWizardDescription()
```
    Returns:
    
    Returns the wizard description
  - getWizardTitle
```
public abstract String getWizardTitle()
```
    Returns:
    
    Returns the wizard title
  - getStepTitle
```
public abstract String getStepTitle()
```
    Returns:
    
    Returns the title for the current step
  - getStepDescription
```
public abstract String getStepDescription()
```
    Returns:
    
    Returns the description for the current step
  - getStepInstructions
```
public abstract String getStepInstructions()
```
    Returns:
    
    Returns the instructional text for the current step
  - determineOutcomeForStep
```
protected abstract String determineOutcomeForStep(int step)
```
    Determines the outcome string for the given step number
    
    Parameters:
    
    step - The step number to get the outcome for
    
    Returns:
    
    The outcome
  - finish
```
public abstract String finish()
```
    Handles the finish button being pressed
    
    Returns:
    
    The finish outcome
  - startWizard
```
public void startWizard(ActionEvent event)
```
    Action listener called when the wizard is being launched allowing state to be setup
  - startWizardForEdit
```
public void startWizardForEdit(ActionEvent event)
```
    Action listener called when the wizard is being launched for editing an existing node.
  - isInEditMode
```
public boolean isInEditMode()
```
    Determines whether the wizard is in edit mode
    
    Returns:
    
    true if the wizard is in edit mode, false if it is in creation mode
  - next
```
public String next()
```
    Deals with the next button being pressed
    
    Returns:
    
    The outcome for the next step
  - back
```
public String back()
```
    Deals with the back button being pressed
    
    Returns:
    
    The outcome for the previous step
  - cancel
```
public String cancel()
```
    Handles the cancelling of the wizard
    
    Returns:
    
    The cancel outcome
  - init
```
public void init()
```
    Initialises the wizard
  - populate
```
public void populate()
```
    Populates the wizard's values with the current values of the node about to be edited
  - getNodeService
```
public org.alfresco.service.cmr.repository.NodeService getNodeService()
```
    Returns:
    
    Returns the nodeService.
  - setNodeService
```
public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
```
    Parameters:
    
    nodeService - The nodeService to set.
  - setFileFolderService
```
public void setFileFolderService(FileFolderService fileFolderService)
```
    Parameters:
    
    fileFolderService - used to manipulate folder/folder model nodes
  - getFileFolderService
```
protected FileFolderService getFileFolderService()
```
  - setSearchService
```
public void setSearchService(org.alfresco.service.cmr.search.SearchService searchService)
```
    Parameters:
    
    searchService - the service used to find nodes
  - getSearchService
```
protected org.alfresco.service.cmr.search.SearchService getSearchService()
```
  - getNavigator
```
public NavigationBean getNavigator()
```
    Returns:
    
    Returns the navigation bean instance.
  - setNavigator
```
public void setNavigator(NavigationBean navigator)
```
    Parameters:
    
    navigator - The NavigationBean to set.
  - getBrowseBean
```
public BrowseBean getBrowseBean()
```
    Returns:
    
    The BrowseBean
  - setBrowseBean
```
public void setBrowseBean(BrowseBean browseBean)
```
    Parameters:
    
    browseBean - The BrowseBean to set.
  - buildSummary
```
protected String buildSummary(String[] labels,
                              String[] values)
```
    Build summary table from the specified list of Labels and Values
    
    Parameters:
    
    labels - Array of labels to display
    
    values - Array of values to display
    
    Returns:
    
    summary table HTML

Class AbstractWizardBean

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FINISH_OUTCOME

CANCEL_OUTCOME

DEFAULT_INSTRUCTION_ID

SUMMARY_TITLE_ID

SUMMARY_DESCRIPTION_ID

currentStep

editMode

navigator

browseBean

Constructor Detail

AbstractWizardBean

Method Detail

getWizardDescription

getWizardTitle

getStepTitle

getStepDescription

getStepInstructions

determineOutcomeForStep

finish

startWizard

startWizardForEdit

isInEditMode

next

back

cancel

init

populate

getNodeService

setNodeService

setFileFolderService

getFileFolderService

setSearchService

getSearchService

getNavigator

setNavigator

getBrowseBean

setBrowseBean

buildSummary