Class: Switch

Switch

The Switch control allows the display of a binary value (similar to a checkbox) using an On/Off visual switch widget. A Switch control provides the following configuration properties in Process Designer:

Appearance

Color Style: Color-based styling for this control
{Default | Primary | Info | Success | Warning | Danger}
string
Shape Style: Shape styling for this control
{Default | Square | Modern}
string
Size Style: Set size style for this control
{Default | Large | Small}
string
Label Type: Determine whether switch labels will be icons or text
{Text | Icon}
string
On Label: Label to use in "on" position. Note: If using icons for labels, check http://fontawesome.io/icons for a comprehensive list of icon keywords. (The "fa-" prefix is optional) string
Off Label: Label to use in "off" position. Note: If using icons for labels, check http://fontawesome.io/icons for a comprehensive list of icon keywords. (The "fa-" prefix is optional) string

Events

On Load:
Description: Triggers whenever the view is loaded.
Example:
me.setChecked(${Checkbox}.isChecked())
On Change:
Description: Triggers when the switch is changed.
Example:
${Section2}.setVisible(me.isChecked())
Article(s)
Switch

new Switch()

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");

click()

Programmatically click this switch

getColorStyle(){string}

Gets color style of the control. NOTE: This always returns the color as set, to avoid ambiguity always set the color using "D"|"P"|"I"|"S"|"W"|"G"
Returns:
Type Description
string

getShapeStyle(){string}

Gets shape style of the control. NOTE: This always returns the shape style as set, to avoid ambiguity always set the size style using "D"|"S"|"M"
Returns:
Type Description
string

getSizeStyle(){string}

Gets size style of control. NOTE: This always returns the size style as set, to avoid ambiguity always set the size style using "D"|"S"|"L"
Returns:
Type Description
string

getType(){string}

Get descriptive string representing the type of control
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.

isChecked(){boolean}

Get checked state for switch control
Returns:
Type Description
boolean
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();
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);

setChecked(checked)

Set checked state for switch control
Name Type Description
checked boolean {true | false}

setColorStyle(style)

Sets color style of the control. NOTE: to avoid ambiguity always set the color using "D"|P"|"I"|"S"|"W"|"G"
Name Type Description
style string "DEFAULT"|"DEF"|"D"=Default | PRIMARY"|"P"=Primary | "INFO"|INF"|"I"=Info | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "ERROR"|"ERR"|"DANGER"|"G"=Danger
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
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);

setShapeStyle(style)

Sets shape style of the control. NOTE: to avoid ambiguity always set the size style using "D"|"S"|"M"
Name Type Description
style string "DEFAULT"|"DEF"|D"=Default | "Modern"|"M"=Modern | "SQUARE"|"S"=Square

setSizeStyle(style)

Sets size style of control. NOTE: to avoid ambiguity always set the size style using "D"|"S"|"L"
Name Type Description
style string "DEFAULT"|"DEF"|"NORMAL"|"D"=Default | "SMALL"|"S"=Small | "LARGE"|"L"=Large
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"
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();