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

validateFieldGroup

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

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.

Methods borrowed from class sap.ui.core.Control

Methods borrowed from class sap.ui.core.Element

Methods borrowed from class sap.ui.base.ManagedObject

addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty

Methods borrowed from class sap.ui.base.EventProvider

attachEvent, attachEventOnce, detachEvent, hasListeners

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
- columnWidth : sap.ui.core.CSSSize (default: 120px)
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:

{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.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:

{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.CalendarLegend.getMetadata(): sap.ui.base.Metadata

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

addItem(oItem): sap.ui.unified.CalendarLegend

Adds some item to the aggregation items.

Parameters:

{sap.ui.unified.CalendarLegendItem}

oItem

the item to add; if empty, nothing is inserted

Returns:

{sap.ui.unified.CalendarLegend} Reference to this in order to allow method chaining

destroyItems(): sap.ui.unified.CalendarLegend

Destroys all the items in the aggregation items.

Returns:

{sap.ui.unified.CalendarLegend} Reference to this in order to allow method chaining

getColumnWidth(): sap.ui.core.CSSSize

Gets current value of property columnWidth.

Width of the columns created in which the items are arranged.

Default value is 120px.

Returns:

{sap.ui.core.CSSSize} Value of property columnWidth

getItems(): sap.ui.unified.CalendarLegendItem[]

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.CalendarLegendItem}

oItem

The item whose index is looked for

Returns:

{int}

The 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.CalendarLegendItem}	oItem	the item to insert; if empty, nothing is inserted
{int}	iIndex	the `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.CalendarLegend} Reference to this in order to allow method chaining

removeAllItems(): sap.ui.unified.CalendarLegendItem[]

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)

removeItem(vItem): sap.ui.unified.CalendarLegendItem

Removes a item from the aggregation items.

Parameters:

{int|string|sap.ui.unified.CalendarLegendItem}