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/replace CSS class(es) for this control
Name | Type | Default | Description |
name | {string} | CSS class name(s) to add to the control. Separate class names by a space if more than one class. | |
replaced | {string} | CSS class name(s) to be replaced by the first argument. Separate class names by a space if more than one class. |
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 this view/control
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}
Indicates bound status of control.
Inherited
isEnabled()
Returns:
{boolean}
Checks if the view is enabled or not
Example
var enabled = MyView.isEnabled(); |
Inherited
isLabelVisible()
Returns:
{boolean}
Checks if control label is visible
Example
var labelVisible = MyView.isLabelVisible(); |
Inherited
isVisible()
Returns:
{boolean}
Checks whether or not view is visible
Example
var visible = MyView.isVisible(); |
Inherited
propagateUpValueChange(event)
Returns:
{boolean}
Propagates value change of control up through 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/disable this view/control
Name | Type | Default | Description |
enabled | {boolean} | Enabled/read-only flag (true to enable view, false to disable/make read-only) | |
required | {boolean} | Enable/disable required field flag for control |
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/hide the label of this view/control
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/update bound data associated this view/control. Only works for views/controls with bound data.
Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the
Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the
binding.set
pattern detailed in the Knowlege Center section Binding Data and Configuration OptionsName | Type | Default | Description |
data | {Object} | Value of bound data. The type of this parameter must match the type of the bound data. | |
createPseudoBinding | {boolean} | If set to true, 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/hide this view/control
Name | Type | Default | Description |
visible | {boolean} | Visibility flag (true to show view, false to hide) | |
collapse | {boolean} | Set to true to collapse the control space when 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/control
Example
MyView.show(); |
Inherited
triggerFormulaUpdates([phase])
Broadcasts 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(); |