InputGroup

Input group

Allows users to add an icon, text, or menu to input views such as date, time, text, and so on. It adjusts its size to the size of the contained form view.

Appearance

Width: Width of the view (%, px) String

Label placement: The position of the label.
{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

Color style: The color of the button.
{Default | Primary | Info | Success | Warning | Danger} TooltipColorStyle

Button location: The position of the button relative to the attached view.
{Left | Right} InputGroupButtonLoc

Button type: The style of button to attach to the contained view. You can use the Menu option only to specify a single menu option.
{Icon | Text | Menu} InputGroupButtonKind

Button info: Set either the displayed text used with the Text and Menu kind options or the icon name for Icon kind. String

Events

On Load:

Description: This event is triggered when the control is loaded.

Example:

me.setIcon("rocket");

On Button Click:

Description: This event is triggered when the control is clicked.

Example:

${PopupMenu1}.setMenuVisible(!${PopupMenu1}.isMenuVisible())

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

getButtonLocation() Returns: {string}

Gets horizontal location of button in the control. NOTE: This always returns the button placement as set, to avoid ambiguity always set the label placement using "L"|"R"

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

getIcon()

Gets the icon currently on display

getLabel() Returns: {string}

Get label associated with 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 InputGroup control (e.g. 50px, 20%, 2em - omitting the unit assumes px)

getSizeStyle()

Gets size style of control

getType() Returns: {string}

Get descriptive string representing the type of control

getWidth() Returns: {string}

Get configured width for the control (including unit)

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

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

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

setButtonLocation(placement)

Sets horizontal location of button in the control. NOTE: to avoid ambiguity always set the label placement using "L" | "R"

Name Type Default Description

placement {string} "L"|"LEFT"=Left | "R"|"RIGHT"=right

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

setHelpText(helptext)

Set help text for the control

Name Type Default Description

helptext {string} Help text for the control

setIcon(icon)

Sets the icon to display

Name Type Default Description

icon {string} See {@link http://fontawesome.io/icons Font Awesome} for a comprehensive list of icons (note the "fa-" prefix is optional). Refer to the knowledge center for the latest Font Awesome version.

setLabel(label)

Set label for control

Name Type Default Description

label {string} label text 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

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

setLabelWidth(labelWidth)

Set label width of InputGroup control (e.g. 50px, 20%, 2em - omitting the unit assumes px)

Name Type Default Description

labelWidth {string} Control's label width

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"

setWidth(width)

Set width of the control (e.g. 50px, 20%, 2em - omitting the unit assumes px)

Name Type Default Description

width {string} width of the input group

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