class sap.ui.vk.tools.TooltipTool

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vk/tools/TooltipTool
Application Component: CA-UI5-VTK

The TooltipTool allows applications to display custom tooltip text on top of 3D object over which pointer is hovering


Constructor

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. sIdis generated automatically if no non-empty ID is given. Note: this can be omitted, regardless of whether mSettings will be provided or not.

mSettings? object

An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance.


Properties

Name Type Default Value Description
animate boolean false Visibility: public
followCursor boolean true Visibility: public
offsetX float 10 Visibility: public
offsetY float 15 Visibility: public

Borrowed Properties

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

Borrowed Aggregations

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


Events Overview

Event Description
hover

This event will be fired when mouse hover occurs.

hover

This event will be fired when mouse hover occurs.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
x int
y int
nodeRef any

Methods Overview

Method Description
attachHover

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.

detachHover

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.

sap.ui.vk.tools.TooltipTool.extend

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.

fireHover

Fires event hover to attached listeners.

getAnimate

Gets current value of property animate.

Default value is false.

getFollowCursor

Gets current value of property followCursor.

Default value is true.

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 10.

getOffsetY

Gets current value of property offsetY.

Default value is 15.

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 null or undefined, the default value of the property will be restored.

Default value is false.

setFollowCursor

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.

setOffsetX

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.

setOffsetY

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.

setTitle

Sets the tooltip title

attachHover

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 sap.ui.vk.tools.TooltipTool itself

detachHover

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

sap.ui.vk.tools.TooltipTool.extend

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

fireHover

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

getAnimate

Gets current value of property animate.

Default value is false.

getFollowCursor

Gets current value of property followCursor.

Default value is true.

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 10.

getOffsetY

Gets current value of property offsetY.

Default value is 15.

queueCommand

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.

setAnimate

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 animate

setFollowCursor

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 followCursor

setOffsetX

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 offsetX

setOffsetY

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 offsetY

setTitle

Sets the tooltip title

Param Type DefaultValue Description
title string

Title