org.alfresco.web.bean.dialog

Interface IDialogBean

All Superinterfaces:

Serializable

All Known Subinterfaces:

IWizardBean

All Known Implementing Classes:

AboutBean, AddContentDialog, AddTranslationDialog, AddTranslationWithoutContentDialog, AddUsersDialog, AdminConsoleDialog, AdvancedSearchDialog, ApplyDocTemplateDialog, ApplyRssTemplateDialog, ApplySpaceTemplateDialog, BaseActionWizard, BaseContentWizard, BaseDetailsBean, BaseDialogBean, BaseInviteUsersWizard, BasePreviewBean, BaseReassignDialog, BaseWizardBean, CancelEditingDialog, CancelWorkflowDialog, CategoriesDialog, CCCheckinFileDialog, CCCheckoutFileDialog, CCCheckoutFileLinkDialog, CCEditFileDialog, CCEditHtmlInlineDialog, CCEditTextInlineDialog, CCUndoCheckoutFileDialog, CCUpdateFileDialog, CCWorkingCopyMissingDialog, ChangeMyPasswordDialog, ChangePasswordDialog, CheckinCheckoutDialog, ContentUsersBean, CreateCategoryDialog, CreateCompositeRuleWizard, CreateContentWizard, CreateDiscussionDialog, CreateForumDialog, CreateForumsDialog, CreateGroupDialog, CreatePostDialog, CreateReplyDialog, CreateRuleWizard, CreateSpaceDialog, CreateSpaceWizard, CreateTopicDialog, CreateUserWizard, DashboardWizard, DeleteCategoryDialog, DeleteContentAssociationDialog, DeleteContentDialog, DeleteForumDialog, DeleteForumsDialog, DeleteGroupDialog, DeletePostDialog, DeleteRuleDialog, DeleteSpaceAssociationDialog, DeleteSpaceDialog, DeleteTopicDialog, DeleteUserDialog, DocumentDetailsDialog, DocumentLinkDetailsDialog, DocumentPreviewBean, DoneEditingDialog, EditCategoryDialog, EditContentPropertiesDialog, EditContentUserRolesDialog, EditContentWizard, EditFileDialog, EditMLContainerDialog, EditNodeCategoriesDialog, EditOfflineDialog, EditOnlineDialog, EditPostDialog, EditRuleWizard, EditSearchDialog, EditSimpleWorkflowDialog, EditSimpleWorkflowDialog, EditSpaceDialog, EditUserDetailsDialog, EditUserRolesDialog, EditUserWizard, EmailSpaceUsersDialog, ExportDialog, ForumDetailsDialog, ForumsDetailsDialog, GroupsDialog, ImportDialog, InviteContentUsersWizard, InviteSpaceUsersWizard, LinkPropertiesDialog, MailInviteSpaceUsersWizard, MakeMultilingualDialog, ManageTaskDialog, MultilingualManageDialog, NewEditionWizard, ReassignTaskDialog, ReassignWorkItemDialog, RemoveContentUserDialog, RemoveInvitedUserDialog, RulesDialog, RunActionWizard, SaveSearchDialog, SetContentPropertiesDialog, ShowSystemInfoDialog, SpaceDetailsDialog, SpaceLinkDetailsDialog, SpacePreviewBean, SpaceUsersBean, StartWorkflowWizard, TopicDetailsDialog, TrashcanDeleteAllItemsDialog, TrashcanDeleteItemDialog, TrashcanDeleteListedItemsDialog, TrashcanDialog, TrashcanItemDetailsDialog, TrashcanRecoverItemDialog, TrashcanRecoverListedItemsDialog, TrashcanRecoveryReportDialog, UploadNewVersionDialog, UserConsoleDialog, UserMembersBean, UserProfileDialog, UsersDialog, ViewCompletedTaskDialog, ViewContentPropertiesDialog

public interface IDialogBean
extends Serializable

Interface that defines the contract for a dialog backing bean

Author:

gavinc

Method Summary

Modifier and Type	Method and Description
String	cancel() Method handler called when the cancel button of the dialog is pressed
String	finish() Method handler called when the finish button of the dialog is pressed
String	getActionsConfigId() Returns the id of an action group to use for the main actions
Object	getActionsContext() Returns the object to use as the context for the main and more actions that may be configured by the dialog
List<DialogsConfigElement.DialogButtonConfig>	getAdditionalButtons() Returns a list of additional buttons to display in the dialog.
String	getCancelButtonLabel() Returns the label to use for the cancel button
String	getContainerDescription() Returns the description to be used for the dialog
String	getContainerSubTitle() Returns the subtitle to be used for the dialog
String	getContainerTitle() Returns the title to be used for the dialog
boolean	getFinishButtonDisabled() Determines whether the finish button on the dialog should be disabled
String	getFinishButtonLabel() Returns the label to use for the finish button
String	getMoreActionsConfigId() Returns the id of an action group to use for the more actions
void	init(Map<String,String> parameters) Initialises the dialog bean
boolean	isFinished() Determines whether the has finished
void	restored() Called when the dialog is restored after a nested dialog is closed

Method Detail

init

void init(Map<String,String> parameters)

Initialises the dialog bean

Parameters:

parameters - Map of parameters for the dialog

restored

void restored()

Called when the dialog is restored after a nested dialog is closed

cancel

String cancel()

Method handler called when the cancel button of the dialog is pressed

Returns:

The outcome to return

finish

String finish()

Method handler called when the finish button of the dialog is pressed

Returns:

The outcome to return

getAdditionalButtons

List<DialogsConfigElement.DialogButtonConfig> getAdditionalButtons()

Returns a list of additional buttons to display in the dialog.

Returns:

List of button configurations, null if there are no buttons

getCancelButtonLabel

String getCancelButtonLabel()

Returns the label to use for the cancel button

Returns:

The cancel button label

getFinishButtonLabel

String getFinishButtonLabel()

Returns the label to use for the finish button

Returns:

The finish button label

getFinishButtonDisabled

boolean getFinishButtonDisabled()

Determines whether the finish button on the dialog should be disabled

Returns:

true if the button should be disabled

getContainerTitle

String getContainerTitle()

Returns the title to be used for the dialog

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

Returns:

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

getContainerSubTitle

String getContainerSubTitle()

Returns the subtitle to be used for the dialog

If this returns null the DialogManager will lookup the subtitle via the dialog configuration

Returns:

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

getContainerDescription

String getContainerDescription()

Returns the description to be used for the dialog

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

Returns:

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

getActionsContext

Object getActionsContext()

Returns the object to use as the context for the main and more actions that may be configured by the dialog

Returns:

Object to use as the context for actions

getActionsConfigId

String getActionsConfigId()

Returns the id of an action group to use for the main actions

Returns:

Id of an action group

getMoreActionsConfigId

String getMoreActionsConfigId()

Returns the id of an action group to use for the more actions

Returns:

Id of an action group

isFinished

boolean isFinished()

Determines whether the has finished

Returns:

true if the wizard has finished