Element: <oj-c-input-number>

CORE PACK

Oracle® JavaScript Extension Toolkit (JET)
17.1.0

G12196-01

Since:
  • 14.0.0
Module:
  • input-number

Note: This component supersedes the following component: <oj-input-number>. Migration info available at preceding link.

QuickNav

Attributes


JET InputNumber Component

Description: The JET Input Number component enhances a browser input element into one that holds numbers and it has a spinbox to quickly increment or decrement the number. The value attribute must be a number and must be within the min and max range..

<oj-c-input-number value="20" label-hint="Input Number"></oj-c-input-number>

Validation and Messaging

An editable component runs validation (normal or deferred) based on the action performed on it (either by end-user or page author), and the state it was in when the action occurred. Examples of actions are - creating a component, user changing the value of the component by interacting with it, the app setting a value programmatically, the app calling the validate() method etc. At the time the action occurs, the component could already be showing errors, or can have a deferred error or have no errors.

These factors also determine whether validation errors/messages get shown to the user immediately or get deferred. The following sections highlight the kinds of validation that are run and how messages get handled.

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 lifecycle is run on the UI value. The steps performed are outlined below.
    1. All messages are cleared and messagesCustom property is cleared
    2. If the UI display value is empty, then the component normalizes the value to null.
    3. If no converter is present, or the normalized value is null, then processing continues to next step. Otherwise, the UI value is first converted (i.e., parsed). If there is a parse error then the messages are shown and processing stops.
    4. 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. If the normalized value is null, then only the required validator is run.
      • NOTE: The value is trimmed before required validation is run
    5. 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 UI.
  • 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 converter property changes. See converter property for details.
  • when required property changes. See required property for details.
  • when validators property changes. See validators property for details.

Showing Deferred Messages

Deferred validation messages are displayed only when page author requests for it explicitly in one of the following ways:

Validators Participating in Deferred Validation

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.

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.

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

The 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

Target Gesture Action
Up Button Tap Increment the number.
Down Button Tap Decrement the number.
Input Tap Set focus to the input. Show user assistance text. This may be inline or in a notewindow depending upon theme and property settings.
Elsewhere on Page Touch Submit the value you typed in the input field.

Keyboard End User Information

Target Key Action
Input Enter or Tab Submit the value you typed in the input field.
Tab In Set focus to input. Show user assistance text. This may be inline or in a notewindow depending upon theme and property settings.
UpArrow Increment the number.
DownArrow Decrement the number.

Accessibility

For accessibility, set the label-hint property. 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.

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.


Usage

Signature:

interface CInputNumberElement

Typescript Import Format
//To typecheck the element APIs, import as below.
import { CInputNumberElement } from "oj-c/input-number";

//For the transpiled javascript to load the element's module, import as below
import "oj-c/input-number";

For additional information visit:

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.


Global Attributes

Note: In addition to the component's custom attributes, the following global attributes are also supported by this component (note the differences in data binding syntax between component and global attributes described here)

autofocus :boolean

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.
Names
Item Name
Property autofocus
Property change event autofocusChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-autofocus-changed

Attributes

autocomplete :string

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'.
Default Value:
  • "on"
Names
Item Name
Property autocomplete
Property change event autocompleteChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-autocomplete-changed

column-span :number

Specifies how many columns this component should span. This only takes effect when this component is a child of a form layout that has direction 'row'.
Default Value:
  • 1
Names
Item Name
Property columnSpan
Property change event columnSpanChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-column-span-changed

container-readonly :boolean

Specifies whether an ancestor container, like oj-c-form-layout, is readonly. This affects whether a readonly component renders in full or mixed readonly mode.
Names
Item Name
Property containerReadonly
Property change event containerReadonlyChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-container-readonly-changed

converter :Converter<number>|null

A converter instance or one that duck types oj.Converter.

When no converter is specified, an instance of NumberConverter with no options will be used.

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.

During validation, the converter takes the input value which is a string and parses it into the type of the component's value property (e.g. a number) before it passes it to the validator. It then takes the validated value property and formats it into a string to be displayed and puts it into the input. If the converter's format or parse functions throw an error, it will be displayed to the user inline on the field.

The hint exposed by the converter is shown inline by default in the Redwood theme when the field has focus. 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.

Default Value:
  • null
Names
Item Name
Property converter
Property change event converterChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-converter-changed

disabled :boolean

Whether the component is disabled. The default is false.

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.
  • when enabled component is disabled then no validation is run and the component appears disabled.

Default Value:
  • false
Names
Item Name
Property disabled
Property change event disabledChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-disabled-changed

display-options :oj-c.InputNumber.DisplayOptions

Display options for auxiliary content that determines whether or not it should be displayed.
Names
Item Name
Property displayOptions
Property change event displayOptionsChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-display-options-changed

help :oj-c.InputNumber.Help

Form component help information.
Names
Item Name
Property help
Property change event helpChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-help-changed

help-hints :oj-c.InputNumber.HelpHints

The helpHints object contains a definition property and a source property.
Names
Item Name
Property helpHints
Property change event helpHintsChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-help-hints-changed

input-prefix :string

The inputPrefix displays as regular text before the input text. The inputPrefix is not editable or focusable.
Names
Item Name
Property inputPrefix
Property change event inputPrefixChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-input-prefix-changed

input-suffix :string

The inputSuffix displays as regular text after the input text. The inputSuffix is not editable or focusable.
Names
Item Name
Property inputSuffix
Property change event inputSuffixChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-input-suffix-changed

label-edge :"inside"|"none"|"start"|"top"

Specifies how the label of the component is positioned when the label-hint attribute is set on the component.
Supported Values:
Value Description
inside The label floats over the input element, but moves up on focus or when the component has a value (default, if unspecified).
none The component will not create a label, but instead set the aria-label property on the input element.
start The label will be placed before the start of the component.
top The label will be placed on top of the component.
Names
Item Name
Property labelEdge
Property change event labelEdgeChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-label-edge-changed

label-hint* :string

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.
Names
Item Name
Property labelHint
Property change event labelHintChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-label-hint*-changed

label-start-width :(number|string)

The width of the label when labelEdge is 'start'.

This attribute accepts values of type 0 | `--${string}` | `${number}%` | `${number}x` | `calc(${string})`

Names
Item Name
Property labelStartWidth
Property change event labelStartWidthChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-label-start-width-changed

label-wrapping :"truncate"|"wrap"

Should the labels wrap or truncate when there is not enough available space.
Supported Values:
Value Description
truncate Label will truncate if needed.
wrap Label will wrap if needed.
Names
Item Name
Property labelWrapping
Property change event labelWrappingChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-label-wrapping-changed

max :(number|null)

The maximum allowed value. This number is used in the range validator; if the value is greater than the max, then the range validator flags an error to the user. The increase button and up arrow are disabled when the maximum value is reached.

The max must not be less than the min, else an Error is thrown during initialization.

Names
Item Name
Property max
Property change event maxChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-max-changed

messages-custom :Array.<oj-c.InputNumber.ComponentMessageItem>

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.

See the Validation and Messages section for details on when the component clears messagesCustom; for example, when full validation is run.

Default Value:
  • []
Supports writeback:
  • true
Names
Item Name
Property messagesCustom
Property change event messagesCustomChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-messages-custom-changed

min :(number|null)

The minimum allowed value. This number is used in the range validator; if the value is less than the min, then the range validator flags an error to the user. The decrease button and down arrow are disabled when the minimum value is reached. The min must not be greater than the max, else an Error is thrown during initialization.
Names
Item Name
Property min
Property change event minChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-min-changed

number-range-exact-message-detail :string

The component-specific message detail when the number range validation fails when the input value is not between min and max when min and max are equal. If the component needs a number range validation error message for an exact number that is different from the default, set this property. It should be a translated string.

Tokens:
{num} - the allowed value

Usage:
The number must be {num}.

Names
Item Name
Property numberRangeExactMessageDetail
Property change event numberRangeExactMessageDetailChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-number-range-exact-message-detail-changed

number-range-overflow-message-detail :string

The component-specific message detail when the number range validation fails when the input value is greater than the max. If the component needs a number range validation error message for overflow that is different from the default, set this property. It should be a translated string.

Tokens:
{value} - value entered by the user
{max} - the maximum allowed value

Usage:
The number must be less than or equal to {max}.

Names
Item Name
Property numberRangeOverflowMessageDetail
Property change event numberRangeOverflowMessageDetailChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-number-range-overflow-message-detail-changed

number-range-underflow-message-detail :string

The component-specific message detail when the number range validation fails when the input value is less than the min. If the component needs a number range validation error message for underflow that is different from the default, set this property. It should be a translated string.

Tokens:
{value} - value entered by the user
{min} - the minimum allowed value

Usage:
The number must be greater than or equal to {min}.

Names
Item Name
Property numberRangeUnderflowMessageDetail
Property change event numberRangeUnderflowMessageDetailChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-number-range-underflow-message-detail-changed

placeholder :string

The placeholder text to set on the element.
Names
Item Name
Property placeholder
Property change event placeholderChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-placeholder-changed

(readonly) raw-value :string

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.

Supports writeback:
  • true
Names
Item Name
Property rawValue
Property change event rawValueChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-raw-value-changed

readonly :boolean

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.

If the property value is not set either directly on the component or inherited from a parent form layout, then the property is treated as if its value were false.

Names
Item Name
Property readonly
Property change event readonlyChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-readonly-changed

required :boolean

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.

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 required-message-detail 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 valid when required is set from true to false, then no validation is run.
  • if component is invalid and has deferred messages (invalidHidden) 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 (invalidShown) when required is changed to either true or false, 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.

Default Value:
  • false
Names
Item Name
Property required
Property change event requiredChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-required-changed

required-message-detail :string

The component-specific message detail when the required validation fails. If the component needs a required validation error message that is different from the default, set this property. It should be a translated string.

Names
Item Name
Property requiredMessageDetail
Property change event requiredMessageDetailChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-required-message-detail-changed

step :number

The size of the step to take when spinning via the step buttons or up/down arrows. If step is 0, inputNumber will not have the step buttons or up/down spin functionality. If step is less than 0, an exception is thrown.

step defaults to 0.

The step attribute can be used together with the min and max attributes to create a range of values the step buttons or up/down arrows will step through. For example, if min is 0 and step is 3, the range of values is 0, 3, 6, etc.

The step buttons or up/down arrows will spin the value and adjust it to keep it a 'step match' value. A 'step match' value is when the value is a multiple of step, starting at the min, and if min is not set, then starting at the initial value, and if neither min and initial value are set, then starting at 0.

When using step > 1 with min and/or max, make sure the initial value and max are both a 'step match' value, otherwise the first step will adjust the value in a way that could confuse the user.

A value can be a step mismatch; if the value is set to be a step mismatch, it will not be flagged as a validation error.

Names
Item Name
Property step
Property change event stepChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-step-changed

stepper-variant :"directional"|"quantitative"

Variant style of step buttons. Quantitative is recommended only for non-negative integers where the step value is 1, which is common in ecommerce or procurement cases.
Supported Values:
Value Description
directional Displays directional buttons, grouped together and located at end of input.
quantitative Displays quantitative buttons, separated and located at start and end of input.
Default Value:
  • "directional"
Names
Item Name
Property stepperVariant
Property change event stepperVariantChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-stepper-variant-changed

text-align :"start"|"end"|"right"

Specifies how the text is aligned within the text field
Supported Values:
Value Description
end Aligns text right when reading direction is ltr and left when reading direction is rtl.
right Aligns text right regardless of reading direction, often used for numbers.
start Aligns text left when reading direction is ltr and right when reading direction is rtl (default, if unspecified).
Names
Item Name
Property textAlign
Property change event textAlignChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-text-align-changed

(readonly) transient-value :number

The transientValue is the read-only property for retrieving the current transient value.

The transientValue updates to display the transient changes from pressing the step buttons or up/down arrow (subject to the step constraints). transientValue will update only if it passes validation.

The difference in behavior is transientValue will be updated as the step buttons or up/down arrow is pressed (and only if validation succeeds), whereas value is updated only after the step buttons or up/down arrow is released (and only if validation succeeds).

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

Supports writeback:
  • true
Names
Item Name
Property transientValue
Property change event transientValueChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-transient-value-changed

user-assistance-density :"reflow"|"efficient"|"compact"

Specifies the density of the form component's user assistance presentation. It can be shown inline with reserved rows to prevent reflow if a user assistance text shows up, inline without reserved rows that would reflow if a user assistance text shows up, or it can be shown compactly in a popup instead.

If the property value is not set either directly on the component or inherited from a parent form layout, then the property is treated as if its value were "reflow".

Supported Values:
Value Description
compact Messages, help, hints, and required will not be shown inline; they will show in a mode that keeps the screen more compact, like a popup for the messages, and a required icon to indicate Required.
efficient Messages, help, hints, and required are all shown inline under the field with reserved space.
reflow Messages, help, hints, and required are all shown inline under the field with no reserved space.
Names
Item Name
Property userAssistanceDensity
Property change event userAssistanceDensityChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-user-assistance-density-changed

(readonly) valid :"valid"|"pending"|"invalidHidden"|"invalidShown"

The current valid state of the component. It is evaluated on initial render. It is re-evaluated

  • after each validator (validators or async-validators) is run (full or deferred)
  • when messagesCustom is updated, since messagesCustom can be added by the app developer any time.
  • when showMessages() is called. Since showMessages() moves the hidden messages into messages shown, if the valid state was "invalidHidden" then it would become "invalidShown".
  • when the required property has changed. If a component is empty and has required set, the valid state may be "invalidHidden" (if no invalid messages are being shown as well). If required property is removed, the valid state would change to "valid".

Note: New valid states may be added to the list of valid values in future releases. Any new values will start with "invalid" if it is an invalid state, "pending" if it is pending state, and "valid" if it is a valid state.

Supported Values:
Value Description
invalidHidden The component has invalid messages hidden and no invalid messages showing. An invalid message is one with severity 'error'.
invalidShown The component has invalid messages showing. An invalid message is one with severity 'error'.
pending The component is waiting for the validation state to be determined. The 'pending' state is set at the start of the convert/validate process.
valid The component is valid
Supports writeback:
  • true
Names
Item Name
Property valid
Property change event validChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-valid-changed

validators :Array<AsyncValidator<number>|Validator<number>>|null

List of validators, synchronous or asynchronous, used by the component and the implicit component validators when performing validation. Each item is either an instance that duck types oj.Validator or oj.AsyncValidator.

Implicit validators are created by the element when certain attributes are present. For example, if the required attribute is set, an implicit oj.RequiredValidator is created. At runtime when the component runs validation, it combines all the implicit validators with all the validators specified through this validators attribute and the async-validators attribute, and runs all of them.

Hints exposed by validators are shown inline by default in the Redwood theme when the field has focus. You can turn off showing validator hints by using the 'validatorHint' 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 validators property changes due to programmatic intervention, the component may decide to clear messages and run validation, based on the current state it is in.

Steps Performed Always

  • The cached list of validator instances are cleared and new validator hints is pushed to messaging.

Running Validation

  • if component is valid when validators changes, component does nothing other than the steps it always performs.
  • if component is invalid and is showing messages when validators or async-validators changes then all component messages are cleared and full validation run using the display value on the component.
    • 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 to clear custom errors.
  • if component is invalid and has deferred messages when validators changes, it does nothing other than the steps it performs always.

Clearing Messages

  • Only messages created by the component are cleared.
  • messagesCustom property is not cleared.

Default Value:
  • []
Names
Item Name
Property validators
Property change event validatorsChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-validators-changed

value :(number|null)

The value of the component.

When value property changes due to programmatic intervention, the component always clears all messages including messagesCustom, runs deferred validation, and always refreshes UI display value.

When the input field is cleared and the value is committed, the value property is set to null.

Running Validation

  • component always runs deferred validation; the valid property is updated with the result.
Default Value:
  • null
Supports writeback:
  • true
Names
Item Name
Property value
Property change event valueChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-value-changed

virtual-keyboard :"number"|"auto"|"text"

The type of virtual keyboard to display for entering a value on mobile browsers. This attribute has no effect on desktop browsers.
Supported Values:
Value Description
auto The component will determine the best mobile virtual keyboard to use (default, if unspecified).
number Use a mobile virtual keyboard for entering numbers. If using 'number', you must set the converter attribute to a converter that formats to numeric characters only, otherwise the value will not be shown. The reason for this is oj-c-input-number uses the browser native input type='number' and when you set a value that contains a non-numeric character, browsers do not display the value. For example, '1,000' would not be shown. Note that on Android and Windows Mobile, the 'number' keyboard does not contain the minus sign. This value should not be used on fields that accept negative values.
text Use a mobile virtual keyboard for entering text.
Default Value:
  • "auto"
Names
Item Name
Property virtualKeyboard
Property change event virtualKeyboardChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-virtual-keyboard-changed

Methods

getProperty(property) : {any}

Retrieves the value of a property or a subproperty.
Parameters:
Name Type Description
property The property name to get. Supports dot notation for subproperty access.
Returns:
Type
any

reset : {void}

Resets the component by clearing all messages and messagesCustom attribute and updates the component's display value using the attribute value. User entered values will be erased when this method is called.
Returns:
Type
void

setProperties(properties) : {void}

Performs a batch set of properties.
Parameters:
Name Type Description
properties An object containing the property and value pairs to set.
Returns:
Type
void

setProperty(property, value) : {void}

Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a corresponding event.
Parameters:
Name Type Description
property The property name to set. Supports dot notation for subproperty access.
value The new value to set the property to.
Returns:
Type
void

showMessages : {void}

Takes all deferred messages and shows them. It then updates the valid property; e.g., if the valid state was "invalidHidden" before showMessages(), the valid state will become "invalidShown" after showMessages(). If there were no deferred messages this method simply returns.
Returns:
Type
void

validate : {Promise}

If enabled, validates the component's display value using the converter and all validators registered on the component and updates the value option by performing the following steps.
  1. All messages are cleared, including custom messages added by the app.
  2. If the UI display value is empty, then the component normalizes the value to null.
  3. If no converter is present, or the normalized value is null, then processing continues to next step. Otherwise, the UI value is first converted (i.e., parsed). If there is a parse error then the messages are shown and processing stops.
  4. If required is true, the implicit required validator is run. If the required validator throws an error, the message is shown.
  5. If there are no other validators registered on the component, or if the UI display value is empty, the value option is updated using the display value (an empty field's display value is null). Otherwise all validators are run in sequence using the parsed value from the previous step. When a validation error is encountered it is remembered and the next validator in the sequence is run.
  6. At the end of validation if there are errors, the messages are shown. If there were no errors, then the value option is updated.

If the component is readonly or disabled, returns a Promise that resolves to 'valid' without doing any validation.

Returns:

Promise resolves to "valid" if there were no converter parse errors and the component passed all validations. The Promise resolves to "valid" if the component is disabled or readonly. The Promise resolves to "invalid" if there were converter parse errors or if there were validation errors.

Type
Promise

Type Definitions

ComponentMessageItem

A type for a single component message
Properties:
Name Type Argument
detail string <optional>
severity "error" | "confirmation" | "info" | "warning" <optional>
summary string <optional>

DisplayOptions

Display options for auxiliary content that determines whether or not it should be displayed.
Properties:
Name Type Argument Default Description
converterHint "none" | "display" <optional>
"display" Display options for auxiliary converter hint text.
messages "none" | "display" <optional>
"display" Display options for auxiliary message text.
validatorHint "none" | "display" <optional>
"display" Display options for auxiliary validator hint text.

Help

Form component help information.
Properties:
Name Type Argument Description
instruction string <optional>
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.

HelpHints

The helpHints object contains a definition property and a source property.
Properties:
Name Type Argument Description
definition string <optional>
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.
source string <optional>
Help source URL associated with the component.
sourceText string <optional>
Custom text to be used for the source link.