Class: Note

Note

The Note control displays read-only text, with various Header options for the label. A Note control provides the following configuration properties in Process Designer:

Formula

Text Formula: Formula/expression to use for calculating note text string

Appearance

Width: Width in px, %, em For example: 50px, 20%, 0.4em. If no unit is specified, px is assumed string
Label Style: Header style for the note label
{Default | Heading 1 | Heading 2 | Heading 3}
string
Color Style: Color style of note
{Default | Primary | Success | Info | Warning | Danger}
string

Events

On Load:
Description: Triggers whenever the view is loaded.
Example:
me.setText(${DynamicNoteText}.getValue())
On Click:
Description: Triggers when the view is clicked.
Example:
me.setVisible(false)
Article(s)
Note

new Note()

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

getColorStyle(){string}

Gets color style of note. NOTE: This always returns the color as set, to avoid ambiguity always set the color using "D"|"I"|"S"|"W"|"G"
Returns:
Type Description
string
Retrieve bound data associated this view/control. Only works for views/controls with bound data.
Returns:
Type Description
Object Value of bound data. undefined if the view has no data binding.
Example
var dec1 = MyDecimal.getData();

getLabel(){string}

Get Note control label style
Returns:
Type Description
string

getLabel(){string}

Get label associated with note control
Returns:
Type Description
string

getText(){string}

Get text for note control
Returns:
Type Description
string

getType(){string}

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

getWidth(){string}

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

isLabelVisible(){boolean}

Get label visibility for note control
Returns:
Type Description
boolean
Returns the valid status as last set by the setValid() method.
Returns:
Type Description
boolean Validity status. true if setValid(false, ...) was never called
Example
var valid = MyView.isValid();
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);
Only for formula-enabled views!
Explicitly triggers the re-evaluation of the formula for this view (if a formula has been 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

setColorStyle(style)

Sets color style of note. NOTE: to avoid ambiguity always set the color using "D"|"I"|"S"|"W"|"G"
Name Type Description
style string "DEFAULT"|"DEF"|"D"=Default | "INFO"|INF"|"I"=Info | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "DANGER"|"G"=Danger
Set/update bound data associated this view/control. Only works for views/controls with bound data.
Name Type Description
value Object Value of bound data. The type of this parameter must match the type of the bound data.
Example
MyView.setData("TEST"); //Updates bound data to the string 'TEST'
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

setLabel(label)

Set label for note control
Name Type Description
label string Note label

setLabelStyle(style)

Set label style for note control
Name Type Description
style string Note label style ("H1"|"H2"|"H3"|"H4")

setLabelVisible(flag)

Set label visibility for note control
Name Type Description
flag boolean {true | false}

setText(text)

Set text for note control
Name Type Description
text string Note text
Flag this view/control as valid or invalid
Name Type Description
valid boolean Valid/invalid flag (true to set view valid, false to make it invalid - which typically shows the view with "invalid" styling and indicator)
errorText string Validation error text to show on the invalid-styled view
Example
MyView.setValid(false, "Please fix your data entry"); //Make MyView invalid
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 text control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
width string Note 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();