public abstract class BaseDialogBean extends Object implements IDialogBean, Serializable
Modifier and Type | Field and Description |
---|---|
protected BrowseBean |
browseBean |
protected boolean |
isFinished |
protected NavigationBean |
navigator |
protected Map<String,String> |
parameters |
Constructor and Description |
---|
BaseDialogBean() |
Modifier and Type | Method and Description |
---|---|
String |
cancel()
Method handler called when the cancel button of the dialog is pressed
|
protected String |
doPostCommitProcessing(FacesContext context,
String outcome)
Performs any post commit processing subclasses may want to provide
|
String |
finish()
Method handler called when the finish button of the dialog is pressed
|
protected abstract String |
finishImpl(FacesContext context,
String outcome)
Performs the actual processing for the wizard.
|
protected String |
formatErrorMessage(Throwable exception)
Returns a formatted exception string for the given exception
|
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
|
protected CheckOutCheckInService |
getCheckOutCheckInService() |
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
|
protected String |
getDefaultCancelOutcome()
Returns the default cancel outcome
|
protected String |
getDefaultFinishOutcome()
Returns the default finish outcome
|
protected org.alfresco.service.cmr.dictionary.DictionaryService |
getDictionaryService() |
protected String |
getErrorMessageId()
The default message id to use in error messages
|
protected String |
getErrorOutcome(Throwable exception)
The outcome to return if the given exception occurs
|
protected FileFolderService |
getFileFolderService() |
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
|
protected org.alfresco.service.namespace.NamespaceService |
getNamespaceService() |
protected org.alfresco.service.cmr.repository.NodeService |
getNodeService() |
protected RuleService |
getRuleService()
Get the rule service
|
protected org.alfresco.service.cmr.search.SearchService |
getSearchService() |
protected TransactionService |
getTransactionService() |
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
|
void |
setBrowseBean(BrowseBean browseBean) |
void |
setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
Sets the dictionary service
|
void |
setFileFolderService(FileFolderService fileFolderService) |
void |
setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService) |
void |
setNavigator(NavigationBean navigator) |
void |
setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService) |
void |
setSearchService(org.alfresco.service.cmr.search.SearchService searchService) |
protected boolean isFinished
protected BrowseBean browseBean
protected NavigationBean navigator
public void init(Map<String,String> parameters)
IDialogBean
init
in interface IDialogBean
parameters
- Map of parameters for the dialogpublic void restored()
IDialogBean
restored
in interface IDialogBean
public String cancel()
IDialogBean
cancel
in interface IDialogBean
public String finish()
IDialogBean
finish
in interface IDialogBean
public boolean isFinished()
IDialogBean
isFinished
in interface IDialogBean
public List<DialogsConfigElement.DialogButtonConfig> getAdditionalButtons()
IDialogBean
getAdditionalButtons
in interface IDialogBean
public String getCancelButtonLabel()
IDialogBean
getCancelButtonLabel
in interface IDialogBean
public String getFinishButtonLabel()
IDialogBean
getFinishButtonLabel
in interface IDialogBean
public boolean getFinishButtonDisabled()
IDialogBean
getFinishButtonDisabled
in interface IDialogBean
public String getContainerTitle()
IDialogBean
If this returns null the DialogManager will lookup the title via the dialog configuration
getContainerTitle
in interface IDialogBean
public String getContainerSubTitle()
IDialogBean
If this returns null the DialogManager will lookup the subtitle via the dialog configuration
getContainerSubTitle
in interface IDialogBean
public String getContainerDescription()
IDialogBean
If this returns null the DialogManager will lookup the description via the dialog configuration
getContainerDescription
in interface IDialogBean
public Object getActionsContext()
IDialogBean
getActionsContext
in interface IDialogBean
public String getActionsConfigId()
IDialogBean
getActionsConfigId
in interface IDialogBean
public String getMoreActionsConfigId()
IDialogBean
getMoreActionsConfigId
in interface IDialogBean
public void setBrowseBean(BrowseBean browseBean)
browseBean
- The BrowseBean to set.public void setNavigator(NavigationBean navigator)
navigator
- The NavigationBean to set.protected TransactionService getTransactionService()
public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
nodeService
- The nodeService to set.protected org.alfresco.service.cmr.repository.NodeService getNodeService()
protected CheckOutCheckInService getCheckOutCheckInService()
protected RuleService getRuleService()
public void setFileFolderService(FileFolderService fileFolderService)
fileFolderService
- used to manipulate folder/folder model nodesprotected FileFolderService getFileFolderService()
public void setSearchService(org.alfresco.service.cmr.search.SearchService searchService)
searchService
- the service used to find nodesprotected org.alfresco.service.cmr.search.SearchService getSearchService()
public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
dictionaryService
- the dictionary serviceprotected org.alfresco.service.cmr.dictionary.DictionaryService getDictionaryService()
public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
namespaceService
- The NamespaceServiceprotected org.alfresco.service.namespace.NamespaceService getNamespaceService()
protected String getDefaultCancelOutcome()
protected String getDefaultFinishOutcome()
protected abstract String finishImpl(FacesContext context, String outcome) throws Throwable
context
- FacesContextoutcome
- The default outcomeThrowable
protected String doPostCommitProcessing(FacesContext context, String outcome)
context
- FacesContextoutcome
- The default outcomeprotected String getErrorMessageId()
protected String getErrorOutcome(Throwable exception)
exception
- The exception that got thrownCopyright © 2005–2017 Alfresco Software. All rights reserved.