tapestry-framework/src/java/org/apache/tapestry/html/InsertText.java

// 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.html;

import org.apache.hivemind.ApplicationRuntimeException;
import org.apache.tapestry.AbstractComponent;
import org.apache.tapestry.IMarkupWriter;
import org.apache.tapestry.IRequestCycle;

import java.io.IOException;
import java.io.LineNumberReader;
import java.io.Reader;
import java.io.StringReader;

/**
 * Inserts formatted text (possibly collected using a
 * {@link org.apache.tapestry.form.TextArea} component. [<a
 * href="../../../../../components/general/inserttext.html">Component Reference</a>]
 * <p>
 * To maintain the line breaks provided originally, this component will break
 * the input into individual lines and insert additional HTML to make each line
 * seperate.
 * <p>
 * This can be down more simply, using the &lt;pre&gt; HTML element, but that
 * usually renders the text in a non-proportional font.
 * 
 * @author Howard Lewis Ship
 */

public abstract class InsertText extends AbstractComponent
{

    protected void renderComponent(IMarkupWriter writer, IRequestCycle cycle)
    {
        if (cycle.isRewinding())
            return;

        String value = getValue();

        if (value == null)
            return;

        StringReader reader = null;
        LineNumberReader lineReader = null;
        InsertTextMode mode = getMode();
        boolean raw = getRaw();

        try
        {
            reader = new StringReader(value);
            lineReader = new LineNumberReader(reader);

            int lineNumber = 0;

            while(true)
            {
                String line = lineReader.readLine();

                // Exit loop at end of file.

                if (line == null) 
                    break;

                mode.writeLine(lineNumber, line, writer, raw);
                
                lineNumber++;
            }

        }
        catch (IOException ex)
        {
            throw new ApplicationRuntimeException(HTMLMessages.textConversionError(ex), this, null, ex);
        }
        finally
        {
            close(lineReader);
            close(reader);
        }

    }

    private void close(Reader reader)
    {
        if (reader == null) return;

        try
        {
            reader.close();
        }
        catch (IOException e)
        {
        }
    }

    /** Parameter. */
    public abstract InsertTextMode getMode();

    public abstract void setMode(InsertTextMode mode);

    /** Parameter. */

    public abstract String getValue();

    /** Parameter. */

    public abstract boolean getRaw();

    /**
     * Sets the mode parameter property to its default,
     * {@link InsertTextMode#BREAK}.
     * 
     * @since 3.0
     */
    protected void finishLoad()
    {
        setMode(InsertTextMode.BREAK);
    }

}