com.sun.webui.jsf.renderkit.html.HiddenFieldRenderer Maven / Gradle / Ivy

Go to download
/*
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License).  You may not use this file except in
 * compliance with the License.
 * 
 * You can obtain a copy of the license at
 * https://woodstock.dev.java.net/public/CDDLv1.0.html.
 * See the License for the specific language governing
 * permissions and limitations under the License.
 * 
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at https://woodstock.dev.java.net/public/CDDLv1.0.html.
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * you own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 * 
 * Copyright 2007 Sun Microsystems, Inc. All rights reserved.
 */

/*
 * HiddenFieldRenderer.java
 */
package com.sun.webui.jsf.renderkit.html;

import com.sun.faces.annotation.Renderer;
import java.io.IOException;
import java.util.Map;
import javax.faces.FacesException;
import javax.faces.component.EditableValueHolder;
import javax.faces.component.UIComponent;
import javax.faces.context.ResponseWriter;
import javax.faces.context.FacesContext;
import com.sun.webui.jsf.component.Field;
import com.sun.webui.jsf.component.HiddenField;
import com.sun.webui.jsf.component.ComplexComponent;
import com.sun.webui.jsf.util.ConversionUtilities;
import com.sun.webui.jsf.util.MessageUtil;

/**
 * Renderer for HiddenFieldRenderer {@link HiddenField} component.
 */
@Renderer(@Renderer.Renders(componentFamily = "com.sun.webui.jsf.HiddenField"))
public class HiddenFieldRenderer extends javax.faces.render.Renderer {

    private static final boolean DEBUG = false;

    @Override
    public void encodeEnd(FacesContext context, UIComponent component) throws IOException {

        if (!(component instanceof HiddenField)) {
            Object[] params = {component.toString(),
                this.getClass().getName(),
                HiddenField.class.getName()};
            String message = MessageUtil.getMessage("com.sun.webui.jsf.resources.LogMessages", //NOI18N
                    "Renderer.component", params);              //NOI18N
            throw new FacesException(message);
        }

        HiddenField field = (HiddenField) component;
        ResponseWriter writer = context.getResponseWriter();
        writer.startElement("input", field); //NOI18N
        writer.writeAttribute("type", "hidden", null); //NOI18N
        String id = field.getClientId(context);
        writer.writeAttribute("id", id, null); //NOI18N
        writer.writeAttribute("name", id, null); //NOI18N

        // Record the value that is rendered.
        // Note that getValueAsString conforms to JSF conventions
        // for NULL values, in that it returns "" if the component
        // value is NULL. This value cannot be trusted since
        // the fidelity of the data must be preserved, i.e. if the
        // value is null, it must remain null if the component is unchanged
        // by the user..
        //
        // What should be done in the case of submittedValue != null ?
        // This call to getValue may not be value is used by
        // getValueAsString, it may use the submittedValue.
        // Then should the previously set rendered value be
        // preserved ?
        //
        // If submittedValue is not null then the component's
        // model value or local value has not been updated
        // therefore assume that this is an immediate or premature
        // render response. Therefore just assume that if the rendered
        // value was null, the saved information is still valid.
        //
        if (((HiddenField) component).getSubmittedValue() == null) {
            ConversionUtilities.setRenderedValue(component,
                    ((HiddenField) component).getText());
        }

        // Still call the component's getValueAsString method
        // in order to render it.
        //
        String value = field.getValueAsString(context);
        writer.writeAttribute("value", value, "value"); //NOI18N

        if (field.isDisabled()) {
            writer.writeAttribute("disabled", "disabled", null); //NOI18N
        }
        writer.endElement("input");
    }

    @Override
    public void decode(FacesContext context, UIComponent component) {
        decodeInput(context, component);
    }

    /**
     * Decode the component component
     * @param context The FacesContext associated with this request
     * @param component The TextField component to decode
     */
    static void decodeInput(FacesContext context, UIComponent component) {

        if (DEBUG) {
            log("decodeInput()");
        }

        String id = component.getClientId(context);
        Map params = context.getExternalContext().getRequestParameterMap();
        Object valueObject = params.get(id);
        String value = null;

        if (valueObject == null && component instanceof Field) {
            if (component instanceof ComplexComponent) {
                id = ((Field) component).getLabeledElementId(context);
            } else {
                id = component.getClientId(context);
            }
            valueObject = params.get(id);
        }

        if (valueObject != null) {
            value = (String) valueObject;
            if (DEBUG) {
                log("Submitted value is " + value);
            }

            if (component instanceof Field && ((Field) component).isTrim()) {
                value = value.toString().trim();
                if (DEBUG) {
                    log("Trimmed value is " + String.valueOf(value));
                }
            }
        } else if (DEBUG) {
            log("\tNo relevant input parameter");
        }

        ((EditableValueHolder) component).setSubmittedValue(value);
    }

    static protected void log(String s) {
        System.out.println(s);
    }
}