Class ValidatingText

Object
   |
   +--Widget
         |
         +--Text
               |
               +--ValidatingText

Direct Known Subclasses:

TrimmedText, AlphaText, NumericText, DecimalText, AlphaNumericText, IntegerText

class ValidatingText

extends Text

Defined in form_widgets.js

Constructor Detail

ValidatingText

function ValidatingText(<Function> validKeyRangeFunc, <Function> validValueFunc, <Function> textTransformerFunc)

The ValidatingText object inherits Text and provides a means for executing validation functions on a text box. ValidatingText uses three validation functions. A key validator (used to restrict key presses), a value validtor (used to ensure a valid value is in the text field) and a text transformer (used to translate text from one form to another). Several pre-defined implementations use ValidatingText including: DecimalText,NumericText,TrimmedText,AlphaText,AlphaNumericText and IntegerText. Creates a text widget that has the capability to restrict the keys the user is able to enter. Also, it has the capability to validate the text in the text box on the 'change' event and will revert the change if it doesn't match.

Parameters:
validKeyRangeFunc - (Optional) - a function taking a single integer argument representing the entered key code (Unicode) and returning true if the character is allowed or false otherwise. If this argument is null all charactors will be allowed.

For example: function(keyCode) { return (keyCode >= 65 && keyCode <= 90); }

validValueFunc - (Optional) - a function taking a single string argument representing the current text value. The function should return true if the text is valid or false otherwise.

For example: function(text) { return (text == "TEST"); }

textTransformerFunc - (Optional) - this function is called on a change event to transform the text in the text box. It is also called when the validation function fails in order to attempt to resolve the failed validation. It takes a single string as it's argument and returns a resultant string.

For example: function(text) { return ((text=="123A") ? "123" : text); }

_handleChange

function _handleChange(e)

_handleKeyPress

function _handleKeyPress(e)

isAlpha

boolean isAlpha(<int> keyCode)

Returns true if the keyCode is alphabetic.

Parameters:
keyCode - An ascii integer.

isAlphaNum

boolean isAlphaNum(<int> keyCode)

Returns true if the keyCode is alphanumeric.

Parameters:
keyCode - An ascii integer.

isDigit

boolean isDigit(<int> keyCode)

Returns true if the keyCode is a digit.

Parameters:
keyCode - An ascii integer.

isLower

boolean isLower(<int> keyCode)

Returns true if the keyCode is lower case.

Parameters:
keyCode - An ascii integer.

isSpace

boolean isSpace(<int> keyCode)

Returns true if the keyCode is a space character which includes tabs, line-feeds, etc.

Parameters:
keyCode - An ascii integer.

isUpper

boolean isUpper(<int> keyCode)

Returns true if the keyCode is upper case.

Parameters:
keyCode - An ascii integer.

setTextTransformer

void setTextTransformer(<Function> func)

Set the text transformation function for this validating text widget. See constructor for more details.

Parameters:
func - The text transformation function.