Element: <oj-input-text>

<oj-input-text></oj-input-text>

<oj-input-text id="textId" disabled></oj-input-text>

<oj-input-text id="textId" value="{{currentValue}}"></oj-input-text>

Slots

JET elements can have up to two types of child content:

• Any child element with a slot attribute will be moved into that named slot, e.g. <span slot='startIcon'>...</span>. All supported named slots are documented below. Child elements with unsupported named slots will be removed from the DOM.
• Any child element lacking a slot attribute will be moved to the default slot, also known as a regular child.

contextMenu

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 and demos 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.

Example

Initialize the component with a context menu:

<oj-some-element>
    <-- use the contextMenu slot to designate this as the context menu for this component -->
    <oj-menu slot="contextMenu" style="display:none" aria-label="Some element's context menu">
...
    </oj-menu>
</oj-some-element>

Attributes

async-validators :Array.<oj.AsyncValidator.<V>>

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 oj.IntlConverterUtils.getConverterInstance(converterOption) to get the converter instance, then call converter.format(value).

Hints exposed by async-validators and validators are shown in the notewindow by default, or as determined by the 'validatorHint' property set 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 onValidChanged or ojValueChanged events.

The steps performed always, running validation and clearing messages is the same as for the oj.inputBase#validators attribute.

Default Value:

• []

Names

Item	Name
Property	asyncValidators
Property change event	asyncValidatorsChanged
Property change listener attribute (must be of type function)	on-async-validators-changed

Examples

Create an Object that duck-types the oj.AsyncValidator interface. Bind the Object to the JET form component's async-validators attribute. The validator's 'validate' method will be called when the user changes the input.

 self.asyncValidator1 = {
   // required validate method
   'validate': function(value) {
     return new Promise(function(resolve, reject) {
       var successful = someBackendMethod();
       if (successful) {
         resolve(true);
       } else {
         reject(new Error('The amount of purchase is too high. It is ' + value));
       }
     });
   },
   // optional hint attribute. hint shows up when user sets focus to input.
   'hint': new Promise(function (resolve, reject) {
     var formattedMaxPurchase = getSomeBackendFormattedMaxPurchase();
     resolve(maxPurchase + " is the maximum.");
   });
 };
 -- HTML --
 <oj-input-text value="{{value}}"
 async-validators="[[[asyncValidator1]]]"></oj-input-text>

Initialize the component with multiple AsyncValidator duck-typed instances:

-- HTML --
<oj-input-text id="asyncValKo1" data-oj-context
                  valid="{{koAsyncValid}}" value="{{koAsyncValue}}"
                  required validators="[[[checkfoo, checkfooey]]]"
                  async-validators="[[[asyncValidator1, asyncValidator2]]]"></oj-input-text>

Get or set the asyncValidators property after initialization:

// getter
var validators = myComp.asyncValidators;

// setter
var myValidators = [{
'validate' : function(value) {
  return new Promise(function(resolve, reject) {
  // mock server-side delay
  setTimeout(function () {
    if (value === "pass" || value === "another pass") {
      resolve(true);
    } else {
      reject(new Error("value isn't 'pass' or 'another pass'. It is " + value.));
    }
  },10);
  });
}
}];
myComp.asyncValidators = myValidators;

autocomplete :('on'|'off'|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"

Since:

• 4.0.0

See:

• 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

Names

Item	Name
Property	autocomplete
Property change event	autocompleteChanged
Property change listener attribute (must be of type function)	on-autocomplete-changed

Examples

Initialize component with autocomplete attribute:

<oj-some-element autocomplete="on"></oj-some-element>

Get or set the autocomplete property after initialization:

// getter
var ro = myComp.autocomplete;

// setter
myComp.autocomplete = "on";

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.

Default Value:

• false

Since:

• 4.0.0

Names

Item	Name
Property	autofocus
Property change event	autofocusChanged
Property change listener attribute (must be of type function)	on-autofocus-changed

Examples

Initialize component with autofocus attribute:

<oj-some-element autofocus></oj-some-element>

Get or set the autofocus property after initialization:

// getter
var ro = myComp.autofocus;

// setter
myComp.autofocus = false;

clear-icon :string

Specifies if the clear icon should be visible.

Supported Values:

Name	Type	Description
"always"	string	The clear icon is always visible
"conditional"	string	The clear icon is visible under the following conditions: if the component has a non-empty value AND it either has focus OR the mouse is over the field.
"never"	string	The clear icon is never visible

Default Value:

• "never"

Names

Item	Name
Property	clearIcon
Property change event	clearIconChanged
Property change listener attribute (must be of type function)	on-clear-icon-changed

Examples

Initialize the oj-input-text with the clear-icon attribute specified:

<oj-input-text clear-icon="conditional" id="inputcontrol"></oj-input-text>

Get or set the clearIcon property after initialization:

// getter
var clearIcon = myInputText.clearIcon;

// setter
myInputText.clearIcon = 'conditional';

converter :(oj.Converter.<any>|oj.Validation.RegisteredConverter|null)

a converter instance that duck types oj.Converter. Or an object literal containing the following properties.

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 onValueChanged 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.

Properties:

Name	Type	Argument	Description
type	string		the converter type registered with the oj.ConverterFactory. Supported types are 'number' and 'datetime'. See oj.ConverterFactory for details. E.g., converter='{"type": "number"}'
options	Object	<optional>	optional Object literal of options that the converter expects. See oj.IntlNumberConverter for options supported by the number converter. See oj.IntlDateTimeConverter for options supported by the date time converter. E.g., converter='{"type": "number", "options": {"style": "decimal"}}'

Default Value:

• null

Names

Item	Name
Property	converter
Property change event	converterChanged
Property change listener attribute (must be of type function)	on-converter-changed

Examples

Initialize the component with a number converter instance:

<oj-input-text converter="[[salaryConverter]]"></oj-input-text>

// Initialize converter instance using currency options
var options = {style: 'currency', 'currency': 'USD', maximumFractionDigits: 0};
var numberConverterFactory = oj.Validation.converterFactory("number");
var salaryConverter = numberConverterFactory.createConverter(options);

Initialize the component with converter object literal:

<oj-input-text converter='{"type": "number", "options": {"style": "decimal"}}'></oj-input-text>

Get or set the converter property after initialization:

// getter
var converter = myComp.converter;

// setter
myComp.converter = myConverter;

(nullable) described-by :string

It is used to establish a relationship between this component and another element. Typically this is not used by the application developer, but by the oj-label custom element's code. One use case is where the oj-label custom element code writes described-by on its form component for accessibility reasons. To facilitate correct screen reader behavior, the described-by attribute is copied to the aria-describedby attribute on the component's dom element.

Since:

• 4.0.0

Names

Item	Name
Property	describedBy
Property change event	describedByChanged
Property change listener attribute (must be of type function)	on-described-by-changed

Examples

Initialize component with the described-by attribute specified:

<oj-some-element described-by="someId"></oj-some-element>

Get or set the describedBy property after initialization:

// getter
var descById = myComp.describedBy;

// setter
myComp.describedBy = "someId";

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 onValueChanged 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

Since:

• 0.7

Names

Item	Name
Property	disabled
Property change event	disabledChanged
Property change listener attribute (must be of type function)	on-disabled-changed

Examples

Initialize component with disabled attribute:

<oj-some-element disabled></oj-some-element>

Get or set the disabled property after initialization:

// getter
var disabled = myComp.disabled;

// setter
myComp.disabled = false;

display-options :Object

Display options for auxilliary content that determines where it should be displayed in relation to the component.

The types of messaging content for which display options can be configured include converterHint, helpInstruction, messages, and validatorHint.
The display options for each type is specified either as an array of strings or a string. When an array is specified the first display option takes precedence over the second and so on.

When display-options changes due to programmatic intervention, the component updates its display to reflect the updated choices. For example, if 'help.instruction' property goes from 'notewindow' to 'none' then it no longer shows in the notewindow.

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. To format the help.instruction, you could do this:

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

Since:

• 0.7

Names

Item	Name
Property	displayOptions
Property change event	displayOptionsChanged
Property change listener attribute (must be of type function)	on-display-options-changed

Examples

Override default values for display-options for one component:

// In this example, the display-options are changed from the defaults.
// The 'converterHint' is none, the 'validatorHint' is none and the 'helpInstruction' is none,
// so only the 'messages' will display in its default state.
//
<oj-some-element display-options='{"converterHint": "none",
                                    "validatorHint": "none",
                                    "helpInstruction": "none"}'></oj-some-element>

Get or set the displayOptions property after initialization:

// Get one subproperty
var hint = myComp.displayOptions.converterHint;

// Set one, leaving the others intact. Use the setProperty API for 
// subproperties so that a property change event is fired.
myComp.setProperty("displayOptions.converterHint", "none");

// get all
var options = myComp.displayOptions;

// set all.  Must list every resource key, as those not listed are lost.
myComp.displayOptions = {converterHint: "none", validatorHint: "none", helpInstruction: "none"};

display-options.converter-hint :(Array.<('placeholder'|'notewindow'|'none')>|'placeholder'|'notewindow'|'none')

Display options for auxilliary converter hint text that determines where it should be displayed in relation to the component. When there is already a placeholder set on the component, the converter hint falls back to display type of 'notewindow'.

Default Value:

• ['placeholder','notewindow']

Since:

• 0.7

Names

Item	Name
Property	displayOptions.converterHint

display-options.help-instruction :(Array.<('notewindow'|'none')>|'notewindow'|'none')

Display options for auxilliary help instruction text that determines where it should be displayed in relation to the component.

Default Value:

• ['notewindow']

Since:

• 0.7

Names

Item	Name
Property	displayOptions.helpInstruction

display-options.messages :(Array.<('inline'|'notewindow'|'none')>|'inline'|'notewindow'|'none')

Display options for auxilliary message text that determines where it should be displayed in relation to the component.

Default Value:

• ['inline']

Since:

• 0.7

Names

Item	Name
Property	displayOptions.messages

display-options.validator-hint :(Array.<('notewindow'|'none')>|'notewindow'|'none')

Display options for auxilliary validator hint text that determines where it should be displayed in relation to the component.

Default Value:

• ['notewindow']

Since:

• 0.7

Names

Item	Name
Property	displayOptions.validatorHint

help :Object

Form component help information.

The properties supported on the help option are:

Properties:

Name	Type	Argument	Description
instruction	string	<optional>	this represents advisory information for the component The default value is null.

Since:

• 0.7

Names

Item	Name
Property	help
Property change event	helpChanged
Property change listener attribute (must be of type function)	on-help-changed

help.instruction :string

Represents advisory information for the component, such as would be appropriate for a tooltip.

When help.instruction is present it is by default displayed in the notewindow, or as determined by the 'helpInstruction' property set on the displayOptions attribute. When the help.instruction property changes the component refreshes to display the updated information.

JET takes the help instruction text and creates a notewindow with the text. The help instruction only shows up as a tooltip on mouse over, not on keyboard and not in a mobile device. So help instruction 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 it. For these reasons, the JET EditableValue components do not use the HTML's title attribute.

To include formatted text in the help.instruction, format the string using html tags. 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.

Default Value:

• ""

Since:

• 4.0.0

Names

Item	Name
Property	help.instruction

Examples

Initialize the component with the help.instruction sub-attribute:

<oj-some-element help.instruction="some tooltip"></oj-some-element>
 

Get or set the help.instruction property after initialization:

// Get one subproperty
var instr = myComp.help.instruction;

// Set one subproperty, leaving the others intact. Use the setProperty API for 
// subproperties so that a property change event is fired.
myComponent.setProperty('help.instruction', 'some new value');

// Get all
var values = myComponent.help;

// Set all.  Must list every resource key, as those not listed are lost.
myComponent.help = {
  instruction: 'some new value'
};

help-hints :Object

Represents hints for oj-form-layout element to render help information on the label of the editable component.

This is used only if the editable component is added as a direct child to an oj-form-layout element, and the labelHint property is also specified.

The helpHints object contains a definition property and a source property.

• definition - hint for help definition text.
• source - hint for help source URL.

Since:

• 4.1.0

Names

Item	Name
Property	helpHints
Property change event	helpHintsChanged
Property change listener attribute (must be of type function)	on-help-hints-changed

Examples

Initialize the component with help hints:

<!-- Using dot notation -->
<oj-some-element help-hints.definition='some value' help-hints.source='some-url'></oj-some-element>

<!-- Using JSON notation -->
<oj-some-element help-hints='{"definition":"some value", "source":"some-url"}'></oj-some-element>

Get or set the helpHints property after initialization:

// Get one
var value = myComponent.helpHints.definition;

// Set one, leaving the others intact. Always use the setProperty API for 
// subproperties rather than setting a subproperty directly.
myComponent.setProperty('helpHints.definition', 'some new value');

// Get all
var values = myComponent.helpHints;

// Set all.  Must list every subproperty, as those not listed are lost.
myComponent.helpHints = {
    definition: 'some new value',
    source: 'some-new-url'
};

help-hints.definition :string

Hint for help definition text associated with the label.

It is what shows up when the user hovers over the help icon, 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.

Default Value:

• ""

Since:

• 4.1.0

Names

Item	Name
Property	helpHints.definition

help-hints.source :string

Hint for help source URL associated with the label.

If present, a help icon will render next to the label. 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.

Default Value:

• ""

Since:

• 4.1.0

Names

Item	Name
Property	helpHints.source

label-hint :string

Represents a hint for oj-form-layout element to render a label on the editable component.

This is used only if the editable component is added as a direct child to an oj-form-layout element.

When labelHint is present it gives a hint to the oj-form-layout element to create an oj-label element for the editable component. When the labelHint property changes oj-form-layout element refreshes to display the updated label information.

Default Value:

• ""

Since:

• 4.1.0

Names

Item	Name
Property	labelHint
Property change event	labelHintChanged
Property change listener attribute (must be of type function)	on-label-hint-changed

Examples

Initialize the component with the label-hint attribute specified:

<oj-some-element label-hint='input label'></oj-some-element>

Get or set the labelHint property after initialization:

// getter
var value = myComponent.labelHint;

// setter
myComponent.labelHint = 'some new value'

list :string

Indicates a list of pre-defined options to suggest to the user. The value must be the id of a <datalist> element in the same page. This attribute is ignored when the type attribute's value is hidden.

Names

Item	Name
Property	list
Property change event	listChanged
Property change listener attribute (must be of type function)	on-list-changed

Examples

Initialize component with list attribute:

<oj-some-element list="sampleDataList"></oj-some-element>

Example for datalist:

<datalist id="sampleDataList">
  <option value="item 1">item 1</option>
  <option value="item 2">item 2</option>
  <option value="item 3">item 3</option>
  <option value="item 4">item 4</option>
</datalist> 

Get or set the list property after initialization:

// getter
var ro = myComp.list;

// setter
myComp.list = "myDataList";

messages-custom :Array.<Object>

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 oj.Message for details.

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

Since:

• 0.7

Names

Item	Name
Property	messagesCustom
Property change event	messagesCustomChanged
Property change listener attribute (must be of type function)	on-messages-custom-changed

Examples

Get or set the messagesCustom property after initialization:

// getter
var customMsgs = myComp.messagesCustom;

// setter
myComp.messagesCustom = [{summary:"hello", detail:"detail", severity:oj.Message.SEVERITY_LEVEL.INFO}];

Set messagesCustom when there are cross-validation errors:

--- HTML ---
<oj-some-element messages-custom='{{messagesCustom}}'></oj-some-element> 

--- ViewModel code ---
self.messagesCustom = ko.observableArray([]);

// the app's function that gets called when the user presses the submit button
if (!myValidateCrossValidationFields())
{
  // the app adds a custom messages to the component and it is displayed right away
  var msgs = [];
  msgs.push({'summary':'Cross field error', 'detail':'Field 1 needs to be less than Field 2'});
  self.messagesCustom(msgs);
}
else
{
  // submit data to the server
}

name :string

It indicates the name of the component.

Default Value:

• ""

Since:

• 4.0.0

Names

Item	Name
Property	name
Property change event	nameChanged
Property change listener attribute (must be of type function)	on-name-changed

Examples

Initialize component with name attribute:

<oj-some-element name="myName"></oj-some-element>

Get or set the name property after initialization:

// getter
var ro = myComp.name;

// setter
myComp.name = myName;

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)	on-placeholder-changed

Examples

Initialize the component with the placeholder attribute:

<oj-some-element placeholder="User Name"></oj-some-element>

Get or set the placeholder property after initialization:

// getter
var myPh = myComp.placeholder;

// setter
myComp.placeholder = myPlaceholder;

If the attribute is not set and if a converter is set then the
converter hint is used. See displayOptions for details.

(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

Since:

• 1.2.0

Names

Item	Name
Property	rawValue
Property change event	rawValueChanged
Property change listener attribute (must be of type function)	on-raw-value-changed

readonly :boolean

Dictates component's readonly state.

Default Value:

• false

Names

Item	Name
Property	readonly
Property change event	readonlyChanged
Property change listener attribute (must be of type function)	on-readonly-changed

Examples

Initialize component with readonly attribute:

<oj-some-element readonly></oj-some-element>

Get or set the readonly property after initialization:

// getter
var ro = myComp.readonly;

// setter
myComp.readonly = false;

required :boolean

Whether the component is required or optional. When required is set to true, an implicit required validator is created using the validator factory - oj.Validation.validatorFactory(oj.ValidatorFactory.VALIDATOR_TYPE_REQUIRED).createValidator(). Translations specified using the translations.required attribute and the label associated with the component, are passed through to the options parameter of the createValidator method.

When required property changes due to programmatic intervention, the component may clear messages and run validation, based on the current state it's in.

Running Validation

• if component is valid when required is set to true, then it runs deferred validation on the value property. This is to ensure errors are not flagged unnecessarily.
• if component is invalid and has deferred messages when required is set to false, then component messages are cleared but no deferred validation is run.
• 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

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

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 user and the input's label will render a required icon. Additionally a required validator - oj.RequiredValidator - is implicitly used if no explicit required validator is set. An explicit required validator can be set by page authors using the validators attribute.

Default Value:

• false

Since:

• 0.7

See:

• #translations

Names

Item	Name
Property	required
Property change event	requiredChanged
Property change listener attribute (must be of type function)	on-required-changed

Examples

Initialize the component with the required attribute:

<oj-some-element required></oj-some-element>

Customize messages and hints used by implicit required validator when required attribute is set:

<oj-some-element required translations='{"required": {
                "hint": "custom: enter at least 3 alphabets",
                "messageSummary": "custom: \'{label}\' is Required", 
                "messageDetail": "custom: please enter a valid value for \'{label}\'"}}'>
</oj-some-element>

Get or set the required property after initialization:

// getter
var rq = myComp.required;

// setter
myComp.required = false;

spellcheck :boolean

Setting the value of this attribute to true indicates that the element needs to have its spelling and grammar checked. The value default indicates that the element is to act according to a default behavior, possibly based on the parent element's own spellcheck value. The value false indicates that the element should not be checked.

Default Value:

• false

Names

Item	Name
Property	spellcheck
Property change event	spellcheckChanged
Property change listener attribute (must be of type function)	on-spellcheck-changed

Examples

Initialize component with spellcheck attribute:

<oj-some-element spellcheck></oj-some-element>

Get or set the spellcheck property after initialization:

// getter
var ro = myComp.spellcheck;

// setter
myComp.spellcheck = false;

translations :Object|null

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.

Names

Item	Name
Property	translations
Property change event	translationsChanged
Property change listener attribute (must be of type function)	on-translations-changed

Examples

Initialize the component, overriding some translated resources and leaving the others intact:

<!-- Using dot notation -->
<oj-some-element translations.some-key='some value' translations.some-other-key='some other value'></oj-some-element>

<!-- Using JSON notation -->
<oj-some-element translations='{"someKey":"some value", "someOtherKey":"some other value"}'></oj-some-element>

Get or set the translations property after initialization:

// Get one
var value = myComponent.translations.someKey;

// Set one, leaving the others intact. Always use the setProperty API for 
// subproperties rather than setting a subproperty directly.
myComponent.setProperty('translations.someKey', 'some value');

// Get all
var values = myComponent.translations;

// Set all.  Must list every resource key, as those not listed are lost.
myComponent.translations = {
    someKey: 'some value',
    someOtherKey: 'some other value'
};

(nullable) translations.regexp :Object

Provides properties to customize the message text used by the implicit regexp validator associated to the InputText and TextArea components.

See the translations attribute for usage examples.

Since:

• 0.7

Names

Item	Name
Property	translations.regexp

(nullable) translations.regexp.message-detail :string

Provides properties to customize the error message detail used by the implicit regexp validator associated to the InputText and TextArea components.

See the translations attribute for usage examples.

Since:

• 0.7

Names

Item	Name
Property	translations.regexp.messageDetail

(nullable) translations.regexp.message-summary :string

Provides properties to customize the error message summary used by the implicit regexp validator associated to the InputText and TextArea components.

See the translations attribute for usage examples.

Since:

• 0.7

Names

Item	Name
Property	translations.regexp.messageSummary

(nullable) translations.required :Object

Provides properties to customize the summary, detail and hint text used by the implicit required validator associated to any editable component that supports the required option.

See the translations attribute and required option for usage examples.

Since:

• 0.7

Names

Item	Name
Property	translations.required

(nullable) translations.required.hint :string

Hint text used by required validation error.

See the translations attribute for usage examples.

Default Value:

• ""

Since:

• 0.7

See:

• oj.RequiredValidator

Names

Item	Name
Property	translations.required.hint

(nullable) translations.required.message-detail :string

Message text that describes the details of the required validation error.

See the translations attribute for usage examples.

Default Value:

• ""

Since:

• 0.7

See:

• oj.RequiredValidator

Names

Item	Name
Property	translations.required.messageDetail

(nullable) translations.required.message-summary :string

Message text for summarizing a required validation error.

See the translations attribute for usage examples.

Default Value:

• ""

Since:

• 0.7

See:

• oj.RequiredValidator

Names

Item	Name
Property	translations.required.messageSummary

(readonly) valid :string

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

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

• after validation 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:

Name	Type	Description
"invalidHidden"	string	The component has invalid messages hidden and no invalid messages showing. An invalid message is one with severity "error" or higher.
"invalidShown"	string	The component has invalid messages showing. An invalid message is one with severity "error" or higher.
"pending"	string	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"	string	The component is valid

Supports writeback:

• true

Since:

• 4.2.0

Names

Item	Name
Property	valid
Property change event	validChanged
Property change listener attribute (must be of type function)	on-valid-changed

Examples

Get valid attribute, after initialization:

// Getter:
var valid = myComp.valid;

Set the on-valid-changed listener so you can do work in the ViewModel based on the valid property:

<oj-some-element id='username' on-valid-changed='[[validChangedListener]]'>
</oj-some-element>
<oj-some-element id='password' on-valid-changed='[[validChangedListener]]'>
</oj-some-element>
<oj-button disabled='[[componentDisabled]]' on-click='[[submit]]'>Submit</oj-button>
-- ViewModel --
self.validChangedListener = function (event) {
  var enableButton;
  var usernameValidState;
  var passwordValidState;
  
  // update the button's disabled state.
  usernameValidState = document.getElementById("username").valid;
  passwordValidState = document.getElementById("password").valid;
  
  // this updates the Submit button's disabled property's observable based
  // on the valid state of two components, username and password.
  // It is up to the application how it wants to handle the �pending� state 
  // but we think that in general buttons don�t need to be 
  // enabled / disabled based on the "pending" state.
  enableButton = 
   (usernameValidState !== "invalidShown") &&
   (passwordValidState !== "invalidShown");
  self.componentDisabled(!enableButton);;
};

validators :(Array.<(oj.Validator.<V>|oj.Validation.RegisteredValidator)>|null)

List of synchronous validators used by component along with asynchronous validators and the implicit component validators when performing validation. Each item is either an instance that duck types oj.Validator, or is an Object literal containing the properties listed below.

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 in the notewindow by default, or as determined by the 'validatorHint' property set on the display-options attribute.

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. E.g., notewindow displays the new hint(s).

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.

Properties:

Name	Type	Argument	Description
type	string		the validator type that has a oj.ValidatorFactory that can be retrieved using the oj.Validation module. For a list of supported validators refer to oj.ValidatorFactory. E.g., {validators: [{type: 'regExp'}]}
options	Object	<optional>	optional Object literal of options that the validator expects. E.g., {validators: [{type: 'regExp', options: {pattern: '[a-zA-Z0-9]{3,}'}}]}

Default Value:

• []

Names

Item	Name
Property	validators
Property change event	validatorsChanged
Property change listener attribute (must be of type function)	on-validators-changed

Examples

Initialize the component with validator object literal:

<oj-some-element validators='[{"type": "regExp", "options": {
                    "pattern": "[a-zA-Z0-9]{3,}", 
                    "messageDetail": "You must enter at least 3 letters or numbers"}}]'>
</oj-some-element>      

Initialize the component with multiple validator instances:

self.checkfooey = {
  'validate' : function(value) {
    if (value === "fooey" || value === "pass") {
      return true;
    } else {
      throw new Error("value isn't fooey or pass");
    }
  }
};
self.checkbar = {
'validate' : function(value) {
  if (value === "bar" || value === "pass") {
    return true;
  } else {
    throw new Error("value isn't bar or pass");
  }
 }
};
var validators = [checkfooey, checkbar]

... HTML...
<oj-some-element validators='[[validators]]'>
</oj-some-element>      

Get or set the validators property after initialization:

// getter
var validators = myComp.validators;

// setter
myComp.validators = myValidators;

value :any

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.

Running Validation

• component always runs deferred validation; the valid property is updated with the result.

Default Value:

• null

Supports writeback:

• true

Since:

• 0.6

Names

Item	Name
Property	value
Property change event	valueChanged
Property change listener attribute (must be of type function)	on-value-changed

Examples

Initialize the component with the value attribute specified:

<oj-some-element value='10'></oj-some-element>

Get or set value attribute, after initialization:

// Getter: returns '10'
var val = myComp.value;
// Setter: sets '20'
myComp.value = '20';

virtual-keyboard :string

The type of virtual keyboard to display for entering value on mobile browsers. This attribute has no effect on desktop browsers.

Supported Values:

Name	Type	Description
"auto"	string	The component will determine the best virtual keyboard to use. This is always "text" for this release but may change in future releases.
"email"	string	Use a virtual keyboard for entering email.
"number"	string	Use a virtual keyboard for entering number. 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.
"search"	string	Use a virtual keyboard for entering search terms.
"tel"	string	Use a virtual keyboard for entering telephone number.
"text"	string	Use a virtual keyboard for entering text.
"url"	string	Use a virtual keyboard for entering URL.

Default Value:

• "auto"

Since:

• 5.0.0

Names

Item	Name
Property	virtualKeyboard
Property change event	virtualKeyboardChanged
Property change listener attribute (must be of type function)	on-virtual-keyboard-changed

Examples

Initialize the component with the virtual-keyboard attribute:

<oj-input-text virtual-keyboard="number"></oj-input-text>

Get or set the virtualKeyboard property after initialization:

// Getter
var virtualKeyboard = myComp.virtualKeyboard;

// Setter
myComp.virtualKeyboard = "number";

Events

ojAnimateEnd

Triggered when a default animation has ended.

Properties:

All of the event payloads listed below can be found under event.detail.

Name	Type	Description
action	string	The action that triggers the animation. Supported values are: "inline-open" - when an inline message container opens or increases in size "inline-close" - when an inline message container closes or decreases in size "notewindow-open" - when a note window opens "notewindow-close" - when a note window closes
element	Element	The element being animated.

Since:

• 4.0.0

Examples

Define an event listener for the ojAnimateEnd event to add any processing after the end of "inline-open" animation:

var listener = function( event )
{
  // Check if this is the end of "inline-open" animation for inline message
  if (event.detail.action == "inline-open") {
    // Add any processing here
  }
};

Specify an ojAnimateEnd listener via the DOM attribute:

<oj-input-text on-oj-animate-end='[[listener]]'></oj-input-text>

Specify an ojAnimateEnd listener via the JavaScript property:

myInputText.onOjAnimateEnd = listener;

Add an ojAnimateEnd listener via the addEventListener API:

myInputText.addEventListener('ojAnimateEnd', listener);

ojAnimateStart

Triggered when a default animation is about to start on an element owned by the component.

The default animation can be cancelled by calling event.preventDefault, followed by a call to event.detail.endCallback. event.detail.endCallback should be called immediately after event.preventDefault if the application merely wants to cancel animation, or it should be called when the custom animation ends if the application is invoking another animation function. Failure to call event.detail.endCallback may prevent the component from working properly.

For more information on customizing animations, see the documentation of oj.AnimationUtils.

The default animations are controlled via the theme (SCSS) :

// default animations for "notewindow" display option
$noteWindowOpenAnimation: (effect: "zoomIn", transformOrigin: "#myPosition") !default;
$noteWindowCloseAnimation: (effect: "none") !default;

// default animations for "inline" display option
$messageComponentInlineOpenAnimation: (effect: "expand", startMaxHeight: "#oldHeight") !default;
$messageComponentInlineCloseAnimation: (effect: "collapse", endMaxHeight: "#newHeight") !default;

Properties:

All of the event payloads listed below can be found under event.detail.

Name	Type	Description
action	string	The action that triggers the animation. Supported values are: "inline-open" - when an inline message container opens or increases in size "inline-close" - when an inline message container closes or decreases in size "notewindow-open" - when a note window opens "notewindow-close" - when a note window closes
element	Element	The element being animated.
endCallback	function():void	If the event listener calls event.preventDefault to cancel the default animation, it must call the endCallback function when it finishes its own animation handling and any custom animation has ended.

Since:

• 4.0.0

Examples

Define an event listener for the ojAnimateStart event to override the default "inline-open" animation:

var listener = function( event )
  {
    // Change the "inline-open" animation for inline message
    if (event.detail.action == "inline-open") {
      // Cancel default animation
      event.preventDefault();
      // Invoke new animation and call endCallback when the animation ends
      oj.AnimationUtils.fadeIn(event.detail.element).then(event.detail.endCallback);
    }
  };

Define an event listener for the ojAnimateStart event to cancel the default "notewindow-close" animation:

var listener = function( event )
  {
    // Change the "notewindow-close" animation for note window
    if (ui.action == "notewindow-close") {
      // Cancel default animation
      event.preventDefault();
      // Call endCallback immediately to indicate no more animation
      event.detail.endCallback();
  };

Specify an ojAnimateStart listener via the DOM attribute:

<oj-input-text on-oj-animate-start='[[listener]]'></oj-input-text>

Specify an ojAnimateStart listener via the JavaScript property:

myInputText.onOjAnimateStart = listener;

Add an ojAnimateStart listener via the addEventListener API:

myInputText.addEventListener('ojAnimateStart', listener);

Methods

getProperty(property) → {any}

Retrieves a value for a property or a single subproperty for complex properties.

Parameters:

Name	Type	Description
property	string	The property name to get. Supports dot notation for subproperty access.

Since:

• 4.0.0

Returns:

Type

any

Example

Get a single subproperty of a complex property:

var subpropValue = myComponent.getProperty('complexProperty.subProperty1.subProperty2');

refresh() → {void}

Refreshes the component. Usually called after dom changes have been made.

Returns:

Type

void

Example

Refresh component after dome changes have been made.

// refresh component. 
myComp.refresh();

reset() → {void}

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

Since:

• 0.7

Returns:

Type

void

Example

Reset component

myComp.reset(); 

setProperties(properties) → {void}

Performs a batch set of properties.

Parameters:

Name	Type	Description
properties	Object	An object containing the property and value pairs to set.

Since:

• 4.0.0

Returns:

Type

void

Example

Set a batch of properties:

myComponent.setProperties({"prop1": "value1", "prop2.subprop": "value2", "prop3": "value3"});

setProperty(property, value) → {void}

Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a [property]Changed event.

Parameters:

Name	Type	Description
property	string	The property name to set. Supports dot notation for subproperty access.
value	any	The new value to set the property to.

Since:

• 4.0.0

Returns:

Type

void

Example

Set a single subproperty of a complex property:

myComponent.setProperty('complexProperty.subProperty1.subProperty2', "someValue");

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.

Since:

• 0.7

Returns:

Type

void

Example

Display all messages including deferred ones.

myComp.showMessages();

validate() → {Promise.<string>}

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

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 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.
3. If there are no validators setup for the component the value option is updated using the display value. Otherwise all validators are run in sequence using the parsed value from the previous step. The implicit required validator 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.
4. At the end of validation if there are errors, the messages are shown. If there were no errors, then the value option is updated.

Since:

• 4.0.0

Returns:

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

Type

Promise.<string>

Examples

Validate component using its current value.

// validate display value and shows messages if there are any to be shown.
myComp.validate();

Validate component and use the Promise's resolved state.

myComp.validate().then(
 function(result) {
   if(result === "valid")
   {
     submitForm();
   }
 });