Class sap.ui.unified.CalendarLegendModule: sap/ui/unified/CalendarLegend

extends Control

A legend for the Calendar Control. Displays special dates colors with their corresponding description. The aggregation specialDates can be set herefor.
Since: 1.24.0.
Constructor Summary
new sap.ui.unified.CalendarLegend(sId?, mSettings?)Constructor for a new CalendarLegend.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.unified.CalendarLegend.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.unified.CalendarLegend with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.unified.CalendarLegend.getMetadata()Returns a metadata object for class sap.ui.unified.CalendarLegend.
addItem(oItem)Adds some item to the aggregation items.
destroyItems()Destroys all the items in the aggregation items.
getColumnWidth()Gets current value of property columnWidth.
getItems()Gets content of aggregation items.
indexOfItem(oItem)Checks for the provided sap.ui.unified.CalendarLegendItem in the aggregation items.
insertItem(oItem, iIndex)Inserts a item into the aggregation items.
removeAllItems()Removes all the controls from the aggregation items.
removeItem(vItem)Removes a item from the aggregation items.
setColumnWidth(sColumnWidth)Sets a new value for property columnWidth.
Constructor Detail
new sap.ui.unified.CalendarLegend(sId?, mSettings?)

Constructor for a new CalendarLegend.

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

  • Aggregations

    • items : sap.ui.unified.CalendarLegendItem[]

In addition, all settings applicable to the base type sap.ui.core.Control 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.CalendarLegend.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.unified.CalendarLegend 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.Control.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.CalendarLegend.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.unified.CalendarLegend.
Returns:
sap.ui.base.MetadataMetadata object describing this class
Adds some item to the aggregation items.
Parameters:
sap.ui.unified.CalendarLegendItemoItemthe item to add; if empty, nothing is inserted
Returns:
sap.ui.unified.CalendarLegendReference to this in order to allow method chaining
Destroys all the items in the aggregation items.
Returns:
sap.ui.unified.CalendarLegendReference to this in order to allow method chaining
getColumnWidth(): sap.ui.core.CSSSize

Gets current value of property columnWidth.

Defines the width of the created columns in which the items are arranged.

Default value is 120px.

Returns:
sap.ui.core.CSSSizeValue of property columnWidth

Gets content of aggregation items.

Items to be displayed.

Returns:
sap.ui.unified.CalendarLegendItem[]
indexOfItem(oItem): int
Checks for the provided sap.ui.unified.CalendarLegendItem in the aggregation items. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.unified.CalendarLegendItemoItemThe item whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertItem(oItem, iIndex): sap.ui.unified.CalendarLegend
Inserts a item into the aggregation items.
Parameters:
sap.ui.unified.CalendarLegendItemoItemthe item to insert; if empty, nothing is inserted
intiIndexthe 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
Returns:
sap.ui.unified.CalendarLegendReference to this in order to allow method chaining

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.unified.CalendarLegendItem[]An array of the removed elements (might be empty)
Removes a item from the aggregation items.
Parameters:
int|string|sap.ui.unified.CalendarLegendItemvItemThe item to remove or its index or id
Returns:
sap.ui.unified.CalendarLegendItemThe removed item or null
setColumnWidth(sColumnWidth): sap.ui.unified.CalendarLegend

Sets a new value for property columnWidth.

Defines the width of the created columns in which the items are arranged.

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

Default value is 120px.

Parameters:
sap.ui.core.CSSSizesColumnWidthNew value for property columnWidth
Returns:
sap.ui.unified.CalendarLegendReference to this in order to allow method chaining