Class: Badge

Badge

The Badge control displays textual or numerical content and can be programmatically set to be clickable. A Badge control provides the following configuration properties in Process Designer:

Formula
Text Formula: Formula to use to populate badge display string

Appearance
Color Style: Color-based styling for this control (default, primary, success, warning, danger)
{Default | Primary | Info | Success | Warning | Danger}		 string
Shape Style: Determines the shape of the control
{Badge | Label | Tag}		 string

Events
On Load:
Description: This event is fired when the badge is loaded.
Example: 
me.setColorStyle("I")
On Click:
Description: This event is fired when the badge is clicked.
Example: 
${Tooltip1}.setTooltipVisible(!${Tooltip1}.isTooltipVisible())
Article(s)
Badge

new Badge()

Badge.js, line 42
This constructor is never used explicitly.

Extends

Members

uibpmext.ui.View

Methods

inherited addClass(name, replaced)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2466
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");

getColorStyle(){string}

Badge.js, line 126
Gets color style of badge. 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

getShapeStyle(){string}

Badge.js, line 142
Get the shape style of the badge. NOTE: This always returns the shape as set, to avoid ambiguity always set the shape using "B"|"T"|"L"
Returns:
Type Description
string

getText(){string}

Badge.js, line 158
Get the text in the badge
Returns:
Type Description
string

getType(){string}

Badge.js, line 166
Get descriptive string representing the type of control
Returns:
Type Description
string

inherited hide(collapseFlag)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1861
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();

inherited isBound(){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2088
Indicates bound status of control.
Returns:
Type Description
boolean True if the control is bound to coach data.

inherited isEnabled(){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2034
Checks if the view is enabled or not
Returns:
Type Description
boolean Enabled status
Example
var enabled = MyView.isEnabled();

inherited isLabelVisible(){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1835
Checks if control label is visible
Returns:
Type Description
boolean Label visibility status
Example
var labelVisible = MyView.isLabelVisible();

inherited isVisible(){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1943
Checks whether or not view is visible
Returns:
Type Description
boolean Visibility status
Example
var visible = MyView.isVisible();

inherited propagateUpValueChange(event){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2403
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)

Badge.js, line 118
Sets color style of badge. 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"=Danger

inherited setEnabled(enabled, required)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1959
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

inherited setLabelVisible(visible)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1874
Show/hide the label of this view/control
Name Type Description
visible boolean Label visibility flag (true to show view label, false to hide)
Example
MyView.setLabelVisible(false);

setShapeStyle(style)

Badge.js, line 134
Sets shape style of badge. NOTE: to avoid ambiguity always set the shape using "B"|"T"|"L"
Name Type Description
style string "B"|"Badge"|"Def"|"Default"=badge || "T"|"Tag"=tag || "L"|"Label"=label

setText(text)

Badge.js, line 150
Set the text in the badge
Name Type Description
text string Text to set in the badge

inherited setVisible(visible, collapse)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1887
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"

inherited show()

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1849
Show this view/control
Example
MyView.show();

inherited triggerFormulaUpdates(phase)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 4229
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();