DialogView (g9 jVine 2.9.0 API)

```
public interface DialogView
```
The view as seen from the controller.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`clearObject(DialogObjectConstant target)` Clear the given dialog object.
`void`	`disable(DialogObjectConstant target)` Disable the given dialog object.
`void`	`dispatchEvent(ListRow listRow, DialogObjectConstant trigger, Object event, String method)` Dispatch an event to the dialog controller.
`void`	`enable(DialogObjectConstant target)` Enable the given dialog object.
`DialogObjectConstant`	`getCurrentNotebookPage(DialogObjectConstant notebook)` Get the current page for the given Notebook.
`DialogObjectConstant`	`getDefaultButton()` Get the current default button for the dialog.
`int`	`getDialogInstanceNumber()` Gets the 1-based dialog instance number.
`List<DialogObjectConstant>`	`getDialogObjectConstants()` Returns the list of all dialog object constants for the dialog.
`Object`	`getEffect(DialogObjectConstant target)` Get the effect object for the given dialog object.
`boolean`	`getMandatory(DialogObjectConstant target)` Get the mandatory property for the given dialog object.
`String`	`getTitle(DialogObjectConstant dialogObject)` Get the message title property for the specified dialog object.
`ViewModel`	`getViewModel()`
`Object`	`getWidgetProperty(DialogObjectConstant target, String key)` Get a property value for a widget.
`void`	`hide(DialogObjectConstant target)` Hide the given dialog object.
`void`	`init()` Invoked after the view has been fully initialized.
`boolean`	`isEditable(DialogObjectConstant target)` Check if the given dialog object is editable.
`boolean`	`isEnabled(DialogObjectConstant target)` Check if the given dialog object is enabled.
`boolean`	`isMandatory(DialogObjectConstant target)` Check if the given dialog object is mandatory.
`boolean`	`isModal()` Check if the given dialog is modal.
`boolean`	`isShown(DialogObjectConstant target)` Check if the given dialog object is shown.
`void`	`performAction(ActionType action, DialogObjectConstant target)` Perform the specified action.
`void`	`setCurrentNotebookPage(DialogObjectConstant notebook, DialogObjectConstant page)` Set the current Notebook page to show.
`void`	`setDefaultButton(DialogObjectConstant defaultButton)` Set the new default button for the dialog.
`void`	`setDialogTitle(String title)` Set the title to use for this dialog instance.
`void`	`setEditable(DialogObjectConstant target, boolean value)` Set the editable property for the given dialog object.
`void`	`setEffect(DialogObjectConstant target, Object effect)` Set the effect object for the given dialog object.
`void`	`setMandatory(DialogObjectConstant target, boolean value)` Set the mandatory property for the given dialog object.
`void`	`setModal(boolean modal)` Set the modal property for a dialog.
`void`	`setProperty(DialogObjectConstant target, String key, Object value)` Set a property for the given dialog component.
`void`	`setWidgetProperty(DialogObjectConstant target, String key, Object value)` Set the given property value for a widget.
`void`	`show(DialogObjectConstant target)` Show the given dialog object.
`void`	`update(Collection<no.esito.jvine.controller.OSNode<?>> nodes)` Notify the view that the given roles are updated.

- Method Detail
  - init
```
void init()
```
    Invoked after the view has been fully initialized.
  - update
```
void update(Collection<no.esito.jvine.controller.OSNode<?>> nodes)
```
    Notify the view that the given roles are updated. The view should ask the controller to get the actual data for the updated roles, and then display it.
    
    Parameters:
    
    nodes - a collection of (generated) role enums.
  - performAction
```
void performAction(ActionType action,
                   DialogObjectConstant target)
```
    Perform the specified action.
    
    Parameters:
    
    action - the action to perform.
    
    target - the action's target.
  - isEditable
```
boolean isEditable(DialogObjectConstant target)
```
    Check if the given dialog object is editable.
    
    Parameters:
    
    target - the dialog object to check.
    
    Returns:
    
    true if editable, false otherwise.
  - isEnabled
```
boolean isEnabled(DialogObjectConstant target)
```
    Check if the given dialog object is enabled.
    
    Parameters:
    
    target - the dialog object to check.
    
    Returns:
    
    true if enabled, false otherwise.
  - isMandatory
```
boolean isMandatory(DialogObjectConstant target)
```
    Check if the given dialog object is mandatory.
    
    Parameters:
    
    target - the dialog object to check.
    
    Returns:
    
    true if mandatory, false otherwise.
  - isShown
```
boolean isShown(DialogObjectConstant target)
```
    Check if the given dialog object is shown.
    
    Parameters:
    
    target - the dialog object to check.
    
    Returns:
    
    true if shown, false otherwise.
  - setModal
```
void setModal(boolean modal)
```
    Set the modal property for a dialog.
    
    Parameters:
    
    modal - true if the dialog should be modal
  - isModal
```
boolean isModal()
```
    Check if the given dialog is modal.
    
    Returns:
    
    true if modal, false otherwise.
  - getEffect
```
Object getEffect(DialogObjectConstant target)
```
    Get the effect object for the given dialog object.
    
    Parameters:
    
    target - the dialog object to check.
    
    Returns:
    
    the effect object, or null.
  - setEditable
```
void setEditable(DialogObjectConstant target,
                 boolean value)
```
    Set the editable property for the given dialog object.
    
    Parameters:
    
    target - the dialog object to set.
    
    value - the new value for the property.
  - setMandatory
```
void setMandatory(DialogObjectConstant target,
                  boolean value)
```
    Set the mandatory property for the given dialog object.
    
    Parameters:
    
    target - the dialog object to set.
    
    value - the new value for the property.
  - getMandatory
```
boolean getMandatory(DialogObjectConstant target)
```
    Get the mandatory property for the given dialog object.
    
    Parameters:
    
    target - the dialog object with said property
    
    Returns:
    
    the property value
  - setEffect
```
void setEffect(DialogObjectConstant target,
               Object effect)
```
    Set the effect object for the given dialog object.
    
    Parameters:
    
    target - the dialog object to set.
    
    effect - the effect object to set.
  - enable
```
void enable(DialogObjectConstant target)
```
    Enable the given dialog object.
    
    Parameters:
    
    target - the dialog object to enable.
  - disable
```
void disable(DialogObjectConstant target)
```
    Disable the given dialog object.
    
    Parameters:
    
    target - the dialog object to disable.
  - show
```
void show(DialogObjectConstant target)
```
    Show the given dialog object.
    
    Parameters:
    
    target - the dialog object to show.
  - hide
```
void hide(DialogObjectConstant target)
```
    Hide the given dialog object.
    
    Parameters:
    
    target - the dialog object to hide.
  - setWidgetProperty
```
void setWidgetProperty(DialogObjectConstant target,
                       String key,
                       Object value)
```
    Set the given property value for a widget.
    
    Parameters:
    
    target - the dialog object to set the property for
    
    key - the property key
    
    value - the property value to set
  - getWidgetProperty
```
Object getWidgetProperty(DialogObjectConstant target,
                         String key)
```
    Get a property value for a widget.
    
    Parameters:
    
    target - the dialog object to get the property for
    
    key - the property key
    
    Returns:
    
    the property value
  - clearObject
```
void clearObject(DialogObjectConstant target)
```
    Clear the given dialog object.
    
    Parameters:
    
    target - the dialog object to clear.
  - setCurrentNotebookPage
```
void setCurrentNotebookPage(DialogObjectConstant notebook,
                            DialogObjectConstant page)
```
    Set the current Notebook page to show. To be used for Notebooks without tabs (widget stacks).
    
    Parameters:
    
    notebook - the Notebook.
    
    page - the new current page for the Notebook.
  - getCurrentNotebookPage
```
DialogObjectConstant getCurrentNotebookPage(DialogObjectConstant notebook)
```
    Get the current page for the given Notebook.
    
    Parameters:
    
    notebook - the Notebook in question.
    
    Returns:
    
    the current page for the Notebook.
  - setProperty
```
void setProperty(DialogObjectConstant target,
                 String key,
                 Object value)
```
    Set a property for the given dialog component. The available properties and property values is target dependent.
    
    Parameters:
    
    target - the dialog object to set the property on.
    
    key - the property to set.
    
    value - the new value to set for the property.
  - getViewModel
```
ViewModel getViewModel()
```
    Returns:
    
    the view model for the dialog.
  - getTitle
```
String getTitle(DialogObjectConstant dialogObject)
```
    Get the message title property for the specified dialog object.
    
    Parameters:
    
    dialogObject - the dialog object
    
    Returns:
    
    the title or null if no title exist
  - setDialogTitle
```
void setDialogTitle(String title)
```
    Set the title to use for this dialog instance. If the title is null, the default dialog title will be used.
    
    Parameters:
    
    title - the new title to use for the instance
  - getDialogInstanceNumber
```
int getDialogInstanceNumber()
```
    Gets the 1-based dialog instance number.
    
    Returns:
    
    the dialog instance number
  - getDialogObjectConstants
```
List<DialogObjectConstant> getDialogObjectConstants()
```
    Returns the list of all dialog object constants for the dialog.
    
    Returns:
    
    all dialog object constants
  - dispatchEvent
```
void dispatchEvent(ListRow listRow,
                   DialogObjectConstant trigger,
                   Object event,
                   String method)
```
    Dispatch an event to the dialog controller. Checks that the dialog can dispatch events before proceeding. Note that this method should only be used from a GUI thread.
    
    Parameters:
    
    listRow - the Table or List row in which the event occurred, or null if not in a table/list
    
    trigger - the cause of the event
    
    event - the type of event
    
    method - the event method name
  - getDefaultButton
```
DialogObjectConstant getDefaultButton()
```
    Get the current default button for the dialog. The default button can be set as a property on a Window in the dialog model, and can be changed at runtime.
    
    Returns:
    
    the current default button for the dialog
  - setDefaultButton
```
void setDefaultButton(DialogObjectConstant defaultButton)
```
    Set the new default button for the dialog. The default button should have a Clicked event in the model.
    
    Parameters:
    
    defaultButton - the new default button for the dialog

Interface DialogView

Method Summary

Method Detail

init

update

performAction

isEditable

isEnabled

isMandatory

isShown

setModal

isModal

getEffect

setEditable

setMandatory

getMandatory

setEffect

enable

disable

show

hide

setWidgetProperty

getWidgetProperty

clearObject

setCurrentNotebookPage

getCurrentNotebookPage

setProperty

getViewModel

getTitle

setDialogTitle

getDialogInstanceNumber

getDialogObjectConstants

dispatchEvent

getDefaultButton

setDefaultButton