CalendarLegend

Legend for the calendar control

Deprecated API:Since version 1.34.0. This control was experimental since 1.12. Please use the sap.ui.unified.CalendarLegend instead!

Constructor Summary

new sap.me.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.me.CalendarLegend.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.me.CalendarLegend with name sClassName and enriches it with the information contained in oClassInfo.

sap.me.CalendarLegend.getMetadata()Returns a metadata object for class sap.me.CalendarLegend.

getDesign()Gets current value of property design.

getExpandable()Gets current value of property expandable.

getExpanded()Gets current value of property expanded.

getLegendForNormal()Gets current value of property legendForNormal.

getLegendForSelected()Gets current value of property legendForSelected.

getLegendForSelected00()Gets current value of property legendForSelected00.

getLegendForToday()Gets current value of property legendForToday.

getLegendForType00()Gets current value of property legendForType00.

getLegendForType01()Gets current value of property legendForType01.

getLegendForType04()Gets current value of property legendForType04.

getLegendForType06()Gets current value of property legendForType06.

getLegendForType07()Gets current value of property legendForType07.

getLegendWidth()Gets current value of property legendWidth.

getVisible()Gets current value of property visible.

getWidth()Gets current value of property width.

setDesign(sDesign)Sets a new value for property design.

setExpandable(bExpandable)Sets a new value for property expandable.

setExpanded(bExpanded)Sets a new value for property expanded.

setLegendForNormal(sLegendForNormal)Sets a new value for property legendForNormal.

setLegendForSelected(sLegendForSelected)Sets a new value for property legendForSelected.

setLegendForSelected00(sLegendForSelected00)Sets a new value for property legendForSelected00.

setLegendForToday(sLegendForToday)Sets a new value for property legendForToday.

setLegendForType00(sLegendForType00)Sets a new value for property legendForType00.

setLegendForType01(sLegendForType01)Sets a new value for property legendForType01.

setLegendForType04(sLegendForType04)Sets a new value for property legendForType04.

setLegendForType06(sLegendForType06)Sets a new value for property legendForType06.

setLegendForType07(sLegendForType07)Sets a new value for property legendForType07.

setLegendWidth(sLegendWidth)Sets a new value for property legendWidth.

setVisible(bVisible)Sets a new value for property visible.

setWidth(sWidth)Sets a new value for property width.

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.me.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
- legendForType00 : string
- legendForType01 : string
- legendForType04 : string
- legendForType06 : string
- legendForType07 : string
- legendForToday : string
- legendForSelected : string
- legendForSelected00 : string
- legendForNormal : string
- expandable : boolean (default: true)
- expanded : boolean (default: true)
- width : sap.ui.core.CSSSize (default: auto)
- legendWidth : sap.ui.core.CSSSize (default: 12.5rem)
- visible : boolean (default: true)
- design : sap.me.CalendarDesign (default: Approval)
Aggregations

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

Deprecated:
Since version 1.34.0. This control was experimental since 1.12. Please use the sap.ui.unified.CalendarLegend instead!

Method Detail

sap.me.CalendarLegend.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.me.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.me.CalendarLegend.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.me.CalendarLegend.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getDesign(): sap.me.CalendarDesign

Gets current value of property design.

design name for the legend

Default value is Approval.

Returns:

{sap.me.CalendarDesign} Value of property design

getExpandable(): boolean

Gets current value of property expandable.

Indicates if the legend can be collapsed and expanded

Default value is true.

Returns:

{boolean} Value of property expandable

getExpanded(): boolean

Gets current value of property expanded.

Indicates if the legend is expanded or not

Default value is true.

Returns:

{boolean} Value of property expanded

getLegendForNormal(): string

Gets current value of property legendForNormal.

legend for normal

Returns:

{string} Value of property legendForNormal

getLegendForSelected(): string

Gets current value of property legendForSelected.

legend for selected

Returns:

{string} Value of property legendForSelected

getLegendForSelected00(): string

Gets current value of property legendForSelected00.

legend for selected 00

Returns:

{string} Value of property legendForSelected00

getLegendForToday(): string

Gets current value of property legendForToday.

legend for today

Returns:

{string} Value of property legendForToday

getLegendForType00(): string

Gets current value of property legendForType00.

legend for type 00

Returns:

{string} Value of property legendForType00

getLegendForType01(): string

Gets current value of property legendForType01.

legend for type 01

Returns:

{string} Value of property legendForType01

getLegendForType04(): string

Gets current value of property legendForType04.

legend for type 04

Returns:

{string} Value of property legendForType04

getLegendForType06(): string

Gets current value of property legendForType06.

legend for type 06

Returns:

{string} Value of property legendForType06

getLegendForType07(): string

Gets current value of property legendForType07.

legend for type 07

Returns:

{string} Value of property legendForType07

getLegendWidth(): sap.ui.core.CSSSize

Gets current value of property legendWidth.

Indicates the legend items width

Default value is 12.5rem.

Returns:

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

getVisible(): boolean

Gets current value of property visible.

Indicates if the legend is visible

Default value is true.

Returns:

{boolean} Value of property visible

getWidth(): sap.ui.core.CSSSize

Gets current value of property width.

Indicates the whole component width

Default value is auto.

Returns:

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

setDesign(sDesign): sap.me.CalendarLegend

Sets a new value for property design.

design name for the legend

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

Default value is Approval.

Parameters:

{sap.me.CalendarDesign} sDesign New value for property design

Returns:

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

setExpandable(bExpandable): sap.me.CalendarLegend

Sets a new value for property expandable.

Indicates if the legend can be collapsed and expanded

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

Default value is true.

Parameters:

{boolean} bExpandable New value for property expandable

Returns:

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

setExpanded(bExpanded): sap.me.CalendarLegend

Sets a new value for property expanded.

Indicates if the legend is expanded or not

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

Default value is true.

Parameters:

{boolean} bExpanded New value for property expanded

Returns:

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

setLegendForNormal(sLegendForNormal): sap.me.CalendarLegend

Sets a new value for property legendForNormal.

legend for normal

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

Parameters:

{string} sLegendForNormal New value for property legendForNormal

Returns:

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

setLegendForSelected(sLegendForSelected): sap.me.CalendarLegend

Sets a new value for property legendForSelected.

legend for selected

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

Parameters:

{string} sLegendForSelected New value for property legendForSelected

Returns:

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

setLegendForSelected00(sLegendForSelected00): sap.me.CalendarLegend

Sets a new value for property legendForSelected00.

legend for selected 00

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

Parameters:

{string} sLegendForSelected00 New value for property legendForSelected00

Returns:

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

setLegendForToday(sLegendForToday): sap.me.CalendarLegend

Sets a new value for property legendForToday.

legend for today

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

Parameters:

{string} sLegendForToday New value for property legendForToday

Returns:

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

setLegendForType00(sLegendForType00): sap.me.CalendarLegend

Sets a new value for property legendForType00.

legend for type 00

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

Parameters:

{string} sLegendForType00 New value for property legendForType00

Returns:

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

setLegendForType01(sLegendForType01): sap.me.CalendarLegend

Sets a new value for property legendForType01.

legend for type 01

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

Parameters:

{string} sLegendForType01 New value for property legendForType01

Returns:

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

setLegendForType04(sLegendForType04): sap.me.CalendarLegend

Sets a new value for property legendForType04.

legend for type 04

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

Parameters:

{string} sLegendForType04 New value for property legendForType04

Returns:

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

setLegendForType06(sLegendForType06): sap.me.CalendarLegend

Sets a new value for property legendForType06.

legend for type 06

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

Parameters:

{string} sLegendForType06 New value for property legendForType06

Returns:

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

setLegendForType07(sLegendForType07): sap.me.CalendarLegend

Sets a new value for property legendForType07.

legend for type 07

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

Parameters:

{string} sLegendForType07 New value for property legendForType07

Returns:

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

setLegendWidth(sLegendWidth): sap.me.CalendarLegend

Sets a new value for property legendWidth.

Indicates the legend items width

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

Default value is 12.5rem.

Parameters:

{sap.ui.core.CSSSize} sLegendWidth New value for property legendWidth

Returns:

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

setVisible(bVisible): sap.me.CalendarLegend

Sets a new value for property visible.

Indicates if the legend is visible

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

Default value is true.

Parameters:

{boolean} bVisible New value for property visible

Returns:

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

setWidth(sWidth): sap.me.CalendarLegend

Sets a new value for property width.

Indicates the whole component width

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

Default value is auto.

Parameters:

{sap.ui.core.CSSSize} sWidth New value for property width

Returns:

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