Methods

addClass
addSelectedItem
appendItem
clearItems
focus
getData
getHelpText
getItemCount
getItemText
getItemTextAt
getLabel
getLabelPlacement
getLabelWidth
getSelectedIndices
getSelectedItems
getServiceInputData
getType
hide
isBound
isEnabled
isLabelVisible
isValid
isVisible
propagateUpValueChange
recalculate
reloadServiceItems
removeItem
removeItemAt
removeSelectedItem
setEnabled
setHelpText
setItem
setItemText
setLabel
setLabelPlacement
setLabelVisible
setLabelWidth
setOptionDisabled
setSelectedItems
setServiceInputData
setValid
setViewData
setVisible
show
triggerFormulaUpdates

Parent

CoachView

Helpers

bpmext.log
bpmext.number
bpmext.text
bpmext.ui
bpmext.ui.View
bpmext.ui.util
Check box group
Allows users to select multiple options from a list of check boxes. You can populate the list either statically or by using a service.
Items
Item lookup mode: The method used to populate the selection list.
{Start Empty | Items From Service | Items From Static List | Items From Config Option}		 SelectItemsLookupMode
List items service: Provides the selection list based on the service input data value when the Item lookup mode is Items From Service.
Service input data: Provides the input data to the service that populates the selection list when the Item lookup mode is Items From Service. ANY
Ignore input data changes: Disable the automatic service call when the service input data changes. Boolean
Item input data: A business object list that populates the selection list when the Item lookup mode is Items From Config Option. ANY[]
Static list: Enter the static selection list. The strings that you enter in the value property are displayed in the selection list. When the user makes a selection, the string that is in the corresponding name property is mapped to the value property of the output object. Note: Do not specify a variable here. For a variable list, use the Items From Config Option lookup mode. NameValuePair[]
Item selection data: In the optionDisplayProperty field, set the business object property to display in the selection list and to take as the selection value. If not set, the defaults are: optionValueProperty, name and optionDisplayProperty, value. SelectDataMapping
Appearance
Width: The width in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed. String
Label placement: The position of the label. If you select Left, the width of the view changes.
{Top | Left}		 LabelPlacement
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
Show validation marker: Show a validation icon and border when the view is invalid. Boolean
Behavior
Tab index: Form view tabbing sequence index. Tab indices start at 1, and may be set sparsely. String
Events
On Load:
Description: Triggers whenever the view is loaded.
Example: 
console.log(me.getItemCount())
On Service Items:
Description: Triggers when AJAX Service returns item list. Only triggers if Item lookup Mode is set to Items From Service.
Example: 
console.log("CheckboxGroup1 item service retrieved items successfully")
On Service Error:
Description: Triggers when AJAX selection service returns an error. Will not trigger if Item Lookup Mode is not set to Items From Service.
Example: 
me.clearItems()
On Change:
Description: Triggers when the bound data changes.
Example: 
${CheckboxGroup2}.reloadServiceItems(me.getSelectedIndices())
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");
addSelectedItem(key)
Adds the item to those selected in checkbox group control based on the key of the item/option -- setSelectedItem is an alias to this method.
NameTypeDefaultDescription
key{ANY}Key of item to set selection to
appendItem(value, displayText) Returns: {object}
Appends an item to the selection list
NameTypeDefaultDescription
value{*}The value of the selection
displayText{string}The text to be displayed
clearItems()
Clears the selection list
focus()
Focus on the first selected item/option or the first item/option of the in check button group control
Inherited getData() Returns: {Object}
Retrieve bound data associated this view/control. Only works for views/controls with bound data.
Example
var dec1 = MyDecimal.getData();
getHelpText() Returns: {string}
Get help text associated with the control
getItemCount() Returns: {integer}
Get number of items in the list
getItemText(itemVal) Returns: {string}
Get the display text for a value (value must be known)
NameTypeDefaultDescription
itemVal{ANY}Value of item to get text for
Examples
mltslct.getItemText("option1") // returns "Option 1" (for a selection item with value="option1" and name="Option 1")
mltslct.getItemText(mltslct.getSelectedItems()[0]) // returns the text of the first selected item
getItemTextAt(index) Returns: {string}
Get display text associated with item at specified index
NameTypeDefaultDescription
index{integer}Index of item/option in checkbox group control
getLabel() Returns: {string}
Get label associated with checkbox group control
getLabelPlacement() Returns: {string}
Get label placement for control. NOTE: This always returns the label placement as set, to avoid ambiguity always set the label placement using "T"|"L"|
getLabelWidth() Returns: {string}
Get label width of CheckboxGroup control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
getSelectedIndices() Returns: {integer[]}
Get indices of items selected in checkbox group control
getSelectedItems() Returns: {ANY[]}
Get values associated with items selected in checkbox group control, or null. NOTE: as of IBM Business Automation Workflow 18.0.0.1 this method returns an array of NameValuePairs by default.
getServiceInputData() Returns: {ANY}
Returns the input for the list items AJAX service
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.
Inherited isEnabled() Returns: {boolean}
Checks if the view is enabled or not
Example
var enabled = MyView.isEnabled();
isLabelVisible() Returns: {boolean}
Get label visibility for checkbox group control
Inherited isValid() Returns: {boolean}
Returns the valid status as last set by the setValid() method.
Example
var valid = MyView.isValid();
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);
Inherited recalculate()
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
reloadServiceItems(input)
Sets tab index of checkbox group control
NameTypeDefaultDescription
input{ANY}Data to be passed to the AJAX Service retrieving the items for the control
removeItem(value)
Remove the first item/option matching the value specified
NameTypeDefaultDescription
value{*}Value of item/option in checkbox group control
removeItemAt(index)
Remove item at specified index
NameTypeDefaultDescription
index{integer}Index of item/option in checkbox group control
removeSelectedItem(key)
Removes the item from those selected in checkbox group control based on the key of the item/option.
NameTypeDefaultDescription
key{ANY}Key of item to set selection to
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
setHelpText(helptext)
Set help text for the control
NameTypeDefaultDescription
helptext{string}Help text for the control
setItem(idx, value, text)
Set display text of item/option at specified index
NameTypeDefaultDescription
idx{integer}Index to set
value{ANY}Value of item/option in checkbox group control
text{string}The display text to show for the item/option
setItemText(value, text)
Set display text of the first item/option matching the value specified
NameTypeDefaultDescription
value{ANY}Value of item/option in checkbox group control
text{string}The display text to show for the item/option
setLabel(label)
Set label for checkbox group control
NameTypeDefaultDescription
label{string}Label for the control
setLabelPlacement(placement)
Set label placement for control. NOTE: to avoid ambiguity always set the label placement using "T"|"L"|
NameTypeDefaultDescription
placement{string}"T"|"TOP"=Top | "L"|"LEFT"=Left
setLabelVisible(flag)
Set label visibility for checkbox group control
NameTypeDefaultDescription
flag{boolean}{true | false} Set to false to hide label
setLabelWidth(labelWidth)
Set label width of CheckboxGroup control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
NameTypeDefaultDescription
labelWidth{string}Control's label width
setOptionDisabled(value, flag)
disables all of the items that have the provided value
NameTypeDefaultDescription
value{String}- value of checkbox to disable
flag{Boolean}- true to disable the checkbox, false to enable it
setSelectedItems(value)
Set items selected in the control based on the value of the items/options
NameTypeDefaultDescription
value{ANY}Array of values (i.e. keys) of items to set selection to
setServiceInputData(data)
Specifies the default input for the list items AJAX service
NameTypeDefaultDescription
data{ANY}Default input data for service
Inherited setValid(valid, errorText)
Flag this view/control as valid or invalid
NameTypeDefaultDescription
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
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();