Methods

addClass
getColorStyle
getData
getLabelPlacementt
getLabelWidth
getSizeStyle
getText
getType
hide
isBound
isEnabled
isLabelVisible
isTooltipVisible
isVisible
propagateUpValueChange
recalculate
setColorStyle
setEnabled
setLabelPlacement
setLabelVisible
setLabelWidth
setSizeStyle
setText
setTooltipVisible
setViewData
setVisible
show
triggerFormulaUpdates

Parent

CoachView

Helpers

bpmext.log
bpmext.number
bpmext.text
bpmext.ui
bpmext.ui.View
bpmext.ui.util
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/replace CSS class(es) for this control
NameTypeDefaultDescription
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 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 bound data associated this view/control. Only works for views/controls 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 this view/control
NameTypeDefaultDescription
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();
isTooltipVisible() Returns: {boolean}
Get visibility for tooltip
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
NameTypeDefaultDescription
event{Event}Value change event (usually an onchange event)
Example
MyView.propagateUp(event);
Inherited recalculate()
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 the tooltip. NOTE: to avoid ambiguity always set the color using "D"|P"|"I"|"S"|"W"|"G"
NameTypeDefaultDescription
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/disable this view/control
NameTypeDefaultDescription
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
setLabelPlacement(placement)
Set label placement for control. NOTE: to avoid ambiguity always set the label placement using "T"|"L"
NameTypeDefaultDescription
placement{string}"T"|"TOP"=Top | "L"|"LEFT"=Left
Inherited setLabelVisible(visible)
Show/hide the label of this view/control
NameTypeDefaultDescription
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)
NameTypeDefaultDescription
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"
NameTypeDefaultDescription
(string)style "Default"|"DEF"|"D"=Default | "LARGE"|"L"=Large | "EXTRA-SMALL"|"X-SMALL"|"XS"=Extra-Small
setText(text)
Set text for the tooltip
NameTypeDefaultDescription
text{string}text of the tooltip
setTooltipVisible(visible)
Set visibility for the tooltip control
NameTypeDefaultDescription
visible{boolean}visibility of the tooltip
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 binding.set pattern detailed in the Knowlege Center section Binding Data and Configuration Options
NameTypeDefaultDescription
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
NameTypeDefaultDescription
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
NameTypeDefaultDescription
phase{int}bpmext.ui.PHASE_NORMALThe phase we are currently in
Example
MyView.triggerFormulaUpdates();