The TooltipTool allows applications to display custom tooltip text on top of 3D object over which pointer is hovering
Constructor for a new TooltipTool.
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
new sap.ui.vk.tools.TooltipTool(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID of the new tool instance. |
|
mSettings? | object | An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. |
Name | Type | Default Value | Description |
---|---|---|---|
active | boolean | false | Used to control the tool rendering and interaction pipeline. Visibility: public |
footprint | string[] | Used to decide whether this tool should be enabled for the target viewport. Visibility: public |
|
targetViewportType | any | Visibility: public | |
toolid | string | GUID identifier for the tool to prevent naming conflicts. Visibility: public |
Name | Cardinality | Type | Description |
---|---|---|---|
gizmo | 0..1 | sap.ui.vk.tools.Gizmo |
sap.ui.vk.tools.Gizmo owned by this control and used for rendering floating UI |
Method | Description |
---|---|
attachHover |
Attaches event handler When called, the context of the event handler (its This event will be fired when mouse hover occurs. |
detachHover |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.vk.tools.TooltipTool.extend |
Creates a new subclass of class sap.ui.vk.tools.TooltipTool with name
|
fireHover |
Fires event hover to attached listeners. |
getAnimate |
Gets current value of property animate. Default value is |
getFollowCursor |
Gets current value of property followCursor. Default value is |
sap.ui.vk.tools.TooltipTool.getMetadata |
Returns a metadata object for class sap.ui.vk.tools.TooltipTool. |
getOffsetX |
Gets current value of property offsetX. Default value is |
getOffsetY |
Gets current value of property offsetY. Default value is |
queueCommand |
MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should be called using this method. |
setAnimate |
Sets a new value for property animate. When called with a value of Default value is |
setFollowCursor |
Sets a new value for property followCursor. When called with a value of Default value is |
setOffsetX |
Sets a new value for property offsetX. When called with a value of Default value is |
setOffsetY |
Sets a new value for property offsetY. When called with a value of Default value is |
setTitle |
Sets the tooltip title |
Attaches event handler fnFunction
to the hover event of this sap.ui.vk.tools.TooltipTool
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vk.tools.TooltipTool
itself.
This event will be fired when mouse hover occurs.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Detaches event handler fnFunction
from the hover event of this sap.ui.vk.tools.TooltipTool
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Creates a new subclass of class sap.ui.vk.tools.TooltipTool with name sClassName
and enriches it with the information contained in oClassInfo
.
oClassInfo
might contain the same kind of information as described in sap.ui.vk.tools.Tool.extend.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Fires event hover to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
x | int | ||
y | int | ||
nodeRef | any |
Returns a metadata object for class sap.ui.vk.tools.TooltipTool.
MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should be called using this method.
Param | Type | DefaultValue | Description |
---|---|---|---|
command | function |
The command to be executed. |
Sets a new value for property animate.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bAnimate | boolean | false |
New value for property |
Sets a new value for property followCursor.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bFollowCursor | boolean | true |
New value for property |
Sets a new value for property offsetX.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 10
.
Param | Type | DefaultValue | Description |
---|---|---|---|
fOffsetX | float | 10 |
New value for property |
Sets a new value for property offsetY.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 15
.
Param | Type | DefaultValue | Description |
---|---|---|---|
fOffsetY | float | 15 |
New value for property |