Class sap.ui.unified.calendar.MonthPickerModule: sap/ui/unified/calendar/MonthPicker

extends Control

renders a MonthPicker with ItemNavigation This is used inside the calendar. Not for stand alone usage


Since: 1.28.0.
Constructor Summary
new sap.ui.unified.calendar.MonthPicker(sId?, mSettings?)Constructor for a new MonthPicker.
Event Summary
pageChange(oControlEvent)If less than 12 months are displayed the pageChange event is fired if the displayed months are changed by user navigation.
select(oControlEvent)Month selection changed
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.unified.calendar.MonthPicker.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.unified.calendar.MonthPicker with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.unified.calendar.MonthPicker.getMetadata()Returns a metadata object for class sap.ui.unified.calendar.MonthPicker.
attachPageChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the pageChange event of this sap.ui.unified.calendar.MonthPicker.
attachSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the select event of this sap.ui.unified.calendar.MonthPicker.
detachPageChange(fnFunction, oListener)Detaches event handler fnFunction from the pageChange event of this sap.ui.unified.calendar.MonthPicker.
detachSelect(fnFunction, oListener)Detaches event handler fnFunction from the select event of this sap.ui.unified.calendar.MonthPicker.
firePageChange(mArguments?)Fires event pageChange to attached listeners.
fireSelect(mArguments?)Fires event select to attached listeners.
getColumns()Gets current value of property columns.
getMonth()Gets current value of property month.
getMonths()Gets current value of property months.
getPrimaryCalendarType()Gets current value of property primaryCalendarType.
nextPage()displays the next page
previousPage()displays the previous page
setColumns(iColumns)Sets a new value for property columns.
setMinMax(iMin?, iMax?)sets a minimum an maximum month
setMonth(iMonth)Sets a new value for property month.
setMonths(iMonths)Sets a new value for property months.
setPrimaryCalendarType(sPrimaryCalendarType)Sets a new value for property primaryCalendarType.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, 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, setLayoutData, setTooltip, toString, unbindElement
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, 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.calendar.MonthPicker(sId?, mSettings?)
Constructor for a new MonthPicker.

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
  • Events
    • select : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • pageChange : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Control 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
Event Detail
pageChange(oControlEvent)
If less than 12 months are displayed the pageChange event is fired if the displayed months are changed by user navigation.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Since:
1.38.0
select(oControlEvent)
Month selection changed
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.ui.unified.calendar.MonthPicker.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.unified.calendar.MonthPicker 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:
{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.calendar.MonthPicker.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.unified.calendar.MonthPicker.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachPageChange(oData?, fnFunction, oListener?): sap.ui.unified.calendar.MonthPicker
Attaches event handler fnFunction to the pageChange event of this sap.ui.unified.calendar.MonthPicker.

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.calendar.MonthPicker itself.

If less than 12 months are displayed the pageChange event is fired if the displayed months are changed by user navigation.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.MonthPicker itself
Since:
1.38.0
Returns:
{sap.ui.unified.calendar.MonthPicker} Reference to this in order to allow method chaining
attachSelect(oData?, fnFunction, oListener?): sap.ui.unified.calendar.MonthPicker
Attaches event handler fnFunction to the select event of this sap.ui.unified.calendar.MonthPicker.

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.calendar.MonthPicker itself.

Month selection changed

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.unified.calendar.MonthPicker itself
Returns:
{sap.ui.unified.calendar.MonthPicker} Reference to this in order to allow method chaining
detachPageChange(fnFunction, oListener): sap.ui.unified.calendar.MonthPicker
Detaches event handler fnFunction from the pageChange event of this sap.ui.unified.calendar.MonthPicker.

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

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Since:
1.38.0
Returns:
{sap.ui.unified.calendar.MonthPicker} Reference to this in order to allow method chaining
detachSelect(fnFunction, oListener): sap.ui.unified.calendar.MonthPicker
Detaches event handler fnFunction from the select event of this sap.ui.unified.calendar.MonthPicker.

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

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.unified.calendar.MonthPicker} Reference to this in order to allow method chaining
firePageChange(mArguments?): sap.ui.unified.calendar.MonthPicker
Fires event pageChange to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.38.0
Returns:
{sap.ui.unified.calendar.MonthPicker} Reference to this in order to allow method chaining
fireSelect(mArguments?): sap.ui.unified.calendar.MonthPicker
Fires event select to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.unified.calendar.MonthPicker} Reference to this in order to allow method chaining
getColumns(): int
Gets current value of property columns.

number of months in each row The value must be between 0 and 12 (0 means just to have all months in one row, independent of the number)

Default value is 3.

Since:
1.30.0
Returns:
{int} Value of property columns
getMonth(): int
Gets current value of property month.

The month is initial focused and selected The value must be between 0 and 11

Default value is 0.

Returns:
{int} Value of property month
getMonths(): int
Gets current value of property months.

number of displayed months The value must be between 1 and 12

Default value is 12.

Since:
1.30.0
Returns:
{int} Value of property months
getPrimaryCalendarType(): sap.ui.core.CalendarType
Gets current value of property primaryCalendarType.

If set, the calendar type is used for display. If not set, the calendar type of the global configuration is used.

Since:
1.34.0
Returns:
{sap.ui.core.CalendarType} Value of property primaryCalendarType
nextPage(): sap.ui.unified.calendar.MonthPicker
displays the next page
Returns:
{sap.ui.unified.calendar.MonthPicker}this to allow method chaining
previousPage(): sap.ui.unified.calendar.MonthPicker
displays the previous page
Returns:
{sap.ui.unified.calendar.MonthPicker}this to allow method chaining
setColumns(iColumns): sap.ui.unified.calendar.MonthPicker
Sets a new value for property columns.

number of months in each row The value must be between 0 and 12 (0 means just to have all months in one row, independent of the number)

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

Default value is 3.

Parameters:
{int}iColumns New value for property columns
Since:
1.30.0
Returns:
{sap.ui.unified.calendar.MonthPicker} Reference to this in order to allow method chaining
setMinMax(iMin?, iMax?): sap.ui.unified.calendar.MonthPicker
sets a minimum an maximum month
Parameters:
{int}iMin? minimum month as integer (starting with 0)
{int}iMax? maximum month as integer (starting with 0)
Returns:
{sap.ui.unified.calendar.MonthPicker}this to allow method chaining
setMonth(iMonth): sap.ui.unified.calendar.MonthPicker
Sets a new value for property month.

The month is initial focused and selected The value must be between 0 and 11

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

Default value is 0.

Parameters:
{int}iMonth New value for property month
Returns:
{sap.ui.unified.calendar.MonthPicker} Reference to this in order to allow method chaining
setMonths(iMonths): sap.ui.unified.calendar.MonthPicker
Sets a new value for property months.

number of displayed months The value must be between 1 and 12

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

Default value is 12.

Parameters:
{int}iMonths New value for property months
Since:
1.30.0
Returns:
{sap.ui.unified.calendar.MonthPicker} Reference to this in order to allow method chaining
setPrimaryCalendarType(sPrimaryCalendarType): sap.ui.unified.calendar.MonthPicker
Sets a new value for property primaryCalendarType.

If set, the calendar type is used for display. If not set, the calendar type of the global configuration is used.

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

Parameters:
{sap.ui.core.CalendarType}sPrimaryCalendarType New value for property primaryCalendarType
Since:
1.34.0
Returns:
{sap.ui.unified.calendar.MonthPicker} Reference to this in order to allow method chaining