org.apache.tapestry.valid

Class StringValidator

java.lang.Object

org.apache.tapestry.valid.BaseValidator

org.apache.tapestry.valid.StringValidator

All Implemented Interfaces:

IValidator

public class StringValidator
extends BaseValidator

Simple validation of strings, to enforce required, and minimum length (maximum length is enforced in the client browser, by setting a maximum input length on the text field).

Since:

1.0.8

Author:

Howard Lewis Ship

Field Summary

Fields inherited from class org.apache.tapestry.valid.BaseValidator

FIELD_SYMBOL, FORM_SYMBOL, FUNCTION_SYMBOL, VALIDATOR_SYMBOL

Constructor Summary

Constructors

Constructor and Description
StringValidator()
StringValidator(java.lang.String initializer) Initializes the StringValidator with properties defined by the initializer.

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	buildMinimumLengthMessage(IFormComponent field)
int	getMinimumLength()
java.lang.String	getMinimumLengthMessage()
java.lang.String	getScriptPath()
void	renderValidatorContribution(IFormComponent field, IMarkupWriter writer, IRequestCycle cycle) This implementation does nothing.
void	setMinimumLength(int minimumLength)
void	setMinimumLengthMessage(java.lang.String string) Overrides the field-too-short bundle key.
void	setScriptPath(java.lang.String scriptPath) Allows a developer to use the existing validation logic with a different client-side script.
java.lang.Object	toObject(IFormComponent field, java.lang.String input) Converts input, submitted by the client, into an object value.
java.lang.String	toString(IFormComponent field, java.lang.Object value) Invoked during rendering to convert an object value (which may be null) to a String.

Methods inherited from class org.apache.tapestry.valid.BaseValidator

buildRequiredMessage, checkRequired, formatString, formatString, formatString, getPattern, getRequiredMessage, isClientScriptingEnabled, isRequired, processValidatorScript, setClientScriptingEnabled, setRequired, setRequiredMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringValidator

public StringValidator()

StringValidator

public StringValidator(java.lang.String initializer)

Initializes the StringValidator with properties defined by the initializer.

Since:

4.0

Method Detail

toString

public java.lang.String toString(IFormComponent field,
                        java.lang.Object value)

Description copied from interface: IValidator

Invoked during rendering to convert an object value (which may be null) to a String. It is acceptible to return null. The string will be the VALUE attribute of the HTML text field.

toObject

public java.lang.Object toObject(IFormComponent field,
                        java.lang.String input)
                          throws ValidatorException

Description copied from interface: IValidator

Converts input, submitted by the client, into an object value. May return null if the input is null (and the required flag is false).

The input string will already have been trimmed. It may be null.

Throws:

ValidatorException - if the string cannot be converted into an object, or the object is not valid (due to other constraints).

getMinimumLength

public int getMinimumLength()

setMinimumLength

public void setMinimumLength(int minimumLength)

renderValidatorContribution

public void renderValidatorContribution(IFormComponent field,
                               IMarkupWriter writer,
                               IRequestCycle cycle)

Description copied from class: BaseValidator

This implementation does nothing. Subclasses may supply their own implementation.

Specified by:

renderValidatorContribution in interface IValidator

Overrides:

renderValidatorContribution in class BaseValidator

Since:

2.2

getScriptPath

public java.lang.String getScriptPath()

Since:

2.2

setScriptPath

public void setScriptPath(java.lang.String scriptPath)

Allows a developer to use the existing validation logic with a different client-side script. This is often sufficient to allow application-specific error presentation (perhaps by using DHTML to update the content of a <span> tag, or to use a more sophisticated pop-up window than window.alert()).

Since:

2.2

getMinimumLengthMessage

public java.lang.String getMinimumLengthMessage()

Since:

3.0

setMinimumLengthMessage

public void setMinimumLengthMessage(java.lang.String string)

Overrides the field-too-short bundle key. Parameter {0} is the minimum length. Parameter {1} is the display name of the field.

Since:

3.0

buildMinimumLengthMessage

protected java.lang.String buildMinimumLengthMessage(IFormComponent field)

Since:

3.0