Class: CaptionBox

CaptionBox

The caption box is a container control which alllows more label placement options than other containers.  NOTE: Caption box can only contain a single control. A CaptionBox control provides the following configuration properties in Process Designer:

Formula

Label Formula: Formula/expression to use for calculating caption value string

Appearance

Width: Width of the control (%, px) string
Label Placement: Label placement (top, left, bottom, right)
{Top | Left | Bottom | Right}
string
Label Horizontal Alignment: Horizontal alignment to be used (left, center, right)
{Left | Center | Right}
string
Label Vertical Alignment: Vertical alignment to be used (Top, Middle, Bottom)
{Top | Middle | Bottom}
string
Shrink to Content: boolean
Color Style: Button color
{Default | Normal | Muted | Light-gray | Primary | Info | Success | Warning | Danger}
string
Label Size Style: Label Size Style to be used (Default, Super-Large, Extra-Large, Larger, Large, Small, Smaller)
{Default | Super-Large | Extra-Large | Larger | Large | Small | Smaller}
string
Label Weight Style: Label Weight Style to be used (Default, Slim, Normal, Semi-Bold, and Bold)
{Default | Slim | Normal | Semi-bold | Bold}
string

Events

On Load:
Description: Triggers whenever the view is loaded.
Example:
console.log("Button loaded")
Articles

new CaptionBox()

This constructor is never used explicitly.

Extends

Members

Methods

Add/replace CSS class(es) for this control
Name Type 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 optional 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");
Retrieve bound data associated this view/control. Only works for views/controls with bound data.
Returns:
Type Description
Object Value of bound data. undefined if the view has no data binding.
Example
var dec1 = MyDecimal.getData();

getLabel(){string}

Get label associated with control
Returns:
Type Description
string

getLabelColorStyle(){string}

Gets color style of label/caption
Returns:
Type Description
string "D"=Default | "M"=Muted | "L"=Light-gray | "P"=Primary | "I"=Info | "S"=Success | "W"=Warning | "G"=Danger

getLabelPlacement(){string}

Get label/caption placement for the control
Returns:
Type Description
string {"T"=Top | "L"=Left}

getLabelSizeStyle(){string}

Gets color style of label/caption
Returns:
Type Description
string "R"=Super large | "X"=Extra large | "G"=Larger | "L"=Large | "S"=Small | "M"=Smaller | "D"=Default

getLabelWeightStyle(){string}

Gets color style of label/caption
Returns:
Type Description
string "D"=Default | "N"=Normal | "S"=Slim | "M"=Semi-bold | "B"=Bold

getType(){string}

Get descriptive string representing the type of control
Returns:
Type Description
string

getWidth(){string}

Get configured width for text control (including unit)
Returns:
Type Description
string
Hide this view/control
Name Type Description
collapseFlag boolean Set to true to collapse the view (equivalent to a view setting of "NONE")
Example
MyView.hide();
Indicates bound status of control.
Returns:
Type Description
boolean True if the control is bound to coach data.
Checks if the view is enabled or not
Returns:
Type Description
boolean Enabled status
Example
var enabled = MyView.isEnabled();
Checks if control label is visible
Returns:
Type Description
boolean Label visibility status
Example
var labelVisible = MyView.isLabelVisible();
Returns the valid status as last set by the setValid() method.
Returns:
Type Description
boolean Validity status. true if setValid(false, ...) was never called
Example
var valid = MyView.isValid();
Checks whether or not view is visible
Returns:
Type Description
boolean Visibility status
Example
var visible = MyView.isVisible();
Propagates value change of control up through parent views
Name Type Description
event Event Value change event (usually an onchange event)
Returns:
Type Description
boolean True if a formula update was triggered on the control's parent, otherwise false
Example
MyView.propagateUp(event);
Only for formula-enabled views!
Explicitly triggers the re-evaluation of the formula for this view (if a formula has been 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
Set/update bound data associated this view/control. Only works for views/controls with bound data.
Name Type Description
value Object Value of bound data. The type of this parameter must match the type of the bound data.
Example
MyView.setData("TEST"); //Updates bound data to the string 'TEST'
Enable/disable this view/control
Name Type 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

setLabel(label)

Set label for control
Name Type Description
label string label text for the control

setLabelColorStyle(style)

Sets color style of label/caption
Name Type Description
style string "D"=Default | "M"=Muted | "L"=Light-gray | "P"=Primary | "I"=Info | "S"=Success | "W"=Warning | "G"=Danger

setLabelHorizontalAlignment(){string}

Set the horizontal alignment for the label/caption
Returns:
Type Description
string {"T"=Top | "C"=Center | "L"=Left}

setLabelPlacement(placement)

Set label placement for caption box
Name Type 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 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(){string}

Set the veritical alignment for the label/caption
Returns:
Type Description
string {"T"=Top | "M"=Middle | "B"=Left}
Show/hide the label of this view/control
Name Type Description
visible boolean Label visibility flag (true to show view label, false to hide)
Example
MyView.setLabelVisible(false);

setLabelWeightStyle(style)

Sets color style of label/caption
Name Type Description
style string "D"=Default | "N"=Normal | "S"=Slim | "M"=Semi-bold | "B"=Bold
Flag this view/control as valid or invalid
Name Type 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, "Please fix your data entry"); //Make MyView invalid
Show/hide this view/control
Name Type 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 text control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
width string width of the input group
Show this view/control
Example
MyView.show();
Broadcasts the expression trigger for the specified view
Name Type Default Description
phase int bpmext.ui.PHASE_NORMAL optional The phase we are currently in
Example
MyView.triggerFormulaUpdates();