class sap.ui.commons.RichTooltip

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/commons/RichTooltip
Application Component: CA-UI5-CTR

Is used to provide tool tips that can have long text, image and title. This tool tip extends the TooltipBase.


Constructor

Constructor for a new RichTooltip.

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.commons.RichTooltip(sId?, mSettings?)
Param Type Default Value Description
sId? string

id for the new control, generated automatically if no id is given

mSettings? object

initial settings for the new control


Properties

Name Type Default Value Description
imageAltText string

This is the alt text for the image

Since: 1.11.1.

Visibility: public
imageSrc sap.ui.core.URI

If RichTooltip contains an image, this property is used to define the source path.

Visibility: public
title string

Tool tip title to be displayed in the header.

Visibility: public
valueStateText string

This property is an individual text that will be used instead of the default ValueState text

Since: 1.11.1.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
formattedText 0..1 sap.ui.commons.FormattedTextView

FormattedTextView control used in the content area to enable HTML-text within the content

individualStateText 0..1 sap.ui.commons.FormattedTextView

Value State Text that can be specified individually.


Methods Overview

Method Description
sap.ui.commons.RichTooltip.extend

Creates a new subclass of class sap.ui.commons.RichTooltip 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.core.TooltipBase.extend.

getImageAltText

Gets current value of property imageAltText.

This is the alt text for the image

getImageSrc

Gets current value of property imageSrc.

If RichTooltip contains an image, this property is used to define the source path.

sap.ui.commons.RichTooltip.getMetadata

Returns a metadata object for class sap.ui.commons.RichTooltip.

getTitle

Gets current value of property title.

Tool tip title to be displayed in the header.

getValueStateText

This returns the previously set text. Since a FormattedTextView is used for rendering and stuff the corresponding property of the FormattedTextView is being read and returned. If no text was set an empty string is being returned.

onAfterRendering

Calculates the height of the RichTooltip to set a proper min-height. Additionally the ARIA attributes are set to the corresponding elements.

setImageAltText

Sets a new value for property imageAltText.

This is the alt text for the image

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

setImageSrc

Sets a new value for property imageSrc.

If RichTooltip contains an image, this property is used to define the source path.

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

setTitle

Sets a new value for property title.

Tool tip title to be displayed in the header.

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

setValueStateText

This sets an individual text for the ValueState of the parent element of the RichTooltip.

sap.ui.commons.RichTooltip.extend

Creates a new subclass of class sap.ui.commons.RichTooltip 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.core.TooltipBase.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

getImageAltText

Gets current value of property imageAltText.

This is the alt text for the image

getImageSrc

Gets current value of property imageSrc.

If RichTooltip contains an image, this property is used to define the source path.

sap.ui.commons.RichTooltip.getMetadata

Returns a metadata object for class sap.ui.commons.RichTooltip.

getTitle

Gets current value of property title.

Tool tip title to be displayed in the header.

getValueStateText

This returns the previously set text. Since a FormattedTextView is used for rendering and stuff the corresponding property of the FormattedTextView is being read and returned. If no text was set an empty string is being returned.

onAfterRendering

Calculates the height of the RichTooltip to set a proper min-height. Additionally the ARIA attributes are set to the corresponding elements.

setImageAltText

Sets a new value for property imageAltText.

This is the alt text for the image

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

Param Type DefaultValue Description
sImageAltText string

New value for property imageAltText

setImageSrc

Sets a new value for property imageSrc.

If RichTooltip contains an image, this property is used to define the source path.

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

Param Type DefaultValue Description
sImageSrc sap.ui.core.URI

New value for property imageSrc

setTitle

Sets a new value for property title.

Tool tip title to be displayed in the header.

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

Param Type DefaultValue Description
sTitle string

New value for property title

setValueStateText

This sets an individual text for the ValueState of the parent element of the RichTooltip.

Param Type DefaultValue Description
sText string

the text that should be shown as individual ValueState text