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.
getColor()Gets current value of property color.
getText()Gets current value of property text.
getType()Gets current value of property type.
setColor(sColor)Sets a new value for property color.
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)
    • color : sap.ui.core.CSSColor

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

Parameters:
stringsId?id for the new control, generated automatically if no id is given
objectmSettings?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:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated 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.MetadataMetadata object describing this class

Gets current value of property color.

Overrides the color derived from the type property.

Returns:
sap.ui.core.CSSColorValue of property color
Since:
1.46.0
getText(): string

Gets current value of property text.

Text to be displayed for the item.

Returns:
stringValue 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.

Returns:
sap.ui.unified.CalendarDayTypeValue of property type
Since:
1.28.9

Sets a new value for property color.

Overrides the color derived from the type property.

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

Parameters:
sap.ui.core.CSSColorsColorNew value for property color
Returns:
sap.ui.unified.CalendarLegendItemReference to this in order to allow method chaining
Since:
1.46.0

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:
stringsTextNew value for property text
Returns:
sap.ui.unified.CalendarLegendItemReference 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.CalendarDayTypesTypeNew value for property type
Returns:
sap.ui.unified.CalendarLegendItemReference to this in order to allow method chaining
Since:
1.28.9