Methods

addClass
click
getColorStyle
getShapeStyle
getSizeStyle
getType
hide
isBound
isChecked
isEnabled
isLabelVisible
isVisible
propagateUpValueChange
setChecked
setColorStyle
setEnabled
setLabelVisible
setShapeStyle
setSizeStyle
setViewData
setVisible
show
triggerFormulaUpdates

Parent

CoachView

Helpers

bpmext.log
bpmext.number
bpmext.text
bpmext.ui
bpmext.ui.View
bpmext.ui.util
Switch
Appearance
Color style: Color-based styling for this view
{Default | Primary | Info | Success | Warning | Danger}		 ButtonColorStyle
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/replace CSS class(es) for this control
NameTypeDefaultDescription
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");
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"
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 this view/control
NameTypeDefaultDescription
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.
isChecked() Returns: {boolean}
Get checked state for switch 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
NameTypeDefaultDescription
event{Event}Value change event (usually an onchange event)
Example
MyView.propagateUp(event);
setChecked(checked)
Set checked state for switch control
NameTypeDefaultDescription
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"
NameTypeDefaultDescription
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/disable this view/control
NameTypeDefaultDescription
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
Inherited setLabelVisible(visible)
Show/hide the label of this view/control
NameTypeDefaultDescription
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"
NameTypeDefaultDescription
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"
NameTypeDefaultDescription
style{string}"DEFAULT"|"DEF"|"NORMAL"|"D"=Default | "SMALL"|"S"=Small | "LARGE"|"L"=Large
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 binding.set pattern detailed in the Knowlege Center section Binding Data and Configuration Options
NameTypeDefaultDescription
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
NameTypeDefaultDescription
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"
Inherited show()
Show this view/control
Example
MyView.show();
Inherited triggerFormulaUpdates([phase])
Broadcasts the expression trigger for the specified view
NameTypeDefaultDescription
phase{int}bpmext.ui.PHASE_NORMALThe phase we are currently in
Example
MyView.triggerFormulaUpdates();