Class sap.ui.commons.RichTooltipModule: sap/ui/commons/RichTooltip

extends TooltipBase

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

Deprecated API:Since version 1.38. Instead, use the sap.m.Popover control.

Constructor Summary
new sap.ui.commons.RichTooltip(sId?, mSettings?)Constructor for a new RichTooltip.
Events borrowed from class sap.ui.core.TooltipBase
closed
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.commons.RichTooltip.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.RichTooltip with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.RichTooltip.getMetadata()Returns a metadata object for class sap.ui.commons.RichTooltip.
getImageAltText()Gets current value of property imageAltText.
getImageSrc()Gets current value of property imageSrc.
getTitle()Gets current value of property title.
getValueStateText()This returns the previously set text.
onAfterRendering()Calculates the height of the RichTooltip to set a proper min-height.
setImageAltText(sImageAltText)Sets a new value for property imageAltText.
setImageSrc(sImageSrc)Sets a new value for property imageSrc.
setTitle(sTitle)Sets a new value for property title.
setValueStateText(sText)This sets an individual text for the ValueState of the parent element of the RichTooltip.
Methods borrowed from class sap.ui.core.TooltipBase
attachClosed, detachClosed, fireClosed, getAtPosition, getCloseDelay, getCloseDuration, getCollision, getMyPosition, getOffset, getOpenDelay, getOpenDuration, getText, setAtPosition, setCloseDelay, setCloseDuration, setCollision, setMyPosition, setOffset, setOpenDelay, setOpenDuration, setText
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.commons.RichTooltip(sId?, mSettings?)
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 for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.ui.core.TooltipBase can be used as well.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Deprecated:
Since version 1.38. Instead, use the sap.m.Popover control.
Method Detail
sap.ui.commons.RichTooltip.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.ui.commons.RichTooltip.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.RichTooltip.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getImageAltText(): string
Gets current value of property imageAltText.

This is the alt text for the image

Since:
1.11.1
Returns:
{string} Value of property imageAltText
getImageSrc(): sap.ui.core.URI
Gets current value of property imageSrc.

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

Returns:
{sap.ui.core.URI} Value of property imageSrc
getTitle(): string
Gets current value of property title.

Tool tip title to be displayed in the header.

Returns:
{string} Value of property title
getValueStateText(): string
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.
Returns:
{string} the ValueState text that was previously set.
onAfterRendering()
Calculates the height of the RichTooltip to set a proper min-height. Additionally the ARIA attributes are set to the corresponding elements.
setImageAltText(sImageAltText): sap.ui.commons.RichTooltip
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.

Parameters:
{string}sImageAltText New value for property imageAltText
Since:
1.11.1
Returns:
{sap.ui.commons.RichTooltip} Reference to this in order to allow method chaining
setImageSrc(sImageSrc): sap.ui.commons.RichTooltip
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.

Parameters:
{sap.ui.core.URI}sImageSrc New value for property imageSrc
Returns:
{sap.ui.commons.RichTooltip} Reference to this in order to allow method chaining
setTitle(sTitle): sap.ui.commons.RichTooltip
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.

Parameters:
{string}sTitle New value for property title
Returns:
{sap.ui.commons.RichTooltip} Reference to this in order to allow method chaining
setValueStateText(sText): sap.ui.commons.RichTooltip
This sets an individual text for the ValueState of the parent element of the RichTooltip.
Parameters:
{string}sText the text that should be shown as individual ValueState text
Returns:
{sap.ui.commons.RichTooltip} Returns this to facilitate method chaining.