Class sap.ui.commons.DatePickerModule: sap/ui/commons/DatePicker

extends TextField

Allows end users to interact with dates. Entries can directly be written in, or selected from a calendar pad. Note: Dates can always be manually entered in the fix YYYYMMDD format, on top of the flexible "locale" format. If the value is provided via data binding, using a Date.type the formatter of the Date.type is used. Since version 1.22 the unified.Calendar is used inside the datePicker. So applications using the DatePicker should load the unified library. Otherwise it will be loaded the first time a DatePicker is opened.

Deprecated API:Since version 1.38. Instead, use the sap.m.DatePicker control.

Constructor Summary
new sap.ui.commons.DatePicker(sId?, mSettings?)Constructor for a new DatePicker.
Events borrowed from class sap.ui.commons.TextField
change, liveChange
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.commons.DatePicker.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.DatePicker with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.DatePicker.getMetadata()Returns a metadata object for class sap.ui.commons.DatePicker.
fireChange(bInvalidValue)Fire event change to attached listeners.
getAccessibilityInfo()
getLocale()Gets current value of property locale.
getYyyymmdd()Gets current value of property yyyymmdd.
setLocale(sLocale)Sets a new value for property locale.
setYyyymmdd(sYyyymmdd)Sets a new value for property yyyymmdd.
Methods borrowed from class sap.ui.commons.TextField
_checkChange, addAriaDescribedBy, addAriaLabelledBy, attachChange, attachLiveChange, bindValue, detachChange, detachLiveChange, fireLiveChange, getAccessibleRole, getAriaDescribedBy, getAriaLabelledBy, getDesign, getEditable, getEnabled, getFocusInfo, getHelpId, getImeMode, getInputDomRef, getLiveValue, getMaxLength, getName, getPlaceholder, getRequired, getTextAlign, getTextDirection, getValue, getValueState, getWidth, onfocusin, onkeyup, onsapenter, onsapfocusleave, onselectstart, removeAllAriaDescribedBy, removeAllAriaLabelledBy, removeAriaDescribedBy, removeAriaLabelledBy, setAccessibleRole, setDesign, setEditable, setEnabled, setHelpId, setImeMode, setMaxLength, setName, setPlaceholder, setRequired, setTextAlign, setTextDirection, setValue, setValueState, setWidth, unbindValue
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, 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, 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.commons.DatePicker(sId?, mSettings?)
Constructor for a new DatePicker.

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:

In addition, all settings applicable to the base type sap.ui.commons.TextField 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
Deprecated:
Since version 1.38. Instead, use the sap.m.DatePicker control.
Method Detail
sap.ui.commons.DatePicker.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.commons.DatePicker 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.commons.TextField.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.commons.DatePicker.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.DatePicker.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
fireChange(bInvalidValue): sap.ui.commons.DatePicker
Fire event change to attached listeners.

Provides the following event parameters:

  • 'newValue' of type string The new / changed value of the DatePicker.
  • 'newYyyymmdd' of type string The new / changed Yyyymmdd of the DatePicker.
  • 'invalidValue' of type boolean The new / changed value of the DatePicker is not a valid date.
Parameters:
{boolean}bInvalidValue true is value is invalid
Returns:
{sap.ui.commons.DatePicker}this to allow method chaining
getAccessibilityInfo()
See:
{sap.ui.core.Control#getAccessibilityInfo}
getLocale(): string
Gets current value of property locale.

Defines the locale (language and country), e.g. "en-US", whose translations and Date formatters should be used to render the DatePicker.If the value property is bound to a model using a Date type the locale will be ignored, because the locale information of the model are used.

Returns:
{string} Value of property locale
getYyyymmdd(): string
Gets current value of property yyyymmdd.

Defines the date as a "yyyymmdd" string, independent from the format used. The inherited textField "value" attribute uses the date format as configured via the locale. The date is interpreted as gregorian date

Returns:
{string} Value of property yyyymmdd
setLocale(sLocale): sap.ui.commons.DatePicker
Sets a new value for property locale.

Defines the locale (language and country), e.g. "en-US", whose translations and Date formatters should be used to render the DatePicker.If the value property is bound to a model using a Date type the locale will be ignored, because the locale information of the model are used.

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

Parameters:
{string}sLocale New value for property locale
Returns:
{sap.ui.commons.DatePicker} Reference to this in order to allow method chaining
setYyyymmdd(sYyyymmdd): sap.ui.commons.DatePicker
Sets a new value for property yyyymmdd.

Defines the date as a "yyyymmdd" string, independent from the format used. The inherited textField "value" attribute uses the date format as configured via the locale. The date is interpreted as gregorian date

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

Parameters:
{string}sYyyymmdd New value for property yyyymmdd
Returns:
{sap.ui.commons.DatePicker} Reference to this in order to allow method chaining