class sap.ui.unified.DateTypeRange

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

Date range with calendar day type information. Used to visualize special days in the Calendar.


Constructor

Constructor for a new DateTypeRange.

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.DateTypeRange(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

Background color of the Calendar specialDates aggregation. If set, this color will override the default background color defined in Calendar specialDates aggregation

Since: 1.76.0.

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

Applies secondary CalendarDayType combined with the CalendarDayType type chosen. Allows specialDates to be also a NonWorkingDay. The secondary day type can only be used for NonWorkingDay or None calendar day types. In other cases it will not be visible.

Since: 1.81.0.

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

Type of the date range.

Visibility: public

Borrowed Properties

Name Type Default Value Description
endDate object

End date for a date range. If empty only a single date is presented by this DateRange element. This must be a JavaScript date object.

Visibility: public
startDate object

Start date for a date range. This must be a JavaScript date object.

Visibility: public

Methods Overview

Method Description
sap.ui.unified.DateTypeRange.extend

Creates a new subclass of class sap.ui.unified.DateTypeRange 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.unified.DateRange.extend.

getColor

Gets current value of property color.

Background color of the Calendar specialDates aggregation. If set, this color will override the default background color defined in Calendar specialDates aggregation

sap.ui.unified.DateTypeRange.getMetadata

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

getSecondaryType

Gets current value of property secondaryType.

Applies secondary CalendarDayType combined with the CalendarDayType type chosen. Allows specialDates to be also a NonWorkingDay. The secondary day type can only be used for NonWorkingDay or None calendar day types. In other cases it will not be visible.

Default value is None.

getType

Gets current value of property type.

Type of the date range.

Default value is Type01.

setColor

Sets a new value for property color.

Background color of the Calendar specialDates aggregation. If set, this color will override the default background color defined in Calendar specialDates aggregation

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

setSecondaryType

Sets a new value for property secondaryType.

Applies secondary CalendarDayType combined with the CalendarDayType type chosen. Allows specialDates to be also a NonWorkingDay. The secondary day type can only be used for NonWorkingDay or None calendar day types. In other cases it will not be visible.

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

Default value is None.

setType

Sets a new value for property type.

Type of the date range.

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

Default value is Type01.

sap.ui.unified.DateTypeRange.extend

Creates a new subclass of class sap.ui.unified.DateTypeRange 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.unified.DateRange.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.

Background color of the Calendar specialDates aggregation. If set, this color will override the default background color defined in Calendar specialDates aggregation

sap.ui.unified.DateTypeRange.getMetadata

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

getSecondaryType

Gets current value of property secondaryType.

Applies secondary CalendarDayType combined with the CalendarDayType type chosen. Allows specialDates to be also a NonWorkingDay. The secondary day type can only be used for NonWorkingDay or None calendar day types. In other cases it will not be visible.

Default value is None.

getType

Gets current value of property type.

Type of the date range.

Default value is Type01.

setColor

Sets a new value for property color.

Background color of the Calendar specialDates aggregation. If set, this color will override the default background color defined in Calendar specialDates aggregation

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

setSecondaryType

Sets a new value for property secondaryType.

Applies secondary CalendarDayType combined with the CalendarDayType type chosen. Allows specialDates to be also a NonWorkingDay. The secondary day type can only be used for NonWorkingDay or None calendar day types. In other cases it will not be visible.

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
sSecondaryType sap.ui.unified.CalendarDayType None

New value for property secondaryType

setType

Sets a new value for property type.

Type of the date range.

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

Default value is Type01.

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

New value for property type