Class sap.ui.unified.CalendarRowModule: sap/ui/unified/CalendarRow

extends Control

A calendar row with a header and appointments. The Appointments will be placed in the defined interval.
Since: 1.34.0.
Constructor Summary
new sap.ui.unified.CalendarRow(sId?, mSettings?)Constructor for a new CalendarRow.
Event Summary
intervalSelect(oControlEvent)Fired if an interval was selected
leaveRow(oControlEvent)The CalendarRow should be left while navigating.
select(oControlEvent)Fired if an appointment was selected
startDateChange(oControlEvent)startDate was changed while navigating in CalendarRow
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.unified.CalendarRow.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.unified.CalendarRow with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.unified.CalendarRow.getMetadata()Returns a metadata object for class sap.ui.unified.CalendarRow.
addAppointment(oAppointment)Adds some appointment to the aggregation appointments.
addAriaLabelledBy(vAriaLabelledBy)Adds some ariaLabelledBy into the association ariaLabelledBy.
addIntervalHeader(oIntervalHeader)Adds some intervalHeader to the aggregation intervalHeaders.
attachIntervalSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the intervalSelect event of this sap.ui.unified.CalendarRow.
attachLeaveRow(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the leaveRow event of this sap.ui.unified.CalendarRow.
attachSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the select event of this sap.ui.unified.CalendarRow.
attachStartDateChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the startDateChange event of this sap.ui.unified.CalendarRow.
destroyAppointments()Destroys all the appointments in the aggregation appointments.
destroyIntervalHeaders()Destroys all the intervalHeaders in the aggregation intervalHeaders.
detachIntervalSelect(fnFunction, oListener)Detaches event handler fnFunction from the intervalSelect event of this sap.ui.unified.CalendarRow.
detachLeaveRow(fnFunction, oListener)Detaches event handler fnFunction from the leaveRow event of this sap.ui.unified.CalendarRow.
detachSelect(fnFunction, oListener)Detaches event handler fnFunction from the select event of this sap.ui.unified.CalendarRow.
detachStartDateChange(fnFunction, oListener)Detaches event handler fnFunction from the startDateChange event of this sap.ui.unified.CalendarRow.
fireIntervalSelect(mParameters?)Fires event intervalSelect to attached listeners.
fireLeaveRow(mParameters?)Fires event leaveRow to attached listeners.
fireSelect(mParameters?)Fires event select to attached listeners.
fireStartDateChange(mParameters?)Fires event startDateChange to attached listeners.
focusAppointment(oAppointment)Focus the given CalendarAppointment in the CalendarRow.
focusNearestAppointment(oDate)Focus the CalendarAppointment in the CalendarRow that is nearest to the given date.
getAppointments()Gets content of aggregation appointments.
getAriaLabelledBy()Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
getCheckResize()Gets current value of property checkResize.
getFocusedAppointment()Returns the focused CalendarAppointment of the CalendarRow.
getGroupAppointmentsMode()Gets current value of property groupAppointmentsMode.
getHeight()Gets current value of property height.
getIntervalHeaders()Gets content of aggregation intervalHeaders.
getIntervals()Gets current value of property intervals.
getIntervalType()Gets current value of property intervalType.
getLegend()ID of the element which is the current target of the association legend, or null.
getNonWorkingDays()Gets current value of property nonWorkingDays.
getNonWorkingHours()Gets current value of property nonWorkingHours.
getShowEmptyIntervalHeaders()Gets current value of property showEmptyIntervalHeaders.
getShowIntervalHeaders()Gets current value of property showIntervalHeaders.
getShowSubIntervals()Gets current value of property showSubIntervals.
getStartDate()Gets current value of property startDate.
getUpdateCurrentTime()Gets current value of property updateCurrentTime.
getWidth()Gets current value of property width.
handleResize(oEvent)After a resize of the CalendarRow, some calculations for appointment sizes are needed.
indexOfAppointment(oAppointment)Checks for the provided sap.ui.unified.CalendarAppointment in the aggregation appointments.
indexOfIntervalHeader(oIntervalHeader)Checks for the provided sap.ui.unified.CalendarAppointment in the aggregation intervalHeaders.
insertAppointment(oAppointment, iIndex)Inserts a appointment into the aggregation appointments.
insertIntervalHeader(oIntervalHeader, iIndex)Inserts a intervalHeader into the aggregation intervalHeaders.
removeAllAppointments()Removes all the controls from the aggregation appointments.
removeAllAriaLabelledBy()Removes all the controls in the association named ariaLabelledBy.
removeAllIntervalHeaders()Removes all the controls from the aggregation intervalHeaders.
removeAppointment(vAppointment)Removes a appointment from the aggregation appointments.
removeAriaLabelledBy(vAriaLabelledBy)Removes an ariaLabelledBy from the association named ariaLabelledBy.
removeIntervalHeader(vIntervalHeader)Removes a intervalHeader from the aggregation intervalHeaders.
setAppointmentsReducedHeight(bAppointmentsReducedHeight)Sets a new value for property appointmentsReducedHeight.
setAppointmentsVisualization(sAppointmentsVisualization)Sets a new value for property appointmentsVisualization.
setCheckResize(bCheckResize)Sets a new value for property checkResize.
setGroupAppointmentsMode(sGroupAppointmentsMode)Sets a new value for property groupAppointmentsMode.
setHeight(sHeight)Sets a new value for property height.
setIntervals(iIntervals)Sets a new value for property intervals.
setIntervalType(sIntervalType)Sets a new value for property intervalType.
setLegend(oLegend)Sets the associated legend.
setNonWorkingDays(sNonWorkingDays)Sets a new value for property nonWorkingDays.
setNonWorkingHours(sNonWorkingHours)Sets a new value for property nonWorkingHours.
setShowEmptyIntervalHeaders(bShowEmptyIntervalHeaders)Sets a new value for property showEmptyIntervalHeaders.
setShowIntervalHeaders(bShowIntervalHeaders)Sets a new value for property showIntervalHeaders.
setShowSubIntervals(bShowSubIntervals)Sets a new value for property showSubIntervals.
setStartDate(oStartDate)Sets a new value for property startDate.
setUpdateCurrentTime(bUpdateCurrentTime)Sets a new value for property updateCurrentTime.
setWidth(sWidth)Sets a new value for property width.
updateCurrentTimeVisualization()If the current time is in the visible output of the CalendarRow, the indicator for the current time must be positioned.
Constructor Detail
new sap.ui.unified.CalendarRow(sId?, mSettings?)

Constructor for a new CalendarRow.

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:

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
Event Detail
intervalSelect(oControlEvent)
Fired if an interval was selected
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
objectoControlEvent.getParameters.startDateInterval start date as JavaScript date object
objectoControlEvent.getParameters.endDateInterval end date as JavaScript date object
booleanoControlEvent.getParameters.subIntervalIf set, the selected interval is a subinterval
Since:
1.38.0
leaveRow(oControlEvent)
The CalendarRow should be left while navigating. (Arrow up or arrow down.) The caller should determine the next control to be focused
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
stringoControlEvent.getParameters.typeThe type of the event that triggers this leaveRow
select(oControlEvent)
Fired if an appointment was selected
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.ui.unified.CalendarAppointmentoControlEvent.getParameters.appointmentselected appointment
sap.ui.unified.CalendarAppointment[]oControlEvent.getParameters.appointmentsselected appointments in case a group appointment is selected
booleanoControlEvent.getParameters.multiSelectIf set, the appointment was selected by multiple selection (e.g. shift + mouse click). So more than the current appointment could be selected.
startDateChange(oControlEvent)
startDate was changed while navigating in CalendarRow
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
Method Detail
sap.ui.unified.CalendarRow.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.unified.CalendarRow 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.CalendarRow.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.unified.CalendarRow.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addAppointment(oAppointment): sap.ui.unified.CalendarRow
Adds some appointment to the aggregation appointments.
Parameters:
sap.ui.unified.CalendarAppointmentoAppointmentthe appointment to add; if empty, nothing is inserted
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
addAriaLabelledBy(vAriaLabelledBy): sap.ui.unified.CalendarRow
Adds some ariaLabelledBy into the association ariaLabelledBy.
Parameters:
sap.ui.core.ID|sap.ui.core.ControlvAriaLabelledBythe ariaLabelledBy to add; if empty, nothing is inserted
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
addIntervalHeader(oIntervalHeader): sap.ui.unified.CalendarRow
Adds some intervalHeader to the aggregation intervalHeaders.
Parameters:
sap.ui.unified.CalendarAppointmentoIntervalHeaderthe intervalHeader to add; if empty, nothing is inserted
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
attachIntervalSelect(oData?, fnFunction, oListener?): sap.ui.unified.CalendarRow

Attaches event handler fnFunction to the intervalSelect event of this sap.ui.unified.CalendarRow.

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.CalendarRow itself.

Fired if an interval was selected

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarRow itself
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
Since:
1.38.0
attachLeaveRow(oData?, fnFunction, oListener?): sap.ui.unified.CalendarRow

Attaches event handler fnFunction to the leaveRow event of this sap.ui.unified.CalendarRow.

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.CalendarRow itself.

The CalendarRow should be left while navigating. (Arrow up or arrow down.) The caller should determine the next control to be focused

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarRow itself
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
attachSelect(oData?, fnFunction, oListener?): sap.ui.unified.CalendarRow

Attaches event handler fnFunction to the select event of this sap.ui.unified.CalendarRow.

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.CalendarRow itself.

Fired if an appointment was selected

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarRow itself
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
attachStartDateChange(oData?, fnFunction, oListener?): sap.ui.unified.CalendarRow

Attaches event handler fnFunction to the startDateChange event of this sap.ui.unified.CalendarRow.

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.CalendarRow itself.

startDate was changed while navigating in CalendarRow

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.unified.CalendarRow itself
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
destroyAppointments(): sap.ui.unified.CalendarRow
Destroys all the appointments in the aggregation appointments.
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
destroyIntervalHeaders(): sap.ui.unified.CalendarRow
Destroys all the intervalHeaders in the aggregation intervalHeaders.
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
detachIntervalSelect(fnFunction, oListener): sap.ui.unified.CalendarRow

Detaches event handler fnFunction from the intervalSelect event of this sap.ui.unified.CalendarRow.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
Since:
1.38.0
detachLeaveRow(fnFunction, oListener): sap.ui.unified.CalendarRow

Detaches event handler fnFunction from the leaveRow event of this sap.ui.unified.CalendarRow.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
detachSelect(fnFunction, oListener): sap.ui.unified.CalendarRow

Detaches event handler fnFunction from the select event of this sap.ui.unified.CalendarRow.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
detachStartDateChange(fnFunction, oListener): sap.ui.unified.CalendarRow

Detaches event handler fnFunction from the startDateChange event of this sap.ui.unified.CalendarRow.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
fireIntervalSelect(mParameters?): sap.ui.unified.CalendarRow
Fires event intervalSelect to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
objectmParameters.startDate?Interval start date as JavaScript date object
objectmParameters.endDate?Interval end date as JavaScript date object
booleanmParameters.subInterval?If set, the selected interval is a subinterval
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
Since:
1.38.0
fireLeaveRow(mParameters?): sap.ui.unified.CalendarRow
Fires event leaveRow to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
stringmParameters.type?The type of the event that triggers this leaveRow
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
fireSelect(mParameters?): sap.ui.unified.CalendarRow
Fires event select to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.ui.unified.CalendarAppointmentmParameters.appointment?selected appointment
sap.ui.unified.CalendarAppointment[]mParameters.appointments?selected appointments in case a group appointment is selected
booleanmParameters.multiSelect?If set, the appointment was selected by multiple selection (e.g. shift + mouse click). So more than the current appointment could be selected.
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
fireStartDateChange(mParameters?): sap.ui.unified.CalendarRow
Fires event startDateChange to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
focusAppointment(oAppointment): sap.ui.unified.CalendarRow
Focus the given CalendarAppointment in the CalendarRow.
Parameters:
sap.ui.unified.CalendarAppointmentoAppointmentAppointment to be focused.
Returns:
sap.ui.unified.CalendarRowthis to allow method chaining
focusNearestAppointment(oDate): sap.ui.unified.CalendarRow
Focus the CalendarAppointment in the CalendarRow that is nearest to the given date.
Parameters:
objectoDateJavascript Date object.
Returns:
sap.ui.unified.CalendarRowthis to allow method chaining

Gets content of aggregation appointments.

Appointments to be displayed in the row. Appointments outside the visible time frame are not rendered.

Note: For performance reasons, only appointments in the visible time range or nearby should be assigned.

Returns:
sap.ui.unified.CalendarAppointment[]
getAppointmentsReducedHeight(): boolean

Gets current value of property appointmentsReducedHeight.

If set the appointments without text (only title) are rendered with a smaller height.

Note: On phone devices this property is ignored, appointments are always rendered in full height to allow touching.

Default value is false.

Returns:
booleanValue of property appointmentsReducedHeight
Since:
1.38.0
getAppointmentsVisualization(): sap.ui.unified.CalendarAppointmentVisualization

Gets current value of property appointmentsVisualization.

Defines the visualization of the CalendarAppoinment

Note: The real visualization depends on the used theme.

Default value is Standard.

Returns:
sap.ui.unified.CalendarAppointmentVisualizationValue of property appointmentsVisualization
Since:
1.40.0
getAriaLabelledBy(): sap.ui.core.ID[]
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Returns:
sap.ui.core.ID[]
getCheckResize(): boolean

Gets current value of property checkResize.

If set, the CalendarRow checks for resize by itself.

If a lot of CalendarRow controls are used in one container control (like PlanningCalendar). the resize checks should be done only by this container control. Then the container control should call handleResize of the CalendarRow if a resize happens.

Default value is true.

Returns:
booleanValue of property checkResize
getFocusedAppointment(): sap.ui.unified.CalendarAppointment

Returns the focused CalendarAppointment of the CalendarRow.

The focus must not really be on the CalendarAppointment, it have just to be the one that has the focus when the CalendarRow was focused last time.

Returns:
sap.ui.unified.CalendarAppointmentFocused Appointment
getGroupAppointmentsMode(): sap.ui.unified.GroupAppointmentsMode

Gets current value of property groupAppointmentsMode.

Defines the mode in which the overlapping appointments are displayed.

Note: This property takes effect, only if the intervalType of the current calendar view is set to sap.ui.unified.CalendarIntervalType.Month. On phone devices this property is ignored, and the default value is applied.

Default value is Collapsed.

Returns:
sap.ui.unified.GroupAppointmentsModeValue of property groupAppointmentsMode
getHeight(): sap.ui.core.CSSSize

Gets current value of property height.

Height of the row

Returns:
sap.ui.core.CSSSizeValue of property height
getIntervalHeaders(): sap.ui.unified.CalendarAppointment[]

Gets content of aggregation intervalHeaders.

Appointments to be displayed in the top of the intervals. The intervalHeaders are used to visualize public holidays and similar things.

Appointments outside the visible time frame are not rendered.

The intervalHeaders always fill whole intervals. If they are shorter than one interval, they are not displayed.

Note: For performance reasons, only appointments in the visible time range or nearby should be assigned.

Returns:
sap.ui.unified.CalendarAppointment[]
getIntervals(): int

Gets current value of property intervals.

Number of displayed intervals. The size of the intervals is defined with intervalType

Default value is 12.

Returns:
intValue of property intervals

Gets current value of property intervalType.

Type of the intervals of the row. The default is one hour.

Default value is Hour.

Returns:
sap.ui.unified.CalendarIntervalTypeValue of property intervalType
getLegend(): sap.ui.core.ID
ID of the element which is the current target of the association legend, or null.
Returns:
sap.ui.core.ID
Since:
1.40.0
getNonWorkingDays(): int[]

Gets current value of property nonWorkingDays.

If set, the provided weekdays are displayed as non-working days. Valid values inside the array are 0 to 6. (Other values will just be ignored.)

If not set, the weekend defined in the locale settings is displayed as non-working days.

Note: The non working days are only visualized if intervalType is set to day.

Returns:
int[]Value of property nonWorkingDays
getNonWorkingHours(): int[]

Gets current value of property nonWorkingHours.

If set, the provided hours are displayed as non-working hours. Valid values inside the array are 0 to 23. (Other values will just be ignored.)

Note: The non working hours are only visualized if intervalType is set to hour.

Returns:
int[]Value of property nonWorkingHours
getShowEmptyIntervalHeaders(): boolean

Gets current value of property showEmptyIntervalHeaders.

If set, interval headers are shown even if no intervalHeaders are assigned to the visible time frame.

If not set, no interval headers are shown if no intervalHeaders are assigned.

Note: This property is only used if showIntervalHeaders is set to true.

Default value is true.

Returns:
booleanValue of property showEmptyIntervalHeaders
Since:
1.38.0
getShowIntervalHeaders(): boolean

Gets current value of property showIntervalHeaders.

If set, interval headers are shown like specified in showEmptyIntervalHeaders.

If not set, no interval headers are shown even if intervalHeaders are assigned.

Default value is true.

Returns:
booleanValue of property showIntervalHeaders
getShowSubIntervals(): boolean

Gets current value of property showSubIntervals.

If set, subintervals are shown.

If the interval type is Hour, quarter hours are shown.

If the interval type is Day, hours are shown.

If the interval type is Month, days are shown.

Default value is false.

Returns:
booleanValue of property showSubIntervals
getStartDate(): object

Gets current value of property startDate.

Start date, as JavaScript Date object, of the row. As default, the current date is used.

Returns:
objectValue of property startDate
getUpdateCurrentTime(): boolean

Gets current value of property updateCurrentTime.

If set the CalendarRow triggers a periodic update to visualize the current time.

If a lot of CalendarRow controls are used in one container control (like PlanningCalendar) the periodic update should be triggered only by this container control. Then the container control should call updateCurrentTimeVisualization of the CalendarRow to update the visualization.

Default value is true.

Returns:
booleanValue of property updateCurrentTime
getWidth(): sap.ui.core.CSSSize

Gets current value of property width.

Width of the row

Returns:
sap.ui.core.CSSSizeValue of property width
handleResize(oEvent): sap.ui.unified.CalendarRow

After a resize of the CalendarRow, some calculations for appointment sizes are needed.

For this, each CalendarRow can trigger the resize check for it's own DOM. But if multiple CalendarRows are used in one container (e.g. PlanningCalendar), it is better if the container triggers the resize check once and then calls this function of each CalendarRow.

Parameters:
jQuery.EventoEventThe event object of the resize handler.
Returns:
sap.ui.unified.CalendarRowthis to allow method chaining
indexOfAppointment(oAppointment): int
Checks for the provided sap.ui.unified.CalendarAppointment in the aggregation appointments. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.unified.CalendarAppointmentoAppointmentThe appointment whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
indexOfIntervalHeader(oIntervalHeader): int
Checks for the provided sap.ui.unified.CalendarAppointment in the aggregation intervalHeaders. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.unified.CalendarAppointmentoIntervalHeaderThe intervalHeader whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertAppointment(oAppointment, iIndex): sap.ui.unified.CalendarRow
Inserts a appointment into the aggregation appointments.
Parameters:
sap.ui.unified.CalendarAppointmentoAppointmentthe appointment to insert; if empty, nothing is inserted
intiIndexthe 0-based index the appointment should be inserted at; for a negative value of iIndex, the appointment is inserted at position 0; for a value greater than the current size of the aggregation, the appointment is inserted at the last position
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
insertIntervalHeader(oIntervalHeader, iIndex): sap.ui.unified.CalendarRow
Inserts a intervalHeader into the aggregation intervalHeaders.
Parameters:
sap.ui.unified.CalendarAppointmentoIntervalHeaderthe intervalHeader to insert; if empty, nothing is inserted
intiIndexthe 0-based index the intervalHeader should be inserted at; for a negative value of iIndex, the intervalHeader is inserted at position 0; for a value greater than the current size of the aggregation, the intervalHeader is inserted at the last position
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
removeAllAppointments(): sap.ui.unified.CalendarAppointment[]

Removes all the controls from the aggregation appointments.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.unified.CalendarAppointment[]An array of the removed elements (might be empty)
removeAllAriaLabelledBy(): sap.ui.core.ID[]
Removes all the controls in the association named ariaLabelledBy.
Returns:
sap.ui.core.ID[]An array of the removed elements (might be empty)
removeAllIntervalHeaders(): sap.ui.unified.CalendarAppointment[]

Removes all the controls from the aggregation intervalHeaders.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.unified.CalendarAppointment[]An array of the removed elements (might be empty)
removeAppointment(vAppointment): sap.ui.unified.CalendarAppointment
Removes a appointment from the aggregation appointments.
Parameters:
int|string|sap.ui.unified.CalendarAppointmentvAppointmentThe appointment to remove or its index or id
Returns:
sap.ui.unified.CalendarAppointmentThe removed appointment or null
removeAriaLabelledBy(vAriaLabelledBy): sap.ui.core.ID
Removes an ariaLabelledBy from the association named ariaLabelledBy.
Parameters:
int|sap.ui.core.ID|sap.ui.core.ControlvAriaLabelledByThe ariaLabelledBy to be removed or its index or ID
Returns:
sap.ui.core.IDThe removed ariaLabelledBy or null
removeIntervalHeader(vIntervalHeader): sap.ui.unified.CalendarAppointment
Removes a intervalHeader from the aggregation intervalHeaders.
Parameters:
int|string|sap.ui.unified.CalendarAppointmentvIntervalHeaderThe intervalHeader to remove or its index or id
Returns:
sap.ui.unified.CalendarAppointmentThe removed intervalHeader or null
setAppointmentsReducedHeight(bAppointmentsReducedHeight): sap.ui.unified.CalendarRow

Sets a new value for property appointmentsReducedHeight.

If set the appointments without text (only title) are rendered with a smaller height.

Note: On phone devices this property is ignored, appointments are always rendered in full height to allow touching.

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

Default value is false.

Parameters:
booleanbAppointmentsReducedHeightNew value for property appointmentsReducedHeight
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
Since:
1.38.0
setAppointmentsVisualization(sAppointmentsVisualization): sap.ui.unified.CalendarRow

Sets a new value for property appointmentsVisualization.

Defines the visualization of the CalendarAppoinment

Note: The real visualization depends on the used theme.

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

Default value is Standard.

Parameters:
sap.ui.unified.CalendarAppointmentVisualizationsAppointmentsVisualizationNew value for property appointmentsVisualization
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
Since:
1.40.0
setCheckResize(bCheckResize): sap.ui.unified.CalendarRow

Sets a new value for property checkResize.

If set, the CalendarRow checks for resize by itself.

If a lot of CalendarRow controls are used in one container control (like PlanningCalendar). the resize checks should be done only by this container control. Then the container control should call handleResize of the CalendarRow if a resize happens.

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

Default value is true.

Parameters:
booleanbCheckResizeNew value for property checkResize
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
setGroupAppointmentsMode(sGroupAppointmentsMode): sap.ui.unified.CalendarRow

Sets a new value for property groupAppointmentsMode.

Defines the mode in which the overlapping appointments are displayed.

Note: This property takes effect, only if the intervalType of the current calendar view is set to sap.ui.unified.CalendarIntervalType.Month. On phone devices this property is ignored, and the default value is applied.

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

Default value is Collapsed.

Parameters:
sap.ui.unified.GroupAppointmentsModesGroupAppointmentsModeNew value for property groupAppointmentsMode
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
setHeight(sHeight): sap.ui.unified.CalendarRow

Sets a new value for property height.

Height of the row

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

Parameters:
sap.ui.core.CSSSizesHeightNew value for property height
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
setIntervals(iIntervals): sap.ui.unified.CalendarRow

Sets a new value for property intervals.

Number of displayed intervals. The size of the intervals is defined with intervalType

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

Default value is 12.

Parameters:
intiIntervalsNew value for property intervals
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
setIntervalType(sIntervalType): sap.ui.unified.CalendarRow

Sets a new value for property intervalType.

Type of the intervals of the row. The default is one hour.

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

Default value is Hour.

Parameters:
sap.ui.unified.CalendarIntervalTypesIntervalTypeNew value for property intervalType
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
setLegend(oLegend): sap.ui.unified.CalendarRow
Sets the associated legend.
Parameters:
sap.ui.core.ID|sap.ui.unified.CalendarLegendoLegendID of an element which becomes the new target of this legend association; alternatively, an element instance may be given
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
Since:
1.40.0
setNonWorkingDays(sNonWorkingDays): sap.ui.unified.CalendarRow

Sets a new value for property nonWorkingDays.

If set, the provided weekdays are displayed as non-working days. Valid values inside the array are 0 to 6. (Other values will just be ignored.)

If not set, the weekend defined in the locale settings is displayed as non-working days.

Note: The non working days are only visualized if intervalType is set to day.

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

Parameters:
int[]sNonWorkingDaysNew value for property nonWorkingDays
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
setNonWorkingHours(sNonWorkingHours): sap.ui.unified.CalendarRow

Sets a new value for property nonWorkingHours.

If set, the provided hours are displayed as non-working hours. Valid values inside the array are 0 to 23. (Other values will just be ignored.)

Note: The non working hours are only visualized if intervalType is set to hour.

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

Parameters:
int[]sNonWorkingHoursNew value for property nonWorkingHours
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
setShowEmptyIntervalHeaders(bShowEmptyIntervalHeaders): sap.ui.unified.CalendarRow

Sets a new value for property showEmptyIntervalHeaders.

If set, interval headers are shown even if no intervalHeaders are assigned to the visible time frame.

If not set, no interval headers are shown if no intervalHeaders are assigned.

Note: This property is only used if showIntervalHeaders is set to true.

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

Default value is true.

Parameters:
booleanbShowEmptyIntervalHeadersNew value for property showEmptyIntervalHeaders
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
Since:
1.38.0
setShowIntervalHeaders(bShowIntervalHeaders): sap.ui.unified.CalendarRow

Sets a new value for property showIntervalHeaders.

If set, interval headers are shown like specified in showEmptyIntervalHeaders.

If not set, no interval headers are shown even if intervalHeaders are assigned.

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

Default value is true.

Parameters:
booleanbShowIntervalHeadersNew value for property showIntervalHeaders
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
setShowSubIntervals(bShowSubIntervals): sap.ui.unified.CalendarRow

Sets a new value for property showSubIntervals.

If set, subintervals are shown.

If the interval type is Hour, quarter hours are shown.

If the interval type is Day, hours are shown.

If the interval type is Month, days are shown.

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

Default value is false.

Parameters:
booleanbShowSubIntervalsNew value for property showSubIntervals
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
setStartDate(oStartDate): sap.ui.unified.CalendarRow

Sets a new value for property startDate.

Start date, as JavaScript Date object, of the row. As default, the current date is used.

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

Parameters:
objectoStartDateNew value for property startDate
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
setUpdateCurrentTime(bUpdateCurrentTime): sap.ui.unified.CalendarRow

Sets a new value for property updateCurrentTime.

If set the CalendarRow triggers a periodic update to visualize the current time.

If a lot of CalendarRow controls are used in one container control (like PlanningCalendar) the periodic update should be triggered only by this container control. Then the container control should call updateCurrentTimeVisualization of the CalendarRow to update the visualization.

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

Default value is true.

Parameters:
booleanbUpdateCurrentTimeNew value for property updateCurrentTime
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
setWidth(sWidth): sap.ui.unified.CalendarRow

Sets a new value for property width.

Width of the row

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

Parameters:
sap.ui.core.CSSSizesWidthNew value for property width
Returns:
sap.ui.unified.CalendarRowReference to this in order to allow method chaining
updateCurrentTimeVisualization(): sap.ui.unified.CalendarRow

If the current time is in the visible output of the CalendarRow, the indicator for the current time must be positioned.

For this, each CalendarRow can trigger a timer. But if multiple CalendarRows are used in one container (e.G. PlanningCalendar), it is better if the container triggers the interval once and then calls this function of each CalendarRow.

Returns:
sap.ui.unified.CalendarRowthis to allow method chaining