PlanningCalendarView

View of the PlanningCalendar.

The PlanningCalendarView defines the granularity of the output. It defines what type of intervals (hours, days or months) and how many intervals are shown.

Since: 1.34.0.

Constructor Summary

new sap.m.PlanningCalendarView(sId?, mSettings?)Constructor for a new PlanningCalendarView.

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

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

sap.m.PlanningCalendarView.getMetadata()Returns a metadata object for class sap.m.PlanningCalendarView.

getDescription()Gets current value of property description.

getIntervalsL()Gets current value of property intervalsL.

getIntervalsM()Gets current value of property intervalsM.

getIntervalsS()Gets current value of property intervalsS.

getIntervalType()Gets current value of property intervalType.

getKey()Gets current value of property key.

getShowSubIntervals()Gets current value of property showSubIntervals.

setDescription(sDescription)Sets a new value for property description.

setIntervalsL(iIntervalsL)Sets a new value for property intervalsL.

setIntervalsM(iIntervalsM)Sets a new value for property intervalsM.

setIntervalsS(iIntervalsS)Sets a new value for property intervalsS.

setIntervalType(sIntervalType)Sets a new value for property intervalType.

setKey(sKey)Sets a new value for property key.

setShowSubIntervals(bShowSubIntervals)Sets a new value for property showSubIntervals.

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.m.PlanningCalendarView(sId?, mSettings?)

Constructor for a new PlanningCalendarView.

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
- key : string
- intervalType : sap.ui.unified.CalendarIntervalType (default: Hour)
- description : string
- intervalsS : int (default: 6)
- intervalsM : int (default: 8)
- intervalsL : int (default: 12)
- showSubIntervals : boolean (default: false)

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.PlanningCalendarView.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.m.PlanningCalendarView 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

sap.m.PlanningCalendarView.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.m.PlanningCalendarView.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getDescription(): string

Gets current value of property description.

Description of the PlanningCalendarView

Returns:

{string} Value of property description

getIntervalsL(): int

Gets current value of property intervalsL.

Number of intervals (defined with intervalType) that are displayed on large size (desktop)

Note: It is not only the screen size which is used to determine the available space, the size of the PlanningCalendar is used as well.

Default value is 12.

Returns:

{int} Value of property intervalsL

getIntervalsM(): int

Gets current value of property intervalsM.

Number of intervals (defined with intervalType) that are displayed on medium size (tablet)

Note: It is not only the screen size which is used to determine the available space, the size of the PlanningCalendar is used as well.

Default value is 8.

Returns:

{int} Value of property intervalsM

getIntervalsS(): int

Gets current value of property intervalsS.

Number of intervals (defined with intervalType) that are displayed on small size (phones).

Note: It is not only the screen size which is used to determine the available space, the size of the PlanningCalendar is used as well.

Default value is 6.

Returns:

{int} Value of property intervalsS

getIntervalType(): sap.ui.unified.CalendarIntervalType

Gets current value of property intervalType.

Type of the intervals of the row. Default is Hour.

Default value is Hour.

Returns:

{sap.ui.unified.CalendarIntervalType} Value of property intervalType

getKey(): string

Gets current value of property key.

Key of the view. This must be set to identify the used view in the PlanningCalendar

Returns:

{string} Value of property key

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:

{boolean} Value of property showSubIntervals

setDescription(sDescription): sap.m.PlanningCalendarView

Sets a new value for property description.

Description of the PlanningCalendarView

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

Parameters:

{string} sDescription New value for property description

Returns:

{sap.m.PlanningCalendarView} Reference to this in order to allow method chaining

setIntervalsL(iIntervalsL): sap.m.PlanningCalendarView

Sets a new value for property intervalsL.

Number of intervals (defined with intervalType) that are displayed on large size (desktop)

Note: It is not only the screen size which is used to determine the available space, the size of the PlanningCalendar is used as well.

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

Default value is 12.

Parameters:

{int} iIntervalsL New value for property intervalsL

Returns:

{sap.m.PlanningCalendarView} Reference to this in order to allow method chaining

setIntervalsM(iIntervalsM): sap.m.PlanningCalendarView

Sets a new value for property intervalsM.

Number of intervals (defined with intervalType) that are displayed on medium size (tablet)

Note: It is not only the screen size which is used to determine the available space, the size of the PlanningCalendar is used as well.

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

Default value is 8.

Parameters:

{int} iIntervalsM New value for property intervalsM

Returns:

{sap.m.PlanningCalendarView} Reference to this in order to allow method chaining

setIntervalsS(iIntervalsS): sap.m.PlanningCalendarView

Sets a new value for property intervalsS.

Number of intervals (defined with intervalType) that are displayed on small size (phones).

Note: It is not only the screen size which is used to determine the available space, the size of the PlanningCalendar is used as well.

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

Default value is 6.

Parameters:

{int} iIntervalsS New value for property intervalsS

Returns:

{sap.m.PlanningCalendarView} Reference to this in order to allow method chaining

setIntervalType(sIntervalType): sap.m.PlanningCalendarView

Sets a new value for property intervalType.

Type of the intervals of the row. Default is 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.CalendarIntervalType} sIntervalType New value for property intervalType

Returns:

{sap.m.PlanningCalendarView} Reference to this in order to allow method chaining

setKey(sKey): sap.m.PlanningCalendarView

Sets a new value for property key.

Key of the view. This must be set to identify the used view in the PlanningCalendar

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.m.PlanningCalendarView} Reference to this in order to allow method chaining

setShowSubIntervals(bShowSubIntervals): sap.m.PlanningCalendarView

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:

{boolean} bShowSubIntervals New value for property showSubIntervals

Returns:

{sap.m.PlanningCalendarView} Reference to this in order to allow method chaining