public final class DialogManager extends Object implements Serializable
Constructor and Description |
---|
DialogManager() |
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
|
boolean |
getActionsAsMenu()
Determines whether the main actions should be rendered as a
menu
|
Object |
getActionsContext()
Returns the object to use as the context for the main and more
actions that may be configured by the dialog
|
String |
getActionsId()
Returns the id of a configured action group representing the actions to
display for the dialog
|
String |
getActionsMenuLabel()
Returns the label to use for the main actions when a menu is being used
|
List<DialogsConfigElement.DialogButtonConfig> |
getAdditionalButtons()
Returns a list of additional buttons to display in the dialog
|
IDialogBean |
getBean()
Returns the current dialog bean being managed
|
String |
getCancelButtonLabel()
Returns the label to use for the cancel button
|
DialogsConfigElement.DialogConfig |
getCurrentDialog()
Returns the config for the current dialog
|
String |
getDescription()
Returns the resolved description to use for the dialog
|
String |
getErrorMessage()
Returns the error message to use in error conditions
|
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 |
getIcon()
Returns the icon to use for the current dialog
|
String |
getMoreActionsId()
Returns the id of a configured action group representing the
'more actions' to display for the dialog
|
String |
getMoreActionsMenuLabel()
Returns the label to use for the more actions menu
|
String |
getPage()
Returns the page the dialog will use
|
DialogState |
getState()
Returns the state of the currently active dialog
|
String |
getSubTitle()
Returns the resolved subtitle to use for the dialog
|
String |
getTitle()
Returns the resolved title to use for the dialog
|
boolean |
isFilterListVisible()
Determines whether the current dialog should display the list
of filters in the header area
|
boolean |
isNavigationVisible()
Determines whether the current dialog should display the next
and previous buttons in the header area
|
boolean |
isOKButtonVisible()
Determines whether the current dialog's OK button is visible
|
boolean |
isViewListVisible()
Determines whether the current dialog should display the list
of views in the header area
|
void |
restoreState(DialogState state)
Restores the dialog represented by the given DialogState object.
|
void |
setCurrentDialog(DialogsConfigElement.DialogConfig config)
Sets the current dialog
|
void |
setupParameters(ActionEvent event)
Action handler used to setup parameters for the dialog being launched
|
void |
setupParameters(Map<String,String> params)
Sets the parameters the next dialog will initialise with
|
public static final String BEAN_NAME
public void setupParameters(Map<String,String> params)
params
- The parameterspublic void setupParameters(ActionEvent event)
event
- The event containing the parameterspublic void setCurrentDialog(DialogsConfigElement.DialogConfig config)
config
- The configuration for the dialog to setpublic DialogState getState()
public void restoreState(DialogState state)
state
- The DialogState for the dialog to restorepublic DialogsConfigElement.DialogConfig getCurrentDialog()
public IDialogBean getBean()
public String getIcon()
public String getErrorMessage()
public String getTitle()
public String getSubTitle()
public String getDescription()
public String getPage()
public String getActionsId()
public String getMoreActionsId()
public Object getActionsContext()
public String getActionsMenuLabel()
public String getMoreActionsMenuLabel()
public boolean getActionsAsMenu()
public boolean isOKButtonVisible()
public boolean isNavigationVisible()
public boolean isViewListVisible()
public boolean isFilterListVisible()
public List<DialogsConfigElement.DialogButtonConfig> getAdditionalButtons()
public String getCancelButtonLabel()
public String getFinishButtonLabel()
public boolean getFinishButtonDisabled()
public String finish()
public String cancel()
Copyright © 2005–2017 Alfresco Software. All rights reserved.