CalendarAppointment

extends DateTypeRange

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.

Since: 1.34.0.

Constructor Summary

new sap.ui.unified.CalendarAppointment(sId?, mSettings?)Constructor for a new CalendarAppointment.

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.ui.unified.CalendarAppointment.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.unified.CalendarAppointment with name sClassName and enriches it with the information contained in oClassInfo.

sap.ui.unified.CalendarAppointment.getMetadata()Returns a metadata object for class sap.ui.unified.CalendarAppointment.

getIcon()Gets current value of property icon.

getKey()Gets current value of property key.

getSelected()Gets current value of property selected.

getTentative()Gets current value of property tentative.

getText()Gets current value of property text.

getTitle()Gets current value of property title.

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.

setTentative(bTentative)Sets a new value for property tentative.

setText(sText)Sets a new value for property text.

setTitle(sTitle)Sets a new value for property title.

Methods borrowed from class sap.ui.unified.DateTypeRange

getType, setType

Methods borrowed from class sap.ui.unified.DateRange

getEndDate, getStartDate, setEndDate, setStartDate

Methods borrowed from class sap.ui.core.Element

Methods borrowed from class sap.ui.base.ManagedObject

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

Methods borrowed from class sap.ui.base.EventProvider

attachEvent, attachEventOnce, detachEvent, hasListeners

Constructor Detail

new sap.ui.unified.CalendarAppointment(sId?, mSettings?)

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 for a general description of the syntax of the settings object.

The supported settings are:

Properties
- title : string
- text : string
- icon : sap.ui.core.URI
- tentative : boolean (default: false)
- selected : boolean (default: false)
- key : string

In addition, all settings applicable to the base type sap.ui.unified.DateTypeRange 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.ui.unified.CalendarAppointment.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

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

sap.ui.unified.CalendarAppointment.getMetadata(): sap.ui.base.Metadata

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getIcon(): sap.ui.core.URI

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:

{sap.ui.core.URI} Value of property icon

getKey(): string

Gets current value of property key.

Can be used as identifier of the appointment

Returns:

{string} Value of property key

getSelected(): boolean

Gets current value of property selected.

Indicates if the icon is selected.

Default value is false.

Returns:

{boolean} Value of property selected

getTentative(): boolean

Gets current value of property tentative.

Indicates if the icon is tentative.

Default value is false.

Returns:

{boolean} Value of property tentative

getText(): string

Gets current value of property text.

Text of the appointment.

Returns:

{string} Value of property text

getTitle(): string

Gets current value of property title.

Title of the appointment.

Returns:

{string} Value of property title

setIcon(sIcon): sap.ui.unified.CalendarAppointment

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.

Parameters:

{sap.ui.core.URI} sIcon New value for property icon

Returns:

{sap.ui.unified.CalendarAppointment} Reference to this in order to allow method chaining

setKey(sKey): sap.ui.unified.CalendarAppointment

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.

Parameters:

{string} sKey New value for property key

Returns:

{sap.ui.unified.CalendarAppointment} Reference to this in order to allow method chaining

setSelected(bSelected): sap.ui.unified.CalendarAppointment

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.

Parameters:

{boolean} bSelected New value for property selected

Returns:

{sap.ui.unified.CalendarAppointment} Reference to this in order to allow method chaining

setTentative(bTentative): sap.ui.unified.CalendarAppointment

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.

Parameters:

{boolean} bTentative New value for property tentative

Returns:

{sap.ui.unified.CalendarAppointment} Reference to this in order to allow method chaining

setText(sText): sap.ui.unified.CalendarAppointment

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.

Parameters:

{string} sText New value for property text

Returns:

{sap.ui.unified.CalendarAppointment} Reference to this in order to allow method chaining

setTitle(sTitle): sap.ui.unified.CalendarAppointment

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.

Parameters:

{string} sTitle New value for property title

Returns:

{sap.ui.unified.CalendarAppointment} Reference to this in order to allow method chaining