Note

Displays read-only text in the form of a note that shows information or draws attention to a specific area on a page.

Appearance

Width: The width in px, % or em.\r\nFor 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} NoteLabelStyle

Color style: Color style of note
{Default | Primary | Success | Info | Warning | Danger} NoteColorStyle

Formula

Text formula: The formula or expression to calculate note text. 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)

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

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

Inherited getData() Returns: {Object}

Retrieve the bound data associated with the view. It applies only to views with bound data.

Example

var dec1 = MyDecimal.getData();

getLabel() Returns: {string}

Get label associated with note control

getText() Returns: {string}

Get text for note control

getType() Returns: {string}

Get descriptive string representing the type of control

getWidth() Returns: {string}

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

isLabelVisible() Returns: {boolean}

Get label visibility for note control

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

Inherited recalculate()

Applicable only to formula-enabled views!
Triggers the re-evaluation of the formula
for the view, if a formula was 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 Default Description

style {string} "DEFAULT"|"DEF"|"D"=Default | "INFO"|INF"|"I"=Info | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "DANGER"|"G"=Danger

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

setLabel(label)

Set label for note control

Name Type Default Description

label {string} Note label

setLabelStyle(style)

Set label style for note control

Name Type Default Description

style {string} Note label style ("H1"|"H2"|"H3"|"H4")

setLabelVisible(flag)

Set label visibility for note control

Name Type Default Description

flag {boolean} {true | false}

setText(text)

Set text for note control

Name Type Default Description

text {string} Note text

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

Name Type Default Description

width {string} Note 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