Tooltip

Displays a message when users hover over a view on a page.

Appearance

Show label: Displays a label. If the Tooltip coach view has a label, it is displayed. Otherwise, the label of the coach view that is contained inside the Tooltip coach view is displayed. Note: The coach view Label visibility property is ignored. Boolean

Label placement: The placement of the label
{Top | Left} LabelPlacement

Label width: The width of the label in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed. String

Width: The width of the envelope that wraps the contained view. String

Color style: The color style of the tooltip.
{Default | Primary | Info | Success | Warning | Danger} TooltipColorStyle

Horizontal position: Horizontal positioning of the tooltip
{Left | Center | Right} TooltipHorizontalAlignment

Vertical position: The vertical positioning of the tooltip.
{Top | Bottom} TooltipVerticalAlignment

Size: Size-based styling for this view (default, large, extra-small)
{Default | Large | Extra-Small} TooltipSizeStyle

Behavior

Show tooltip: When enabled, tooltip will be visible at load Boolean

Show on hover: When enabled, tooltip will be displayed when user hovers over contained view Boolean

Text as HTML: Include HTML in the tooltip Boolean

Formula

Tooltip formula: The formula or expression to calculate the tooltip text. String

Events

On Load:

Description: This event is fired when the tooltip is loaded.

Example:

me.setToolTipVisible(true)

On Click:

Description: This event is fired when the tooltip is clicked.

Example:

me.setText("You clicked me!")

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 the tooltip. NOTE: This always returns the color as set, to avoid ambiguity always set the color using "D"|"P"|"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();

getLabelPlacementt() Returns: {string}

Get label placement for control. NOTE: This always returns the label placement as set, to avoid ambiguity always set the label placement using "T"|"L"

getLabelWidth() Returns: {string}

Get label width of Tooltip control (e.g. 50px, 20%, 2em - omitting the unit assumes px)

getSizeStyle()

Gets font-size style of the tooltip. NOTE: This always returns the font-size as set, to avoid ambiguity always set the color using "D"|"L"|"X"

getText() Returns: {string}

Get text for tooltip

getType() Returns: {string}

Get descriptive string representing the type of control

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

Inherited isLabelVisible() Returns: {boolean}

Check whether the view label is visible.

Example

var labelVisible = MyView.isLabelVisible();

isTooltipVisible() Returns: {boolean}

Get visibility for tooltip

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 the tooltip. NOTE: to avoid ambiguity always set the color using "D"|P"|"I"|"S"|"W"|"G"

Name Type Default Description

style {string} "DEFAULT"|"DEF"|"D"=Default | PRIMARY"|"P"=Primary | "INFO"|INF"|"I"=Info | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "ERROR"|"ERR"|"DANGER"|"E"|"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

setLabelPlacement(placement)

Set label placement for control. NOTE: to avoid ambiguity always set the label placement using "T"|"L"

Name Type Default Description

placement {string} "T"|"TOP"=Top | "L"|"LEFT"=Left

Inherited setLabelVisible(visible)

Show or hide the view label.

Name Type Default Description

visible {boolean} Label visibility flag (true to show view label, false to hide)

Example

MyView.setLabelVisible(false);

setLabelWidth(labelWidth)

Set label width of Tooltip control (e.g. 50px, 20%, 2em - omitting the unit assumes px)

Name Type Default Description

labelWidth {string} Control's label width

setSizeStyle((string))

Sets font-size style of the tooltip. NOTE: to avoid ambiguity always set the font-size using "D"|"L"|"X"

Name Type Default Description

setText(text)

Set text for the tooltip

Name Type Default Description

text {string} text of the tooltip

setTooltipVisible(visible)

Set visibility for the tooltip control

Name Type Default Description

visible {boolean} visibility of the tooltip

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"

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