Element: <oj-input-date-time>

link管理

链接快照平台

输入网页链接，自动生成快照
标签化管理网页链接

Normal Validation Normal validation is run in the following cases on the display value, using the converter and validators (this includes async-validators) set on the component, and validation errors are reported to user immediately.
When value changes as a result of user interaction all messages are cleared, including custom messages added by the app, and full validation is run on the UI value. The steps performed are outlined below.

All messages are cleared and `messagesCustom` property is cleared

If no converter is present then processing continues to next step. If a converter is present, the UI value is first converted (i.e., parsed). If there is a parse error then the messages are shown and processing returns.

If there are no validators setup for the component then the value is set on the component. Otherwise all validators are run in sequence using the parsed value from the previous step. The implicit required is run first if the component is marked required. When a validation error is encountered it is remembered and the next validator in the sequence is run.

NOTE: The value is trimmed before required validation is run

At the end of the validation run if there are errors, the messages are shown and processing returns. If there are async-validators, those errors are shown as soon as they come in, and not until all validators, sync and async validators, are complete, does processing return, that is, value and valid are updated. If there are no errors, then the `value` property is updated and the formatted value displayed on the

When the `validate` method is called by app, all messages are cleared and full validation run using the display value. See `validate` method on the sub-classes for details. Note: JET validation is designed to catch user input errors, and not invalid data passed from the server; this should be caught on the server.

When certain properties change through programmatic intervention by app, the component determines whether it needs to run normal validation based on the state the component is in. Refer to the Mixed Validation section below for details.

Deferred Validation Deferred validation is run in the following cases on the component value using the implicit required validator if required is true, and validation errors are deferred, i.e., not shown to user immediately. Refer to the Showing Deferred Messages section to understand how deferred messages can be shown.
When a component is created and it is required deferred validation is run and no messages are cleared prior to running validation. Refer to the Validators Participating in Deferred Validation section for details.

When the `value` property changes due to programmatic intervention deferred validation is run, after all messages and messagesCustom property are cleared.

When the `reset` method is called, deferred validation is run after all messages and messagesCustom property are cleared.

When certain properties change through programmatic intervention by app, the component determines whether it needs to run deferred validation based on the state the component is in. Refer to the Mixed Validation section below for details.

Mixed Validation Either deferred or normal validation is run in the following cases based on the state the component is in and any validation errors encountered are either hidden or shown to user.
when disabled property changes. See disabled property for details.

when refresh method is called. See refresh method for details.

when converter property changes. Not all EditableValue components have the converter property. See the sub-classes that have the converter property for details, e.g., oj.ojInputText#converter .

when required property changes. Not all EditableValue components have the required property. See the sub-classes that have the required property for details, e.g., oj.inputBase#required .

when validators property changes. Not all EditableValue components have the validators property. See the sub-classes that have the validators property for details, e.g., oj.inputBase#validators .

when asyncValidators property changes. Not all EditableValue components have the asyncValidators property. See the sub-classes that have the asyncValidators property for details, e.g., oj.inputBase#asyncValidators .
Deferred validation messages are displayed only when page author requests for it explicitly in one of the following ways:
calls the `showMessages` method on the component
The required validator is the only validator type that participates in deferred validation. The required property needs to be set to true for the required validator to run. User Assistance Text User assistive text provides guidance to help the user understand what data to enter or select.
In the Redwood theme, by default all user assistance text shows inline. For input components, it shows when the field takes focus. In other components it shows all the time. See the user-assistance-density property for other ways the user assistance text can render, like in 'compact' mode, it will render as an icon on the label which when clicked will show the user assistance text in a notewindow.

The JET form component properties that are used for user assistance text are help.instruction, validator and converter hints, and help-hints. In the Redwood theme for clarity only one user assistance text shows to the user. The precedence rules are:

help.instruction shows;

if no help.instruction, then validator hint shows;

if no help.instruction or validator hint, then help-hints.definition shows;

if no help.instruction, validator hint, or help-hints.definition, then converter hint shows.

help-hints.source always shows along side the above.

In the Alta theme all the user assistance text are displayed to the user. By default help.instruction and the validator/converter hints show in a notewindow that is displayed when the field takes focus. The help-hints render as a help icon on the label and when clicked show in a notewindow. Note: If there is no label, help-hints help icon will not show.

Sometimes a validator or converter hints shows that you do not want. To not show it, set the display-options.validator-hint and/or display-options.converter-hint property to 'none'.

required and placeholder properties also can be used to guide the user. In Redwood, a required field shows the word Required under the field when the field is empty and does not have focus. Placeholder is shown when the field is empty and has focus. Touch End User Information Input element and calendar trigger icon When not inline, shows the grid and moves the focus into the expanded date grid. Time trigger icon Shows the time picker and moves the focus into the expanded time picker Input element with picker open Set focus to the input. If hints, title or messages exist in a notewindow, pop up the notewindow. Picker `Swipe Left` Switch to next month (or previous month on RTL page). Picker `Swipe Right` Switch to previous month (or next month on RTL page). Input element `DownArrow or UpArrow` When not in inline mode, shows the calendar grid and moves the focus into the expanded grid. When in inline mode, shows the time picker and moves the focus into the expanded time picker Input element `Shift + DownArrow or UpArrow` Shows the time picker and moves the focus into the expanded time picker Input element Close the grid. Input Element `Tab In` Set focus to the input. If hints, title or messages exist in a notewindow, pop up the notewindow. Picker `Enter` Select the currently focused day Picker `UpArrow` Move up in the grid. Picker `DownArrow` Move down in the grid. Picker `RightArrow` Move right in the grid. Picker `LeftArrow` Move left in the grid. Picker Close the grid. Picker Move focus to first day of the month. Picker Move focus to last day of the month. Picker `PageUp` Switch to previous month. Picker `PageDown` Switch to next month. Picker `Alt + PageUp` Switch to previous year. Picker `Alt + PageDown` Switch to next year. Picker `Ctrl + Alt + PageUp` Switch to previous by stepBigMonths. Picker `Ctrl + Alt + PageDown` Switch to next by stepBigMonths. Picker `Ctrl + Alt + T` Places focus on Today button if it exists. For accessibility, set label-hint or associate an oj-label with the form component. If there is no visible label, then to make this accessible to screen reader users, set the label-hint and label-edge='none' which renders an aria-label with the label-hint text. If using an oj-label instead of the `label-hint` attribute, then put an `id` on the form component element, and set the oj-label's `for` attribute to be the form component's id.

The placeholder text is not read reliably by the screen reader. For accessibility reasons, you need to associate the text to its JET form component using aria-describedby.

Disabled content: JET supports an accessible luminosity contrast ratio, as specified in WCAG 2.0 - Section 1.4.3 "Contrast" , in the themes that are accessible. (See the "Theming" chapter of the JET Developer Guide for more information on which themes are accessible.) Note that Section 1.4.3 says that text or images of text that are part of an inactive user interface component have no contrast requirement. Because disabled content may not meet the minimum contrast ratio required of enabled content, it cannot be used to convey meaningful information.

Label and InputDateTime The element will decorate its associated label with required and help information, if the `required` and `help` attributes are set.

Usage

Signature:

interface InputDateTimeElement<SP extends ojInputDateTimeSettableProperties = ojInputDateTimeSettableProperties>

Typescript Import Format

//To typecheck the element APIs, import as below.
import { InputDateTimeElement } from "ojs/ojdatetimepicker";

//For the transpiled javascript to load the element's module, import as below
import "ojs/ojdatetimepicker";

For additional information visit:

Using JET Custom Elements

Using JET with TypeScript

JET Module Loading

Note: Application logic should not interact with the component's properties or invoke its methods until the BusyContext indicates that the component is ready for interaction.

In the Redwood theme the default max width of a text field is 100%. These max width convenience classes are available to create a medium or small field.
The class is applied to the root element.

Classes:

In the Redwood theme the default width of a text field is 100%. These width convenience classes are available to create a medium or small field.
The class is applied to the root element.

Classes:

The contextMenu slot is set on the oj-menu within this element. This is used to designate the JET Menu that this component should launch as a context menu on right-click, Shift-F10, Press & Hold, or component-specific gesture. If specified, the browser's native context menu will be replaced by the JET Menu specified in this slot. The application can register a listener for the Menu's ojBeforeOpen event. The listener can cancel the launch via event.preventDefault(), or it can customize the menu contents by editing the menu DOM directly, and then calling refresh() on the Menu. To help determine whether it's appropriate to cancel the launch or customize the menu, the ojBeforeOpen listener can use component API's to determine which table cell, chart item, etc., is the target of the context menu. See the JSDoc of the individual components for details. Keep in mind that any such logic must work whether the context menu was launched via right-click, Shift-F10, Press & Hold, or component-specific touch gesture. List of asynchronous validators used by the component when performing validation. Use async-validators when you need to perform some validation work on the server. Otherwise, use validators , which are synchronous. Each item in the Array is an instance that duck types oj.AsyncValidator . Implicit validators created by a component when certain attributes are present (e.g. required attribute) are separate from validators specified through the async-validators attribute and the validators attribute. At runtime when the component runs validation, it combines the implicit validators with the list specified through the validators attribute and also the list specified through the async-validators attribute. Error messages are shown as soon as each async validator returns; we do not wait until all the async validators finish to show errors. If the component's valid state changes for the worse, it is also updated as each validator returns so valid will be invalidShown as soon as the first validator has an Error.

It is recommended that you show the value you are validating in the error message because if the async operation takes a while, the user could be typing in a new value when the error message comes back and might be confused what value the error is for. However, if the user enters a new value (like presses Enter or Tab), a new validation lifecycle will start and validation errors for the previous value will not be shown to the user. If you need to format the value for the error message, you can use e.g. for number new NumberConverter.IntlNumberConverter(converterOption) to get the converter instance, then call converter.format(value) . Hints exposed by validators are shown inline by default in the Redwood theme when the field has focus. In the Alta theme, validator hints are shown in a notewindow on focus, or as determined by the 'validatorHint' property set on the display-options attribute. In either theme, you can turn off showing validator hints by using the 'validatorHint' property set to 'none' on the display-options attribute.

Since async validators are run asynchronously, you should wait on the BusyContext before you check valid property or the value property. Alternatively you can add a callback to the validChanged or valueChanged events. The steps performed always, running validation and clearing messages is the same as for the oj.inputBase#validators attribute. Property change listener attribute ( must be of type function, see Events and Listeners for additional information. ) on-async-validators-changed Dictates component's autocomplete state. This attribute indicates whether the value of the control can be automatically completed by the browser. The common values are "on" and "off".

Since this attribute passes through to the input element unchanged, you can look at the html specs for detailed information for how browsers behave and what values besides "on" and "off" you can set. The html spec says the default is "on", so when autocomplete is not explicitly set, the browsers treat it as "on".

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input

https://caniuse.com/#feat=input-autocomplete-onoff

https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofilling-form-controls:-the-autocomplete-attribute

Property change listener attribute ( must be of type function, see Events and Listeners for additional information. )


   on-autocomplete-changed

Autofocus is a Boolean that reflects the autofocus attribute, If it is set to true then the associated component will get input focus when the page is loaded. Setting this property doesn't set the focus to the component: it tells the browser to focus to it when the element is inserted in the document. Property change listener attribute ( must be of type function, see Events and Listeners for additional information. )


   on-autofocus-changed

A datetime converter instance or a Promise to a datetime converter instance or one that duck types oj.DateTimeConverter .

The default options for converter vary by theme. To use different value for options, create a custom converter and set it in this property. For example:

inputDateTime.converter = new DateTimeConverter.IntlDateTimeConverter({formatType: 'datetime',dateFormat: 'short',timeFormat: 'short'});

If the timezone option is provided in the converter, the Today button will highlight the current day based on the timezone specified in the converter. The hint exposed by the converter is shown inline by default in the Redwood theme when the field has focus. In the Alta theme, converter hints are shown in a notewindow on focus, or as determined by the 'converterHint' property set on the display-options attribute. In either theme, you can turn off showing converter hints by using the 'converterHint' property set to 'none' on the display-options attribute. In the Redwood theme, only one hint shows at a time, so the precedence rules are: help.instruction shows; if no help.instruction then validator hints show; if none, then help-hints.definition shows; if none, then converter hint shows. help-hints.source always shows along with the other help or hint. When converter property changes due to programmatic intervention, the element performs various tasks based on the current state it is in.

Steps Performed Always

Any cached converter instance is cleared and new converter created. The converter hint is pushed to messaging. E.g., notewindow displays the new hint(s).

Running Validation

if element is valid when


    converter

property changes, the display value is refreshed.

if element is invalid and is showing messages when


    converter

property changes then all element messages are cleared and full validation run using the current display value on the element.

if there are validation errors, then


    value

property is not updated, and the error is shown. The display value is not refreshed in this case.

if no errors result from the validation, the


    value

property is updated; page author can listen to the


    valueChanged

event to clear custom errors. The display value is refreshed with the formatted value provided by converter.

if element is invalid and has deferred messages when converter property changes, the display value is again refreshed with the formatted value provided by converter.

Clearing Messages

Only messages created by the element are cleared.


    messagesCustom

property is not cleared. Page authors can choose to clear it explicitly when setting the converter option.

Property change listener attribute ( must be of type function, see Events and Listeners for additional information. )


   on-converter-changed

Note that Jet framework prohibits setting subset of properties which are object types.

For example myInputDate.datePicker = {footerLayout: "today"}; is prohibited as it will wipe out all other sub-properties for "datePicker" object.

If one wishes to do this [by above syntax or knockout] one will have to get the "datePicker" object, modify the necessary sub-property and pass it to above syntax.

Default values for the datePicker sub-properties can also be overridden with the theming variable


   $inputDateTimeDatePickerOptionDefault

, which is merged with other defaults.

Note that all of the datePicker sub-properties except showOn are not available when renderMode is 'native'.

Property change listener attribute ( must be of type function, see Events and Listeners for additional information. )


   on-date-picker-changed

The number of months to show at once. Note that if one is using a numberOfMonths > 4 then one should define a CSS rule for the width of each of the months. For example if numberOfMonths is set to 6 then one should define a CSS rule .oj-datepicker-multi-6 .oj-datepicker-group providing the width each month should take in percentage.

See the date-picker attribute for usage examples. Number of months to step back/forward for the (Alt + Page up) + (Alt + Page down) key strokes.

See the date-picker attribute for usage examples. "numberOfMonths" - When set to this string, will use numberOfMonths property value as value. <number> - Number of months to step back/forward.

See the date-picker attribute for usage examples. Whether week of the year will be shown in the datepickeer. The default calculation follows the ISO 8601 definition: the week starts on Monday, the first week of the year contains the first Thursday of the year. This means that some days from one year may be placed into weeks 'belonging' to another year.

See the date-picker attribute for usage examples. The range of years displayed in the year drop-down: either relative to today's year ("-nn:+nn"), relative to the currently selected year ("c-nn:c+nn"), absolute ("nnnn:nnnn"), or combinations of these formats ("nnnn:-nn").

See the date-picker attribute for usage examples. Additional info to be used when rendering the day This should be a JavaScript Function reference which accepts as its argument the following JSON format {fullYear: Date.getFullYear(), month: Date.getMonth()+1, date: Date.getDate()} and returns null or all or partial JSON data of {disabled: true|false, className: "additionalCSS", tooltip: 'Stuff to display'} Property change listener attribute ( must be of type function, see Events and Listeners for additional information. ) on-day-formatter-changed Additional info to be used when rendering the day This should be in the following JSON format with the year, month, day based on Date.getFullYear(), Date.getMonth()+1, and Date.getDate(): {year: {month: {day: {disabled: true|false, className: "additionalCSS", tooltip: 'Stuff to display'}}} There also exists a special '*' character which represents ALL within that field [i.e. * within year, represents for ALL year]. Note that this property will override the value of the dayFormatter property. Setting both dayFormatter and dayMetaData properties is not supported. Property change listener attribute ( must be of type function, see Events and Listeners for additional information. ) on-day-meta-data-changed The oj-label sets the described-by attribute programmatically on the form component. This attribute is not meant to be set by an application developer directly. The described-by is copied to the aria-describedby attribute on the component's inner dom element, and it is needed for accessibility. Property change listener attribute ( must be of type function, see Events and Listeners for additional information. ) on-described-by-changed When the disabled property changes due to programmatic intervention, the component may clear messages and run validation in some cases.

when a required component is initialized as disabled


    value="{{currentValue}}" required disabled

, deferred validation is skipped.

when a disabled component is enabled,

if component is invalid and showing messages then all component messages are cleared, and full validation run using the display value.

if there are validation errors, they are shown.

if no errors result from the validation, the


    value

property is updated. Page authors can listen to the


    valueChanged

event to clear custom errors.

if component is valid and has no errors then deferred validation is run.

if there is a deferred validation error, then the valid property is updated.

if component is invalid and deferred errors then component messages are cleared and deferred validation re-run.

if there is a deferred validation error, then the valid property is updated.

Property change listener attribute ( must be of type function, see Events and Listeners for additional information. )


   on-disabled-changed

Display options for auxiliary content that determines whether or not it should be displayed. In the Redwood theme, the sub-properties of the display-options configure whether or not the types of information is shown. The values of these sub-properties are either 'display' or 'none'. In the Alta theme the sub-properties of the display-options configure aspects of visual behavior such as where types of information is shown. The values of these sub-properties are specified either as an array of strings or a string. When an array is specified the first display option takes precedence over the second display option and so on. When display-options changes due to programmatic intervention, the component updates its display to reflect the updated choices. For example, if you don't want to show the converter hint, set the display-options.converter-hint to 'none'. A side note: help.instruction and message detail text can include formatted HTML text, whereas hints and message summary text cannot. If you use formatted text, it should be accessible and make sense to the user if formatting wasn't there. The allowed html tags are: span, b, i, em, br, hr, li, ol, ul, p, small, pre. To format the help.instruction, you could do this:

<html>Enter <b>at least</b> 6 characters</html>

Property change listener attribute ( must be of type function, see Events and Listeners for additional information. )


   on-display-options-changed

Display options for auxiliary converter hint text. The supported attribute values are theme dependent. In the Redwood theme, this attribute determines whether or not the converter hint should be displayed. The supported values are 'display' and 'none'. If you don't want to show the converter hint, set display-options.converter-hint to 'none'. It defaults to 'display'. To control where the hints display, e.g., inline or in a notewindow, then use the user-assistance-density attribute. In the Alta theme this attribute determines where and whether to show the converter hint. If you don't want to show the converter hint, set display-options.converter-hint to 'none'. The Alta theme supports these attribute values, most of which are deprecated: Array|'placeholder'|'notewindow'|'none'. The default is ['placeholder','notewindow']. Display options for auxiliary help instruction text that determines where it should be displayed in relation to the component. Display options for auxiliary message text. The supported attribute values are theme dependent. In the Redwood theme, this attribute determines whether or not the messages should be displayed. The supported values are 'display' and 'none'. If you don't want to show messages, set display-options.messages to 'none'. It defaults to 'display'. To control where the messages display, e.g., inline or in a notewindow, then use the user-assistance-density attribute. In the Alta theme this attribute determines where and whether to show the messages. If you don't want to show messages, set display-options.messages to 'none'. The Alta theme supports these attribute values, most of which are deprecated: Array|'inline'|'notewindow'|'none'. The default is ['inline']. Display options for auxiliary validator hint text. The supported attribute values are theme dependent. In the Redwood theme, this attribute determines whether or not the validator hint should be displayed. The supported values are 'display' and 'none'. If you don't want to show the validator hint, set display-options.validator-hint to 'none'. It defaults to 'display'. To control where the hints display, e.g., inline or in a notewindow, then use the user-assistance-density attribute. In the Alta theme this attribute determines where and whether to show the validator hint. If you don't want to show the validator hint, set display-options.validator-hint to 'none'. The Alta theme supports these attribute values, most of which are deprecated: Array|'notewindow'|'none'. The default is ['notewindow']. Property change listener attribute ( must be of type function, see Events and Listeners for additional information. )


   on-help-changed

A type of user assistance text. User assistance text is used to provide guidance to help the user understand what data to enter or select.

In the Redwood theme for clarity only one user assistance text shows to the user. The precedence rules are:

help.instruction shows;

if no help.instruction, then validator hint shows;

if no help.instruction or validator hint, then help-hints.definition shows;

if no help.instruction, validator hint, or help-hints.definition, then converter hint shows.

help-hints.source always shows along side the above.

In the Redwood theme, by default all user assistance text shows inline. For input components, it shows when the field takes focus. In other components it shows all the time. See the user-assistance-density property for other ways the user assistance text can render. In Alta theme, help.instruction displays in a notewindow when the field takes focus. How is help.instruction better than the html 'title' attribute? The html 'title' attribute only shows up as a tooltip on mouse over, not on keyboard and not in a mobile device. So the html 'title' would only be for text that is not important enough to show all users, or for text that you show the users in another way as well, like in the label. Also you cannot theme the native browser's title window like you can the JET notewindow, so low vision users may have a hard time seeing the 'title' window. For these reasons, the JET EditableValue components do not use the HTML's 'title' attribute and instead use the help.instruction attribute. To include formatted text in the help.instruction, format the string using html tags. The allowed html tags are: span, b, i, em, br, hr, li, ol, ul, p, small, pre. For example the help.instruction might look like:

<oj-some-element help.instruction="<html>Enter <b>at least</b> 6 characters</html>"></oj-some-element>

If you use formatted text, it should be accessible and make sense to the user if formatting wasn't there. Property change listener attribute ( must be of type function, see Events and Listeners for additional information. )


   on-help-hints-changed

A type of user assistance text. User assistance text is used to provide guidance to help the user understand what data to enter or select. help-hints could come from a help system.

In the Redwood theme for clarity only one user assistance text shows to the user. The precedence rules are:

help.instruction shows;

if no help.instruction, then validator hint shows;

if no help.instruction or validator hint, then help-hints.definition shows;

if no help.instruction, validator hint, or help-hints.definition, then converter hint shows.

help-hints.source always shows along side the above.

In the Alta theme the help-hint.definition shows up when the user hovers over the help icon on the label, or tabs into the help icon, or press and holds the help icon on a mobile device.

No formatted text is available for help definition attribute.

See the help-hints attribute for usage examples.

Help source URL associated with the component.

In the Redwood theme, the help-hints.source will show as a link inline to the field. For input components, it shows when the field takes focus. For other components, it shows all the time.

In the Alta theme, the help-hints.source will show as a a help icon next to the label. When clicked the page will navigate to the source url. For security reasons we only support urls with protocol 'http:' or 'https:'. If the url doesn't comply we ignore it and throw an error. Pass in an encoded URL since we do not encode the URL.

See the help-hints attribute for usage examples.

Determines if keyboard entry of the text is allowed. When disabled the picker must be used to select a date. Default value depends on the theme. In alta-android, alta-ios and alta-windows themes, the default is


   "disabled"

and it's


   "enabled"

for alta web theme. Property change listener attribute ( must be of type function, see Events and Listeners for additional information. )


   on-keyboard-edit-changed

Specifies how the label of the component is created when the


   label-hint

attribute is set on the component.

The default value varies by theme, and it works well for the theme in most cases. If the component is in an oj-form-layout, the label-edge attribute could come from the oj-form-layout's label-edge attribute. The oj-form-layout component uses the MetadataTypes.PropertyBinding provide property to provide and uses the MetadataTypes.ProvideProperty transform property to transform its label-edge attribute to any descendent components that are configured to consume it. For example, if the oj-form-layout's label-edge attribute is set to "top" or "start", and a descendent form component does not have its label-edge attribute set, the form component's label-edge will be the transformed value "provided".

The component creates the label using the


   label-hint

attribute.

For text input components (such as oj-input-text), the label floats over the input element but moves up on focus or when the component has a value.

For non-text input components (such as oj-checkboxset), the label is created at the top of the component and doesn't move.

The component will not have a label, regardless of whether it's in an oj-form-layout or not.

If the component has a label-hint attribute but no labelled-by, aria-label, or aria-labelledby attribute, the label-hint value will be used as the aria-label.

Note that if the component already has an external label, "none" should not be specified and "provided" should be used instead. Otherwise it may end up with conflicting label information.

Label is provided by the parent if the parent is an oj-form-layout.

oj-form-layout provides the label using the label-hint from the form control and the label-edge from oj-form-layout.

If there is no oj-form-layout, use an oj-label.

Property change listener attribute ( must be of type function, see Events and Listeners for additional information. )


   on-label-edge-changed

Represents a hint for rendering a label on the component.

This is used in combination with the label-edge attribute to control how the label should be rendered.

When label-edge is "provided", it gives a hint to oj-form-layout parent element to create an oj-label element for the component. When the


   label-hint

attribute changes, oj-form-layout element refreshes to display the updated label information. When label-edge is "inside", it gives a hint to the component itself to render a label. When label-edge is "none", and if the component has no labelled-by, aria-label, or aria-labelledby attribute, the label-hint value will be used as the aria-label. Property change listener attribute ( must be of type function, see Events and Listeners for additional information. )


   on-label-hint-changed

The oj-label sets the labelledBy property programmatically on the form component to make it easy for the form component to find its oj-label component (a document.getElementById call.) The application developer should use the 'for'/'id api to link the oj-label with the form component; the 'for' on the oj-label to point to the 'id' on the input form component. This is the most performant way for the oj-label to find its form component. Property change listener attribute ( must be of type function, see Events and Listeners for additional information. )


   on-labelled-by-changed

The maximum selectable datetime, in ISO string format. When set to null, there is no maximum.

So it can be properly compared with the value the user selects, this should be in the same format as the converter's isoStrFormat. By default, value is a local isostring for oj-input-date-time. Property change listener attribute ( must be of type function, see Events and Listeners for additional information. ) on-max-changed List of messages an app would add to the component when it has business/custom validation errors that it wants the component to show. This allows the app to perform further validation before sending data to the server. When this option is set the message shows to the user right away. To clear the custom message, set messagesCustom back to an empty array.

Each message in the array is an object that duck types oj.Message. See Message for details. message detail text can include formatted HTML text, whereas hints and message summary text cannot. If you use formatted text, it should be accessible and make sense to the user if formatting wasn't there. The allowed html tags are: span, b, i, em, br, hr, li, ol, ul, p, small, pre. To format the message detail, you could do this:

<html>Enter <b>at least</b> 6 characters</html>

See the Validation and Messages section for details on when the component clears


   messagesCustom

; for example, when full validation is run.

In the Redwood theme, the Message summary is not displayed to the user, so make sure to have a Message detail set in your Message object. Property change listener attribute ( must be of type function, see Events and Listeners for additional information. ) on-messages-custom-changed The minimum selectable datetime, in ISO string format. When set to null, there is no minimum.

So it can be properly compared with the value the user selects, this should be in the same format as the converter's isoStrFormat since the value the user selects is parsed with the converter. By default, value is a local isostring for oj-input-date-time. Property change listener attribute ( must be of type function, see Events and Listeners for additional information. ) on-min-changed Property change listener attribute ( must be of type function, see Events and Listeners for additional information. ) on-name-changed

Attributes specified here will be set on the picker DOM element when it's launched.

The supported attribute is class , which is appended to the picker's class, if any. Note: 1) pickerAttributes is not applied in the native theme. 2) setting this property after element creation has no effect. Property change listener attribute ( must be of type function, see Events and Listeners for additional information. ) on-picker-attributes-changed Property change listener attribute ( must be of type function, see Events and Listeners for additional information. ) on-placeholder-changed

The rawValue is the read-only property for retrieving the current value from the input field in string form. The main consumer of rawValue is a converter.

The


   rawValue

updates on the 'input' javascript event, so the


   rawValue

changes as the value of the input is changed. If the user types in '1,200' into the field, the rawValue will be '1', then '1,', then '1,2', ..., and finally '1,200'. Then when the user blurs or presses Enter the


   value

property gets converted and validated (if there is a converter or validators) and then gets updated if valid.

This is a read-only attribute so page authors cannot set or change it directly.

Property change listener attribute ( must be of type function, see Events and Listeners for additional information. )


   on-raw-value-changed

Whether the component is readonly. The readonly property sets or returns whether an element is readonly, or not. A readonly element cannot be modified. However, a user can tab to it, highlight it, focus on it, and copy the text from it. If you want to prevent the user from interacting with the element, use the disabled property instead. The default value for readonly is false. However, if the form component is a descendent of


   oj-form-layout

, the default value for readonly could come from the


   oj-form-layout

component's readonly attribute. The


   oj-form-layout

uses the MetadataTypes.PropertyBinding


   provide

property to provide its


   readonly

attribute value to be consumed by descendent components. The form components are configured to consume the readonly property if an ancestor provides it and it is not explicitly set. For example, if the oj-form-layout's readonly attribute is set to true, and a descendent form component does not have its readonly attribute set, the form component's readonly will be true. Property change listener attribute ( must be of type function, see Events and Listeners for additional information. )


   on-readonly-changed

Allows applications to specify whether to render date and time pickers in JET or as a native picker control. Valid values: jet, native Default value depends on the theme. In alta-android, alta-ios and alta-windows themes, the default is "native" and it's "jet" for alta web theme.

jet - Applications get full JET functionality.

native - Applications get the functionality of the native picker.

Note that the native renderMode will attempt to load a Cordova plugin that will launch the native picker. If the plugin is not found, the default JET picker will be used. With native renderMode, the functionality that is sacrificed compared to jet renderMode are:

Date and time pickers cannot be themed

Accessibility is limited to what the native picker supports

pickerAttributes is not applied

Sub-IDs are not available

hide() and hideTimePicker() functions are no-op

translations sub properties pertaining to the picker is not available

All of the 'datepicker' sub-properties except 'showOn' are not available

'timePicker.timeIncrement' property is limited to iOS and will only take a precision of minutes


   8.0.0

The "native" mode rendering is deprecated because JET is promoting a consistent Oracle UX over native look and feel in Redwood. Since this property takes only two values the property itself is deprecated. The theme variable "$inputDateTimeRenderModeOptionDefault" is also deprecated for the same reason. Applications get the functionality of the native picker. Native picker is not available when the picker is inline, defaults to 'jet' instead. Note that the native renderMode will attempt to load a Cordova plugin that will launch the native picker. If the plugin is not found, the default JET picker will be used. With native renderMode, the functionality that is sacrificed compared to jet renderMode are:

Date Time picker cannot be themed

Accessibility is limited to what the native picker supports

pickerAttributes is not applied

Sub-IDs are not available

hide() function is no-op

translations sub properties pertaining to the picker is not available

All of the 'datepicker' sub-properties except 'showOn' are not available

'timePicker.timeIncrement' property is limited to iOS and will only take a precision of minutes

Property change listener attribute ( must be of type function, see Events and Listeners for additional information. )


   on-render-mode-changed

This property set to


   false

implies that a value is not required to be provided by the user. This is the default. This property set to


   true

implies that a value is required to be provided by the user. In the Redwood theme, by default, a Required text is rendered inline when the field is empty. If user-assistance-density is 'compact', it will show on the label as an icon. In the Alta theme the input's label will render a required icon.

The Required error text is based on Redwood UX designs, and it is not recommended that it be changed. To override the required error message, use the translations.required attribute. The component's label text is passed in as a token {label} and can be used in the message detail.

When required is set to true, an implicit required validator is created, i.e., new RequiredValidator() . The required validator is the only validator to run during initial render, and its error is not shown to the user at this time; this is called deferred validation. The required validator also runs during normal validation; this is when the errors are shown to the user. See the Validation and Messaging section for details. When the required property changes due to programmatic intervention, the component may clear component messages and run validation, based on the current state it's in.

Running Validation when required property changes

if component is valid when required is set to true, then it runs deferred validation on the value property. If the field is empty, the valid state is invalidHidden. No errors are shown to the user.

if component is invalid and has deferred messages when required is set to false, then component messages are cleared (messages-custom messages are not cleared) but no deferred validation is run because required is false.

if component is invalid and currently showing invalid messages when required is set, then component messages are cleared and normal validation is run using the current display value.

if there are validation errors, then


    value

property is not updated and the error is shown.

if no errors result from the validation, the


    value

property is updated; page author can listen to the


    valueChanged

event on the component to clear custom errors.

Clearing Messages when required property changes

Only messages created by the component, like validation messages, are cleared when the required property changes.


    messagesCustom

property is not cleared.

Property change listener attribute ( must be of type function, see Events and Listeners for additional information. )


   on-required-changed

Note that Jet framework prohibits setting subset of properties which are object types.

For example myInputDateTime.timePicker = {timeIncrement: "00:30:00:00"}; is prohibited as it will wipe out all other sub-properties for "timePicker" object.

If one wishes to do this [by above syntax or knockout] one will have to get the "timePicker" object, modify the necessary sub-property and pass it to above syntax.

Property change listener attribute ( must be of type function, see Events and Listeners for additional information. )


   on-time-picker-changed

Time increment to be used for InputDateTime, the format is hh:mm:ss:SS.

Note that when renderMode is 'native', timeIncrement property is limited to iOS and will only take a precision of minutes.

See the time-picker attribute for usage examples.

A collection of translated resources from the translation bundle, or null if this component has no resources. Resources may be accessed and overridden individually or collectively, as seen in the examples.

If the component does not contain any translatable resource, the default value of this attribute will be null . If not, an object containing all resources relevant to the component.

If this component has translations, their documentation immediately follows this doc entry. Property change listener attribute ( must be of type function, see Events and Listeners for additional information. ) on-translations-changed

Provides properties to customize the hint and message text used by the implicit date restriction validator associated to the InputDateTime and InputDate components.