Class ecm.widget.ValidationTextBox

Extends dijit.form.ValidationTextBox.
Provides a widget that contains a text box in which the user input is validated against the specified criterion.

This class extends the Dojo dijit.form.ValidationTextBox class to add validation for byte maximum length.

Defined in: <ecm\widget\ValidationTextBox.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.ValidationTextBox()

Method Summary

Method Attributes	Method Name and Description
	destroy()
	getErrorMessage(isFocused) Retrieves the error message.
	getValue() Retrieves the displayed value.
	isValid(isFocused) Determines if the value is valid.
	postCreate()
	setCustomValidationError(errorMessage) Sets a custom validation error message.
	validate(isFocused) Validates the value.
	validator(value, constraints) Validates the data.

Constructor Detail

ecm.widget.ValidationTextBox()

Method Detail

destroy()

getErrorMessage(isFocused)

Retrieves the error message.

Parameters:
isFocused

Returns:: The error message string.

getValue()

Retrieves the displayed value.

Returns:: The displayed value.

{Boolean} isValid(isFocused)

Determines if the value is valid.

Parameters:
isFocused: A value of true if it has focus.

Returns:: {Boolean} A value of true if the value is valid, otherwise false.

postCreate()

setCustomValidationError(errorMessage)

Sets a custom validation error message.

Parameters:
errorMessage: The error message string.

{Boolean} validate(isFocused)

Validates the value. Includes error handling.

Parameters:
isFocused: A value of true if this field has focus, otherwise false.

Returns:: {Boolean} A value of true if the value is valid, otherwise false.

validator(value, constraints)

Validates the data.

Parameters:
value: The value.
constraints: A dijit.form.ValidationTextBox.__Constraints.