Final Class: RequiredValidator

Oracle® JavaScript Extension Toolkit (JET)
8.0.0
F18189-01

Signature:

final class RequiredValidator implements Validator<object|string|number>

QuickNav

Methods

Type Definitions


RequiredValidator

Version:
  • 8.0.0
Since:
  • 0.6.0
Module:
  • ojvalidator-required

Module usage

See JET Module Loading for an overview of module usage within JET.

Javascript Import Format
define(['ojs/ojvalidator-required'], function(RequiredValidator) {
 // Application should call API on RequiredValidator 
})
Typescript Import Format
//This class is exported directly as module. To import it
import RequiredValidator= require("ojs/ojvalidator-required");

JET In Typescript

A detailed description of working with JET elements and classes in your typescript project can be found at: JET Typescript Usage.

Final classes in JET

Classes in JET are generally final and do not support subclassing. At the moment, final is not enforced. However, this will likely change in an upcoming JET release.

See:
  • oj.AsyncRequiredValidator

Constructor

new RequiredValidator(options)

Constructs a RequiredValidator that ensures that the value provided is not empty.
Parameters:
Name Type Argument Description
options oj.RequiredValidator.ValidatorOptions <optional>
 an object literal used to provide an optional hint and error message.
See:
  • oj.AsyncRequiredValidator

Methods

getHint() : {string|null}

A message to be used as hint, when giving a hint on the expected pattern. There is no default hint for this property.
Returns:
a hint message or null if no hint is available in the options
Type
string | null

validate(value) : {void}

Validates value to be non-empty
Parameters:
Name Type Description
value Object | string | number that is being validated
Throws:
when fails required-ness check
Type
Error
Returns:
Type
void

Type Definitions

ValidatorOptions

Properties:
Name Type Argument Description
hint string <optional>
 an optional hint text. There is no default hint provided by this validator.
label string <optional>
 an optional label text used when the {label} token is passed into messageSummary or messageDetail.
messageSummary string <optional>
 an optional custom error message summarizing the error. When not present, the default message summary is the resource defined with the key oj-validator.required.summary.

The messageSummary string is passed as the 'pattern' parameter to oj.Translations.html#applyParameters. As stated in that documentation, if you are using a reserved character, you need to escape it with a dollar character ('$').

Tokens: {label} - this token can be used to substitute the label of the component at runtime.

Example:
"'{label}' Required"
messageDetail string <optional>
 a custom error message used for creating detail part of message, when the value provided is empty. When not present, the default message detail is the resource defined with the key oj-validator.required.detail.

The messageDetail string is passed as the 'pattern' parameter to oj.Translations.html#applyParameters. As stated in that documentation, if you are using a reserved character, you need to escape it with a dollar character ('$').

Tokens: {label} - this token can be used to substitute the label of the component at runtime.

Example:
"A value is required for the field '{label}'."