class sap.ui.core.Title

Control sample: sap.ui.core.Title
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/core/Title
Application Component: CA-UI5-COR

Represents a title element that can be used for aggregation with other controls.


Constructor

Constructor for a new Title.

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.core.Title(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
emphasized boolean false

If set the title is displayed emphasized. This feature is nor supported by all controls using the Title.control.

Visibility: public
icon sap.ui.core.URI

Defines the URL for icon display

Visibility: public
level sap.ui.core.TitleLevel Auto

Defines the level of the title. If set to auto the level of the title is chosen by the control rendering the title.

Currently not all controls using the Title.control supporting this property.

Visibility: public
text string

Defines the title text

Visibility: public

Borrowed Aggregations

Name Cardinality Type Description
customData 0..n sap.ui.core.CustomData

Custom Data, a data structure like a map containing arbitrary key value pairs.

dependents 0..n sap.ui.core.Element

Dependents are not rendered, but their databinding context and lifecycle are bound to the aggregating Element.

Since: 1.19.

dragDropConfig 0..n sap.ui.core.dnd.DragDropBase

Defines the drag-and-drop configuration. Note: This configuration might be ignored due to control metadata restrictions.

Since: 1.56.

layoutData 0..1 sap.ui.core.LayoutData

Defines the layout constraints for this control when it is used inside a Layout. LayoutData classes are typed classes and must match the embedding Layout. See VariantLayoutData for aggregating multiple alternative LayoutData instances to a single Element.

tooltip 0..1 sap.ui.core.TooltipBase

The tooltip that should be shown for this Element.

In the most simple case, a tooltip is a string that will be rendered by the control and displayed by the browser when the mouse pointer hovers over the control's DOM. In this variant, tooltip behaves like a simple control property.

Controls need to explicitly support this kind of tooltip as they have to render it, but most controls do. Exceptions will be documented for the corresponding controls (e.g. sap.ui.core.HTML does not support tooltips).

Alternatively, tooltip can act like a 0..1 aggregation and can be set to a tooltip control (an instance of a subclass of sap.ui.core.TooltipBase). In that case, the framework will take care of rendering the tooltip control in a popup-like manner. Such a tooltip control can display arbitrary content, not only a string.

UI5 currently does not provide a recommended implementation of TooltipBase as the use of content-rich tooltips is discouraged by the Fiori Design Guidelines. Existing subclasses of TooltipBase therefore have been deprecated. However, apps can still subclass from TooltipBase and create their own implementation when needed (potentially taking the deprecated implementations as a starting point).

See the section Using Tooltips in the Fiori Design Guideline.


Methods Overview

Method Description
sap.ui.core.Title.extend

Creates a new subclass of class sap.ui.core.Title 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.Element.extend.

getEmphasized

Gets current value of property emphasized.

If set the title is displayed emphasized. This feature is nor supported by all controls using the Title.control.

Default value is false.

getIcon

Gets current value of property icon.

Defines the URL for icon display

getLevel

Gets current value of property level.

Defines the level of the title. If set to auto the level of the title is chosen by the control rendering the title.

Currently not all controls using the Title.control supporting this property.

Default value is Auto.

sap.ui.core.Title.getMetadata

Returns a metadata object for class sap.ui.core.Title.

getText

Gets current value of property text.

Defines the title text

setEmphasized

Sets a new value for property emphasized.

If set the title is displayed emphasized. This feature is nor supported by all controls using the Title.control.

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

Default value is false.

setIcon

Sets a new value for property icon.

Defines the URL for icon display

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

setLevel

Sets a new value for property level.

Defines the level of the title. If set to auto the level of the title is chosen by the control rendering the title.

Currently not all controls using the Title.control supporting this property.

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

Default value is Auto.

setText

Sets a new value for property text.

Defines the title text

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

sap.ui.core.Title.extend

Creates a new subclass of class sap.ui.core.Title 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.Element.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

getEmphasized

Gets current value of property emphasized.

If set the title is displayed emphasized. This feature is nor supported by all controls using the Title.control.

Default value is false.

getIcon

Gets current value of property icon.

Defines the URL for icon display

getLevel

Gets current value of property level.

Defines the level of the title. If set to auto the level of the title is chosen by the control rendering the title.

Currently not all controls using the Title.control supporting this property.

Default value is Auto.

sap.ui.core.Title.getMetadata

Returns a metadata object for class sap.ui.core.Title.

getText

Gets current value of property text.

Defines the title text

setEmphasized

Sets a new value for property emphasized.

If set the title is displayed emphasized. This feature is nor supported by all controls using the Title.control.

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
bEmphasized boolean false

New value for property emphasized

setIcon

Sets a new value for property icon.

Defines the URL for icon display

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

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

New value for property icon

setLevel

Sets a new value for property level.

Defines the level of the title. If set to auto the level of the title is chosen by the control rendering the title.

Currently not all controls using the Title.control supporting this property.

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

Default value is Auto.

Param Type DefaultValue Description
sLevel sap.ui.core.TitleLevel Auto

New value for property level

setText

Sets a new value for property text.

Defines the title text

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

Param Type DefaultValue Description
sText string

New value for property text