Row in the PlanningCalendar.
This element holds the data of one row in the PlanningCalendar. Once the header information (e.g. person information) is assigned, the appointments are assigned.
Since: 1.34.0.
Method Summary
sap.m.PlanningCalendarRow.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.PlanningCalendarRow with name sClassName and enriches it with the information contained in oClassInfo. addAppointment(oAppointment)Adds some appointment to the aggregation appointments. addIntervalHeader(oIntervalHeader)Adds some intervalHeader to the aggregation intervalHeaders. getIcon()Gets current value of property icon. getKey()Gets current value of property key. getText()Gets current value of property text. getTitle()Gets current value of property title. 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. removeAppointment(vAppointment)Removes a appointment from the aggregation appointments. setIcon(sIcon)Sets a new value for property icon. setKey(sKey)Sets a new value for property key. setSelected(bSelected)Sets a new value for property selected. setText(sText)Sets a new value for property text. setTitle(sTitle)Sets a new value for property title. $,
addCustomData,
addDependent,
addEventDelegate,
applyFocusInfo,
bindElement,
clone,
data,
destroy,
destroyCustomData,
destroyDependents,
destroyLayoutData,
destroyTooltip,
enhanceAccessibilityState,
exit,
findElements,
fireEvent,
focus,
getCustomData,
getDependents,
getDomRef,
getElementBinding,
getFocusDomRef,
getFocusInfo,
getInterface,
getLayoutData,
getMetadata,
getTooltip,
getTooltip_AsString,
getTooltip_Text,
indexOfCustomData,
indexOfDependent,
init,
insertCustomData,
insertDependent,
prop,
removeAllCustomData,
removeAllDependents,
removeCustomData,
removeDependent,
removeEventDelegate,
rerender,
setLayoutData,
setTooltip,
toString,
unbindElement 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,
invalidate,
isBound,
isInvalidateSuppressed,
isTreeBinding,
propagateMessages,
removeAggregation,
removeAllAggregation,
removeAllAssociation,
removeAssociation,
setAggregation,
setAssociation,
setBindingContext,
setModel,
setProperty,
unbindAggregation,
unbindContext,
unbindObject,
unbindProperty,
validateAggregation,
validateProperty Constructor Detail
new sap.m.PlanningCalendarRow(sId?, mSettings?)
Constructor for a new
PlanningCalendarRow.
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.Element 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.m.PlanningCalendarRow.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.PlanningCalendarRow 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.Element.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.m.PlanningCalendarRow.
Returns:
Adds some appointment to the aggregation appointments.
Parameters:
Returns:
Adds some intervalHeader to the aggregation intervalHeaders.
Parameters:
Returns:
Destroys all the appointments in the aggregation appointments.
Returns:
Destroys all the intervalHeaders in the aggregation intervalHeaders.
Returns:
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:
Gets current value of property
icon.
Icon of the header (e.g. picture of the person)
URI of an image or an icon registered in sap.ui.core.IconPool.
Returns:
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:
getKey(): string
Gets current value of property
key.
Can be used as an identifier of the row
Returns:
| {string} | Value of property key |
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 |
getSelected(): boolean
Gets current value of property
selected.
Defines the selected state of the PlanningCalendarRow. Note: Binding the selected property in single selection modes may cause unwanted results if you have more than one selected row in your binding.
Default value is false.
Returns:
| {boolean} | Value of property selected |
getText(): string
Gets current value of property
text.
Text of the header (e.g. department of the person)
Returns:
| {string} | Value of property text |
getTitle(): string
Gets current value of property
title.
Title of the header (e.g. name of the person)
Returns:
| {string} | Value of property title |
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:
Returns:
| {int} | The 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:
Returns:
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
Inserts a appointment into the aggregation appointments.
Parameters:
| {sap.ui.unified.CalendarAppointment} | oAppointment | the appointment to insert; if empty, nothing is inserted |
| {int} | iIndex | the 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:
Inserts a intervalHeader into the aggregation intervalHeaders.
Parameters:
| {sap.ui.unified.CalendarAppointment} | oIntervalHeader | the intervalHeader to insert; if empty, nothing is inserted |
| {int} | iIndex | the 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:
Removes all the controls from the aggregation
appointments.
Additionally, it unregisters them from the hosting UIArea.
Returns:
Removes all the controls from the aggregation
intervalHeaders.
Additionally, it unregisters them from the hosting UIArea.
Returns:
Removes a appointment from the aggregation appointments.
Parameters:
Returns:
Removes a intervalHeader from the aggregation intervalHeaders.
Parameters:
Returns:
Sets a new value for property
icon.
Icon of the header (e.g. picture of the person)
URI of an image or an icon registered in sap.ui.core.IconPool.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
Returns:
Sets a new value for property
key.
Can be used as an identifier of the row
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {string} | sKey | New value for property key |
Returns:
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[]} | sNonWorkingDays | New value for property nonWorkingDays |
Returns:
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[]} | sNonWorkingHours | New value for property nonWorkingHours |
Returns:
Sets a new value for property
selected.
Defines the selected state of the PlanningCalendarRow. Note: Binding the selected property in single selection modes may cause unwanted results if you have more than one selected row in your binding.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is false.
Parameters:
| {boolean} | bSelected | New value for property selected |
Returns:
Sets a new value for property
text.
Text of the header (e.g. department of the person)
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {string} | sText | New value for property text |
Returns:
Sets a new value for property
title.
Title of the header (e.g. name of the person)
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {string} | sTitle | New value for property title |
Returns: