org.alfresco.web.bean.wizard

Interface IWizardBean

All Superinterfaces:

IDialogBean, Serializable

All Known Implementing Classes:

AddContentDialog, AddTranslationDialog, BaseActionWizard, BaseContentWizard, BaseInviteUsersWizard, BaseWizardBean, CreateCompositeRuleWizard, CreateContentWizard, CreateDiscussionDialog, CreateForumDialog, CreateForumsDialog, CreatePostDialog, CreateReplyDialog, CreateRuleWizard, CreateSpaceDialog, CreateSpaceWizard, CreateTopicDialog, CreateUserWizard, DashboardWizard, EditContentWizard, EditPostDialog, EditRuleWizard, EditSpaceDialog, EditUserWizard, InviteContentUsersWizard, InviteSpaceUsersWizard, MailInviteSpaceUsersWizard, NewEditionWizard, RunActionWizard, StartWorkflowWizard

public interface IWizardBean
extends IDialogBean

Interface that defines the contract for a wizard backing bean

Author:

gavinc

Method Summary

Modifier and Type	Method and Description
String	back() Called when the back button is pressed by the user
String	getBackButtonLabel() Returns the label to use for the back 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 interface org.alfresco.web.bean.dialog.IDialogBean

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

Method Detail

next

String next()

Called when the next button is pressed by the user

Returns:

Reserved for future use

back

String back()

Called when the back button is pressed by the user

Returns:

Reserved for future use

getNextButtonLabel

String getNextButtonLabel()

Returns the label to use for the next button

Returns:

The next button label

getBackButtonLabel

String getBackButtonLabel()

Returns the label to use for the back button

Returns:

The back button label

getNextButtonDisabled

boolean getNextButtonDisabled()

Determines whether the next button on the wizard should be disabled

Returns:

true if the button should be disabled

getStepTitle

String getStepTitle()

Returns the title to be used for the current step

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

Returns:

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

getStepDescription

String getStepDescription()

Returns the description to be used for the current step

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

Returns:

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