|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.web.bean.dialog.DialogManager
public final class DialogManager
Bean that manages the dialog framework
Field Summary | |
---|---|
static java.lang.String |
BEAN_NAME
|
Constructor Summary | |
---|---|
DialogManager()
|
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 |
boolean |
getActionsAsMenu()
Determines whether the main actions should be rendered as a menu |
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.lang.String |
getActionsId()
Returns the id of a configured action group representing the actions to display for the dialog |
java.lang.String |
getActionsMenuLabel()
Returns the label to use for the main actions when a menu is being used |
java.util.List |
getAdditionalButtons()
Returns a list of additional buttons to display in the dialog |
IDialogBean |
getBean()
Returns the current dialog bean being managed |
java.lang.String |
getCancelButtonLabel()
Returns the label to use for the cancel button |
DialogsConfigElement.DialogConfig |
getCurrentDialog()
Returns the config for the current dialog |
java.lang.String |
getDescription()
Returns the resolved description to use for the dialog |
java.lang.String |
getErrorMessage()
Returns the error message to use in error conditions |
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 |
getIcon()
Returns the icon to use for the current dialog |
java.lang.String |
getMoreActionsId()
Returns the id of a configured action group representing the 'more actions' to display for the dialog |
java.lang.String |
getMoreActionsMenuLabel()
Returns the label to use for the more actions menu |
java.lang.String |
getPage()
Returns the page the dialog will use |
DialogState |
getState()
Returns the state of the currently active dialog |
java.lang.String |
getSubTitle()
Returns the resolved subtitle to use for the dialog |
java.lang.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(javax.faces.event.ActionEvent event)
Action handler used to setup parameters for the dialog being launched |
void |
setupParameters(java.util.Map params)
Sets the parameters the next dialog will initialise with |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String BEAN_NAME
Constructor Detail |
---|
public DialogManager()
Method Detail |
---|
public void setupParameters(java.util.Map params)
params
- The parameterspublic void setupParameters(javax.faces.event.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 java.lang.String getIcon()
public java.lang.String getErrorMessage()
public java.lang.String getTitle()
public java.lang.String getSubTitle()
public java.lang.String getDescription()
public java.lang.String getPage()
public java.lang.String getActionsId()
public java.lang.String getMoreActionsId()
public java.lang.Object getActionsContext()
public java.lang.String getActionsMenuLabel()
public java.lang.String getMoreActionsMenuLabel()
public boolean getActionsAsMenu()
public boolean isOKButtonVisible()
public boolean isNavigationVisible()
public boolean isViewListVisible()
public boolean isFilterListVisible()
public java.util.List getAdditionalButtons()
public java.lang.String getCancelButtonLabel()
public java.lang.String getFinishButtonLabel()
public boolean getFinishButtonDisabled()
public java.lang.String finish()
public java.lang.String cancel()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |