class sap.ui.unified.CalendarLegendItem

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

Item to be displayed in a CalendarLegend.


Constructor

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#constructor for a general description of the syntax of the settings object.

new sap.ui.unified.CalendarLegendItem(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
color sap.ui.core.CSSColor

Overrides the color derived from the type property.

Since: 1.46.0.

Visibility: public
text string

Text to be displayed for the item.

Visibility: public
type sap.ui.unified.CalendarDayType None

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

Since: 1.28.9.

Visibility: public

Methods Overview

Method Description
sap.ui.unified.CalendarLegendItem.extend

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.

getColor

Gets current value of property color.

Overrides the color derived from the type property.

sap.ui.unified.CalendarLegendItem.getMetadata

Returns a metadata object for class sap.ui.unified.CalendarLegendItem.

getText

Gets current value of property text.

Text to be displayed for the item.

getType

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.

setColor

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.

setText

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.

setType

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.

sap.ui.unified.CalendarLegendItem.extend

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.

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

getColor

Gets current value of property color.

Overrides the color derived from the type property.

sap.ui.unified.CalendarLegendItem.getMetadata

Returns a metadata object for class sap.ui.unified.CalendarLegendItem.

getText

Gets current value of property text.

Text to be displayed for the item.

getType

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.

setColor

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.

Param Type DefaultValue Description
sColor sap.ui.core.CSSColor

New value for property color

setText

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.

Param Type DefaultValue Description
sText string

New value for property text

setType

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.

Param Type DefaultValue Description
sType sap.ui.unified.CalendarDayType None

New value for property type