Caplin Trader 5.1.0

Interface: module:br-presenter/control/tooltip/TooltipHelper

module:br-presenter/control/tooltip/TooltipHelper

Interface that must be implemented by classes that provide tooltip creation and update logic. Classes implementing this interface will be used by the module:br-presenter/control/tooltip/TooltipControl control, which will obtain it trough the br.presenter.tooltip-helper alias.

This is an interface and should not be constructed.

Methods

containWithin(container) → {module:br-presenter/control/tooltip/TooltipHelper}

Sets the container element in which the tooltip will be contained.

Parameters:

Name	Type	Description
`container`	DOMElement	The container element.

Returns:

Returns the this pointer, so calls can be chained.

Type: module:br-presenter/control/tooltip/TooltipHelper

pointTo(errorElement) → {module:br-presenter/control/tooltip/TooltipHelper}

Creates the tooltip and points it to the passed in errorElement.

Parameters:

Name	Type	Description
`errorElement`	DOMElement	The element to which the tooltip will 'point to'.

Returns:

Returns the this pointer, so calls can be chained.

Type: module:br-presenter/control/tooltip/TooltipHelper

remove()

Removes the tooltip element from the DOM.

updateTooltip(message) → {module:br-presenter/control/tooltip/TooltipHelper}

Sets new text for the tooltip.

Parameters:

Name	Type	Description
`message`	String	The message to display in the tooltip.

Returns:

Returns the this pointer, so calls can be chained.

Type: module:br-presenter/control/tooltip/TooltipHelper