/*
* 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.myfaces.renderkit.html.ext;
import java.io.IOException;
import java.util.List;
import javax.faces.FacesException;
import javax.faces.component.NamingContainer;
import javax.faces.component.UIComponent;
import javax.faces.component.UIInput;
import javax.faces.component.UISelectOne;
import javax.faces.component.UIViewRoot;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import javax.faces.convert.Converter;
import javax.faces.model.SelectItem;
import org.apache.myfaces.component.UserRoleUtils;
import org.apache.myfaces.custom.radio.HtmlRadio;
import org.apache.myfaces.shared_tomahawk.renderkit.JSFAttr;
import org.apache.myfaces.shared_tomahawk.renderkit.RendererUtils;
import org.apache.myfaces.shared_tomahawk.renderkit.html.HTML;
import org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlRadioRendererBase;
import org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlRendererUtils;
/**
*
* @JSFRenderer
* renderKitId = "HTML_BASIC"
* family = "org.apache.myfaces.Radio"
* type = "org.apache.myfaces.Radio"
*
* @JSFRenderer
* renderKitId = "HTML_BASIC"
* family = "javax.faces.SelectOne"
* type = "org.apache.myfaces.Radio"
*
* @author Manfred Geiler (latest modification by $Author: lu4242 $)
* @author Thomas Spiegl
* @version $Revision: 1084268 $ $Date: 2011-03-22 12:50:23 -0500 (Tue, 22 Mar 2011) $
*/
public class HtmlRadioRenderer
extends HtmlRadioRendererBase
{
//private static final Log log = LogFactory.getLog(HtmlRadioRenderer.class);
private static final String LAYOUT_SPREAD = "spread";
public void encodeEnd(FacesContext context, UIComponent component) throws IOException
{
if (context == null) throw new NullPointerException("context");
if (component == null) throw new NullPointerException("component");
if (component instanceof HtmlRadio)
{
renderRadio(context, (HtmlRadio)component);
}
else if (HtmlRendererUtils.isDisplayValueOnly(component))
{
HtmlRendererUtils.renderDisplayValueOnlyForSelects(context, component);
}
else if (component instanceof UISelectOne)
{
String layout = getLayout(component);
if (layout != null && layout.equals(LAYOUT_SPREAD))
{
return; //radio inputs are rendered by spread radio components
}
else
{
super.encodeEnd(context, component);
}
}
else
{
throw new IllegalArgumentException("Unsupported component class " + component.getClass().getName());
}
}
protected void renderRadio(FacesContext facesContext, HtmlRadio radio) throws IOException
{
String forAttr = radio.getFor();
if (forAttr == null)
{
throw new IllegalStateException("mandatory attribute 'for'");
}
int index = radio.getIndex();
if (index < 0)
{
throw new IllegalStateException("positive index must be given");
}
UIComponent uiComponent = radio.findComponent(forAttr);
if (uiComponent == null)
{
throw new IllegalStateException("Could not find component '" + forAttr + "' (calling findComponent on component '" + radio.getClientId(facesContext) + "')");
}
if (!(uiComponent instanceof UISelectOne))
{
throw new IllegalStateException("UISelectOne expected");
}
UISelectOne uiSelectOne = (UISelectOne)uiComponent;
Converter converter;
List selectItemList = RendererUtils.getSelectItemList(uiSelectOne);
if (index >= selectItemList.size())
{
throw new IndexOutOfBoundsException("index " + index + " >= " + selectItemList.size());
}
try
{
converter = RendererUtils.findUIOutputConverter(facesContext, uiSelectOne);
}
catch (FacesException e)
{
converter = null;
}
Object currentValue = RendererUtils.getObjectValue(uiSelectOne);
currentValue
= RendererUtils.getConvertedStringValue(facesContext, uiSelectOne,
converter, currentValue);
SelectItem selectItem = (SelectItem)selectItemList.get(index);
String itemStrValue
= RendererUtils.getConvertedStringValue(facesContext, uiSelectOne,
converter,
selectItem.getValue());
ResponseWriter writer = facesContext.getResponseWriter();
//writer.startElement(HTML.LABEL_ELEM, uiSelectOne);
//renderRadio(facesContext,
// uiSelectOne,
// itemStrValue,
// selectItem.getLabel(),
// selectItem.isDisabled(),
// itemStrValue.equals(currentValue), false);
//writer.endElement(HTML.LABEL_ELEM);
//Render the radio component
String itemId = renderRadio(facesContext,
uiSelectOne,
radio,
itemStrValue,
selectItem.isDisabled(),
itemStrValue.equals(currentValue),
false,
index);
//Render the
// label element after the input
boolean componentDisabled = isDisabled(facesContext, uiSelectOne);
boolean itemDisabled = selectItem.isDisabled();
boolean disabled = (componentDisabled || itemDisabled);
renderLabel(writer, radio, uiSelectOne, itemId, selectItem, disabled);
}
/**
* Renders the input item
* @return the 'id' value of the rendered element
*/
protected String renderRadio(FacesContext facesContext,
UIInput uiComponent,
HtmlRadio radio,
String value,
boolean disabled,
boolean checked,
boolean renderId,
Integer itemNum)
throws IOException
{
String clientId = uiComponent.getClientId(facesContext);
String itemId = (radio.getId()!=null && !radio.getId().startsWith(UIViewRoot.UNIQUE_ID_PREFIX)) ?
radio.getClientId(facesContext) :
(itemNum == null)? null : clientId + NamingContainer.SEPARATOR_CHAR + itemNum;
ResponseWriter writer = facesContext.getResponseWriter();
writer.startElement(HTML.INPUT_ELEM, uiComponent);
if (itemId != null)
{
writer.writeAttribute(HTML.ID_ATTR, itemId, null);
}
else if (renderId) {
writer.writeAttribute(HTML.ID_ATTR, clientId, null);
}
writer.writeAttribute(HTML.TYPE_ATTR, HTML.INPUT_TYPE_RADIO, null);
writer.writeAttribute(HTML.NAME_ATTR, clientId, null);
if (disabled) {
writer.writeAttribute(HTML.DISABLED_ATTR, HTML.DISABLED_ATTR, null);
}
if (checked)
{
writer.writeAttribute(HTML.CHECKED_ATTR, HTML.CHECKED_ATTR, null);
}
if (value != null)
{
writer.writeAttribute(HTML.VALUE_ATTR, value, null);
}
renderHTMLAttributes(writer, radio ,uiComponent, HTML.INPUT_PASSTHROUGH_ATTRIBUTES_WITHOUT_DISABLED);
if (isDisabled(facesContext, uiComponent))
{
writer.writeAttribute(org.apache.myfaces.shared_tomahawk.renderkit.html.HTML.DISABLED_ATTR, Boolean.TRUE, null);
}
writer.endElement(HTML.INPUT_ELEM);
return itemId;
}
public static void renderLabel(ResponseWriter writer, UIComponent radio,
UIComponent component, String forClientId, SelectItem item,
boolean disabled) throws IOException
{
writer.startElement(HTML.LABEL_ELEM, component);
writer.writeAttribute(HTML.FOR_ATTR, forClientId, null);
String labelClass = null;
if (disabled)
{
labelClass = (String) radio.getAttributes().get(
JSFAttr.DISABLED_CLASS_ATTR);
if (labelClass == null)
{
labelClass = (String) component.getAttributes().get(
JSFAttr.DISABLED_CLASS_ATTR);
}
}
else
{
labelClass = (String) radio.getAttributes().get(
JSFAttr.ENABLED_CLASS_ATTR);
if (labelClass == null)
{
labelClass = (String) component.getAttributes().get(
JSFAttr.ENABLED_CLASS_ATTR);
}
}
if (labelClass != null)
{
writer.writeAttribute("class", labelClass, "labelClass");
}
if ((item.getLabel() != null) && (item.getLabel().length() > 0))
{
writer.write(HTML.NBSP_ENTITY);
if(item.isEscape())
{
writer.writeText(item.getLabel(), null);
}
else
{
writer.write(item.getLabel());
}
}
writer.endElement(HTML.LABEL_ELEM);
}
private static boolean renderHTMLAttributes(ResponseWriter writer,
UIComponent radio, UIComponent selectOne, String[] attributes) throws IOException
{
boolean somethingDone = false;
for (int i = 0, len = attributes.length; i < len; i++)
{
String attrName = attributes[i];
Object value = radio.getAttributes().get(attrName);
if (value == null)
{
value = selectOne.getAttributes().get(attrName);
}
if (HtmlRendererUtils.renderHTMLAttribute(writer, attrName, attrName, value ))
{
somethingDone = true;
}
}
return somethingDone;
}
protected boolean isDisabled(FacesContext facesContext, UIComponent uiComponent)
{
if (!UserRoleUtils.isEnabledOnUserRole(uiComponent))
{
return true;
}
else
{
return super.isDisabled(facesContext, uiComponent);
}
}
public void decode(FacesContext facesContext, UIComponent uiComponent)
{
if (uiComponent instanceof HtmlRadio)
{
//nothing to decode
}
else
{
super.decode(facesContext, uiComponent);
}
}
}