org.primefaces.component.selectmanycheckbox.SelectManyCheckboxRenderer 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.selectmanycheckbox;
import java.io.IOException;
import java.util.List;
import javax.faces.FacesException;
import javax.faces.component.UIComponent;
import javax.faces.component.UIInput;
import javax.faces.component.UINamingContainer;
import javax.faces.component.UISelectMany;
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.model.SelectItemGroup;
import javax.faces.render.Renderer;
import org.primefaces.renderkit.SelectManyRenderer;
import org.primefaces.util.ComponentUtils;
import org.primefaces.util.GridLayoutUtils;
import org.primefaces.util.HTML;
import org.primefaces.util.WidgetBuilder;
public class SelectManyCheckboxRenderer extends SelectManyRenderer {
@Override
public Object getConvertedValue(FacesContext context, UIComponent component, Object submittedValue) throws ConverterException {
Renderer renderer = ComponentUtils.getUnwrappedRenderer(
context,
"javax.faces.SelectMany",
"javax.faces.Checkbox",
Renderer.class);
return renderer.getConvertedValue(context, component, submittedValue);
}
@Override
public void encodeEnd(FacesContext context, UIComponent component) throws IOException {
SelectManyCheckbox checkbox = (SelectManyCheckbox) component;
encodeMarkup(context, checkbox);
encodeScript(context, checkbox);
}
protected void encodeMarkup(FacesContext context, SelectManyCheckbox checkbox) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String layout = checkbox.getLayout();
if (layout == null) {
layout = "lineDirection";
}
boolean custom = (layout.equals("custom"));
if (custom) {
writer.startElement("span", checkbox);
writer.writeAttribute("id", checkbox.getClientId(context), "id");
writer.writeAttribute("class", "ui-helper-hidden", null);
renderARIARequired(context, checkbox);
encodeCustomLayout(context, checkbox);
writer.endElement("span");
}
else if (layout.equals("responsive")) {
encodeResponsiveLayout(context, checkbox);
}
else {
encodeTabularLayout(context, checkbox, layout);
}
}
protected void encodeScript(FacesContext context, SelectManyCheckbox checkbox) throws IOException {
String clientId = checkbox.getClientId(context);
WidgetBuilder wb = getWidgetBuilder(context);
String layout = checkbox.getLayout();
boolean custom = (layout != null && layout.equals("custom"));
wb.init("SelectManyCheckbox", checkbox.resolveWidgetVar(), clientId)
.attr("custom", custom, false).finish();
}
protected void encodeResponsiveLayout(FacesContext context, SelectManyCheckbox checkbox) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String clientId = checkbox.getClientId(context);
String style = checkbox.getStyle();
String styleClass = checkbox.getStyleClass();
styleClass = (styleClass == null) ? SelectManyCheckbox.STYLE_CLASS : SelectManyCheckbox.STYLE_CLASS + " " + styleClass;
styleClass = styleClass + " ui-grid ui-grid-responsive";
int columns = checkbox.getColumns();
if (columns <= 0) {
throw new FacesException("The value of columns attribute must be greater than zero.");
}
writer.startElement("div", checkbox);
writer.writeAttribute("id", clientId, "id");
writer.writeAttribute("class", styleClass, "styleClass");
if (style != null) {
writer.writeAttribute("style", style, "style");
}
renderARIARequired(context, checkbox);
List selectItems = getSelectItems(context, checkbox);
Converter converter = checkbox.getConverter();
Object values = getValues(checkbox);
Object submittedValues = getSubmittedValues(checkbox);
int idx = 0;
int groupIdx = 0;
int colMod = 0;
for (int i = 0; i < selectItems.size(); i++) {
SelectItem selectItem = selectItems.get(i);
if (selectItem instanceof SelectItemGroup) {
writer.startElement("div", null);
writer.writeAttribute("class", "ui-selectmanycheckbox-responsive-group", null);
encodeGroupLabel(context, checkbox, (SelectItemGroup) selectItem);
writer.endElement("div");
for (SelectItem childSelectItem : ((SelectItemGroup) selectItem).getSelectItems()) {
colMod = idx % columns;
if (colMod == 0) {
writer.startElement("div", null);
writer.writeAttribute("class", "ui-g", null);
}
groupIdx++;
writer.startElement("div", null);
writer.writeAttribute("class", GridLayoutUtils.getColumnClass(columns), null);
encodeOption(context, checkbox, values, submittedValues, converter, childSelectItem, groupIdx);
writer.endElement("div");
idx++;
colMod = idx % columns;
if (colMod == 0) {
writer.endElement("div");
}
}
if (idx != 0 && (idx % columns) != 0) {
writer.endElement("div");
}
idx = 0;
}
else {
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, checkbox, values, submittedValues, converter, selectItem, idx);
writer.endElement("div");
idx++;
colMod = idx % columns;
if (colMod == 0) {
writer.endElement("div");
}
}
}
if (idx != 0 && (idx % columns) != 0) {
writer.endElement("div");
}
writer.endElement("div");
}
protected void encodeTabularLayout(FacesContext context, SelectManyCheckbox checkbox, String layout) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String clientId = checkbox.getClientId(context);
String style = checkbox.getStyle();
String styleClass = checkbox.getStyleClass();
styleClass = styleClass == null ? SelectManyCheckbox.STYLE_CLASS : SelectManyCheckbox.STYLE_CLASS + " " + styleClass;
writer.startElement("table", checkbox);
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, checkbox);
encodeSelectItems(context, checkbox, layout);
writer.endElement("table");
}
protected void encodeOptionInput(FacesContext context, SelectManyCheckbox checkbox, String id, String name, boolean checked,
boolean disabled, String value) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String tabindex = checkbox.getTabindex();
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", "checkbox", null);
writer.writeAttribute("value", value, null);
if (tabindex != null) {
writer.writeAttribute("tabindex", tabindex, null);
}
renderOnchange(context, checkbox);
if (checked) {
writer.writeAttribute("checked", "checked", null);
}
if (disabled) {
writer.writeAttribute("disabled", "disabled", null);
}
renderValidationMetadata(context, checkbox);
writer.endElement("input");
writer.endElement("div");
}
protected void encodeOptionLabel(FacesContext context, SelectManyCheckbox checkbox, String containerClientId, SelectItem option,
boolean disabled) throws IOException {
ResponseWriter writer = context.getResponseWriter();
writer.startElement("label", null);
if (disabled) {
writer.writeAttribute("class", "ui-state-disabled", null);
}
writer.writeAttribute("for", containerClientId, null);
if (option.getDescription() != null) {
writer.writeAttribute("title", option.getDescription(), null);
}
if (option.isEscape()) {
writer.writeText(option.getLabel(), null);
}
else {
writer.write(option.getLabel());
}
writer.endElement("label");
}
protected void encodeGroupLabel(FacesContext context, SelectManyCheckbox checkbox, SelectItemGroup group) throws IOException {
ResponseWriter writer = context.getResponseWriter();
writer.startElement("span", null);
writer.writeAttribute("class", "ui-selectmanycheckbox-item-group", null);
if (group.isEscape()) {
writer.writeText(group.getLabel(), null);
}
else {
writer.write(group.getLabel());
}
writer.endElement("span");
}
protected void encodeOptionOutput(FacesContext context, SelectManyCheckbox checkbox, boolean checked, boolean disabled) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String boxClass = HTML.CHECKBOX_BOX_CLASS;
boxClass = checked ? boxClass + " ui-state-active" : boxClass;
boxClass = disabled ? boxClass + " ui-state-disabled" : boxClass;
boxClass = !checkbox.isValid() ? boxClass + " ui-state-error" : boxClass;
String iconClass = checked ? HTML.CHECKBOX_CHECKED_ICON_CLASS : HTML.CHECKBOX_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 void encodeSelectItems(FacesContext context, SelectManyCheckbox checkbox, String layout) throws IOException {
if (layout.equals("lineDirection")) {
encodeLineLayout(context, checkbox);
}
else if (layout.equals("pageDirection")) {
encodePageLayout(context, checkbox);
}
else if (layout.equals("grid")) {
encodeGridLayout(context, checkbox);
}
else {
throw new FacesException("Invalid '" + layout + "' type for component '" + checkbox.getClientId(context) + "'.");
}
}
protected void encodeLineLayout(FacesContext context, SelectManyCheckbox checkbox) throws IOException {
ResponseWriter writer = context.getResponseWriter();
List selectItems = getSelectItems(context, checkbox);
Converter converter = checkbox.getConverter();
Object values = getValues(checkbox);
Object submittedValues = getSubmittedValues(checkbox);
writer.startElement("tr", null);
for (int i = 0; i < selectItems.size(); i++) {
SelectItem selectItem = selectItems.get(i);
if (selectItem instanceof SelectItemGroup) {
writer.startElement("td", null);
encodeGroupLabel(context, checkbox, (SelectItemGroup) selectItem);
writer.endElement("td");
}
else {
writer.startElement("td", null);
encodeOption(context, checkbox, values, submittedValues, converter, selectItem, i);
writer.endElement("td");
}
}
writer.endElement("tr");
}
protected void encodePageLayout(FacesContext context, SelectManyCheckbox checkbox) throws IOException {
ResponseWriter writer = context.getResponseWriter();
List selectItems = getSelectItems(context, checkbox);
Converter converter = checkbox.getConverter();
Object values = getValues(checkbox);
Object submittedValues = getSubmittedValues(checkbox);
int idx = 0;
for (int i = 0; i < selectItems.size(); i++) {
SelectItem selectItem = selectItems.get(i);
if (selectItem instanceof SelectItemGroup) {
writer.startElement("tr", null);
writer.startElement("td", null);
encodeGroupLabel(context, checkbox, (SelectItemGroup) selectItem);
writer.endElement("td");
writer.endElement("tr");
idx++;
for (SelectItem childSelectItem : ((SelectItemGroup) selectItem).getSelectItems()) {
writer.startElement("tr", null);
writer.startElement("td", null);
encodeOption(context, checkbox, values, submittedValues, converter, childSelectItem, idx);
writer.endElement("td");
writer.endElement("tr");
idx++;
}
}
else {
writer.startElement("tr", null);
writer.startElement("td", null);
encodeOption(context, checkbox, values, submittedValues, converter, selectItem, idx);
writer.endElement("td");
writer.endElement("tr");
idx++;
}
}
}
protected void encodeGridLayout(FacesContext context, SelectManyCheckbox checkbox) throws IOException {
ResponseWriter writer = context.getResponseWriter();
List selectItems = getSelectItems(context, checkbox);
Converter converter = checkbox.getConverter();
Object values = getValues(checkbox);
Object submittedValues = getSubmittedValues(checkbox);
int columns = checkbox.getColumns();
if (columns <= 0) {
throw new FacesException("The value of columns attribute must be greater than zero.");
}
int idx = 0;
int colMod = 0;
for (int i = 0; i < selectItems.size(); i++) {
SelectItem selectItem = selectItems.get(i);
colMod = idx % columns;
if (colMod == 0) {
writer.startElement("tr", null);
}
writer.startElement("td", null);
encodeOption(context, checkbox, values, submittedValues, converter, selectItem, idx);
writer.endElement("td");
idx++;
colMod = idx % columns;
if (colMod == 0) {
writer.endElement("tr");
}
}
// close final if not closed
if (colMod != 0) {
writer.endElement("tr");
}
}
protected void encodeCustomLayout(FacesContext context, SelectManyCheckbox checkbox) throws IOException {
List selectItems = getSelectItems(context, checkbox);
Converter converter = checkbox.getConverter();
Object values = getValues(checkbox);
Object submittedValues = getSubmittedValues(checkbox);
int idx = 0;
for (int i = 0; i < selectItems.size(); i++) {
SelectItem selectItem = selectItems.get(i);
String itemValueAsString = getOptionAsString(context, checkbox, converter, selectItem.getValue());
String name = checkbox.getClientId(context);
String id = name + UINamingContainer.getSeparatorChar(context) + idx;
Object valuesArray;
Object itemValue;
if (submittedValues != null) {
valuesArray = submittedValues;
itemValue = itemValueAsString;
}
else {
valuesArray = values;
itemValue = selectItem.getValue();
}
boolean selected = isSelected(context, checkbox, itemValue, valuesArray, converter);
if (selectItem.isNoSelectionOption() && values != null && !selected) {
return;
}
encodeOptionInput(context, checkbox, id, name, selected, true, itemValueAsString);
idx++;
}
}
protected void encodeOption(FacesContext context, UIInput component, Object values, Object submittedValues, Converter converter,
SelectItem option, int idx) throws IOException {
ResponseWriter writer = context.getResponseWriter();
SelectManyCheckbox checkbox = (SelectManyCheckbox) component;
String itemValueAsString = getOptionAsString(context, component, converter, option.getValue());
String name = checkbox.getClientId(context);
String id = name + UINamingContainer.getSeparatorChar(context) + idx;
boolean disabled = option.isDisabled() || checkbox.isDisabled();
Object valuesArray;
Object itemValue;
if (submittedValues != null) {
valuesArray = submittedValues;
itemValue = itemValueAsString;
}
else {
valuesArray = values;
itemValue = option.getValue();
}
boolean selected = isSelected(context, component, itemValue, valuesArray, converter);
if (option.isNoSelectionOption() && values != null && !selected) {
return;
}
writer.startElement("div", null);
writer.writeAttribute("class", HTML.CHECKBOX_CLASS, null);
encodeOptionInput(context, checkbox, id, name, selected, disabled, itemValueAsString);
encodeOptionOutput(context, checkbox, selected, disabled);
writer.endElement("div");
encodeOptionLabel(context, checkbox, id, option, disabled);
}
@Override
protected String getSubmitParam(FacesContext context, UISelectMany selectMany) {
return selectMany.getClientId(context);
}
@Override
public String getHighlighter() {
return "manychkbox";
}
@Override
protected boolean isGrouped() {
return true;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy