Class Mask

Object
   |
   +--Mask

class Mask

Defined in inputmask.js

Field Detail

fields

Array fields

Set of mask fields and literals

Mask

Mask()

A mask is a set of definitions to restrict the contents and format required in a form field. The mask can be composed by fields (input slots with specific rules for length and acceptable chars) and literals (members of the mask with fixed contents and sometimes fixed position)

accept

Boolean accept(<String> chr, <Number> caretPos, <Number> selSize, <Number> maxLen)

Test if a char must be accepted by the mask, given the current caret position and the current field's selection size

Parameters:
chr - Typed char
caretPos - Current caret position
selSize - Current field's selection size
maxLen - Field's maxlength

addField

void addField(<String> chars, <Number> min, <Number> max)

Adds a new field in the mask. The chars parameter must be a character class (0-9, a-z). Special characters (., [, ], ...) must be escaped

Parameters:
chars - Acceptable chars
min - Minimum size
max - Maximum size

addLiteral

void addLiteral(<String> c, <Boolean> opt)

Adds a new literal in the mask. Literals can't have a length greater than 1

Parameters:
c - Literal char
opt - Whether the literal is optional

apply

void apply(<Object> fld)

Apply the mask by filtering (when the mask is a simple filter) or formatting (when the mask contains multiple fields and literals)

Parameters:
fld - Field reference

filter

 <private> void filter(<Object> field)

Filters the field value removing chars that don't respect the mask regular expression

Parameters:
field - Field reference

format

 <private> void format(<Object> field)

Iterates through all the field chars, validating them against the mask format. Invalid chars will be removed and missing literals will be included

Parameters:
field - Field reference

getCaretPosition

Number getCaretPosition(<String> oldVal, <String> newVal, <Number> caret, <Number> key)

This method can be overriden to add caret position routines. This method will be called inside InputMask.keyUpHandler()

Parameters:
oldVal - Field's old value
newVal - Field's new value
caret - Field's last caret position
key - Last typed key

getMaxLength

Number getMaxLength()

Calculate the maxlength of the mask

getMaxPosition

Number getMaxPosition(<Number> idx, <Number> max)

Return the highest available position inside a field, based on its index. Optional literals will return 0

Parameters:
idx - Field index
max - Form input maxlength

isComplete

Boolean isComplete()

Verifies if the mask is complete

isOnlyFilter

Boolean isOnlyFilter()

Verify if the mask is a simple regexp filter, without multiple fields or literals

loadExpression

void loadExpression(<String> expr)

Transforms a given expression into fields and literals. The set of information that can be understood by this method is a small subset of the RegExp specification: character classes (with or without limits), mask chars or mask char sequences and literals

Parameters:
expr - Expression to be parsed

onAfterChange

String onAfterChange(<String> val)

Handler function called from inside Mask.format(). Should be used to apply extra format on the new field's value after the mask was applied and before updating the form input

Parameters:
val - New input value

onBeforeChange

String onBeforeChange(<String> val)

Handler function called from inside Mask.format(). It can be used to apply filters on the field's value before the formatting routines

Parameters:
val - Current input value

onBlur

void onBlur(<Object> fld)

This method can be overriden to apply transformations or validations in the field's value when the blur event occurs

Parameters:
fld - Field reference

onKeyDown

Boolean onKeyDown(<Object> fld, <Integer> caret, <Integer> key)

Handler function called from inside InputMask.keyDownHandler(). It can be used to override mask's default policy to accept typed chars

Parameters:
fld - Field reference
caret - Caret position
key - Last typed key

serialize

String serialize()

Serialize the mask

fromExpression

<static> Mask fromExpression(<String> expr, d)

Build a new instance of the Mask class based on a given expression. The expression is parsed by Mask.loadExpression()

Parameters:
expr - Mask expression

fromMaskName

<static> Mask fromMaskName(<String> name)

Return a Mask object based on one of the mask names available to the PHP2Go form API: DIGIT, INTEGER, FLOAT, CURRENCY, DATE, ...

Parameters:
name - Mask name