class sap.ui.vtm.extensions.SceneNodeHoverTooltipExtension

Visiblity: public
UX Guidelines:
Implements: sap.ui.vtm.interfaces.ISceneNodeHoverTooltipExtension
Available since: N/A
Module: sap/ui/vtm/extensions/SceneNodeHoverTooltipExtension
Application Component:

Adds a behaviour in which a tooltip (which can be specified by application code using a callback function) is displayed when the mouse is hovering over a scene node.


Constructor

Constructor for a new SceneNodeHoverTooltipExtension.

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.vtm.extensions.SceneNodeHoverTooltipExtension(sId, mSettings)
Param Type Default Value Description
sId string

id for the new instance.

mSettings object

Object with initial property values, aggregated objects etc. for the new instance.


Properties

Name Type Default Value Description
tooltipCallback any

A callback function that gets a tooltip for a given sap.ui.vtm.SceneNode. If unspecified, the scene node name is used for the tooltip text.

The first parameter is the sap.ui.vtm.SceneNode under cursor.
The function should return an object containing a tooltip text for the specified scene node.

  {
    text: [string]
  }
If function returns null no tooltip will be displayed.

Visibility: public

Borrowed Properties

Name Type Default Value Description
enabled boolean true

Controls whether the extension is enabled.

Visibility: public

Methods Overview

Method Description
sap.ui.vtm.extensions.SceneNodeHoverTooltipExtension.extend

Creates a new subclass of class sap.ui.vtm.extensions.SceneNodeHoverTooltipExtension 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.vtm.Extension.extend.

sap.ui.vtm.extensions.SceneNodeHoverTooltipExtension.getMetadata

Returns a metadata object for class sap.ui.vtm.extensions.SceneNodeHoverTooltipExtension.

getTooltipCallback

Gets current value of property tooltipCallback.

A callback function that gets a tooltip for a given sap.ui.vtm.SceneNode. If unspecified, the scene node name is used for the tooltip text.

The first parameter is the sap.ui.vtm.SceneNode under cursor.
The function should return an object containing a tooltip text for the specified scene node.

  {
    text: [string]
  }
If function returns null no tooltip will be displayed.

setTooltipCallback

Sets a new value for property tooltipCallback.

A callback function that gets a tooltip for a given sap.ui.vtm.SceneNode. If unspecified, the scene node name is used for the tooltip text.

The first parameter is the sap.ui.vtm.SceneNode under cursor.
The function should return an object containing a tooltip text for the specified scene node.

  {
    text: [string]
  }
If function returns null no tooltip will be displayed.

When called with a value of null or undefined, the default value of the property will be restored.

sap.ui.vtm.extensions.SceneNodeHoverTooltipExtension.extend

Creates a new subclass of class sap.ui.vtm.extensions.SceneNodeHoverTooltipExtension 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.vtm.Extension.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

sap.ui.vtm.extensions.SceneNodeHoverTooltipExtension.getMetadata

Returns a metadata object for class sap.ui.vtm.extensions.SceneNodeHoverTooltipExtension.

getTooltipCallback

Gets current value of property tooltipCallback.

A callback function that gets a tooltip for a given sap.ui.vtm.SceneNode. If unspecified, the scene node name is used for the tooltip text.

The first parameter is the sap.ui.vtm.SceneNode under cursor.
The function should return an object containing a tooltip text for the specified scene node.

  {
    text: [string]
  }
If function returns null no tooltip will be displayed.

setTooltipCallback

Sets a new value for property tooltipCallback.

A callback function that gets a tooltip for a given sap.ui.vtm.SceneNode. If unspecified, the scene node name is used for the tooltip text.

The first parameter is the sap.ui.vtm.SceneNode under cursor.
The function should return an object containing a tooltip text for the specified scene node.

  {
    text: [string]
  }
If function returns null no tooltip will be displayed.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
oTooltipCallback any

New value for property tooltipCallback