org.primefaces.component.selectoneradio.SelectOneRadioRenderer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of primefaces Show documentation
Show all versions of primefaces Show documentation
PrimeFaces is one of the most popular UI libraries in Java EE Ecosystem and widely used by software companies, world renowned brands, banks, financial institutions, insurance companies, universities and more.
/**
* The MIT License
*
* Copyright (c) 2009-2019 PrimeTek
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.primefaces.component.selectoneradio;
import java.io.IOException;
import java.util.List;
import javax.el.ValueExpression;
import javax.faces.FacesException;
import javax.faces.component.UIComponent;
import javax.faces.component.UIInput;
import javax.faces.component.UINamingContainer;
import javax.faces.component.UISelectOne;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import javax.faces.convert.Converter;
import javax.faces.convert.ConverterException;
import javax.faces.model.SelectItem;
import javax.faces.render.Renderer;
import org.primefaces.component.radiobutton.RadioButton;
import org.primefaces.renderkit.SelectOneRenderer;
import org.primefaces.util.ComponentUtils;
import org.primefaces.util.GridLayoutUtils;
import org.primefaces.util.HTML;
import org.primefaces.util.WidgetBuilder;
public class SelectOneRadioRenderer extends SelectOneRenderer {
@Override
public Object getConvertedValue(FacesContext context, UIComponent component, Object submittedValue) throws ConverterException {
Renderer renderer = ComponentUtils.getUnwrappedRenderer(
context,
"javax.faces.SelectOne",
"javax.faces.Radio",
Renderer.class);
return renderer.getConvertedValue(context, component, submittedValue);
}
@Override
public void encodeEnd(FacesContext context, UIComponent component) throws IOException {
SelectOneRadio radio = (SelectOneRadio) component;
encodeMarkup(context, radio);
encodeScript(context, radio);
}
protected void encodeMarkup(FacesContext context, SelectOneRadio radio) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String layout = radio.getLayout();
if (layout == null) {
layout = "lineDirection";
}
boolean custom = layout.equals("custom");
if (custom) {
String style = radio.getStyle();
String styleClass = radio.getStyleClass();
String defaultStyleClass = "ui-helper-hidden";
styleClass = styleClass == null ? defaultStyleClass : defaultStyleClass + " " + styleClass;
writer.startElement("span", radio);
writer.writeAttribute("id", radio.getClientId(context), "id");
writer.writeAttribute("class", styleClass, "styleClass");
if (style != null) {
writer.writeAttribute("style", style, "style");
}
encodeCustomLayout(context, radio);
writer.endElement("span");
}
else if (layout.equals("responsive")) {
encodeResponsiveLayout(context, radio);
}
else {
encodeTabularLayout(context, radio, layout);
}
}
protected void encodeScript(FacesContext context, SelectOneRadio radio) throws IOException {
String clientId = radio.getClientId(context);
String layout = radio.getLayout();
boolean custom = layout != null && layout.equals("custom");
WidgetBuilder wb = getWidgetBuilder(context);
wb.init("SelectOneRadio", radio.resolveWidgetVar(), clientId)
.attr("custom", custom, false)
.attr("unselectable", radio.isUnselectable()).finish();
}
protected void encodeResponsiveLayout(FacesContext context, SelectOneRadio radio) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String clientId = radio.getClientId(context);
List selectItems = getSelectItems(context, radio);
String style = radio.getStyle();
String styleClass = radio.getStyleClass();
String defaultStyleClass = radio.isPlain() ? SelectOneRadio.NATIVE_STYLE_CLASS : SelectOneRadio.STYLE_CLASS;
defaultStyleClass = defaultStyleClass + " ui-grid ui-grid-responsive";
styleClass = styleClass == null ? defaultStyleClass : defaultStyleClass + " " + styleClass;
writer.startElement("div", radio);
writer.writeAttribute("id", clientId, "id");
writer.writeAttribute("class", styleClass, "styleClass");
if (style != null) {
writer.writeAttribute("style", style, "style");
}
renderARIARequired(context, radio);
Converter converter = radio.getConverter();
String name = radio.getClientId(context);
int columns = radio.getColumns();
String currentValue = ComponentUtils.getValueToRender(context, radio);
if (columns > 0) {
int idx = 0;
int colMod;
for (int i = 0; i < selectItems.size(); i++) {
SelectItem selectItem = selectItems.get(i);
boolean disabled = selectItem.isDisabled() || radio.isDisabled();
String id = name + UINamingContainer.getSeparatorChar(context) + idx;
boolean selected = isSelected(context, radio, selectItem, currentValue);
colMod = idx % columns;
if (colMod == 0) {
writer.startElement("div", null);
writer.writeAttribute("class", "ui-g", null);
}
writer.startElement("div", null);
writer.writeAttribute("class", GridLayoutUtils.getColumnClass(columns), null);
encodeOption(context, radio, selectItem, id, name, converter, selected, disabled);
writer.endElement("div");
idx++;
colMod = idx % columns;
if (colMod == 0) {
writer.endElement("div");
}
}
if (idx != 0 && (idx % columns) != 0) {
writer.endElement("div");
}
}
else {
throw new FacesException("The value of columns attribute must be greater than zero.");
}
writer.endElement("div");
}
protected void encodeTabularLayout(FacesContext context, SelectOneRadio radio, String layout) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String clientId = radio.getClientId(context);
List selectItems = getSelectItems(context, radio);
String style = radio.getStyle();
String styleClass = radio.getStyleClass();
String defaultStyleClass = radio.isPlain() ? SelectOneRadio.NATIVE_STYLE_CLASS : SelectOneRadio.STYLE_CLASS;
styleClass = styleClass == null ? defaultStyleClass : defaultStyleClass + " " + styleClass;
writer.startElement("table", radio);
writer.writeAttribute("id", clientId, "id");
writer.writeAttribute("role", "presentation", null);
writer.writeAttribute("class", styleClass, "styleClass");
if (style != null) {
writer.writeAttribute("style", style, "style");
}
renderARIARequired(context, radio);
encodeSelectItems(context, radio, selectItems, layout);
writer.endElement("table");
}
protected void encodeSelectItems(FacesContext context, SelectOneRadio radio, List selectItems, String layout)
throws IOException {
if (layout.equals("lineDirection")) {
encodeLineLayout(context, radio, selectItems);
}
else if (layout.equals("pageDirection")) {
encodePageLayout(context, radio, selectItems);
}
else if (layout.equals("grid")) {
encodeGridLayout(context, radio, selectItems);
}
else {
throw new FacesException("Invalid '" + layout + "' type for component '" + radio.getClientId(context) + "'.");
}
}
protected void encodeCustomLayout(FacesContext context, SelectOneRadio radio) throws IOException {
Converter converter = radio.getConverter();
String name = radio.getClientId(context);
List selectItems = getSelectItems(context, radio);
String currentValue = ComponentUtils.getValueToRender(context, radio);
for (int i = 0; i < selectItems.size(); i++) {
SelectItem selectItem = selectItems.get(i);
String id = name + UINamingContainer.getSeparatorChar(context) + i;
boolean selected = isSelected(context, radio, selectItem, currentValue);
boolean disabled = selectItem.isDisabled() || radio.isDisabled();
String itemValueAsString = getOptionAsString(context, radio, converter, selectItem.getValue());
encodeOptionInput(context, radio, id, name, selected, disabled, itemValueAsString);
}
}
protected void encodeLineLayout(FacesContext context, SelectOneRadio radio, List selectItems) throws IOException {
ResponseWriter writer = context.getResponseWriter();
Converter converter = radio.getConverter();
String name = radio.getClientId(context);
String currentValue = ComponentUtils.getValueToRender(context, radio);
writer.startElement("tr", null);
for (int i = 0; i < selectItems.size(); i++) {
SelectItem selectItem = selectItems.get(i);
boolean disabled = selectItem.isDisabled() || radio.isDisabled();
String id = name + UINamingContainer.getSeparatorChar(context) + i;
boolean selected = isSelected(context, radio, selectItem, currentValue);
writer.startElement("td", null);
encodeOption(context, radio, selectItem, id, name, converter, selected, disabled);
writer.endElement("td");
}
writer.endElement("tr");
}
protected void encodePageLayout(FacesContext context, SelectOneRadio radio, List selectItems) throws IOException {
ResponseWriter writer = context.getResponseWriter();
Converter converter = radio.getConverter();
String name = radio.getClientId(context);
String currentValue = ComponentUtils.getValueToRender(context, radio);
for (int i = 0; i < selectItems.size(); i++) {
SelectItem selectItem = selectItems.get(i);
boolean disabled = selectItem.isDisabled() || radio.isDisabled();
String id = name + UINamingContainer.getSeparatorChar(context) + i;
boolean selected = isSelected(context, radio, selectItem, currentValue);
writer.startElement("tr", null);
writer.startElement("td", null);
encodeOption(context, radio, selectItem, id, name, converter, selected, disabled);
writer.endElement("td");
writer.endElement("tr");
}
}
protected void encodeGridLayout(FacesContext context, SelectOneRadio radio, List selectItems) throws IOException {
ResponseWriter writer = context.getResponseWriter();
Converter converter = radio.getConverter();
String name = radio.getClientId(context);
int columns = radio.getColumns();
String currentValue = ComponentUtils.getValueToRender(context, radio);
if (columns > 0) {
int idx = 0;
int colMod;
for (int i = 0; i < selectItems.size(); i++) {
SelectItem selectItem = selectItems.get(i);
boolean disabled = selectItem.isDisabled() || radio.isDisabled();
String id = name + UINamingContainer.getSeparatorChar(context) + idx;
boolean selected = isSelected(context, radio, selectItem, currentValue);
colMod = idx % columns;
if (colMod == 0) {
writer.startElement("tr", null);
}
writer.startElement("td", null);
encodeOption(context, radio, selectItem, id, name, converter, selected, disabled);
writer.endElement("td");
idx++;
colMod = idx % columns;
if (colMod == 0) {
writer.endElement("tr");
}
}
}
else {
throw new FacesException("The value of columns attribute must be greater than zero.");
}
}
protected void encodeResponsiveItems(FacesContext context, SelectOneRadio radio, List selectItems) throws IOException {
}
protected void encodeOption(FacesContext context, SelectOneRadio radio, SelectItem option, String id, String name,
Converter converter, boolean selected, boolean disabled) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String itemValueAsString = getOptionAsString(context, radio, converter, option.getValue());
String styleClass = radio.isPlain() ? HTML.RADIOBUTTON_NATIVE_CLASS : HTML.RADIOBUTTON_CLASS;
writer.startElement("div", null);
writer.writeAttribute("class", styleClass, null);
encodeOptionInput(context, radio, id, name, selected, disabled, itemValueAsString);
encodeOptionOutput(context, radio, selected, disabled);
writer.endElement("div");
encodeOptionLabel(context, radio, id, option, disabled);
}
protected void encodeOptionInput(FacesContext context, SelectOneRadio radio, String id, String name, boolean checked,
boolean disabled, String value) throws IOException {
ResponseWriter writer = context.getResponseWriter();
writer.startElement("div", null);
writer.writeAttribute("class", "ui-helper-hidden-accessible", null);
writer.startElement("input", null);
writer.writeAttribute("id", id, null);
writer.writeAttribute("name", name, null);
writer.writeAttribute("type", "radio", null);
writer.writeAttribute("value", value, null);
renderDomEvents(context, radio, SelectOneRadio.SUPPORTED_EVENTS);
if (radio.getTabindex() != null) {
writer.writeAttribute("tabindex", radio.getTabindex(), null);
}
if (checked) {
writer.writeAttribute("checked", "checked", null);
}
if (disabled) {
writer.writeAttribute("disabled", "disabled", null);
}
renderValidationMetadata(context, radio);
writer.endElement("input");
writer.endElement("div");
}
protected void encodeOptionLabel(FacesContext context, SelectOneRadio radio, String containerClientId, SelectItem option,
boolean disabled) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String label = option.getLabel();
writer.startElement("label", null);
writer.writeAttribute("for", containerClientId, null);
if (disabled) {
writer.writeAttribute("class", "ui-state-disabled", null);
}
if (option.getDescription() != null) {
writer.writeAttribute("title", option.getDescription(), null);
}
if (label != null) {
if (option.isEscape()) {
writer.writeText(label, null);
}
else {
writer.write(label);
}
}
writer.endElement("label");
}
protected void encodeOptionOutput(FacesContext context, SelectOneRadio radio, boolean selected, boolean disabled) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String boxClass = HTML.RADIOBUTTON_BOX_CLASS;
boxClass = selected ? boxClass + " ui-state-active" : boxClass;
boxClass = disabled ? boxClass + " ui-state-disabled" : boxClass;
boxClass = !radio.isValid() ? boxClass + " ui-state-error" : boxClass;
String iconClass = selected ? HTML.RADIOBUTTON_CHECKED_ICON_CLASS : HTML.RADIOBUTTON_UNCHECKED_ICON_CLASS;
writer.startElement("div", null);
writer.writeAttribute("class", boxClass, null);
writer.startElement("span", null);
writer.writeAttribute("class", iconClass, null);
writer.endElement("span");
writer.endElement("div");
}
protected boolean isSelected(FacesContext context, SelectOneRadio radio, SelectItem selectItem, String currentValue) {
String itemStrValue = getOptionAsString(context, radio, radio.getConverter(), selectItem.getValue());
return (itemStrValue == null || "".equals(itemStrValue))
? currentValue == null || "".equals(currentValue)
: itemStrValue.equals(currentValue);
}
protected void encodeRadioButton(FacesContext context, SelectOneRadio radio, RadioButton button) throws IOException {
}
protected Class getValueType(FacesContext context, UIInput input) {
ValueExpression ve = input.getValueExpression("value");
Class type = ve == null ? String.class : ve.getType(context.getELContext());
return type == null ? String.class : type;
}
@Override
protected String getSubmitParam(FacesContext context, UISelectOne selectOne) {
return selectOne.getClientId(context);
}
@Override
public void encodeChildren(FacesContext context, UIComponent component) throws IOException {
//Do nothing
}
@Override
public boolean getRendersChildren() {
return true;
}
@Override
public String getHighlighter() {
return "oneradio";
}
@Override
protected boolean isGrouped() {
return true;
}
}