FacesDialogBean (g9 ICEfaces 2 2.8.1 API)

java.lang.Object
- no.g9.client.core.view.faces.FacesDialogBean

All Implemented Interfaces:

Serializable
```
public abstract class FacesDialogBean
extends Object
implements Serializable
```
Common superclass for all JSF backing beans for the dialogs in the application. Note: this class and its generated subclasses is intended as a JSF interface to the view, and should normally not be used by the application programmer (unless the properties accessed from the JSF markup needs customization). Care should be taken if the public or protected methods are overridden in the generated <dialog>Bean subclass.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

FacesDialogBean(DialogConstant dialog)
Create a new backing bean for the given dialog.

Constructors
Constructor and Description
`FacesDialogBean(DialogConstant dialog)` Create a new backing bean for the given dialog.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`copyToEquivalentFields(DialogObjectConstant field, Object value)` Delegate method for the view model.
`void`	`defaultButtonActionListener(javax.faces.event.ActionEvent event)` Execute the action listener method for the current default button.
`protected void`	`dispatchEvent(DialogObjectConstant trigger, Object event, String method)` Delegate the event dispatch to the view.
`protected void`	`dispatchEvent(ListRow listRow, DialogObjectConstant trigger, Object event, String method)` Delegate the event dispatch to the view, with listRow.
`protected void`	`dispatchSystemMessages(DialogObjectConstant trigger, String systemMessagesInJson)` Dispatch the JSON messages.
`FacesApplicationBean`	`getApplicationBean()` Get the JSF managed bean which references the application view.
`List<org.icefaces.ace.component.submenu.Submenu>`	`getApplicationMenu()`
`org.icefaces.ace.model.MenuModel`	`getApplicationMenuModel()`
`protected int`	`getCurrentNotebookIndex(DialogObjectConstant notebook)` Get the current Notebook index from the view.
`protected DialogObjectConstant`	`getCurrentNotebookPage(DialogObjectConstant notebook)` Get the current Notebook page from the view.
`int`	`getDialogInstanceNumber()` Gets the 1-based dialog instance number.
`String`	`getDialogTitle()` Get the title for this dialog.
`String`	`getDialogToolbarIncludePath()` Get the JSF facelet dynamic include path for the toolbar of the current dialog.
`protected <T extends FacesDialogView> T`	`getDialogView()`
`Map<?,?>`	`getEditable()`
`Map<?,?>`	`getEffect()`
`Map<?,?>`	`getEnabled()`
`Map<?,?>`	`getExpanded()`
`protected javax.faces.component.UIComponent`	`getFacesComponent(javax.faces.component.UIComponent comp, String key)` Delegate to the view.
`protected String`	`getFacesId(DialogObjectConstant target)` Delegate to the view.
`protected Object`	`getField(DialogObjectConstant field)` Get the field (view model value) for the given field.
`protected Object`	`getFieldValue(DialogObjectConstant field)` Delegate method for the view model.
`protected ListRow`	`getListRow(no.g9.os.RoleConstant listRole, Object contextValue)` Get the ListRow for the given context value.
`Map<?,?>`	`getMandatory()`
`String`	`getMessageBundleName()`
`protected org.icefaces.ace.model.tree.NodeStateMap`	`getNodeStateMap(DialogObjectConstant diaConst)` Get the node state map for the given dialog constant.
`protected int`	`getOldNotebookIndex(DialogObjectConstant notebook)` Get the old Notebook index from the view.
`protected Collection<DialogObjectConstant>`	`getRoleFields(no.g9.os.RoleConstant role)` Delegate method for the view model.
`protected org.icefaces.ace.model.table.RowStateMap`	`getRowStateMap(no.g9.os.RoleConstant role)` Get the row state map for the given role.
`Map<?,?>`	`getShown()`
`Map<?,?>`	`getSortAscending()`
`Map<?,?>`	`getSortPriority()`
`Map<?,?>`	`getTitle()`
`protected no.esito.jvine.view.ViewModelImpl`	`getViewModel()`
`protected boolean`	`handleListSelection(no.g9.os.RoleConstant listRole, boolean selected, int rowNo, ListRow emptyRow)` Delegate the list selection handling to the view.
`protected boolean`	`hasOpenDialogView()`
`protected void`	`hide(DialogObjectConstant target)` Delegate the hide operation to the view.
`protected abstract void`	`initBean()` Initialization of the bean.
`protected void`	`initPropertyMaps(Class enumClass)` Initialize the property maps for this dialog bean.
`String`	`msg(String key)` Get the message text for the given key.
`void`	`setApplicationBean(FacesApplicationBean applicationBean)` Set the JSF backing bean for the application.
`void`	`setAsActiveInstance()` Set this dialog instance as the active instance for this dialog model.
`protected void`	`setCurrentNotebookIndex(DialogObjectConstant notebook, int index)` Set the current Notebook index in the view.
`protected void`	`setCurrentNotebookPage(DialogObjectConstant notebook, DialogObjectConstant page)` Set the current Notebook page in the view.
`void`	`setDialogInstanceNumber(int dialogInstanceNumber)` Sets the 1-based dialog instance number.
`protected void`	`setField(DialogObjectConstant field, Object value)` Set the field (view model value) for the given field.
`protected void`	`setFieldValue(DialogObjectConstant field, Object fieldValue)` Delegate method for the view model.
`protected void`	`setListSelectionRowNum(int rowNum)` Sets the selected row num in the dialog view, so that it may be fetched during action Select later.
`protected void`	`setNodeStateMap(DialogObjectConstant diaConst, org.icefaces.ace.model.tree.NodeStateMap nodeStateMap)` Set the node state map for the given dialog constant.
`protected void`	`setOldNotebookIndex(DialogObjectConstant notebook, int index)` Set the old Notebook index in the view.
`protected void`	`show(DialogObjectConstant target)` Delegate the show operation to the view.
`protected void`	`updateRowState(no.g9.os.RoleConstant role)` Update the row states for the given role.
`protected boolean`	`validateField(DialogObjectConstant field, Object newValue, Object oldValue)` Validate the new value for the given field.
`protected boolean`	`validateField(ListRow listRow, DialogObjectConstant field, Object newValue, Object oldValue)` Validate the new value for the given field.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FacesDialogBean
```
public FacesDialogBean(DialogConstant dialog)
```
    Create a new backing bean for the given dialog.
    
    Parameters:
    
    dialog - the dialog for this bean.
- Method Detail
  - getEditable
```
public Map<?,?> getEditable()
```
    Returns:
    
    the Map for the EDITABLE property
  - getEnabled
```
public Map<?,?> getEnabled()
```
    Returns:
    
    the Map for the ENABLED property
  - getMandatory
```
public Map<?,?> getMandatory()
```
    Returns:
    
    the Map for the MANDATORY property
  - getShown
```
public Map<?,?> getShown()
```
    Returns:
    
    the Map for the SHOWN property
  - getExpanded
```
public Map<?,?> getExpanded()
```
    Returns:
    
    the Map for the EXPANDED property
  - getEffect
```
public Map<?,?> getEffect()
```
    Returns:
    
    the Map for the EFFECT property
  - getTitle
```
public Map<?,?> getTitle()
```
    Returns:
    
    the Map for the title of a field
  - getSortPriority
```
public Map<?,?> getSortPriority()
```
    Returns:
    
    the Map for sort priority
  - getSortAscending
```
public Map<?,?> getSortAscending()
```
    Returns:
    
    the Map for sort ascending
  - getRowStateMap
```
protected org.icefaces.ace.model.table.RowStateMap getRowStateMap(no.g9.os.RoleConstant role)
```
    Get the row state map for the given role.
    
    Parameters:
    
    role - the role to get the row state map for
    
    Returns:
    
    the rowStateMap
  - updateRowState
```
protected void updateRowState(no.g9.os.RoleConstant role)
```
    Update the row states for the given role.
    
    Parameters:
    
    role - the owning role of the table
  - getNodeStateMap
```
protected org.icefaces.ace.model.tree.NodeStateMap getNodeStateMap(DialogObjectConstant diaConst)
```
    Get the node state map for the given dialog constant.
    
    Parameters:
    
    diaConst - the dialog constant to get the node state map for
    
    Returns:
    
    the nodeStateMap
  - setNodeStateMap
```
protected void setNodeStateMap(DialogObjectConstant diaConst,
                               org.icefaces.ace.model.tree.NodeStateMap nodeStateMap)
```
    Set the node state map for the given dialog constant.
    
    Parameters:
    
    diaConst - the dialog constant to set the node state map for
    
    nodeStateMap - the nodeStateMap to set
  - initPropertyMaps
```
protected void initPropertyMaps(Class enumClass)
```
    Initialize the property maps for this dialog bean. The property maps are accessed from JSF markup, and routes the access to the property manager for the dialog view.
    
    Parameters:
    
    enumClass - - the class for the const enum for this dialog.
  - getCurrentNotebookPage
```
protected DialogObjectConstant getCurrentNotebookPage(DialogObjectConstant notebook)
```
    Get the current Notebook page from the view.
    
    Parameters:
    
    notebook - the Notebook in question.
    
    Returns:
    
    the current page for the Notebook.
  - setCurrentNotebookPage
```
protected void setCurrentNotebookPage(DialogObjectConstant notebook,
                                      DialogObjectConstant page)
```
    Set the current Notebook page in the view.
    
    Parameters:
    
    notebook - the Notebook.
    
    page - the new current page for the Notebook.
  - getCurrentNotebookIndex
```
protected int getCurrentNotebookIndex(DialogObjectConstant notebook)
```
    Get the current Notebook index from the view.
    
    Parameters:
    
    notebook - the Notebook in question.
    
    Returns:
    
    the current index for the Notebook.
  - setCurrentNotebookIndex
```
protected void setCurrentNotebookIndex(DialogObjectConstant notebook,
                                       int index)
```
    Set the current Notebook index in the view.
    
    Parameters:
    
    notebook - the Notebook.
    
    index - the new current page index for the Notebook.
  - getOldNotebookIndex
```
protected int getOldNotebookIndex(DialogObjectConstant notebook)
```
    Get the old Notebook index from the view.
    
    Parameters:
    
    notebook - the Notebook in question.
    
    Returns:
    
    the old index for the Notebook.
  - setOldNotebookIndex
```
protected void setOldNotebookIndex(DialogObjectConstant notebook,
                                   int index)
```
    Set the old Notebook index in the view.
    
    Parameters:
    
    notebook - the Notebook.
    
    index - the new old page index for the Notebook.
  - handleListSelection
```
protected boolean handleListSelection(no.g9.os.RoleConstant listRole,
                                      boolean selected,
                                      int rowNo,
                                      ListRow emptyRow)
```
    Delegate the list selection handling to the view.
    
    Parameters:
    
    listRole - - the object selection role for the list
    
    selected - - true if the row is to be selected
    
    rowNo - - the list row in question
    
    emptyRow - - an empty list row containing a collection of all the fields in a list row
    
    Returns:
    
    true if the selection in the list was changed, false if the operation was canceled by the user
  - setListSelectionRowNum
```
protected void setListSelectionRowNum(int rowNum)
```
    Sets the selected row num in the dialog view, so that it may be fetched during action Select later.
    
    Parameters:
    
    rowNum - row number
  - show
```
protected void show(DialogObjectConstant target)
```
    Delegate the show operation to the view.
    
    Parameters:
    
    target - the dialog object to show.
  - hide
```
protected void hide(DialogObjectConstant target)
```
    Delegate the hide operation to the view.
    
    Parameters:
    
    target - the dialog object to hide.
  - dispatchEvent
```
protected void dispatchEvent(DialogObjectConstant trigger,
                             Object event,
                             String method)
```
    Delegate the event dispatch to the view.
    
    Parameters:
    
    trigger - the cause of the event.
    
    event - the type of event.
    
    method - the event method name.
  - dispatchSystemMessages
```
protected void dispatchSystemMessages(DialogObjectConstant trigger,
                                      String systemMessagesInJson)
```
    Dispatch the JSON messages. Messages where the application menu is the port are dispatched directly, with the message payload as the event method. Other messages are forwarded to the application controller, and will normally contain G9 actions in the payload.
    
    Parameters:
    
    trigger - the cause of the event
    
    systemMessagesInJson - JSON coded array of messages
  - dispatchEvent
```
protected void dispatchEvent(ListRow listRow,
                             DialogObjectConstant trigger,
                             Object event,
                             String method)
```
    Delegate the event dispatch to the view, with listRow.
    
    Parameters:
    
    listRow - the ListRow in which the event occurred.
    
    trigger - the cause of the event.
    
    event - the type of event.
    
    method - the event method name.
  - getDialogToolbarIncludePath
```
public String getDialogToolbarIncludePath()
```
    Get the JSF facelet dynamic include path for the toolbar of the current dialog.
    
    Returns:
    
    the dynamic include path for the current dialog toolbar.
  - getApplicationMenuModel
```
public org.icefaces.ace.model.MenuModel getApplicationMenuModel()
```
    Returns:
    
    the application menu model (for the menu bar), as created by the application view.
  - getApplicationMenu
```
public List<org.icefaces.ace.component.submenu.Submenu> getApplicationMenu()
```
    Returns:
    
    the application menu as a list of menus, as created by the application view.
  - msg
```
public String msg(String key)
```
    Get the message text for the given key. The default is to look for the message in the generated messages.properties file for a dialog. This method is used from the generated xhtml markup, to allow for providing other message sources than the default resource bundle.
    
    Parameters:
    
    key - the message key for the message
    
    Returns:
    
    the message text for the given key
  - copyToEquivalentFields
```
protected void copyToEquivalentFields(DialogObjectConstant field,
                                      Object value)
```
    Delegate method for the view model.
    
    Parameters:
    
    field - the field with the input value.
    
    value - the field value to copy.
  - getField
```
protected Object getField(DialogObjectConstant field)
```
    Get the field (view model value) for the given field.
    
    Parameters:
    
    field - the field holds the value for this field.
    
    Returns:
    
    the field.
  - setField
```
protected void setField(DialogObjectConstant field,
                        Object value)
```
    Set the field (view model value) for the given field. If the new value differs from the old value, the field is marked as changed.
    
    Parameters:
    
    field - the field holds the value for this field.
    
    value - the new field value.
  - getFieldValue
```
protected Object getFieldValue(DialogObjectConstant field)
```
    Delegate method for the view model.
    
    Parameters:
    
    field - The (generated) enum denoting the role attribute
    
    Returns:
    
    the specified field value (possibly converted from view to model value)
  - setFieldValue
```
protected void setFieldValue(DialogObjectConstant field,
                             Object fieldValue)
```
    Delegate method for the view model.
    
    Parameters:
    
    field - The (generated) enum denoting the role attribute
    
    fieldValue - The field value to display (possibly converted from model to view value)
  - getRoleFields
```
protected Collection<DialogObjectConstant> getRoleFields(no.g9.os.RoleConstant role)
```
    Delegate method for the view model.
    
    Parameters:
    
    role - the role which owns the field collection.
    
    Returns:
    
    the field collection.
  - getApplicationBean
```
public FacesApplicationBean getApplicationBean()
```
    Get the JSF managed bean which references the application view.
    
    Returns:
    
    the JSF application bean.
  - setApplicationBean
```
public void setApplicationBean(FacesApplicationBean applicationBean)
```
    Set the JSF backing bean for the application. This done by JSF when the dialog is opened for the first time, injected as the applicationBean property in the config file. The initialization of the bean in the initBean method is essential to get a properly working dialog.
    
    Parameters:
    
    applicationBean - the new JSF application bean.
  - getDialogInstanceNumber
```
public int getDialogInstanceNumber()
```
    Gets the 1-based dialog instance number.
    
    Returns:
    
    the dialog instance number
  - setDialogInstanceNumber
```
public void setDialogInstanceNumber(int dialogInstanceNumber)
```
    Sets the 1-based dialog instance number.
    
    Parameters:
    
    dialogInstanceNumber - the new dialog instance number.
    
    See Also:
    
    DialogConstant.getMaximumNumberOfInstances()
  - setAsActiveInstance
```
public void setAsActiveInstance()
```
    Set this dialog instance as the active instance for this dialog model.
  - initBean
```
protected abstract void initBean()
```
    Initialization of the bean. This method is implemented in the generated subclasses.
  - getDialogView
```
protected <T extends FacesDialogView> T getDialogView()
```
    Type Parameters:
    
    T - The dialog view type
    
    Returns:
    
    the view for this dialog.
  - hasOpenDialogView
```
protected boolean hasOpenDialogView()
```
    Returns:
    
    true if this dialog has an open view
  - getViewModel
```
protected no.esito.jvine.view.ViewModelImpl getViewModel()
```
    Returns:
    
    the view model for this dialog.
  - validateField
```
protected boolean validateField(DialogObjectConstant field,
                                Object newValue,
                                Object oldValue)
```
    Validate the new value for the given field. If the new value does not pass the validation, an error message is shown to the user.
    
    Parameters:
    
    field - the field to validate.
    
    newValue - the new field value (which is to be validated).
    
    oldValue - the old field value.
    
    Returns:
    
    true if the validation passed, false otherwise.
  - validateField
```
protected boolean validateField(ListRow listRow,
                                DialogObjectConstant field,
                                Object newValue,
                                Object oldValue)
```
    Validate the new value for the given field. If the new value does not pass the validation, an error message is shown to the user.
    
    Parameters:
    
    listRow - the ListRow in which the event occurred.
    
    field - the field to validate.
    
    newValue - the new field value (which is to be validated).
    
    oldValue - the old field value.
    
    Returns:
    
    true if the validation passed, false otherwise.
  - getDialogTitle
```
public String getDialogTitle()
```
    Get the title for this dialog.
    
    Returns:
    
    the title
  - getListRow
```
protected ListRow getListRow(no.g9.os.RoleConstant listRole,
                             Object contextValue)
```
    Get the ListRow for the given context value. The context value is taken from the JSF display event, and may be of type ListRow or String.
    
    Parameters:
    
    listRole - the role for the list which contains the row.
    
    contextValue - the context value from the JSF event.
    
    Returns:
    
    the found ListRow, or null if not found.
  - getMessageBundleName
```
public String getMessageBundleName()
```
    Returns:
    
    the messageBundleName
  - defaultButtonActionListener
```
public void defaultButtonActionListener(javax.faces.event.ActionEvent event)
```
    Execute the action listener method for the current default button. The default button must be a button in the dialog model for this dialog, and it must have a Clicked event.
    
    Parameters:
    
    event - the JSF event
  - getFacesId
```
protected String getFacesId(DialogObjectConstant target)
```
    Delegate to the view.
    
    Parameters:
    
    target - the dialog object to look up
    
    Returns:
    
    the faces ID for target
  - getFacesComponent
```
protected javax.faces.component.UIComponent getFacesComponent(javax.faces.component.UIComponent comp,
                                                              String key)
```
    Delegate to the view.
    
    Parameters:
    
    comp - the parent component, or null
    
    key - the JSF component id
    
    Returns:
    
    the JSF component with the given key

Class FacesDialogBean

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FacesDialogBean

Method Detail

getEditable

getEnabled

getMandatory

getShown

getExpanded

getEffect

getTitle

getSortPriority

getSortAscending

getRowStateMap

updateRowState

getNodeStateMap

setNodeStateMap

initPropertyMaps

getCurrentNotebookPage

setCurrentNotebookPage

getCurrentNotebookIndex

setCurrentNotebookIndex

getOldNotebookIndex

setOldNotebookIndex

handleListSelection

setListSelectionRowNum

show

hide

dispatchEvent

dispatchSystemMessages

dispatchEvent

getDialogToolbarIncludePath

getApplicationMenuModel

getApplicationMenu

msg

copyToEquivalentFields

getField

setField

getFieldValue

setFieldValue

getRoleFields

getApplicationBean

setApplicationBean

getDialogInstanceNumber

setDialogInstanceNumber

setAsActiveInstance

initBean

getDialogView

hasOpenDialogView

getViewModel

validateField

validateField

getDialogTitle

getListRow

getMessageBundleName

defaultButtonActionListener

getFacesId

getFacesComponent