Class sap.ui.unified.CalendarLegendItemModule: sap/ui/unified/CalendarLegendItem

extends Element

Item to be displayed in a CalendarLegend.


Since: 1.24.0.
Constructor Summary
new sap.ui.unified.CalendarLegendItem(sId?, mSettings?)Constructor for a new CalendarLegendItem.
Method Summary
sap.ui.unified.CalendarLegendItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.unified.CalendarLegendItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.unified.CalendarLegendItem.getMetadata()Returns a metadata object for class sap.ui.unified.CalendarLegendItem.
getText()Gets current value of property text.
getType()Gets current value of property type.
setText(sText)Sets a new value for property text.
setType(sType)Sets a new value for property type.
Constructor Detail
new sap.ui.unified.CalendarLegendItem(sId?, mSettings?)
Constructor for a new CalendarLegendItem.

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:

  • Properties
    • text : string
    • type : sap.ui.unified.CalendarDayType (default: None)

In addition, all settings applicable to the base type sap.ui.core.Element 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
Method Detail
sap.ui.unified.CalendarLegendItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.unified.CalendarLegendItem 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.

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.unified.CalendarLegendItem.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.unified.CalendarLegendItem.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getText(): string
Gets current value of property text.

Text to be displayed for the item.

Returns:
{string} Value of property text
Gets current value of property type.

Type of the item. If not set the type is automatically determined from the order of the items in the CalendarLegend.

Default value is None.

Since:
1.28.9
Returns:
{sap.ui.unified.CalendarDayType} Value of property type
Sets a new value for property text.

Text to be displayed for the item.

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

Parameters:
{string}sText New value for property text
Returns:
{sap.ui.unified.CalendarLegendItem} Reference to this in order to allow method chaining
Sets a new value for property type.

Type of the item. If not set the type is automatically determined from the order of the items in the CalendarLegend.

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

Default value is None.

Parameters:
{sap.ui.unified.CalendarDayType}sType New value for property type
Since:
1.28.9
Returns:
{sap.ui.unified.CalendarLegendItem} Reference to this in order to allow method chaining