Caption box
Contains a single view and gives you more options to position the view's label.
Appearance
| Width: | Width of the view (%, px) | String |
| Label placement: | Label placement {Top | Left | Bottom | Right} |
CaptionPlacement |
| Label width: | The width of the label in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed. | String |
| Label horizontal alignment: | Horizontal alignment to be used (left, center, right) {Left | Center | Right} |
TooltipHorizontalAlignment |
| Label vertical alignment: | Vertical alignment to be used (Top, Middle, Bottom) {Top | Middle | Bottom} |
VerticalAlignment |
| Shrink to content: | Boolean |
|
| Color style: | Button color {Default | Normal | Muted | Light-gray | Primary | Info | Success | Warning | Danger} |
ParagraphColorStyle |
| Label size: | The size of the label. {Default | Super-Large | Extra-Large | Larger | Large | Small | Smaller} |
OutputTextSizeStyle |
| Label weight style: | The weight of the label text. {Default | Slim | Normal | Semi-bold | Bold} |
OutputTextWeightStyle |
Formula
| Label formula: | The formula or expression to calculate the caption value. | String |
| Events | ||||||
| On Load: |
| |||||
| Articles | ||||||
| ||||||
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"); |
Inherited
getData()
Returns:
{Object}
Retrieve the bound data associated with the view. It applies only to views with bound data.
Example
| var dec1 = MyDecimal.getData(); |
getLabel()
Returns:
{string}
Get label associated with control
getLabelColorStyle()
Returns:
{string}
Gets color style of label/caption
getLabelPlacement()
Returns:
{string}
Get label/caption placement for the control
getLabelSizeStyle()
Returns:
{string}
Gets color style of label/caption
getLabelWeightStyle()
Returns:
{string}
Gets color style of label/caption
getLabelWidth()
Returns:
{string}
Get label width of CaptionBox control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
getType()
Returns:
{string}
Get descriptive string representing the type of control
getWidth()
Returns:
{string}
Get configured width for text control (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(); |
isLabelVisible()
Returns:
{boolean}
Get label visibility for the caption box control
Inherited
isValid()
Returns:
{boolean}
Return the valid status as last set by the setValid() method.
Example
| var valid = MyView.isValid(); |
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); |
Inherited
recalculate()
Applicable only to formula-enabled views!
Triggers the re-evaluation of the formula
for the view, if a formula was specified. If the view is not formula-enabled,
Triggers the re-evaluation of the formula
for the view, if a formula was specified. If the view is not formula-enabled,
recalculate() does nothing.Example
| Text1.recalculate();
//If the formula for Text1 is: new Date().toString(), Text1 is updated to the current date/time |
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 |
setLabel(label)
Set label for control
| Name | Type | Default | Description |
| label | {string} | label text for the control |
setLabelColorStyle(style)
Sets color style of label/caption
| Name | Type | Default | Description |
| style | {string} | "D"=Default | "M"=Muted | "L"=Light-gray | "P"=Primary | "I"=Info | "S"=Success | "W"=Warning | "G"=Danger |
setLabelHorizontalAlignment()
Returns:
{string}
Set the horizontal alignment for the label/caption
setLabelPlacement(placement)
Set label placement for caption box
| Name | Type | Default | Description |
| placement | {string} | "T","TOP"=Top | "L","LEFT"=Left | "B","BOTTOM"=Bottom | "R","RIGHT"=Right |
setLabelSizeStyle(style)
Sets color style of label/caption
| Name | Type | Default | Description |
| style | {string} | "R","SUPER"=Super large | "X","EXTRA-LARGE"=Extra large | "G","LARGER"=Larger | "L","LARGE"=Large | "S","SMALL"=Small | "M","SMALLER"=Smaller | "D","DEFAULT"=Default |
setLabelVerticalAlignment()
Returns:
{string}
Set the veritical alignment for the label/caption
setLabelVisible(flag)
Set label visibility for caption box control
| Name | Type | Default | Description |
| flag | {boolean} | true | false |
setLabelWeightStyle(style)
Sets color style of label/caption
| Name | Type | Default | Description |
| style | {string} | "D"=Default | "N"=Normal | "S"=Slim | "M"=Semi-bold | "B"=Bold |
setLabelWidth(labelWidth)
Set label width of CaptionBox control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
| Name | Type | Default | Description |
| labelWidth | {string} | Control's label width |
Inherited
setValid(valid, errorText)
Flag the view as valid or invalid.
| Name | Type | Default | Description |
| valid | {boolean} | Valid/invalid flag (true to set view valid, false to make it invalid - which typically shows the view with "invalid" styling and indicator) | |
| errorText | {string} | Validation error text to show on the invalid-styled view |
Example
| MyView.setValid(false, "Fix your data entry"); //Make MyView invalid |
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 text control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
| Name | Type | Default | Description |
| width | {string} | width of the input group |
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(); |