actionMap

Action​Map

Assigns the view action map. An action map is generally represented as a toolbar attached to the view. The toolbar follows the structure of the action map :

Depending on the UI channel, the view action map may also be replicated in a component contextual menu. In that case, the translated action name is used to label each menu item. The same grouping rules apply for the contextual menu than for the toolbar.

background

String

Sets the background color of the UI component. The color must be defined using its string hexadecimal representation (0xargb encoded).

Default value is null, meaning use UI default.

borderType

EBorder​Type

Sets the border type of the view. This is either a value of the EBorderType enum or its equivalent string representation :

Default value is EBorderType.NONE, i.e. no border.

font

String

Allows to customize the font used by the UI component. The font must be string encoded using the pattern "[name];[style];[size]" :

Any of the above pattern section can be left empty, thus falling back to the component default.

Default value is null, meaning use default component font.

foreground

String

Sets the foreground color of the UI component. The color must be defined using its string hexadecimal representation (0xargb encoded).

Default value is null, meaning use UI default.

grantedRoles

Collection​<​String​>​

Assigns the roles that are authorized to use this view. It supports "!" prefix to negate the role(s). Whenever the user is not granted sufficient privileges, the view is replaced by an empty section at runtime. Setting the collection of granted roles to null (default value) disables role based authorization on the view level. The framework then checks for the model roles authorizations and will apply the same restrictions. If both view and model granted roles collections are null, then access is granted to anyone.

modelDescriptor

IModel​Descriptor

Assigns the model descriptor backing the view. The model descriptor serves several purposes :

Although it is the developer responsibility to make sure the correct model descriptor is assigned to the view, there are cases where the framework will infer it. For instance, a composite view will by default transmit its model descriptor to its children that do not have their model descriptor explicitely set. This allows for setting the model descriptor only on the composite view and keep default null value on the children as an implicite model inheritance enablement.

permId

String

Sets the permanent identifier to this application element. Permanent identifiers are used by different framework parts, like dynamic security or record/replay controllers to uniquely identify an application element. Permanent identifiers are generated by the SJS build based on the element id but must be explicitely set if Spring XML is used.

preferredHeight

Integer

Allows to set a preferred height (in pixels) for the created peer UI component. This will override default and give hints to the UI layouting system.

preferredWidth

Integer

Allows to set a preferred width (in pixels) for the created peer UI component. This will override default and give hints to the UI layouting system.

readOnly

boolean

Allows to set a view read-only, i.e. none of the view part will allow for updating the underlying model. This is mainly a shortcut to assigning an "always closed" writability gate. One difference though is that, since the framework knows that the view will never be updatable, it may take specific decisions to render properties in a slightly different way, e.g. instead of using a disabled textfied, use a label.

Default value is false, i.e. view is updatable.

secondaryActionMap

Action​Map

Assigns the view secondary action map. Same rules as the primary action map apply except that actions in this map should be visually distinguished from the main action map, e.g. placed in another toolbar.

writabilityGates

Collection​<​IGate​>​

Assigns a collection of gates to determine view writability. A view will be considered writable (updatable) if and only if all gates are open. This mecanism is mainly used for dynamic UI authorization based on model state, e.g. a validated invoice should not be editable anymore.

View assigned gates will be cloned for each view instance created and backed by this descriptor. So basically, each view instance will have its own, unshared collection of writability gates.

Jspresso provides a useful set of gate types, like the binary property gate that open/close based on the value of a boolean property of the view model.

By default, view descriptors are not assigned any gates collection, i.e. there is no writability restriction. Note however that view actual writability is the combination of view and model writability.

cardNameSelector

ICard​Name​Selector

Configures the card determination strategy. This delegate is responsible for selecting the card name key based on the model bound to the view. Everytime the bound model changes, the card name selector is triggered to select a new card. The names returned by the card name selector must match the names under which the cards are registered. Whenever the card name selector returns an unknown name, the card view displays an empty view.

cardViewDescriptors

Map​<​String​,IView​Descriptor​>​

Registers the card views keyed by their name keys. The names used as key of the Map must match the names that are returned by the registered card name selector.

viewDescriptors

List​<​IView​Descriptor​>​

Registers the list of card view descriptors. Every time the bound model changes, this list is iterated until a card with a matching model is found. The first matching card is displayed. Whenever no registered card matches, an empty view is displayed.

action

IDisplayable​Action

Assigns the action to display as a view. The action will typically be rendered as a button in the UI. whenever you want to size the icon used to display the action (and thus the button peer), you might use the preferredWidth / preferredHeight properties.

renderingOptions

ERendering​Options

Indicates how the action should be rendered. This is either a value of the ERenderingOptions enum or its equivalent string representation :

Default value is ERenderingOptions.ICON, i.e. icon only.

autoSelectFirstRow

boolean

Configures the default selection that gets applied when the content of the collection view changes. Whenever set to true, the 1st row will be automatically selected, whereas nothing happens whe set to false.

The default value depends on the selection mode of the collection view. When a cumulative selection mode is used, autoSelectFirstRow defaults to false. It defaults to true otherwise.

itemSelectionAction

IAction

Registers an action that is implicitely triggered everytime the selection changes on the collection view UI peer. The context of the action execution is the same as if the action was registered in the view action map.

modelDescriptor

IModel​Descriptor

{@inheritDoc}

paginationViewDescriptor

IView​Descriptor

Configures a view that will control the pagination (if any) on this collection view. When contructed, the collection view will be decorated with the pagination view. The pagination view will be bound to the same model as the one providing the collection of the collection view.

rowAction

IAction

Registers an action that is implicitely triggered everytime a row is activated (e.g. double-clicked for current UI channels) on the collection view UI peer. The context of the action execution is the same as if the action was registered in the view action map.

selectionMode

ESelection​Mode

Sets the selection mode of the collection view. This is either a value of the ESelectionMode enum or its equivalent string representation :

Default value is ESelectionMode.MULTIPLE_INTERVAL_SELECTION, i.e. any type of selection allowed.

iconImageURLProvider

IIcon​Image​URLProvider

The icon image URL provider is the delegate responsible for inferring a tree node icon based on its underlying model. By default (i.e. when iconImageURLProvider is null), Jspresso will use the underlying component descriptor icon, if any. Using a custom icon image URL provider allows to implement finer rules like using different icons based on the underlying object state. There is a single method to implement to achieve this :

String getIconImageURLForObject(Object userObject);

renderedProperty

String

Configures the model property to be rendered in the list. Whenever this property is left to null (default value), the toStringProperty of the element component descriptor is used.

columnViewDescriptors

List​<​IProperty​View​Descriptor​>​

This property allows for configuring the columns of the table view in a very customizable manner, thus overriding the model descriptor defaults. Each property view descriptor copntained in the list describes a table column that will be rendered in the UI accordingly.

For instance, a writable property can be made specifically read-only on this table view by specifying its column property view descriptor read-only. In that case, the model remains untouched and only the view is impacted.

Following the same scheme, you can assign a list of writability gates on a column to introduce dynamic cell editability on the view without modifying the model.

A last, yet important, example of column view descriptor usage is the role-based column set configuration. Whenever you want a column to be available only for certain user roles (profiles), you can configure a column property view descriptor with a list of granted roles. If the user doesn't have the column(s)required role, the forbidden columns simply won't be displayed. This allows for high authorization-based versatility.

There are many other usages of defining column property view descriptors all of them being linked to customizing the table columns without impacting the model.

horizontallyScrollable

boolean

This property allows to define the table horizontal scrolling behaviour. Whenever it is set to false, the corresponding table UI component will adapt its columns to fit the available horizontal space.

Default value is true, i.e. table columns will have their default size and tha table will scroll horizontally as needed.

renderedProperties

List​<​String​>​

This is somehow a shortcut to using the columnViewDescriptors property. Instead of providing a full-blown list of property view descriptors to configure the table columns, you just pass-in a list of property names. Table columns are then created from this list, keeping model defaults for all column characteristics.

Whenever the property value is null (default), the column list is determined from the collection element component descriptor renderedProperties property.

sortable

boolean

This property allows to define the table horizontal sorting behaviour. Whenever it is set to false, the corresponding table UI component will not allow manual sorting of its rows.

Default value is true, i.e. table allows for its rows to be sorted.

sortingAction

IDisplayable​Action

Configures the action to be activated when a sort is triggered by the user. It should be used with caution and rarely be overriden from the default.

columnCount

int

Configures the number of columns on this component view. Property fields that are to be displayed in the view are spread across columns and rows following their defined order. Whenever a row does not contain enough empty cells to recieve the next field (either because the last column has been reached or the next field has been configured to span multiple columns and there is not enough cells left in the current row to satisfty the span), a new row is created and the next field is added to the first column on the new row.

Note that column count and span are defined in fields coordinates (the field including the property UI component + its label). The underlying grid is actually finer since it has to cope with the labels; but this is internal implementation details and Jspresso takes care of it, without the developer having to cope with labels placements.

Default value is 1, meaning that all rendered fields will be stacked in a single column.

labelsPosition

ELabel​Position

Instructs Jspresso where to place the fields label. This is either a value of the ELabelPosition enum or its equivalent string representation :

Default value is ELabelPosition.ASIDE, i.e. fields label next to the property UI component.

propertyViewDescriptors

List​<​IProperty​View​Descriptor​>​

This property allows for configuring the fields of the component view in a very customizable manner, thus overriding the model descriptor defaults. Each property view descriptor copntained in the list describes a form field that will be rendered in the UI accordingly.

For instance, a writable property can be made specifically read-only on this component view by specifying its property view descriptor read-only. In that case, the model remains untouched and only the view is impacted.

Following the same scheme, you can assign a list of writability gates on a field to introduce dynamic field editability on the view without modifying the model.

A last, yet important, example of column view descriptor usage is the role-based field set configuration. Whenever you want a field to be available only for certain user roles (profiles), you can configure a field property view descriptor with a list of granted roles. If the user doesn't have the field(s)required role, the forbidden field(s) simply won't be displayed. This allows for high authorization-based versatility.

There are many other usages of defining field property view descriptors (like individual labels color and font), all of them being linked to customizing the form fields without impacting the model.

propertyWidths

Map​<​String​,Object​>​

This property allows to simply define property spans in the underlying grid without having to extensively define the propertyViewDescriptors property. It must be configued with a Map containing only the properties that need to span more than 1 column. The other properties will follow the default span of 1.

The Map is :

Default value is null, meaning all property fields have a span of 1.

renderedChildProperties

Map​<​String​,List​>​

Whenever a rendered property is not scalar, this property allows to override which of the referenced component fields should be displayed :

The property must be configured with a Map which is :

A null value (default), means that all non-scalar properties will be rendered using default rendered properties as specified in their referenced model descriptor.

Please note that this is quite unusual to embed non-scalar properties directly in a component view. Although permitted, you won't have as much flexibility in the content layouting as you would have when using composite views; so the latter is by far recommended.

renderedProperties

List​<​String​>​

This is somehow a shortcut to using the propertyViewDescriptors property. Instead of providing a full-blown list of property view descriptors to configure the component view fields, you just pass-in a list of property names. view fields are then created from this list, keeping model defaults for all fields characteristics.

Whenever the property value is null (default), the fields list is determined from the component descriptor renderedProperties property.

action

IAction

Configures the action to be triggered when acting on this property. There are 2 cases :

horizontalAlignment

EHorizontal​Alignment

This property allows to control the property alignment in views that support it. This is either a value of the EHorizontalAlignment enum or its equivalent string representation :

Default value is null, meaning use property type default.

labelBackground

String

When the property has to be labelled (e.g. in a component view), this property defines the background color of the corresponding label. It might differ from the field component one. The color must be defined using its string hexadecimal representation (0xargb encoded).

Default value is null, meaning use UI default.

labelFont

String

When the property has to be labelled (e.g. in a component view), this property defines the font of the corresponding label. It might differ from the field component one. The font must be string encoded using the pattern "[name];[style];[size]" :

Any of the above pattern section can be left empty, thus falling back to the component default.

Default value is null, meaning use default component font.

labelForeground

String

When the property has to be labelled (e.g. in a component view), this property defines the foregroud color of the corresponding label. It might differ from the field component one. The color must be defined using its string hexadecimal representation (0xargb encoded).

Default value is null, meaning use UI default.

renderedChildProperties

List​<​String​>​

Whenever the property decriptor backing the view is not scalar, this property allows to override which of the referenced component fields should be displayed :

The property must be configured with a List containing the property names to render for the child element(s).

A null value (default), means that the non-scalar property will be rendered using default rendered properties as specified in its referenced model descriptor.

Please note that this is quite unusual to embed non-scalar properties directly in a property view. Although permitted, you won't have as much flexibility in the content layouting as you would have when using composite views; so the latter is by far recommended.

sortable

boolean

Configure the sortability of a property view when used to defines a table column for instance. Whenever it is not explicitely set, it falls back to the model property sortability. If no model descriptor is set, defaults to true.

width

Integer

When the property has to be displayed in a grid-like layout (e.g. in a component view), this property defines the umber of grid columns the corresponding UI component will span.

Default value is null, meaning use default span of 1.

allowedValues

Set​<​String​>​

Returns an optional forbidden set of values to restrict the model ones. Only values belonging to the allowed ones should actually be made available as a choice.

forbiddenValues

Set​<​String​>​

Returns an optional forbidden set of values to restrict the model ones. Only values not belonging to the forbidden ones should actually be made available as a choice.

orientation

EOrientation

Configures wether radio values be rendered horizontally or vertically. HORIZONTAL if radio values should be rendered horizontally and VERTICAL otherwise. Default value is VERTICAL.

radio

boolean

Configures the rendering of the enumeration property as radio buttons if supported instead of combobox. Default value is false.

scrollable

boolean

Configures the image view to be either croped or scrollable when the display area is too small to display it. A value of true (default) means that the image view will be made scrollable.

lovAction

IDisplayable​Action

Allows to override the default "List of values" action attached to this reference property view.

A null value (default) keeps the standard action.

childDescriptor

ITree​Level​Descriptor

Configures the first tree level as being a single collection of sibling nodes. For instance, if the child tree level is mapped to a collection (collA) containing 5 elements (collA_Elt-1 to 5), the tree would look like :

 rootItem
   collA_Elt-1
   collA_Elt-2
   collA_Elt-3
   collA_Elt-4
   collA_Elt-5
 

In the example above, you should notice that there is no need for the tree to install an intermediary node to visually group the collection elements since the collection is alone on its level.

This property is only used if the rootSubtreeDescriptor is not explicitely set. In the latter case, nested subtrees are determined from the rootSubtreeDescriptor.

childrenDescriptors

List​<​ITree​Level​Descriptor​>​

Configures the first tree level as being a list of collections of sibling nodes (subtrees). For instance, if the children tree levels are mapped to 2 collection properties (collA, collB) each containing 3 elements (collA_Elt-1 to 3 and collB_Elt-1 to 3), the tree would look like :

 rootItem
   collA
     collA_Elt-1
     collA_Elt-2
     collA_Elt-3
   collB
     collB_Elt-1
     collB_Elt-2
     collB_Elt-3
 

In the example above, you should notice intermediate collection property grouping nodes (collA and collB in italic). They automatically appeared to clearly group the tree nodes belonging to the different collections.

This property is only used if the rootSubtreeDescriptor is not explicitely set. In the latter case, nested subtrees are determined from the rootSubtreeDescriptor.

expanded

boolean

Setting this property to true configures the created tree to appear with its node expanded. A value of false (default) means that the tree nodes are initially collapsed.

iconImageURLProvider

IIcon​Image​URLProvider

The icon image URL provider is the delegate responsible for inferring a tree node icon based on its underlying model. By default (i.e. when iconImageURLProvider is null), Jspresso will use the underlying component descriptor icon, if any. Using a custom icon image URL provider allows to implement finer rules like using different icons based on the underlying object state. There is a single method to implement to achieve this :

String getIconImageURLForObject(Object userObject);

itemSelectionAction

IAction

This property alows to bind an action that gets triggered every time the selection changes on the tree view. The action context passed to the action when it is executed is the same as if it had been registered on the tree view.

maxDepth

int

This property is used only when the tree (or sub-tree) is declared recursively, i.e. a tree level belongs to its own children hierarchy. Default value is 10, meaning that a maximum number of 10 levels can be nested.

renderedProperty

String

This property allows to define the model property used to label the root node.

This property is only used if the rootSubtreeDescriptor is not explicitely set. In the latter case, renderedProperty is determined from the rootSubtreeDescriptor.

rootSubtreeDescriptor

ITree​Level​Descriptor

This property allows to explicitely define the tree root level as any other level. Most of the time, you will prefer using the following shortcut properties :

Whenever rootSubtreeDescriptor is explicitely set, the properties above are simply ignored since all values are determined from rootSubtreeDescriptor.

rowAction

IAction

Registers an action that is implicitely triggered everytime a row is activated (e.g. double-clicked for current UI channels) on the collection view UI peer. The context of the action execution is the same as if the action was registered in the view action map.

grantedRoles

Collection​<​String​>​

Assigns the roles that are authorized to use this subtree. It supports "!" prefix to negate the role(s). Whenever the user is not granted sufficient privileges, the subtree is simply hidden. Setting the collection of granted roles to null (default value) disables role based authorization on the node group level. The framework then checks for the model roles authorizations and will apply the same restrictions. If both view and model granted roles collections are null, then access is granted to anyone.

nodeGroupDescriptor

IList​View​Descriptor

Describes the collection of sibling nodes (node group) as a if it were a list view. This is how you instruct Jspresso the type of the components that are used as model behind the tree nodes and which model property is used to compute the node labels. Most of the other properties defined on the node group descriptor itself are ignored (font, color, selection action, ...) since a tree group is not a "real" view but just a mean of defining a subtree. All these properties that are ignored on the tree group can be defined on the tree view itself.

permId

String

Sets the permanent identifier to this application element. Permanent identifiers are used by different framework parts, like dynamic security or record/replay controllers to uniquely identify an application element. Permanent identifiers are generated by the SJS build based on the element id but must be explicitely set if Spring XML is used.

childrenDescriptors

List​<​ITree​Level​Descriptor​>​

Assigns the list children tree level descriptors. A null value (default) makes this tree level a leaf tree level and is strictly equivalent to declaring a BasicTreeLevelDescriptor instead.

childDescriptor

ITree​Level​Descriptor

Assigns the single child tree level descriptor. A null value (default) makes this tree level a leaf tree level and is strictly equivalent to declaring a BasicTreeLevelDescriptor instead.