An appointment for use in a PlanningCalendar
or similar. The rendering must be done in the Row collecting the appointments. (Because there are different visualizations possible.)
Applications could inherit from this element to add own fields.
Constructor for a new CalendarAppointment
.
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.CalendarAppointment(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 |
Name | Type | Default Value | Description |
---|---|---|---|
color | sap.ui.core.CSSColor | Overrides the color derived from the |
|
description | string | Description of the appointment. |
|
icon | sap.ui.core.URI | Icon of the Appointment. (e.g. picture of the person) URI of an image or an icon registered in sap.ui.core.IconPool. Visibility: public |
|
key | string | Can be used as identifier of the appointment Visibility: public |
|
selected | boolean | false | Indicates if the icon is selected. Visibility: public |
tentative | boolean | false | Indicates if the icon is tentative. Visibility: public |
text | string | Text of the appointment. Visibility: public |
|
title | string | Title of the appointment. Visibility: public |
Name | Type | Default Value | Description |
---|---|---|---|
color | sap.ui.core.CSSColor | Background color of the |
|
secondaryType | sap.ui.unified.CalendarDayType | None | Applies secondary |
type | sap.ui.unified.CalendarDayType | Type01 | Type of the date range. Visibility: public |
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 |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
customContent | 0..n | sap.ui.core.Control |
Holds the content of the appointment. Note , If the
Since: 1.93.0. |
Method | Description |
---|---|
addCustomContent |
Adds some customContent to the aggregation customContent. |
destroyCustomContent |
Destroys all the customContent in the aggregation customContent. |
sap.ui.unified.CalendarAppointment.extend |
Creates a new subclass of class sap.ui.unified.CalendarAppointment with name
|
getColor |
Gets current value of property color. Overrides the color derived from the |
getCustomContent |
Gets content of aggregation customContent. Holds the content of the appointment. Note , If the
|
getDescription |
Gets current value of property description. Description of the appointment. |
getIcon |
Gets current value of property icon. Icon of the Appointment. (e.g. picture of the person) URI of an image or an icon registered in sap.ui.core.IconPool. |
getKey |
Gets current value of property key. Can be used as identifier of the appointment |
sap.ui.unified.CalendarAppointment.getMetadata |
Returns a metadata object for class sap.ui.unified.CalendarAppointment. |
getSelected |
Gets current value of property selected. Indicates if the icon is selected. Default value is |
getTentative |
Gets current value of property tentative. Indicates if the icon is tentative. Default value is |
getText |
Gets current value of property text. Text of the appointment. |
getTitle |
Gets current value of property title. Title of the appointment. |
indexOfCustomContent |
Checks for the provided |
insertCustomContent |
Inserts a customContent into the aggregation customContent. |
removeAllCustomContent |
Removes all the controls from the aggregation customContent. Additionally, it unregisters them from the hosting UIArea. |
removeCustomContent |
Removes a customContent from the aggregation customContent. |
setColor |
Sets a new value for property color. Overrides the color derived from the When called with a value of |
setDescription |
Sets a new value for property description. Description of the appointment. When called with a value of |
setIcon |
Sets a new value for property icon. Icon of the Appointment. (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 |
setKey |
Sets a new value for property key. Can be used as identifier of the appointment When called with a value of |
setSelected |
Sets a new value for property selected. Indicates if the icon is selected. When called with a value of Default value is |
setTentative |
Sets a new value for property tentative. Indicates if the icon is tentative. When called with a value of Default value is |
setText |
Sets a new value for property text. Text of the appointment. When called with a value of |
setTitle |
Sets a new value for property title. Title of the appointment. When called with a value of |
Adds some customContent to the aggregation customContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
oCustomContent | sap.ui.core.Control |
The customContent to add; if empty, nothing is inserted |
Creates a new subclass of class sap.ui.unified.CalendarAppointment 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.DateTypeRange.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 |
Gets current value of property color.
Overrides the color derived from the type
property. This property will work only with full hex color with pound symbol, e.g.: #FF0000.
Gets content of aggregation customContent.
Holds the content of the appointment.
Note , If the customContent
aggregation is added then:
title
, text
, description
, and icon
properties are ignored.Gets current value of property icon.
Icon of the Appointment. (e.g. picture of the person)
URI of an image or an icon registered in sap.ui.core.IconPool.
Returns a metadata object for class sap.ui.unified.CalendarAppointment.
Gets current value of property selected.
Indicates if the icon is selected.
Default value is false
.
Gets current value of property tentative.
Indicates if the icon is tentative.
Default value is false
.
Checks for the provided sap.ui.core.Control
in the aggregation customContent. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oCustomContent | sap.ui.core.Control |
The customContent whose index is looked for |
Inserts a customContent into the aggregation customContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
oCustomContent | sap.ui.core.Control |
The customContent to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation customContent.
Additionally, it unregisters them from the hosting UIArea.
Removes a customContent from the aggregation customContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
vCustomContent | int string sap.ui.core.Control |
The customContent to remove or its index or id |
Sets a new value for property color.
Overrides the color derived from the type
property. This property will work only with full hex color with pound symbol, e.g.: #FF0000.
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 |
Sets a new value for property description.
Description of the appointment.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sDescription | string |
New value for property |
Sets a new value for property icon.
Icon of the Appointment. (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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIcon | sap.ui.core.URI |
New value for property |
Sets a new value for property key.
Can be used as identifier of the appointment
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sKey | string |
New value for property |
Sets a new value for property selected.
Indicates if the icon is selected.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bSelected | boolean | false |
New value for property |
Sets a new value for property tentative.
Indicates if the icon is tentative.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bTentative | boolean | false |
New value for property |
Sets a new value for property text.
Text of the appointment.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sText | string |
New value for property |
Sets a new value for property title.
Title of the appointment.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitle | string |
New value for property |