renders a YearPicker with ItemNavigation This is used inside the calendar. Not for stand alone usage
Since: 1.28.0.
Event Summary
pageChange(oControlEvent)The pageChange event is fired if the displayed years are changed by user navigation. select(oControlEvent)Month selection changed Method Summary
sap.ui.unified.calendar.YearPicker.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.unified.calendar.YearPicker with name sClassName and enriches it with the information contained in oClassInfo. attachPageChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the pageChange event of this sap.ui.unified.calendar.YearPicker. attachSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the select event of this sap.ui.unified.calendar.YearPicker. detachPageChange(fnFunction, oListener)Detaches event handler fnFunction from the pageChange event of this sap.ui.unified.calendar.YearPicker. detachSelect(fnFunction, oListener)Detaches event handler fnFunction from the select event of this sap.ui.unified.calendar.YearPicker. firePageChange(mArguments?)Fires event pageChange to attached listeners. fireSelect(mArguments?)Fires event select to attached listeners. getColumns()Gets current value of property columns. getDate()Gets current value of property date. getFirstRenderedDate()return the first date of the first rendered year Note: If the YearPicker is not rendered no date is returned getYears()Gets current value of property years. setColumns(iColumns)Sets a new value for property columns. setDate(oDate)Sets a new value for property date. setYears(iYears)Sets a new value for property years. getYear()Gets current value of property year. setYear(iYear)Sets a new value for property year. 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 $,
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 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 Constructor Detail
new sap.ui.unified.calendar.YearPicker(sId?, mSettings?)
Constructor for a new YearPicker.
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)
The pageChange event is fired if the displayed years are changed by user navigation.
Parameters:
- Since:
- 1.38.0
select(oControlEvent)
Month selection changed
Parameters:
Method Detail
sap.ui.unified.calendar.YearPicker.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.unified.calendar.YearPicker 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 |
Returns a metadata object for class sap.ui.unified.calendar.YearPicker.
Returns:
Attaches event handler
fnFunction to the
pageChange event of this
sap.ui.unified.calendar.YearPicker.
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.YearPicker itself.
The pageChange event is fired if the displayed years 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.YearPicker itself |
- Since:
- 1.38.0
Returns:
Attaches event handler
fnFunction to the
select event of this
sap.ui.unified.calendar.YearPicker.
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.YearPicker 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.YearPicker itself |
Returns:
Detaches event handler
fnFunction from the
pageChange event of this
sap.ui.unified.calendar.YearPicker.
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:
Detaches event handler
fnFunction from the
select event of this
sap.ui.unified.calendar.YearPicker.
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:
Fires event pageChange to attached listeners.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
- Since:
- 1.38.0
Returns:
Fires event select to attached listeners.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
getColumns(): int
Gets current value of property
columns.
number of years in each row 0 means just to have all years in one row, independent of the number
Default value is 4.
- Since:
- 1.30.0
Returns:
| {int} | Value of property columns |
getDate(): object
Gets current value of property
date.
Date as JavaScript Date object. For this date a YearPicker is rendered. If a Year is selected the date is updated with the start date of the selected year (depending on the calendar type).
- Since:
- 1.34.0
Returns:
| {object} | Value of property date |
getFirstRenderedDate(): object
return the first date of the first rendered year Note: If the YearPicker is not rendered no date is returned
- Since:
- 1.38.0
Returns:
| {object} | JavaScript Date Object |
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:
getYears(): int
Gets current value of property
years.
number of displayed years
Default value is 20.
- Since:
- 1.30.0
Returns:
| {int} | Value of property years |
displays the next page
Returns:
displays the previous page
Returns:
Sets a new value for property
columns.
number of years in each row 0 means just to have all years 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 4.
Parameters:
| {int} | iColumns | New value for property columns |
- Since:
- 1.30.0
Returns:
Sets a new value for property
date.
Date as JavaScript Date object. For this date a YearPicker is rendered. If a Year is selected the date is updated with the start date of the selected year (depending on the calendar type).
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {object} | oDate | New value for property date |
- Since:
- 1.34.0
Returns:
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:
- Since:
- 1.34.0
Returns:
Sets a new value for property
years.
number of displayed years
When called with a value of null or undefined, the default value of the property will be restored.
Default value is 20.
Parameters:
| {int} | iYears | New value for property years |
- Since:
- 1.30.0
Returns:
getYear(): int
Gets current value of property
year.
The year is initial focused and selected The value must be between 0 and 9999
Default value is 2000.
- Deprecated:
- Since version 1.34.0 Use
date instead
Returns:
| {int} | Value of property year |
Sets a new value for property
year.
The year is initial focused and selected The value must be between 0 and 9999
When called with a value of null or undefined, the default value of the property will be restored.
Default value is 2000.
Parameters:
| {int} | iYear | New value for property year |
- Deprecated:
- Since version 1.34.0 Use
date instead
Returns: