sap.ui.unified.CalendarMonthInterval.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.unified.CalendarMonthInterval 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 |
Returns a metadata object for class sap.ui.unified.CalendarMonthInterval.
Returns:
Adds some ariaLabelledBy into the association ariaLabelledBy.
Parameters:
| {string|sap.ui.core.Control} | vAriaLabelledBy | the ariaLabelledBy to add; if empty, nothing is inserted |
Returns:
Adds some selectedDate to the aggregation selectedDates.
Parameters:
Returns:
Adds some specialDate to the aggregation specialDates.
Parameters:
Returns:
Attaches event handler
fnFunction to the
cancel event of this
sap.ui.unified.CalendarMonthInterval.
When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.unified.CalendarMonthInterval itself.
Month selection was cancelled
Parameters:
| {object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
| {function} | fnFunction | The function to be called when the event occurs |
| {object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarMonthInterval itself |
Returns:
Attaches event handler
fnFunction to the
select event of this
sap.ui.unified.CalendarMonthInterval.
When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.unified.CalendarMonthInterval itself.
Month selection changed
Parameters:
| {object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
| {function} | fnFunction | The function to be called when the event occurs |
| {object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarMonthInterval itself |
Returns:
Attaches event handler
fnFunction to the
startDateChange event of this
sap.ui.unified.CalendarMonthInterval.
When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.unified.CalendarMonthInterval itself.
startDate was changed while navigation in CalendarMonthInterval
Parameters:
| {object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
| {function} | fnFunction | The function to be called when the event occurs |
| {object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarMonthInterval itself |
- Since:
- 1.34.0
Returns:
Destroys all the selectedDates in the aggregation selectedDates.
Returns:
Destroys all the specialDates in the aggregation specialDates.
Returns:
Detaches event handler
fnFunction from the
cancel event of this
sap.ui.unified.CalendarMonthInterval.
The passed function and listener object must match the ones used for event registration.
Parameters:
| {function} | fnFunction | The function to be called, when the event occurs |
| {object} | oListener | Context object on which the given function had to be called |
Returns:
Detaches event handler
fnFunction from the
select event of this
sap.ui.unified.CalendarMonthInterval.
The passed function and listener object must match the ones used for event registration.
Parameters:
| {function} | fnFunction | The function to be called, when the event occurs |
| {object} | oListener | Context object on which the given function had to be called |
Returns:
Detaches event handler
fnFunction from the
startDateChange event of this
sap.ui.unified.CalendarMonthInterval.
The passed function and listener object must match the ones used for event registration.
Parameters:
| {function} | fnFunction | The function to be called, when the event occurs |
| {object} | oListener | Context object on which the given function had to be called |
- Since:
- 1.34.0
Returns:
Displays a month in the CalendarMonthInterval but doesn't set the focus.
Parameters:
| {object} | oDate | JavaScript date object for displayed date. (The month of this date will be displayed.) |
Returns:
Fires event cancel to attached listeners.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event select to attached listeners.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event startDateChange to attached listeners.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
- Since:
- 1.34.0
Returns:
Sets the focused month of the CalendarMonthInterval.
Parameters:
| {object} | oDate | JavaScript date object for focused date. (The month of this date will be focused.) |
Returns:
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Returns:
getIntervalSelection(): boolean
Gets current value of property
intervalSelection.
If set, interval selection is allowed
Default value is false.
Returns:
| {boolean} | Value of property intervalSelection |
ID of the element which is the current target of the association legend, or null.
- Since:
- 1.38.5
Returns:
getMaxDate(): object
Gets current value of property
maxDate.
Maximum date that can be shown and selected in the Calendar. This must be a JavaScript date object.
Note: If the maxDate is set to be before the minDate, the minDate is set to the begin of the month of the maxDate.
- Since:
- 1.38.0
Returns:
| {object} | Value of property maxDate |
getMinDate(): object
Gets current value of property
minDate.
Minimum date that can be shown and selected in the Calendar. This must be a JavaScript date object.
Note: If the minDate is set to be after the maxDate, the maxDate is set to the end of the month of the minDate.
- Since:
- 1.38.0
Returns:
| {object} | Value of property minDate |
getMonths(): int
Gets current value of property
months.
Number of months displayed
Note: On phones, the maximum number of months displayed in the row is always 6.
Default value is 12.
Returns:
| {int} | Value of property months |
getPickerPopup(): boolean
Gets current value of property
pickerPopup.
If set, the yearPicker opens on a popup
Default value is false.
- Since:
- 1.34.0
Returns:
| {boolean} | Value of property pickerPopup |
Gets content of aggregation
selectedDates.
Date ranges for selected dates of the CalendarMonthInterval.
If singleSelection is set, only the first entry is used.
Note: Even if only one day is selected, the whole corresponding month is selected.
Returns:
getSingleSelection(): boolean
Gets current value of property
singleSelection.
If set, only a single date or interval, if intervalSelection is enabled, can be selected
Note: Selection of multiple intervals is not supported in the current version.
Default value is true.
Returns:
| {boolean} | Value of property singleSelection |
Gets content of aggregation
specialDates.
Date ranges with type to visualize special months in the CalendarMonthInterval. If one day is assigned to more than one type, only the first one will be used.
Note: Even if only one day is set as a special day, the whole corresponding month is displayed in this way.
Returns:
getStartDate(): object
Gets current value of property
startDate.
Start date of the Interval as JavaScript Date object. The month of this Date will be the first month in the displayed row.
Returns:
| {object} | Value of property startDate |
Gets current value of property
width.
Width of the CalendarMonthInterval. The width of the single months depends on this width.
Returns:
indexOfSelectedDate(oSelectedDate): int
Checks for the provided sap.ui.unified.DateRange in the aggregation selectedDates. and returns its index if found or -1 otherwise.
Parameters:
Returns:
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
indexOfSpecialDate(oSpecialDate): int
Checks for the provided sap.ui.unified.DateTypeRange in the aggregation specialDates. and returns its index if found or -1 otherwise.
Parameters:
Returns:
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
Inserts a selectedDate into the aggregation selectedDates.
Parameters:
| {sap.ui.unified.DateRange} | oSelectedDate | the selectedDate to insert; if empty, nothing is inserted |
| {int} | iIndex | the 0-based index the selectedDate should be inserted at; for a negative value of iIndex, the selectedDate is inserted at position 0; for a value greater than the current size of the aggregation, the selectedDate is inserted at the last position |
Returns:
Inserts a specialDate into the aggregation specialDates.
Parameters:
| {sap.ui.unified.DateTypeRange} | oSpecialDate | the specialDate to insert; if empty, nothing is inserted |
| {int} | iIndex | the 0-based index the specialDate should be inserted at; for a negative value of iIndex, the specialDate is inserted at position 0; for a value greater than the current size of the aggregation, the specialDate is inserted at the last position |
Returns:
Removes all the controls in the association named ariaLabelledBy.
Returns:
Removes all the controls from the aggregation
selectedDates.
Additionally, it unregisters them from the hosting UIArea.
Returns:
Removes all the controls from the aggregation
specialDates.
Additionally, it unregisters them from the hosting UIArea.
Returns:
Removes an ariaLabelledBy from the association named ariaLabelledBy.
Parameters:
| {int|string|sap.ui.core.Control} | vAriaLabelledBy | The ariaLabelledByto be removed or its index or ID |
Returns:
Removes a selectedDate from the aggregation selectedDates.
Parameters:
Returns:
Removes a specialDate from the aggregation specialDates.
Parameters:
Returns:
Sets a new value for property
intervalSelection.
If set, interval selection is allowed
When called with a value of null or undefined, the default value of the property will be restored.
Default value is false.
Parameters:
| {boolean} | bIntervalSelection | New value for property intervalSelection |
Returns:
Sets the associated legend.
Parameters:
| {sap.ui.unified.CalendarLegend} | oLegend | Id of an element which becomes the new target of this legend association; alternatively, an element instance may be given |
- Since:
- 1.38.5
Returns:
Sets a new value for property
maxDate.
Maximum date that can be shown and selected in the Calendar. This must be a JavaScript date object.
Note: If the maxDate is set to be before the minDate, the minDate is set to the begin of the month of the maxDate.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {object} | oMaxDate | New value for property maxDate |
- Since:
- 1.38.0
Returns:
Sets a new value for property
minDate.
Minimum date that can be shown and selected in the Calendar. This must be a JavaScript date object.
Note: If the minDate is set to be after the maxDate, the maxDate is set to the end of the month of the minDate.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {object} | oMinDate | New value for property minDate |
- Since:
- 1.38.0
Returns:
Sets a new value for property
months.
Number of months displayed
Note: On phones, the maximum number of months displayed in the row is always 6.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is 12.
Parameters:
| {int} | iMonths | New value for property months |
Returns:
Sets a new value for property
pickerPopup.
If set, the yearPicker opens on a popup
When called with a value of null or undefined, the default value of the property will be restored.
Default value is false.
Parameters:
| {boolean} | bPickerPopup | New value for property pickerPopup |
- Since:
- 1.34.0
Returns:
Sets a new value for property
singleSelection.
If set, only a single date or interval, if intervalSelection is enabled, can be selected
Note: Selection of multiple intervals is not supported in the current version.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is true.
Parameters:
| {boolean} | bSingleSelection | New value for property singleSelection |
Returns:
Sets a new value for property
startDate.
Start date of the Interval as JavaScript Date object. The month of this Date will be the first month in the displayed row.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {object} | oStartDate | New value for property startDate |
Returns:
Sets a new value for property
width.
Width of the CalendarMonthInterval. The width of the single months depends on this width.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
Returns: