NXCheckboxRenderer.java

/*
 * (C) Copyright 2010 Nuxeo SA (http://nuxeo.com/) and others.
 *
 * 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.
 *
 * Contributors:
 *     Anahide Tchertchian
 */
package org.nuxeo.ecm.platform.ui.web.renderer;

import java.io.IOException;

import javax.faces.component.EditableValueHolder;
import javax.faces.component.UIComponent;
import javax.faces.component.ValueHolder;
import javax.faces.context.FacesContext;
import javax.faces.convert.Converter;
import javax.faces.convert.ConverterException;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import com.sun.faces.renderkit.html_basic.CheckboxRenderer;
import com.sun.faces.util.RequestStateManager;

/**
 * Renderer that does not ignore the converter set on the component on submit
 *
 * @author Anahide Tchertchian
 */
public class NXCheckboxRenderer extends CheckboxRenderer {

    private static final Log log = LogFactory.getLog(NXCheckboxRenderer.class);

    public static final String RENDERER_TYPE = "javax.faces.NXCheckbox";

    @Override
    public Object getConvertedValue(FacesContext context, UIComponent component, Object submittedValue)
            throws ConverterException {

        String newValue = null;
        if (submittedValue instanceof Boolean) {
            newValue = ((Boolean) submittedValue).toString();
        } else if (submittedValue instanceof String) {
            newValue = (String) submittedValue;
        } else if (submittedValue != null) {
            log.error("Unsupported submitted value, should be a string or boolean: '" + submittedValue
                    + "' => using false");
        }

        Converter converter = null;
        // If there is a converter attribute, use it to to ask application
        // instance for a converter with this identifer.
        if (component instanceof ValueHolder) {
            converter = ((ValueHolder) component).getConverter();
        }

        if (converter != null) {
            // If the conversion eventually falls to needing to use EL type
            // coercion,
            // make sure our special ConverterPropertyEditor knows about this
            // value.
            RequestStateManager.set(context, RequestStateManager.TARGET_COMPONENT_ATTRIBUTE_NAME, component);
            return converter.getAsObject(context, component, newValue);
        } else {
            return Boolean.valueOf(newValue);
        }
    }

    @Override
    protected void getEndTextToRender(FacesContext context, UIComponent component, String currentValue)
            throws IOException {
        String val = currentValue;
        // hack to make sure checkbox state is restored correctly from bound value on ajax request
        if (component instanceof EditableValueHolder && context.getPartialViewContext().isAjaxRequest()) {
            Object reset = component.getAttributes().get("resetOnAjax");
            if ((reset instanceof Boolean && Boolean.TRUE.equals(reset))
                    || (reset instanceof String && Boolean.parseBoolean((String) reset))) {
                EditableValueHolder c = (EditableValueHolder) component;
                c.resetValue();
                val = getCurrentValue(context, component);
            }
        }
        super.getEndTextToRender(context, component, val);
    }

}