001    // Copyright 2005 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    //     http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.tapestry.form;
016    
017    import org.apache.tapestry.IMarkupWriter;
018    import org.apache.tapestry.IRequestCycle;
019    import org.apache.tapestry.valid.ValidatorException;
020    
021    /**
022     * 
023     */
024    public interface TranslatedFieldSupport
025    {
026    
027        /**
028         * Formats the field translation.
029         *
030         * @param field
031         *          The field the value is being formatted for.
032         * @param object
033         *          The object value to be formatted.
034         *
035         * @return The formatted string value of the given object.
036         */
037        String format(TranslatedField field, Object object);
038    
039        /**
040         * Parses the field value.
041         * @param field
042         *          The field to parse the value from.
043         * @param text
044         *          The input text.
045         *
046         * @return The parsed field value in its translated object form.
047         * @throws ValidatorException On validation error.
048         */
049        Object parse(TranslatedField field, String text)
050            throws ValidatorException;
051    
052        /**
053         * Renders client side / misc contributions when the field is being rendered.
054         *
055         * @param field
056         *          The field being rendered.
057         * @param writer
058         *          The markup writer to use.
059         * @param cycle
060         *          The current request.
061         */
062        void renderContributions(TranslatedField field, IMarkupWriter writer, IRequestCycle cycle);
063    }