Badge
Displays text and numbers to draw attention to a specific area or to show useful information on a page. You can also make it clickable.
Appearance
| Color style: | The color style for this view. {Default | Primary | Info | Success | Warning | Danger} |
BadgeColorStyle |
| Shape style: | Determines the shape of the view {Badge | Label | Tag} |
BadgeShapeStyle |
Formula
| Text formula: | The formula used to populate the badge display. | String |
| Events | ||||||
| On Load: |
| |||||
| On Click: |
| |||||
Extends:
Methods:
Inherited
addClass(name, [replaced])
Add/replace CSS class(es) for this control
| Name | Type | Default | 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} | 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()
Returns:
{string}
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"
getShapeStyle()
Returns:
{string}
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"
getText()
Returns:
{string}
Get the text in the badge
getType()
Returns:
{string}
Get descriptive string representing the type of control
Inherited
hide(collapseFlag)
Hide this view/control
| 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}
Indicates bound status of control.
Inherited
isEnabled()
Returns:
{boolean}
Checks if the view is enabled or not
Example
| var enabled = MyView.isEnabled(); |
Inherited
isLabelVisible()
Returns:
{boolean}
Checks if control label is visible
Example
| var labelVisible = MyView.isLabelVisible(); |
Inherited
isVisible()
Returns:
{boolean}
Checks whether or not view is visible
Example
| var visible = MyView.isVisible(); |
Inherited
propagateUpValueChange(event)
Returns:
{boolean}
Propagates value change of control up through 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 badge. NOTE: to avoid ambiguity always set the color using "D"|"P"|"I"|"S"|"W"|"E"
| 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"=Danger |
Inherited
setEnabled(enabled, required)
Enable/disable this view/control
| Name | Type | Default | 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)
Show/hide the label of this view/control
| Name | Type | Default | Description |
| visible | {boolean} | Label visibility flag (true to show view label, false to hide) |
Example
| MyView.setLabelVisible(false); |
setShapeStyle(style)
Sets shape style of badge. NOTE: to avoid ambiguity always set the shape using "B"|"T"|"L"
| Name | Type | Default | Description |
| style | {string} | "B"|"Badge"|"Def"|"Default"=badge || "T"|"Tag"=tag || "L"|"Label"=label |
setText(text)
Set the text in the badge
| Name | Type | Default | Description |
| text | {string} | Text to set in the badge |
Inherited
setViewData(data, createPseudoBinding)
Set/update bound data associated this view/control. Only works for views/controls with bound data.
Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the
Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the
binding.set pattern detailed in the Knowlege Center section Binding Data and Configuration Options| Name | Type | Default | Description |
| data | {Object} | Value of bound data. The type of this parameter must match the type of the bound data. | |
| createPseudoBinding | {boolean} | If set to true, 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/hide this view/control
| Name | Type | Default | 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()
Show this view/control
Example
| MyView.show(); |
Inherited
triggerFormulaUpdates([phase])
Broadcasts 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(); |