Class InputMask

Object
   |
   +--InputMask

class InputMask

Defined in inputmask.js

Field Detail

caret

Number caret

Used to catch the field's caret position

ctrl

Boolean ctrl

Used to catch ctrl key

fld

Object fld

Form field associated with the mask

fs

FieldSelection fs

Reference to the FieldSelection singleton

ignore

Boolean ignore

Used to indicate chars that must be ignored

lastValue

String lastValue

Last field value

mask

Mask mask

Active mask object

paste

Boolean paste

Used to indicate a paste keyboard command

pressing

Boolean pressing

Used to control if a key is being pressed

selSize

Number selSize

Used to hold the field's selection size

shift

Boolean shift

Used to catch shift key

valid

Boolean valid

Used to indicate chars that might be accepted

ignoreCodes

<static> String ignoreCodes

Set of key codes to be ignored: pgup (33), pgdown (34), end (35), home (36), left (37), up (38), right (39), down (40), ins (45), del (127, konqueror), 4098 (shift+tab, konqueror)

InputMask

InputMask(<Object> fld, <Object> mask)

The InputMask class is used to apply a mask on a form field. The class contains a set of event handlers that interact with an instance of the Mask class to validate and format the data that is entered in the associated text input

Parameters:
fld - Field reference
mask - Mask instance

addListeners

void addListeners()

Register all event listeners in the field

blurHandler

void blurHandler(<Event> e)

The blur handler also calls the InputMask.update(), validating the field's value once more against the mask

Parameters:
e - Event instance

keyDownHandler

void keyDownHandler(<Event> e)

The keydown handler implements the first phase of the masking process: filters the keys that must be ignored, determine if the keystroke is a paste combination and retrieves the current caret position and selection size

Parameters:
e - Event instance

keyPressHandler

void keyPressHandler(<Event> e)

The keypress handler queries the field mask to determine if the pressed char must be accepted. If the mask rejects the char, the event returns false

Parameters:
e - Event instance

keyUpHandler

void keyUpHandler(<Event> e)

The keyup handler updates the field value by applying the mask format if the value changed, if a valid char was entered or if a paste command was executed

Parameters:
e - Event instance

pasteHandler

void pasteHandler(<Event> e)

The paste handler is used to handle onpaste (IE) and oninput (Gecko) events, updating the field's value by applying the mask format

Parameters:
e - Event instance

update

void update(<Event> e, <Boolean> isBlur)

Runs the format method of the field mask. It's called from inside InputMask.keyUpHandler(), InputMask.pasteHandler() and InputMask.blurHandler()

Parameters:
e - Event instance, when called from the event handlers
isBlur - Whether the update method was called from the blur handler

setup

<static> void setup(<Object> fld, <Object> mask)

Sets up an InputMask instance in a given field

Parameters:
fld - Field reference or id
mask - Mask instance or mask expression that must be parsed