Button

Guides your user through the app or calls an action.

Appearance

Color style: The color style of the view.
{Default | Primary | Info | Success | Warning | Danger | Dark} ButtonColorStyle

Ghost style: Show the button in the selected color style with no outline and no solid fill. Add a light grey background at hover over. Boolean

Shape style: The shape of the view, rounded, flat or square (default).
{Default | Rounded | Flat} ButtonShapeStyle

Size: The size-based styling for this view (default, large, small, extra-small)
{Default | Large | Small | Extra-Small} ButtonSizeStyle

Outline only: Show the outline and hide the solid fill of the button in the selected color style. Add the solid fill at hover over. Boolean

Icon: The icon name, for example, calendar, clock-o, camera, cloud-upload, bell, info, file-text, etc. For a comprehensive list, see http://fontawesome.io/icons. Note that the "fa-" prefix is optional. String

Width: The width in px, %, or em. For example, 50px, 20%, 0.4em. If no unit is specified, px is assumed. String

Icon location: The location of the icon relative to the button text.
{Left | Right} InputGroupButtonLoc

Behavior

Tab index: The tabbing sequence index of the form view. Indices start at 1, and can be set sparsely. For example, you can use 1, 5, 10. Integer

Prevent multiple clicks: Prevents the user from clicking the button more than once. Boolean

Formula

Label formula: The formula or expression to set the button label. For example, "OK" or ${"Text1"}.getText(). String

Events

On Load:

Description: Triggers whenever the view is loaded.

Example:

console.log("Button loaded")

On Click:

Description: Triggers when button is clicked, before navigating away from page. If evaluated expression returns false, the click will not fire a boundary event.

Example:

return ${Text1}.isValid();

On Boundary Event:

Description: Triggers upon reaching a Stay On Page event after a boundary event is fired through this control. For information on the status context variable see the context.trigger() method in the Knowledge Center.

Example:

alert("Stay on Page status '" + status + "'")

Context Variables	status {string}

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 button

focus()

Set focus on this control

getColorStyle() Returns: {string}

Gets color style of button. NOTE: This always returns the color as set, to avoid ambiguity always set the color using "D"|"P"|"I"|"S"|"W"|"E"

getHelpText() Returns: {string}

Get help text for button

getIconLocation()

get button icon alignment location

getShapeStyle() Returns: {string}

Gets shape style of button. NOTE: This always returns the shape style as set, to avoid ambiguity always set the shape style using "D"|"R"|"F"

getSizeStyle() Returns: {string}

Gets size style of button. NOTE: This always returns the size style as set, to avoid ambiguity always set the size style using "D"|"S"|"L"|"X"

getTabIndex() Returns: {integer}

Get tab index for Button control

getText() Returns: {string}

Get text of button

getType() Returns: {string}

Get descriptive string representing the type of control

getWidth() Returns: {string}

Get configured width for button (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 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);

setColorStyle(style)

Sets color style of button. NOTE: to avoid ambiguity always set the color using "D"|"P"|"I"|"S"|"W"|"E"|"B"

Name Type Default Description

style {string} "DEFAULT"|"DEF"|"D"=Default | "PRIMARY"|"PRI"|"P"=Primary | "INFO"|INF"|"I"=Info | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "DANGER"|ERROR|ERR"|"E"|"G"=Danger | "BLACK"|BLACK|"BLK"|"B"|"B"=Black

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

setGhost(ghostMode)

Sets ghost style of button

Name Type Default Description

ghostMode {boolean} {true | false}

setHelpText(text)

Set help text for button

Name Type Default Description

text {string} Rollover text to be set

setIcon(icon)

Sets icon to display on the button

Name Type Default Description

icon {string} See {@link http://fontawesome.io/icons Font Awesome} for a comprehensive list of icons. Refer to the knowledge center for the latest Font Awesome version.

setIconLocation(direction)

Sets the direction of the icon alignment

Name Type Default Description

direction {string} Indicates the direction of the icon alignment (L - left | R - right)

setOutline(outline)

Sets outline style of button

Name Type Default Description

outline {boolean} {true | false}

setShapeStyle(style)

Sets shape style of button. NOTE: to avoid ambiguity always set the shape style using "D"|"R"|"F"

Name Type Default Description

style {string} "Default"|"D"=Default | "ROUNDED"|ROUND"|"R"=Rounded | "FLAT"|"F"=Flat

setSizeStyle(style)

Sets size style of button. NOTE: to avoid ambiguity always set the size style using "D"|"S"|"L"|"X"

Name Type Default Description

style {string} "DEFAULT"|"DEF"|"NORMAL"|"D"=Default | "SMALL"|"S"=Small | "LARGE"|"L"=Large | "EXTRA-SMALL"|"X-SMALL"|"XS"|"X"=X-small

setTabIndex(tabIndex)

Sets tab index of Button control

Name Type Default Description

tabIndex {integer} Tab indices start at 1 and may be set sparsely

setText(text)

Set text of button

Name Type Default Description

text {string} Text to be set on the button

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 button (e.g. 50px, 20%, 2em - omitting the unit assumes px)

Name Type Default Description

width {string} Button width

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