org.alfresco.web.bean.wizard

Class BaseWizardBean

java.lang.Object

org.alfresco.web.bean.dialog.BaseDialogBean

org.alfresco.web.bean.wizard.BaseWizardBean

All Implemented Interfaces:

Serializable, IDialogBean, IWizardBean

Direct Known Subclasses:

BaseActionWizard, BaseContentWizard, BaseInviteUsersWizard, CreateSpaceWizard, CreateUserWizard, DashboardWizard, NewEditionWizard, StartWorkflowWizard

public abstract class BaseWizardBean
extends BaseDialogBean
implements IWizardBean

Base class for all wizard beans providing common functionality

Author:

gavinc

See Also:

Serialized Form

Field Summary

Fields inherited from class org.alfresco.web.bean.dialog.BaseDialogBean

browseBean, isFinished, navigator, parameters

Constructor Summary

Constructors

Constructor and Description
BaseWizardBean()

Method Summary

Modifier and Type	Method and Description
String	back() Called when the back button is pressed by the user
protected String	buildSummary(String[] labels, String[] values) Build summary table from the specified list of Labels and Values
String	getBackButtonLabel() Returns the label to use for the back button
protected String	getDefaultCancelOutcome() Returns the default cancel outcome
protected String	getDefaultFinishOutcome() Returns the default finish outcome
String	getFinishButtonLabel() Returns the label to use for the finish button
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	getStepDescription() Returns the description to be used for the current step
String	getStepTitle() Returns the title to be used for the current step
String	next() Called when the next button is pressed by the user

Methods inherited from class org.alfresco.web.bean.dialog.BaseDialogBean

cancel, doPostCommitProcessing, finish, finishImpl, formatErrorMessage, getActionsConfigId, getActionsContext, getAdditionalButtons, getCancelButtonLabel, getCheckOutCheckInService, getContainerDescription, getContainerSubTitle, getContainerTitle, getDictionaryService, getErrorMessageId, getErrorOutcome, getFileFolderService, getFinishButtonDisabled, getMoreActionsConfigId, getNamespaceService, getNodeService, getRuleService, getSearchService, getTransactionService, init, isFinished, restored, setBrowseBean, setDictionaryService, setFileFolderService, setNamespaceService, setNavigator, setNodeService, setSearchService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.alfresco.web.bean.dialog.IDialogBean

cancel, finish, getActionsConfigId, getActionsContext, getAdditionalButtons, getCancelButtonLabel, getContainerDescription, getContainerSubTitle, getContainerTitle, getFinishButtonDisabled, getMoreActionsConfigId, init, isFinished, restored

Constructor Detail

BaseWizardBean

public BaseWizardBean()

Method Detail

next

public String next()

Description copied from interface: IWizardBean

Called when the next button is pressed by the user

Specified by:

next in interface IWizardBean

Returns:

Reserved for future use

back

public String back()

Description copied from interface: IWizardBean

Called when the back button is pressed by the user

Specified by:

back in interface IWizardBean

Returns:

Reserved for future use

getNextButtonDisabled

public boolean getNextButtonDisabled()

Description copied from interface: IWizardBean

Determines whether the next button on the wizard should be disabled

Specified by:

getNextButtonDisabled in interface IWizardBean

Returns:

true if the button should be disabled

getNextButtonLabel

public String getNextButtonLabel()

Description copied from interface: IWizardBean

Returns the label to use for the next button

Specified by:

getNextButtonLabel in interface IWizardBean

Returns:

The next button label

getBackButtonLabel

public String getBackButtonLabel()

Description copied from interface: IWizardBean

Returns the label to use for the back button

Specified by:

getBackButtonLabel in interface IWizardBean

Returns:

The back button label

getFinishButtonLabel

public String getFinishButtonLabel()

Description copied from interface: IDialogBean

Returns the label to use for the finish button

Specified by:

getFinishButtonLabel in interface IDialogBean

Overrides:

getFinishButtonLabel in class BaseDialogBean

Returns:

The finish button label

getStepTitle

public String getStepTitle()

Description copied from interface: IWizardBean

Returns the title to be used for the current step

If this returns null the WizardManager will lookup the title via the dialog configuration

Specified by:

getStepTitle in interface IWizardBean

Returns:

The title or null if the title is to be acquired via configuration

getStepDescription

public String getStepDescription()

Description copied from interface: IWizardBean

Returns the description to be used for the current step

If this returns null the WizardManager will lookup the description via the dialog configuration

Specified by:

getStepDescription in interface IWizardBean

Returns:

The decsription or null if the title is to be acquired via configuration

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

getDefaultCancelOutcome

protected String getDefaultCancelOutcome()

Description copied from class: BaseDialogBean

Returns the default cancel outcome

Overrides:

getDefaultCancelOutcome in class BaseDialogBean

Returns:

Default close outcome, dialog:close by default

getDefaultFinishOutcome

protected String getDefaultFinishOutcome()

Description copied from class: BaseDialogBean

Returns the default finish outcome

Overrides:

getDefaultFinishOutcome in class BaseDialogBean

Returns:

Default finish outcome, dialog:close by default