Class: Button

Button

The button control is used to allow users to continue through a Coach with a 'next' button to another Coach, or to exit a Coach with an 'exit' button for example. The button control always shows a label, to show an Image or an Icon as a button use an Image or Icon control. A Button control provides the following configuration properties in Process Designer:

Formula

Label Formula: Formula/expression to use for calculating button label string

Behavior

Tab Index: Form control tabbing sequence index. Tab indices start at 1, and may be set sparsely. integer
Prevent Multiple Clicks: Prevents the user from clicking the button more than once boolean

Appearance

Color Style: Color-based styling for this control (default, primary, success, warning, danger)
{Default | Primary | Info | Success | Warning | Danger}
string
Shape Style: Rounded, flat or default square control shape
{Default | Rounded | Flat}
string
Size Style: Size-based styling for this control (default, large, small, extra-small)
{Default | Large | Small | Extra-Small}
string
Outline Only: When true, control only shows its color-based style when hovered over boolean
Icon: Icon name, for example: calendar, clock-o, camera, cloud-upload, bell, info, file-text, etc... Check http://fontawesome.io/icons for a comprehensive list. (Note that the "fa-" prefix is optional) string
Width: Width in px, %, em For example: 50px, 20%, 0.4em. If no unit is specified, px is assumed 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}
Articles
Button

new Button()

This constructor is never used explicitly.

Extends

Members

Methods

Add/replace CSS class(es) for this control
Name Type Description
name string CSS class name(s) to add to the control. Separate class names by a space if more than one class.
replaced string optional 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 button

focus()

Set focus on this control

getColorStyle(){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"
Returns:
Type Description
string

getHelpText(){string}

Get help text for button
Returns:
Type Description
string

getShapeStyle(){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"
Returns:
Type Description
string

getSizeStyle(){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"
Returns:
Type Description
string

getTabIndex(){integer}

Get tab index for Button control
Returns:
Type Description
integer

getText(){string}

Get text of button
Returns:
Type Description
string

getType(){string}

Get descriptive string representing the type of control
Returns:
Type Description
string

getWidth(){string}

Get configured width for button (including unit)
Returns:
Type Description
string
Hide this view/control
Name Type Description
collapseFlag boolean Set to true to collapse the view (equivalent to a view setting of "NONE")
Example
MyView.hide();
Indicates bound status of control.
Returns:
Type Description
boolean True if the control is bound to coach data.
Checks if the view is enabled or not
Returns:
Type Description
boolean Enabled status
Example
var enabled = MyView.isEnabled();
Checks whether or not view is visible
Returns:
Type Description
boolean Visibility status
Example
var visible = MyView.isVisible();
Propagates value change of control up through parent views
Name Type Description
event Event Value change event (usually an onchange event)
Returns:
Type Description
boolean True if a formula update was triggered on the control's parent, otherwise false
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"
Name Type 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
Enable/disable this view/control
Name Type Description
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(text)

Set help text for button
Name Type Description
text string Rollover text to be set

setIcon(icon)

Sets icon to display on the button
Name Type Description
icon string visit http://fontawesome.io/icons/ for icon options

setOutline(outline)

Sets outline style of button
Name Type 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 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 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 Description
tabIndex integer Tab indices start at 1 and may be set sparsely

setText(text)

Set text of button
Name Type Description
text string Text to be set on the button
Show/hide this view/control
Name Type Description
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"

setWidth(width)

Set width of button (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
width string Button width
Show this view/control
Example
MyView.show();
Broadcasts the expression trigger for the specified view
Name Type Default Description
phase int bpmext.ui.PHASE_NORMAL optional The phase we are currently in
Example
MyView.triggerFormulaUpdates();