Vertical layout
Creates a section inside which you can stack views vertically, on top of one another. When the view is bound to a list, the vertical section repeats for each item in the list, which results in a format that is similar to a table.
Appearance
| Layout flow: | Layout of the child views. Note\: Do not use Justified when the layout is Inline Scroll or Auto-Wrap. Combining these options may result in unexpected layout behavior. {Vertical | Vertical Tight | Horizontal | Horizontal Inline Scroll | Horizontal Tight | Horizontal Auto-wrap} |
LayoutFlow |
| Horizontal alignment: | Horizontal alignment of child views. Note\: Do not use Justified when the layout is Inline Scroll or Auto-Wrap. Combining these options may result in unexpected layout behavior. {Justified | Left | Center | Right} |
HorizontalAlignment |
| Vertical alignment: | Controls the vertical alignment of the elements displayed in the layout. Only applies to horizontal layout flows. {Top | Middle | Bottom} |
VerticalAlignment |
| Width: | The width in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed. | String |
| Height: | Height in px, %, em\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed | String |
Behavior
| Start empty: | The layout is initially empty. The layout will be populated with repeating content sections when the binding is dynamically updated. | Boolean |
Performance
| Async loading: | Provides a better UI experience for large data sets (at the expense of slower overall row-loading time once the section starts loading). Used only if this section is bound to a list. | Boolean |
| Async batch size: | The number of rows that are loaded synchronously in an asynchronous batch. This can help optimize synchronous vs. asynchronous loading performance. Used only if this section is bound to a list. | Integer |
Responsive
| Responsive sensor: | (Optional) Id of the Responsive Sensor view containing this Layout. If ommitted, the nearest sensor in the parent chain is used. | String |
| Behaviors: | The how the section should behave based on box factors defined in a responsive sensor. | ResponsiveBehavior[] |
| Events | ||
| On Load: | | Javascript expression |
| On Responsive Update: | string | |
Extends:
Methods:
Inherited
addClass(name, [replaced])
Add or replace the CSS classes for this view.
| Name | Type | Default | Description |
| name | {string} | The CSS class names to add to the view. For multiple classes, use space to separate the class names. | |
| replaced | {string} | The CSS class names to be replaced by the first argument. For multiple classes, use space to separate the class names. |
Example
| Button.addClass("green"); |
appendElement(obj The)
Adds the specified layout element (created by createListElement) to the table
| Name | Type | Default | Description |
| obj The | {object} | layout element to be added |
getActiveBoxFactor()
Returns "Behaviors" attributes, the vertical layout must be nested within Responsive Sensor control in order for it to work, and set the responsive sensor in the vertical layout.
getHeight()
Returns:
{string}
Get configured height for section (including unit)
getHelpText()
Returns:
{string}
Get help text for section
getType()
Returns:
{string}
Get descriptive string representing the type of control
getWidth()
Returns:
{string}
Get configured width for section (including unit)
Inherited
hide(collapseFlag)
Hide the view.
| Name | Type | Default | Description |
| collapseFlag | {boolean} | Set to true to collapse the view (equivalent to a view setting of "NONE") |
Example
| MyView.hide(); |
Inherited
isBound()
Returns:
{boolean}
Indicate the bound status of the view.
Inherited
isEnabled()
Returns:
{boolean}
Check whether the view is enabled.
Example
| var enabled = MyView.isEnabled(); |
Inherited
isLabelVisible()
Returns:
{boolean}
Check whether the view label is visible.
Example
| var labelVisible = MyView.isLabelVisible(); |
Inherited
isVisible()
Returns:
{boolean}
Check whether the view is visible.
Example
| var visible = MyView.isVisible(); |
Inherited
propagateUpValueChange(event)
Returns:
{boolean}
Propagate the value change of the view up through the parent views.
| Name | Type | Default | Description |
| event | {Event} | Value change event (usually an onchange event) |
Example
| MyView.propagateUp(event); |
removeElement(index)
Remove the specified layout element
| Name | Type | Default | Description |
| index | {integer} | The index of the layout element to be removed |
Inherited
setEnabled(enabled, required)
Enable or disable the view.
| Name | Type | Default | Description |
| enabled | {boolean} | Enabled/read-only flag (true to enable view, false to disable/make read-only) | |
| required | {boolean} | Enable or disable the required field flag for the view. |
Example
| MyView.setEnabled(false); //Make MyView read-only |
setHeight(height)
Set height of section (e.g. 50px, 20%, 2em - omitting the unit assumes px)
| Name | Type | Default | Description |
| height | {string} | sets the height of the section |
setHelpText(text)
Set help text for section
| Name | Type | Default | Description |
| text | {string} | sets the help text for the section |
Inherited
setLabelVisible(visible)
Show or hide the view label.
| Name | Type | Default | Description |
| visible | {boolean} | Label visibility flag (true to show view label, false to hide) |
Example
| MyView.setLabelVisible(false); |
setSelected(obj, flag)
Sets whether or not an object is selected
| Name | Type | Default | Description |
| obj | {object} | Object to modify selection of | |
| flag | {boolean} | Set whether object is selected or not {true | false} |
Inherited
setViewData(data, createPseudoBinding)
Set or update the bound data associated with the view. It applies only to views with bound data.
Note: It should only be used with simple type bindings, or complex type bindings with simple type properties.
It should not be used with bindings that have properties that are lists or compext types. For complex types, set the bindings by using
the
Note: It should only be used with simple type bindings, or complex type bindings with simple type properties.
It should not be used with bindings that have properties that are lists or compext types. For complex types, set the bindings by using
the
binding.set pattern, as described in the Binding data and configuration options documentation section.| Name | Type | Default | Description |
| data | {Object} | The value of the bound data. The parameter type must match the type of the bound data. | |
| createPseudoBinding | {boolean} | If the value is set to true, the parameter creates a pseudo binding if there is no current binding. |
Example
| MyView.setViewData("TEST"); //Updates bound data to the string 'TEST' |
Inherited
setVisible(visible, collapse)
Show or hide the view.
| Name | Type | Default | Description |
| visible | {boolean} | Visibility flag (true to show the view, false to hide it) | |
| collapse | {boolean} | Set it to true to collapse the view space when the option visible is set to false. |
Examples
| MyView.setVisible(false, false); //Equivalent to MyView.hide() |
| MyView.setVisible(false, true); // Sets visibility to "None" |
setWidth(width)
Set width of section (e.g. 50px, 20%, 2em - omitting the unit assumes px)
| Name | Type | Default | Description |
| width | {string} | sets the width of the section |
Inherited
show()
Show this view.
Example
| MyView.show(); |
Inherited
triggerFormulaUpdates([phase])
Broadcast the expression trigger for the specified view.
| Name | Type | Default | Description |
| phase | {int} | bpmext.ui.PHASE_NORMAL | The phase we are currently in |
Example
| MyView.triggerFormulaUpdates(); |