org.alfresco.web.bean.dialog
Interface IDialogBean

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
IWizardBean
All Known Implementing Classes:
AboutBean, AddAvmContentDialog, AddContentDialog, AddTranslationDialog, AddTranslationWithoutContentDialog, AddUsersDialog, AdminConsoleDialog, AdvancedSearchDialog, ApplyDocTemplateDialog, ApplyRssTemplateDialog, ApplySpaceTemplateDialog, AVMDetailsBean, AVMEditBean, BaseActionWizard, BaseContentWizard, BaseDetailsBean, BaseDialogBean, BaseInviteUsersWizard, BasePermissionsDialog, BasePreviewBean, BaseReassignDialog, BaseWizardBean, CancelEditingDialog, CancelWorkflowDialog, CategoriesDialog, CCCheckinFileDialog, CCCheckoutFileDialog, CCCheckoutFileLinkDialog, CCEditFileDialog, CCEditHtmlInlineDialog, CCEditTextInlineDialog, CCUndoCheckoutFileDialog, CCUpdateFileDialog, CCWorkingCopyMissingDialog, ChangeExpirationDateDialog, ChangeMyPasswordDialog, ChangePasswordDialog, CheckinCheckoutDialog, CompareSnapshotDialog, CompareToAnySnapshotDialog, CompareToCurrentSnapshotDialog, CompareToPreviousSnapshotDialog, ContentUsersBean, CreateCategoryDialog, CreateCompositeRuleWizard, CreateContentWizard, CreateDiscussionDialog, CreateFolderDialog, CreateFormWizard, CreateForumDialog, CreateForumsDialog, CreateGroupDialog, CreateLayeredFolderDialog, CreatePostDialog, CreateReplyDialog, CreateRuleWizard, CreateSpaceDialog, CreateSpaceWizard, CreateTopicDialog, CreateUserWizard, CreateWebappDialog, CreateWebContentWizard, CreateWebsiteWizard, DashboardWizard, DeleteCategoryDialog, DeleteContentAssociationDialog, DeleteContentDialog, DeleteDeploymentReportsDialog, DeleteFileBrowseDialog, DeleteFileDialog, DeleteFolderBrowseDialog, DeleteFolderDialog, DeleteForumDialog, DeleteForumsDialog, DeleteGroupDialog, DeleteLayeredFolderBrowseDialog, DeletePostDialog, DeleteRuleDialog, DeleteSandboxDialog, DeleteSpaceAssociationDialog, DeleteSpaceDialog, DeleteTopicDialog, DeleteUserDialog, DeleteWebsiteDialog, DeployWebsiteDialog, DocumentDetailsDialog, DocumentLinkDetailsDialog, DocumentPreviewBean, DoneEditingDialog, EditAvmFileDialog, EditCategoryDialog, EditContentPropertiesDialog, EditContentUserRolesDialog, EditContentWizard, EditFileDialog, EditFilePropertiesDialog, EditFolderPropertiesDialog, EditFormWizard, EditMLContainerDialog, EditNodeCategoriesDialog, EditOfflineDialog, EditOnlineDialog, EditPermissionsDialog, EditPostDialog, EditRuleWizard, EditSearchDialog, EditSimpleWorkflowDialog, EditSimpleWorkflowDialog, EditSpaceDialog, EditUserDetailsDialog, EditUserRolesDialog, EditUserWizard, EditWebContentWizard, EditWebsiteWizard, EmailSpaceUsersDialog, ExportDialog, FileDetailsBean, FolderDetailsBean, FormDetailsDialog, FormTemplatesDialog, FormWorkflowDialog, ForumDetailsDialog, ForumsDetailsDialog, GroupsDialog, ImportDialog, ImportWebsiteDialog, InviteContentUsersWizard, InviteSpaceUsersWizard, InviteWebsiteUsersWizard, LinkPropertiesDialog, MailInviteSpaceUsersWizard, MakeMultilingualDialog, ManageChangeRequestTaskDialog, ManagePermissionsDialog, ManageReviewTaskDialog, ManageTaskDialog, MonitorDeploymentDialog, MultilingualManageDialog, NewEditionWizard, PromptForWebFormDialog, ReassignTaskDialog, ReassignWorkItemDialog, RegenerateRenditionsWizard, ReleaseTestServerDialog, RemoveContentUserDialog, RemoveInvitedUserDialog, RemovePermissionsDialog, RevertAllDialog, RevertSelectedDialog, RevertSnapshotDialog, RulesDialog, RunActionWizard, SaveSearchDialog, SetContentPropertiesDialog, SetPermissionsDialog, ShowSystemInfoDialog, SnapshotSandboxDialog, SpaceDetailsDialog, SpaceLinkDetailsDialog, SpacePreviewBean, SpaceUsersBean, StartWorkflowWizard, SubmitConfigureWorkflowDialog, SubmitDialog, TopicDetailsDialog, TrashcanDeleteAllItemsDialog, TrashcanDeleteItemDialog, TrashcanDeleteListedItemsDialog, TrashcanDialog, TrashcanItemDetailsDialog, TrashcanRecoverItemDialog, TrashcanRecoverListedItemsDialog, TrashcanRecoveryReportDialog, UnlockFileDialog, UpdatePermissionsDialog, UploadNewVersionDialog, UserConsoleDialog, UserMembersBean, UserProfileDialog, UsersDialog, ViewCompletedTaskDialog, ViewContentPropertiesDialog, ViewDeploymentReportDialog, WebSiteDetailsDialog

public interface IDialogBean
extends java.io.Serializable

Interface that defines the contract for a dialog backing bean


Method Summary
 java.lang.String cancel()
          Method handler called when the cancel button of the dialog is pressed
 java.lang.String finish()
          Method handler called when the finish button of the dialog is pressed
 java.lang.String getActionsConfigId()
          Returns the id of an action group to use for the main actions
 java.lang.Object getActionsContext()
          Returns the object to use as the context for the main and more actions that may be configured by the dialog
 java.util.List getAdditionalButtons()
          Returns a list of additional buttons to display in the dialog.
 java.lang.String getCancelButtonLabel()
          Returns the label to use for the cancel button
 java.lang.String getContainerDescription()
          Returns the description to be used for the dialog
 java.lang.String getContainerSubTitle()
          Returns the subtitle to be used for the dialog
 java.lang.String getContainerTitle()
          Returns the title to be used for the dialog
 boolean getFinishButtonDisabled()
          Determines whether the finish button on the dialog should be disabled
 java.lang.String getFinishButtonLabel()
          Returns the label to use for the finish button
 java.lang.String getMoreActionsConfigId()
          Returns the id of an action group to use for the more actions
 void init(java.util.Map 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(java.util.Map 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

java.lang.String cancel()
Method handler called when the cancel button of the dialog is pressed

Returns:
The outcome to return

finish

java.lang.String finish()
Method handler called when the finish button of the dialog is pressed

Returns:
The outcome to return

getAdditionalButtons

java.util.List getAdditionalButtons()
Returns a list of additional buttons to display in the dialog.

Returns:
List of button configurations, null if there are no buttons

getCancelButtonLabel

java.lang.String getCancelButtonLabel()
Returns the label to use for the cancel button

Returns:
The cancel button label

getFinishButtonLabel

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

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

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

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

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

java.lang.String getActionsConfigId()
Returns the id of an action group to use for the main actions

Returns:
Id of an action group

getMoreActionsConfigId

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


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