org.apache.tapestry.contrib.valid.ValidatingTextField Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tapestry-contrib

There is a newer version: 4.1.6

// Copyright 2004, 2005 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package org.apache.tapestry.contrib.valid;

import org.apache.tapestry.valid.IValidator;
import org.apache.tapestry.valid.StringValidator;
import org.apache.tapestry.valid.ValidField;

/**
 * Backwards compatible version of the 1.0.7 ValidatingTextField component.
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Parameter Type Read / Write Required Default Description
text java.lang.String R / W yes   The text inside the text field.
 * 
 * When the form is submitted, the binding is only updated if the value is
 * valid.
minimumLength int R no 0 The minimum length (number of characters read) for the field. The value
 * provided in the request is trimmed of leading and trailing whitespace.
 * 
 * If a field is not required and no value is given, then minimumLength is
 * ignored. Minimum length only applies if some non-null value is
 * given.
required boolean R no false If true, then a non-null value must be provided. A value consisting only
 * of whitespace is considered null.
displayName String R yes   A textual name for the field that is used when formulating error
 * messages.
 * 
 * May not have a body. May have informal parameters.
 * 
 * @author Howard Lewis Ship
 * @since 1.0.8
 * @see org.apache.tapestry.valid.ValidField
 */

public abstract class ValidatingTextField extends ValidField
{

    public abstract int getMinimumLength();

    public abstract boolean isRequired();

    public abstract String getText();

    public abstract void setText(String value);

    /*
     * (non-Javadoc)
     * 
     * @see org.apache.tapestry.valid.ValidField#getValue()
     */
    public Object getValue()
    {
        return getText();
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.apache.tapestry.valid.ValidField#setValue(java.lang.Object)
     */
    public void setValue(Object value)
    {
        setText((String) value);
    }

    /**
     * Overrides {@link ValidField#getValidator()}to construct a validator on
     * the fly.
     */
    public IValidator getValidator()
    {
        StringValidator validator = new StringValidator();

        if (isParameterBound("required")) validator.setRequired(isRequired());

        if (isParameterBound("minimumLength"))
            validator.setMinimumLength(getMinimumLength());

        return validator;
    }
}

Parameter	Type	Read / Write	Required	Default	Description
text	java.lang.String	R / W	yes		The text inside the text field. * * When the form is submitted, the binding is only updated if the value is * valid.
minimumLength	int	R	no	0	The minimum length (number of characters read) for the field. The value * provided in the request is trimmed of leading and trailing whitespace. * * If a field is not required and no value is given, then minimumLength is * ignored. Minimum length only applies if some non-null value is * given.
required	boolean	R	no	false	If true, then a non-null value must be provided. A value consisting only * of whitespace is considered null.
displayName	String	R	yes		A textual name for the field that is used when formulating error * messages.