Supplied Validators

Requires Platform 4.5+   

Supplied Validators

 This documet describes the use of the following supplied validators:

Common Attributes

All supplied validators provide the following common attributes:

For example:

Validator Declaration

<validator:requiredFieldValidator
xmlns="http://nexaweb.com/validator"
id="usernameValidator"
value="username.text"
onSuccess="macro://success.execute()"
onFailure="macro://failure.execute()" /> 

Element to Validate

<textField id="username" text="" /> 

stringLengthValidator

In addition to the attributes common to all validators, the stringLengthValidator provides the following attributes:

Maximum and minimum values include the value specified.

You can use an open ended range by specifying only a maximum or minimum value.

If you do not specify a minimum or maximum value, the element on which you invoke the validator accepts data of any length.

For example:

The following stringLengthValidator validates a string from 8 to 15 characters in length.

Validator Declaration

<validator:stringLengthValidator
xmlns:validator="http://nexaweb.com/validator"
id="passwordValidator"
value="password.text"
minimum="8"
maximum="15"
onSuccess="mco://myMco.validPassword()"
onFailure="mco://myMco.invalidPassword()"/> 

Element to Validate

<passwordField id="password" text="" />

Specify a minimum attribute value of 8 to create an open-ended range of at least 8 characters.

Specify a maximum attribute value of 8 to create an open-ended range of no more than 8 characters. 

Specify minimum and maximim values of 8 to validate for a value length of exactly 8 characters.

rangeValidator

In addition to the attributes common to all validators, the rangeValidator provides the following attributes:

Maximum and minimum values include the value specified.

You can use an open ended range by specifying only a maximum or minimum value. 

For example:

Validator Declaration

 <validator:rangeValidator
xmlns:validator=http://nexaweb.com/validator
id="weightValidator"
value="weight.text"
minimum="2.5"
maximum="5.8"
format="0.0"
locale="en_US"
onSuccess="mco://myMco.validWeight()"
onFailure="mco://myMco.invalidWeight()" />

Element to Validate

<textField id="weight" text="" />

dateValidator

In addition to the attributes common to all validators, the dateValidator provides the following attributes:

For example:

Validator Declaration

 <validator:dateValidator
xmlns=http://nexaweb.com/validator
id="birthValidator"
value="birthdate.text" 
format="yyyy/MM/dd"
locale="es_ES"
onSuccess="mco://myMco.validBirthdate()"
onFailure="mco://myMco.invalidBirthdate()" />

Element to Validate

<textField id="birthdate" text="" />

currencyValidator

In addition to the attributes common to all validators, the currencyValidator provides the following attributes:

Example

Validator Declaration  

<validator:dateValidator
xmlns:validator=http://nexaweb.com/validator
id="totalValidator"
value="total.text"
prefix="¥" 
locale="ja_JP"
onSuccess="mco://myMco.validTotal()"
onFailure="mco://myMco.invalidTotal()" /> 

Element to Validate

 <textField id="total" text="" />

Validator Chain

You can create a validatorChain to run a series of validators on the same or different fields in a UI file.

The validatorChain provides a failFast boolean attribute, which when set to true, causes the validator chain to stop executing as soon as any validator fails. You can specify onSuccess and onFailure behaviors for the chain in addition to setting these for each validator included in the chain. The chain succeeds if all the validators within it succeed.

 If you set onSuccess and onFailure behaviors for the chain in addition to any or all of the validator included in the chain, users can potentially see messages for the success or failure of each validator in addition to seeing messages for the success or failure of the chain. 

You can include in a validatorChain a:

• Previously declared validator
• Validator declared for first time in chain
• Validator reference.

The validatorChain element tag includes the following attributes:

<val:validatorChain
xmlns:validator=http://nexaweb.com/validator
id="loginValidator"
onSuccess="mco://myMco.login()"
onFailure="macro://failure.execute('invalid username and or password')"
failFast= >
<validator:Validator />
<validator:validatorReference  />
</validator:validatorChain>

The following table provides descriptions of the validatorChain attributes:

 Example:

Validator Declaration

 <validator:requiredFieldValidator 
   xmlns:validator="http://nexaweb.com/validator"
   id="passwordRequiredValidator"
   value="password.text"
   onSuccess=""
   onFailure="macro://failureMacro.execute('Password required')" />

Validator Chain Declaration

 <validator:validatorChain 
   xmlns:validator="http://nexaweb.com/validator">
   id="myValidator">
  <validator:validatorReference validator="passwordRequiredValidator" />
  <validator:stringLengthValidator
     value="password.text"
     minimum="8"
     maximum="20"
    onSuccess="mco://myMco.login()"
    onFailure="macro://failureMacro.execute(
               'Password must be between 8 and 20 character')" />
</validator:validatorChain>

Element to Validate

 <textField id="password"
   text=""
   onTextChange="validator://myValidator.execute()" />

In this example, the validatorChain, myValidator, includes two validators: the passwordRequiredValidator, declared outside of the chain and specified by reference; and the stringLengthValidator, declared inside the chain only.

Validator Reference

You can reference a previously declared validator in a validatorChain using a validator reference as a shorcut syntax.

The validatorReference tag element appears as follows

<validator:validatorReference
xmlns:validator="http://nexaweb.com/validator"
validator="usernameValidator" /> 

The following table provides descriptions of the validatorReference attributes: