org.apache.wiki.forms.FormTextarea Maven / Gradle / Ivy

Go to download
/*
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you 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.wiki.forms;

import org.apache.wiki.api.core.Context;
import org.apache.wiki.api.exceptions.PluginException;
import org.apache.wiki.api.plugin.Plugin;
import org.apache.wiki.preferences.Preferences;
import org.apache.wiki.util.XHTML;
import org.apache.wiki.util.XhtmlUtil;
import org.jdom2.Element;

import java.util.HashMap;
import java.util.Map;
import java.util.ResourceBundle;

/**
 *  Creates a Form text area element. You may specify the size of the textarea
 *  by using the {@link #PARAM_COLS} and {@link #PARAM_ROWS} to signify the width
 *  and height of the area.
 */
public class FormTextarea extends FormElement {
    /** Parameter name for setting the rows value.  Value is {@value}. */
    public static final String PARAM_ROWS = "rows";

    /** Parameter name for setting the columns value.  Value is {@value}. */
    public static final String PARAM_COLS = "cols";

    /**
     *  {@inheritDoc}
     */
    @Override
    public String execute( final Context ctx, final Map< String, String > params ) throws PluginException {
        // Don't render if no error and error-only-rendering is on.
        final FormInfo info = getFormInfo( ctx );
        Map< String, String > previousValues = null;
        final ResourceBundle rb = Preferences.getBundle( ctx, Plugin.CORE_PLUGINS_RESOURCEBUNDLE );

        if ( info != null ) {
            if ( info.hide() ) {
                return "" + rb.getString( "formclose.noneedtoshow" ) + "";
            }
            previousValues = info.getSubmission();
        }

        if ( previousValues == null ) {
            previousValues = new HashMap<>();
        }

        final Element field = buildTextArea( params, previousValues, rb );

        // We should look for extra params, e.g. width, ..., here.
        return XhtmlUtil.serialize(field, XhtmlUtil.EXPAND_EMPTY_NODES ); // ctx.getEngine().getContentEncoding()
    }

    private Element buildTextArea(
            final Map< String, String > params,
            final Map< String, String > previousValues,
            final ResourceBundle rb )
            throws PluginException {
        final String inputName = params.get(PARAM_INPUTNAME);
        final String rows = params.get(PARAM_ROWS);
        final String cols = params.get(PARAM_COLS);

        if ( inputName == null ) {
        	throw new PluginException( rb.getString( "formtextarea.namemissing" ) );
        }

        // In order to isolate posted form elements into their own map, prefix the variable name here. It will be stripped
        // when the handler plugin is executed.
        final Element field = XhtmlUtil.element(XHTML.textarea);
        field.setAttribute(XHTML.ATTR_name,HANDLERPARAM_PREFIX + inputName);
        if ( rows != null ) {
            field.setAttribute(XHTML.ATTR_rows,rows);
        }
        if ( cols != null ) {
            field.setAttribute(XHTML.ATTR_cols,cols);
        }

        if ( previousValues != null ) {
            String oldValue = previousValues.get( inputName );
            if( oldValue != null ) {
                field.addContent( oldValue );
            } else {
                oldValue = params.get( PARAM_VALUE );
                if( oldValue != null ) {
                    field.addContent( oldValue );
                }
            }
        }
        return field;
    }

}