CheckboxGroup

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

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.

Name Type Default Description

key {ANY} Key of item to set selection to

appendItem(value, displayText) Returns: {object}

Appends an item to the selection list

Name Type Default Description

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 the bound data associated with the view. It applies only to views 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)

Name Type Default Description

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

Name Type Default Description

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

Inherited isEnabled() Returns: {boolean}

Check whether the view is enabled.

Example

var enabled = MyView.isEnabled();

isLabelVisible() Returns: {boolean}

Get label visibility for checkbox group control

Inherited isValid() Returns: {boolean}

Return the valid status as last set by the setValid() method.

Example

var valid = MyView.isValid();

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

Inherited recalculate()

Applicable only to formula-enabled views!
Triggers the re-evaluation of the formula
for the view, if a formula was 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

Name Type Default Description

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

Name Type Default Description

value {*} Value of item/option in checkbox group control

removeItemAt(index)

Remove item at specified index

Name Type Default Description

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.

Name Type Default Description

key {ANY} Key of item to set selection to

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

setHelpText(helptext)

Set help text for the control

Name Type Default Description

helptext {string} Help text for the control

setItem(idx, value, text)

Set display text of item/option at specified index

Name Type Default Description

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

Name Type Default Description

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

Name Type Default Description

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

Name Type Default Description

placement {string} "T"|"TOP"=Top | "L"|"LEFT"=Left

setLabelVisible(flag)

Set label visibility for checkbox group control

Name Type Default Description

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)

Name Type Default Description

labelWidth {string} Control's label width

setOptionDisabled(value, flag)

disables all of the items that have the provided value

Name Type Default Description

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

Name Type Default Description

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

Name Type Default Description

data {ANY} Default input data for service

Inherited setValid(valid, errorText)

Flag the view as valid or invalid.

Name Type Default 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, "Fix your data entry"); //Make MyView invalid

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