The sap.m.DateTimeField
control provides a basic functionality for date/time input controls.
To be extended by date and time picker controls. For internal use only.
Constructor for a new sap.m.DateTimeField
.
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
new sap.m.DateTimeField(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID for the new control, generated automatically if no ID is given |
|
mSettings? | object | Initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
dateValue | object | Holds a reference to a JavaScript Date Object. The |
|
displayFormat | string | Determines the format, displayed in the input field. Visibility: public |
|
initialFocusedDateValue | object | Holds a reference to a JavaScript Date Object to define the initially focused date/time when the picker popup is opened. Notes:
Since: 1.54.Visibility: public |
|
valueFormat | string | Determines the format of the value property. Visibility: public |
Name | Type | Default Value | Description |
---|---|---|---|
editable | boolean | true | Defines whether the control can be modified by the user or not. Note: A user can tab to non-editable control, highlight it, and copy the text from it. |
enabled | boolean | true | Indicates whether the user can interact with the control or not. Note: Disabled controls cannot be focused and they are out of the tab-chain. Visibility: public |
name | string | The name to be used in the HTML code (for example, for HTML forms that send data to the server via submission). Visibility: public |
|
placeholder | string | Defines a short hint intended to aid the user with data entry when the control has no value. Visibility: public |
|
required | boolean | false | Indicates that user input is required. This property is only needed for accessibility purposes when a single relationship between the field and a label (see aggregation |
showValueStateMessage | boolean | true | Indicates whether the value state message should be shown or not. |
textAlign | sap.ui.core.TextAlign | Initial | Defines the horizontal alignment of the text that is shown inside the input field. |
textDirection | sap.ui.core.TextDirection | Inherit | Defines the text directionality of the input field, e.g. |
value | string | Defines the value of the control. Visibility: public |
|
valueState | sap.ui.core.ValueState | None | Visualizes the validation state of the control, e.g. |
valueStateText | string | Defines the text that appears in the value state message pop-up. If this is not specified, a default text is shown from the resource bundle. |
|
width | sap.ui.core.CSSSize | Defines the width of the control. Note: If the provided width is too small, the control gets stretched to its min width, which is needed in order for the control to be usable and well aligned. Visibility: public |
Name | Cardinality | Type | Description |
---|---|---|---|
formattedValueStateText | 0..1 | sap.m.FormattedText |
Defines the formatted text that appears in the value state message pop-up. It can include links. If both |
Method | Description |
---|---|
sap.m.DateTimeField.extend |
Creates a new subclass of class sap.m.DateTimeField with name
|
getDateValue |
Gets current value of property dateValue. Holds a reference to a JavaScript Date Object. The |
getDisplayFormat |
Gets current value of property displayFormat. Determines the format, displayed in the input field. |
getInitialFocusedDateValue |
Gets current value of property initialFocusedDateValue. Holds a reference to a JavaScript Date Object to define the initially focused date/time when the picker popup is opened. Notes:
|
sap.m.DateTimeField.getMetadata |
Returns a metadata object for class sap.m.DateTimeField. |
getValueFormat |
Gets current value of property valueFormat. Determines the format of the value property. |
setDateValue |
Sets a new value for property dateValue. Holds a reference to a JavaScript Date Object. The When called with a value of |
setDisplayFormat |
Sets a new value for property displayFormat. Determines the format, displayed in the input field. When called with a value of |
setInitialFocusedDateValue |
Sets a new value for property initialFocusedDateValue. Holds a reference to a JavaScript Date Object to define the initially focused date/time when the picker popup is opened. Notes:
When called with a value of |
setValueFormat |
Sets a new value for property valueFormat. Determines the format of the value property. When called with a value of |
Creates a new subclass of class sap.m.DateTimeField with name sClassName
and enriches it with the information contained in oClassInfo
.
oClassInfo
might contain the same kind of information as described in sap.m.InputBase.extend.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Gets current value of property dateValue.
Holds a reference to a JavaScript Date Object. The value
(string) property will be set according to it. Alternatively, if the value
and valueFormat
pair properties are supplied instead, the dateValue
will be instantiated according to the parsed value
. Use dateValue
as a helper property to easily obtain the day, month, year, hours, minutes and seconds of the chosen date and time. Although possible to bind it, the recommendation is not to do it. When binding is needed, use value
property instead.
Gets current value of property displayFormat.
Determines the format, displayed in the input field.
Gets current value of property initialFocusedDateValue.
Holds a reference to a JavaScript Date Object to define the initially focused date/time when the picker popup is opened.
Notes:
value
property.Gets current value of property valueFormat.
Determines the format of the value property.
Sets a new value for property dateValue.
Holds a reference to a JavaScript Date Object. The value
(string) property will be set according to it. Alternatively, if the value
and valueFormat
pair properties are supplied instead, the dateValue
will be instantiated according to the parsed value
. Use dateValue
as a helper property to easily obtain the day, month, year, hours, minutes and seconds of the chosen date and time. Although possible to bind it, the recommendation is not to do it. When binding is needed, use value
property instead.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
oDateValue | object |
New value for property |
Sets a new value for property displayFormat.
Determines the format, displayed in the input field.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sDisplayFormat | string |
New value for property |
Sets a new value for property initialFocusedDateValue.
Holds a reference to a JavaScript Date Object to define the initially focused date/time when the picker popup is opened.
Notes:
value
property.When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
oInitialFocusedDateValue | object |
New value for property |
Sets a new value for property valueFormat.
Determines the format of the value property.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sValueFormat | string |
New value for property |