org.alfresco.web.bean.wizard
Interface IWizardBean

All Superinterfaces:
IDialogBean, java.io.Serializable
All Known Implementing Classes:
AddAvmContentDialog, AddContentDialog, AddTranslationDialog, BaseActionWizard, BaseContentWizard, BaseInviteUsersWizard, BaseWizardBean, CreateCompositeRuleWizard, CreateContentWizard, CreateDiscussionDialog, CreateFormWizard, CreateForumDialog, CreateForumsDialog, CreatePostDialog, CreateReplyDialog, CreateRuleWizard, CreateSpaceDialog, CreateSpaceWizard, CreateTopicDialog, CreateUserWizard, CreateWebContentWizard, CreateWebsiteWizard, DashboardWizard, EditContentWizard, EditFolderPropertiesDialog, EditFormWizard, EditPostDialog, EditRuleWizard, EditSpaceDialog, EditUserWizard, EditWebContentWizard, EditWebsiteWizard, InviteContentUsersWizard, InviteSpaceUsersWizard, InviteWebsiteUsersWizard, MailInviteSpaceUsersWizard, NewEditionWizard, RegenerateRenditionsWizard, RunActionWizard, StartWorkflowWizard

public interface IWizardBean
extends IDialogBean

Interface that defines the contract for a wizard backing bean


Method Summary
 java.lang.String back()
          Called when the back button is pressed by the user
 java.lang.String getBackButtonLabel()
          Returns the label to use for the back button
 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 getStepDescription()
          Returns the description to be used for the current step
 java.lang.String getStepTitle()
          Returns the title to be used for the current step
 java.lang.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

java.lang.String next()
Called when the next button is pressed by the user

Returns:
Reserved for future use

back

java.lang.String back()
Called when the back button is pressed by the user

Returns:
Reserved for future use

getNextButtonLabel

java.lang.String getNextButtonLabel()
Returns the label to use for the next button

Returns:
The next button label

getBackButtonLabel

java.lang.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

java.lang.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

java.lang.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


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.