BiToolTip
This class is used for showing generic tool tip controls. A tool tip can contain other controls.
This class extends
BiPopup
and therefore all methods and fields available for
BiPopup
are also available for
BiToolTip
.
Constructor
new
BiToolTip
(
sText
)
Parameters
| Name | Type | Optional | Default | Descripton |
sText |
String |
The text to show on the tool tip |
Properties
| Name | Type | get | set | Descripton |
component |
|
 |
If the tool tip was shown due to mouse movement or a component
becoming focused where the component is assosciated with the current
tool tip then this will point to the component that caused the tool
tip to be shown. This will return null if the tool tip is hidden or not
opened by the tool tip manager. In other words by setting
visible manually. |
|
hideInterval |
Number |
|
|
The number of milliseconds before hiding the tool tip |
hideOnHover |
Boolean |
|
|
If this is true then the tool tip is hidden if the mouse pointer enters the tool tip. |
mousePointerOffsetX |
Number |
|
|
The position of the tool tip relative to the mouse pointer |
mousePointerOffsetY |
Number |
|
|
The position of the tool tip relative to the mouse pointer |
showInterval |
Number |
|
|
The number of milliseconds before showing the tool tip |
Methods
None.
Events
None.
Static Methods
| Name | Description |
getTextToolTip |
This returns a tool tip object suitable for text only tool tips. Once the usage of the tool tip is complete some other component might resuse this so if you need to modify your tool tip in any way create a new tool tip. |
Static Fields
None.
Remarks
If only plain text tool tips without any events or changes while shown are needed consider using the toolTipText property on the component instead.
Static Method Details
getTextToolTip
This returns a tool tip object suitable for text only tool tips. Once the usage of the tool tip is complete some other component might resuse this so if you need to modify your tool tip in any way create a new tool tip.
Syntax
BiToolTip
.
getTextToolTip
(
sText
)
Parameters
| Name | Type | Optional | Default | Descripton |
sText |
String |
The text to show on the tool tip |