no.g9.client.core.view

Interface ViewModel

public interface ViewModel

The view model interface, representing the public interface to the view model of a DialogView.

Method Summary

Modifier and Type	Method and Description
void	clearViewModel() Clear all fields of the view model.
Collection<no.esito.jvine.controller.FieldData>	getAllFieldData(RoleConstant role) Get all field values for a role.
Collection<DialogObjectConstant>	getAttributeFields(AttributeConstant attribute) Get all fields which display values for the given attribute.
Collection<AttributeConstant>	getChangedAttributes(RoleConstant role) Get a collection of changed attributes for the given role.
Collection<DialogObjectConstant>	getChangedFields() Get a collection of all changed fields for the dialog, ie.
<M,T> AttributeConverter<M,T>	getConverter(DialogObjectConstant field) Get the converter for the given field.
no.esito.jvine.controller.FieldData	getCurrentFieldData(RoleConstant role) Get the field values for the current (selected) fields of a role.
DialogController	getDialogController() Get the dialog controller for this view model.
<T extends ListRow> List<T>	getDisplayList(RoleConstant role) Get the displayed list of ListRows for the given role.
Object	getFieldValue(DialogObjectConstant field) Gets the specified field value. Note: The field value is the value as seen from the model.
Collection<DialogObjectConstant>	getRoleFields(RoleConstant role) Get the collection of fields for the given role.
no.esito.jvine.controller.FieldData	getRowFieldData(ListRow row, RoleConstant role) Get row field values for a role.
<T extends ListRow> TableModel<T>	getTableModel(RoleConstant role) Get the TableModel for the given role.
<T extends TreeNode,L extends ListRow> TreeModel<T,L>	getTreeModel(DialogObjectConstant attribute) Get the TreeModel for the given treeview.
FieldValidator	getValidator(DialogObjectConstant field) Get the validator for the given field.
boolean	isChanged(DialogObjectConstant field) Return the changed status for the given field.
void	setChanged(DialogObjectConstant field, boolean changed) Set the changed status for the given field.
void	setFieldValue(DialogObjectConstant field, Object fieldValue) Displays the specified field value.
<T extends ListRow> void	setTableModel(RoleConstant role, TableModel<T> tableModel) Set the TableModel for the given role.
void	setTreeModel(DialogObjectConstant attribute, TreeModel<? extends TreeNode,? extends ListRow> treeModel) Set the TreeModel for the given treeview.

Method Detail

getFieldValue

Object getFieldValue(DialogObjectConstant field)

Gets the specified field value.
Note: The field value is the value as seen from the model. If the field attribute has a converter, this may differ from the value as seen in the view, as the converter's toModel will be invoked for the field value before it is returned.

Parameters:

field - The (generated) enum denoting the role attribute

Returns:

the specified field value.

setFieldValue

void setFieldValue(DialogObjectConstant field,
                   Object fieldValue)

Displays the specified field value.
Note: The field value is the value as seen from the model. If the field attribute has a converter, this may differ from the value as seen in the view, as the converter's fromModel will be invoked for the field value.

Parameters:

field - The (generated) enum denoting the role attribute

fieldValue - The field value to display

isChanged

boolean isChanged(DialogObjectConstant field)

Return the changed status for the given field. A field is considered to be changed if the user has changed the field value since the last display involving the field.

Parameters:

field - the field to check.

Returns:

the changed status for the given field.

setChanged

void setChanged(DialogObjectConstant field,
                boolean changed)

Set the changed status for the given field. The changed status is automatically handled by the view itself, but may be overridden with this method.

Parameters:

field - the field to set.

changed - the new changed status for the given field (true/false).

getChangedFields

Collection<DialogObjectConstant> getChangedFields()

Get a collection of all changed fields for the dialog, ie. a collection containing all fields which returns true from the isChanged method.

Returns:

a collection of all changed fields.

getChangedAttributes

Collection<AttributeConstant> getChangedAttributes(RoleConstant role)

Get a collection of changed attributes for the given role. This is a convenience method, returning the attributes for the fields of the given role from the getChangedFields method.

Parameters:

role - the role which owns the attributes.

Returns:

a collection of changed attributes for the given role.

getAttributeFields

Collection<DialogObjectConstant> getAttributeFields(AttributeConstant attribute)

Get all fields which display values for the given attribute.

Parameters:

attribute - the attribute behind the fields.

Returns:

the fields for the given attribute.

getDisplayList

<T extends ListRow> List<T> getDisplayList(RoleConstant role)

Get the displayed list of ListRows for the given role.

Type Parameters:

T - the actual return type (subclass of List<ListRow>)

Parameters:

role - the role which "owns" the list

Returns:

the list of ListRows

getTableModel

<T extends ListRow> TableModel<T> getTableModel(RoleConstant role)

Get the TableModel for the given role.

Type Parameters:

T - actual generated subclass of ListRow

Parameters:

role - the role which "owns" the TableModel

Returns:

the table model used to hold list rows for the given role

setTableModel

<T extends ListRow> void setTableModel(RoleConstant role,
                                       TableModel<T> tableModel)

Set the TableModel for the given role.

Type Parameters:

T - actual generated subclass of ListRow

Parameters:

role - the role which "owns" the list

tableModel - the table model to set

getTreeModel

<T extends TreeNode,L extends ListRow> TreeModel<T,L> getTreeModel(DialogObjectConstant attribute)

Get the TreeModel for the given treeview.

Type Parameters:

T - generated node that implements TreeNode

L - list row

Parameters:

attribute - the treeview dialog object constant

Returns:

the tree model that holds the tree nodes for a given treeview widget

setTreeModel

void setTreeModel(DialogObjectConstant attribute,
                  TreeModel<? extends TreeNode,? extends ListRow> treeModel)

Set the TreeModel for the given treeview.

Parameters:

attribute - the treeview dialog object constant

treeModel - the tree model for a given treeview

clearViewModel

void clearViewModel()

Clear all fields of the view model.

getConverter

<M,T> AttributeConverter<M,T> getConverter(DialogObjectConstant field)

Get the converter for the given field.

Type Parameters:

M - model

T - target

Parameters:

field - the field which has a converter.

Returns:

the converter.

getValidator

FieldValidator getValidator(DialogObjectConstant field)

Get the validator for the given field.

Parameters:

field - the field which has a validator.

Returns:

the validator.

getRoleFields

Collection<DialogObjectConstant> getRoleFields(RoleConstant role)

Get the collection of fields for the given role.

Parameters:

role - the role which owns the field collection.

Returns:

the field collection.

getDialogController

DialogController getDialogController()

Get the dialog controller for this view model.

Returns:

the dialog controller.

getRowFieldData

no.esito.jvine.controller.FieldData getRowFieldData(ListRow row,
                                                    RoleConstant role)

Get row field values for a role.

Parameters:

row - The row number.

role - The (generated) enum denoting the role.

Returns:

field data for the given row.

getAllFieldData

Collection<no.esito.jvine.controller.FieldData> getAllFieldData(RoleConstant role)

Get all field values for a role.

Parameters:

role - The (generated) enum denoting the role

Returns:

a collection of instance field data populated by the view.

getCurrentFieldData

no.esito.jvine.controller.FieldData getCurrentFieldData(RoleConstant role)

Get the field values for the current (selected) fields of a role.

Parameters:

role - The (generated) enum denoting the role

Returns:

an instance field data populated by the view.