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 :

• each action list is contained in its own toolbar section which is visually separated from the other sections. This allows for visually grouping related actions as they are grouped in the action lists.
• each action contained in an action list is represented by a toolbar button using the action image as icon and translated action description as toolTip.

borderType

EBorder​Type

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

• NONE for no border
• SIMPLE for a line border
• TITLED for a titled border. The view is then labeled with its translated name and and icon. Whenever the view name has not been explicitly set, the model name is used is used.
• TITLED_ACTIONS like TITLED but with the action map next to it if the UI channel supports it

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

collapsible

boolean

Configures wether the UI frontend is alowed to collapse this view. Some UI frontends allow the user to collapse views when they are surrounded by a titled border. This is true by default. if set to false, the view will not collapse.

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.

modelDescriptor

IModel​Descriptor

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

• configuration of the view content. For instance whenever a form is assigned a component model descriptor, it will install 1 field per component rendering properties, unless otherwise specified in the view descriptor itself.
• configuration of the binding layer. There is no need for the developer to configure anything for the binding to occur between the view and the model. Based on their model descriptor, Jspresso will setup all the necessary plumbing to efficiently synchronize model properties with their view counterpart bi-directionally. This synchronization occurs implicitly using the observer pattern and one of the Jspresso key contract is to guarantee this synchronization seamlessly.

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.

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 mechanism 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. Every time 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. The card name selector can optionally implement ICardProvider in which case, it will be given a chance to create cards dynamically based on their names.

forClientTypes

List​<​String​>​

Sets for client types.

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.

forClientTypes

List​<​String​>​

Sets for client types.

accessorFactory

IAccessor​Factory

Sets accessor factory.

propertyName

String

Sets the model property name used to determine the card name.

forClientTypes

List​<​String​>​

Sets for client types.

labelFont

String

This property defines the font of the property labels. It might differ from the field component one. The font must be string encoded using the pattern "[name];[style];[size]" :

• [name] is the name of the font, e.g. arial.
• [style] is PLAIN, BOLD, ITALIC or a union of BOLD and ITALIC combined with the '|' character, e.g. BOLD|ITALIC.
• [size] is the size of the font, e.g. 10.

This property can be overridden on a field basis using an explicit property view definition.

Default value is null, meaning use default component font.

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 contained 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.

valueFont

String

This property defines the font of the property values. The font must be string encoded using the pattern "[name];[style];[size]" :

• [name] is the name of the font, e.g. arial.
• [style] is PLAIN, BOLD, ITALIC or a union of BOLD and ITALIC combined with the '|' character, e.g. BOLD|ITALIC.
• [size] is the size of the font, e.g. 10.

This property can be overridden on a field basis using an explicit property view definition.

Default value is null, meaning use default component font.

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 receive 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 satisfy 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.

labelsHorizontalPosition

EHorizontal​Position

Configures the label horizontal position. There are special cases when the default label position has to be overridden. This is either a value of the EHorizontalPosition enum or its equivalent string representation :

• LEFT for left position
• RIGHT for right position

Default value is LEFT.

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 :

• as columns when the rendered property is a collection property
• as fields when the rendered property is a reference property

• keyed by the non-scalar property name
• valued by the list of the property names to render for the child element(s)

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.

widthResizeable

boolean

This property allows to define the form horizontal fill behaviour. Whenever it is set to true, the corresponding UI component will fill all its available horizontal space.

Default value is true.

excludedReadingProperties

List​<​String​>​

Sets filtered reading properties. Allows to configure the properties that will be excluded from the read-only page.

forClientTypes

List​<​String​>​

Sets for client types.

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 explicitly set. In the latter case, nested subtrees are determined from the rootSubtreeDescriptor.

displayIcon

boolean

Configures if the tree view should show icon based on the icon image url provider. Defaults to true.

itemSelectionAction

IAction

This property allows 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.

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 explicitly set. In the latter case, renderedProperty is determined from the rootSubtreeDescriptor.

rowAction

IAction

Registers an action that is implicitly triggered every time 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.

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.

forClientTypes

List​<​String​>​

Sets for client types.

showArrow

boolean

Sets show arrow.

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 :

• LABEL_ICON for label and icon
• LABEL for label only
• ICON for icon only.

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

forClientTypes

List​<​String​>​

Sets for client types.

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 when 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.

modelDescriptor

IModel​Descriptor

{@inheritDoc}

rowAction

IAction

Registers an action that is implicitly triggered every time 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.

selectionModelDescriptor

IModel​Descriptor

Sets the selectionModelDescriptor.

displayIcon

boolean

Configures if the list view should show icon based on the icon image url provider. Defaults to true.

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.

autoSelectFirstRow

boolean

Not supported in mobile environment.

{@inheritDoc}

position

EPosition

Sets position.

repeatedViewDescriptor

IView​Descriptor

Configures the view to be repeated as many times as necessary to match the element count in the model collection.

autoSelectFirstRow

boolean

Not supported in mobile environment.

{@inheritDoc}

position

EPosition

Sets position.

columnReorderingAllowed

boolean

Configures if the table view should allow for column reordering. The default value is true.

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.

singleClickEdit

boolean

Configures the table view to enter edition on single clicks instead of double clicks.

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 overridden from the default.

defaultZoom

Integer

Sets default zoom to display when there is no route and a single marker.

markerAction

IDisplayable​Action

Sets marker action.

zoneAction

IDisplayable​Action

Sets zone action.

forClientTypes

List​<​String​>​

Sets for client types.

position

EPosition

Sets position.

action

IAction

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

1. If the property is read-only, then assigning an action turns the property into a clickable hyperlink
2. If the property is read-write, the registered action will be triggered when the user changes the value of the field. Note that in that case, the action is executed after the model has been updated. However the old property value can be retrieved from the context action param.

focusLostAction

IAction

Sets focus lost action.

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 :

• LEFT for left alignment
• CENTER for center alignment
• RIGHT for right alignment

Default value is null, meaning use property type 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]" :

• [name] is the name of the font, e.g. arial.
• [style] is PLAIN, BOLD, ITALIC or a union of BOLD and ITALIC combined with the '|' character, e.g. BOLD|ITALIC.
• [size] is the size of the font, e.g. 10.

Default value is null, meaning use default component font.

labelHorizontalPosition

EHorizontal​Position

Configures the label horizontal position. There are special cases when the default label position has to be overridden. This is either a value of the EHorizontalPosition enum or its equivalent string representation :

• LEFT for left position
• RIGHT for right position

Default value is LEFT.

sortable

boolean

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

formatPattern

String

Sets format pattern. Allows to override the default one.

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.

enumIconHeight

int

Sets the enumeration icon height.

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.

radio

boolean

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

editorConfiguration

String

Sets editor configuration.

verticallyScrollable

boolean

Configures the view to be either vertically cropped or scrollable when the display area is too small to display it.

drawable

boolean

Configures whether this image view can be modified by the user drawing in the screen, e.g. a POD signature. Defaults to false.

scaledHeight

Integer

Sets scaled height. This property, when set to a positive integer will force the image height to be resized to the target value. If only one of the 2 scaled dimensions is set, then the image is scaled by preserving its aspect ratio.

scrollable

boolean

Configures the image view to be either cropped 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.

nestedComponentViewDescriptor

IComponent​View​Descriptor

Sets nested component view descriptor.

formatPattern

String

Sets format pattern. Allows to override the default one.

i18nTextKey

String

Configures the key to be used for getting the translated static text.

readOnly

Boolean

Sets read only.

characterAction

IDisplayable​Action

Configures an action that gets triggered every time the text is changed in the field.

autoCompleteEnabled

boolean

Sets auto complete enabled. I set to false, then the field will always be read-only whereas the LOV action button will follow enabled / disabled rules.

formatPattern

String

Sets format pattern. Allows to override the default one.

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.

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 explicitly 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.

cascadingModels

boolean

Enables the model "cascading" behaviour. This allows for instance to link 2 nested tables where the 2nd table model is the selected row of the first table (or null if selection is empty). Using cascadingModel=true is only necessary when tracking view selection on the master nested view. You don't need it if, for instance, the master nested view is a single model view like a component view. In the latter case, you can bind a table detail view just by adding it to the same composite without having to set cascadingModel=true.

Default value is false, i.e. al nested views share the same model than the outer composite unless explicitly specified differently.

verticallyScrollable

boolean

This property allows to define the form vertical scrolling behaviour. Whenever it is set to true, the corresponding UI component will install a vertical scroll bar when the available vertical space is not enough.

Default value is false.

backAction

IDisplayable​Action

Sets back action.

forClientTypes

List​<​String​>​

Sets for client types.

i18nHeader

String

Sets i 18 n header.

mainAction

IDisplayable​Action

Sets main action.

position

EPosition

Sets position.

swipeRightAction

IDisplayable​Action

Sets swipe right action.

cascadingModels

boolean

Sets cascading models. This operation is not supported on mobile pages.

cascadingModels

boolean

Sets cascading models. This operation is not supported on mobile pages.

inlineEditing

boolean

Sets inline editing.

cascadingModels

boolean

Sets cascading models. This operation is not supported on mobile lists.

nextPageViewDescriptor

IMobile​Page​View​Descriptor

Sets next page.

centerViewDescriptor

IView​Descriptor

Sets the child view to layout in the center zone. The child view will be resized both horizontally and vertically.

northViewDescriptor

IView​Descriptor

Sets the child view to layout in the north zone. The child view will be resized horizontally.

westViewDescriptor

IView​Descriptor

Sets the child view to layout in the west zone. The child view will be resized vertically.

backAction

IDisplayable​Action

Sets back action.

enterAction

IDisplayable​Action

Sets enter action.

i18nHeader

String

Sets i 18 n header.

pageEndAction

IDisplayable​Action

Sets page end action.

swipeLeftAction

IDisplayable​Action

Sets swipe left action.

westViewDescriptor

IView​Descriptor

Not supported in mobile environment.

{@inheritDoc}

cells

Map​<​IView​Descriptor​,Cell​Constraints​>​

Registers the nested children views along with their cell constraints. They are set as a Map that is :

• keyed by the children views
• valued by the cell constraints to apply to each nested view

cells

List​<​IView​Descriptor​>​

Registers the nested views to display as grid cells.

drivingDimensionCellCount

int

This property configures the maximum number of cells in the driving dimension (row or column). Nested views are distributed along the driving axis until this maximum number has been reached. A new row or column is then created to host the remaining cells.

backAction

IDisplayable​Action

Sets back action.

drivingDimensionCellCount

int

Not supported in mobile environment.

{@inheritDoc}

forClientTypes

List​<​String​>​

Sets for client types.

mainAction

IDisplayable​Action

Sets main action.

position

EPosition

Sets position.

swipeRightAction

IDisplayable​Action

Sets swipe right action.

leftTopViewDescriptor

IView​Descriptor

Sets the left (horizontal split) of top (vertical split) nested view.

rightBottomViewDescriptor

IView​Descriptor

Sets the right (horizontal split) of bottom (vertical split) nested view.

lazy

boolean

When set to true, this parameter configures the tabs to be lazy bound (binding occurs only for the selected tab). This feature is only supported for tab views with cascadingModel set to false. default value is true.

selectFirstTab

boolean

If true, the tab view will select its the first tab each time its model changes. Default value is {@false}.

tabs

List​<​IView​Descriptor​>​

Registers the list of views to be displayed as tabs. The tabs order follows the children views order of this list.

carouselMode

boolean

Sets carousel mode.

forClientTypes

List​<​String​>​

Sets for client types.