Switch

Displays a binary value (similar to a check box) using an On or Off visual switch widget.

Appearance

Color style: Color-based styling for this view
{Default | Primary | Info | Success | Warning | Danger} TooltipColorStyle

Shape style: The shape of the view.
{Default | Square | Modern} SwitchShapeStyle

Size: Set size for this view
{Default | Large | Small} SwitchSizeStyle

Label type: Determine whether switch labels will be icons or text
{Text | Icon} SwitchLabelType

On label: The label for the "on" position. Note: To use icons for labels, see http://fontawesome.io/icons for a list of icon keywords. (The "fa-" prefix is optional) String

Off label: The label for the "off" position. Note: To use icons for labels, see http://fontawesome.io/icons for a 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())

Extends:

com.ibm.bpm.coach.CoachView

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

click()

Programmatically click this switch

getColorStyle() Returns: {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"

getOffLabel() Returns: {string}

Gets the label for the OFF state of the switch

getOnLabel() Returns: {string}

Gets the label for the ON state of the switch

getShapeStyle() Returns: {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"

getSizeStyle() Returns: {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"

getType() Returns: {string}

Get descriptive string representing the type of control

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.

isChecked() Returns: {boolean}

Get checked state for switch control

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

setChecked(checked)

Set checked state for switch control

Name Type Default 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 Default 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

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

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

setOffLabel(null)

Sets the label when the switch is in OFF state

Name Type Default Description

{string} label

setOnLabel(null)

Sets the label when the switch is in ON state

Name Type Default Description

{string} label

setShapeStyle(style)

Sets shape style of the control. NOTE: to avoid ambiguity always set the size style using "D"|"S"|"M"

Name Type Default 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 Default Description

style {string} "DEFAULT"|"DEF"|"NORMAL"|"D"=Default | "SMALL"|"S"=Small | "LARGE"|"L"=Large

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

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

Methods

Parent

Helpers