Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.primefaces.component.panelgrid.PanelGridRenderer Maven / Gradle / Ivy
/*
* The MIT License
*
* Copyright (c) 2009-2023 PrimeTek Informatics
*
* 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.panelgrid;
import java.io.IOException;
import javax.faces.FacesException;
import javax.faces.component.UIComponent;
import javax.faces.component.UIPanel;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import org.primefaces.component.column.Column;
import org.primefaces.component.row.Row;
import org.primefaces.renderkit.CoreRenderer;
import org.primefaces.util.ComponentUtils;
import org.primefaces.util.Constants;
import org.primefaces.util.GridLayoutUtils;
public class PanelGridRenderer extends CoreRenderer {
@Override
public void encodeEnd(FacesContext context, UIComponent component) throws IOException {
PanelGrid grid = (PanelGrid) component;
String layout = grid.getLayout();
if (PanelGrid.LAYOUT_TABULAR.equalsIgnoreCase(layout)) {
encodeLegacyTableLayout(context, grid);
}
else if (PanelGrid.LAYOUT_GRID.equalsIgnoreCase(layout) || PanelGrid.LAYOUT_FLEX.equalsIgnoreCase(layout)) {
encodeGridLayout(context, grid);
}
else {
throw new FacesException("The value of 'layout' attribute of PanelGrid \"" + grid.getClientId(
context) + "\" must be 'grid', 'tabular' or 'flex'. Default value is 'grid'.");
}
}
/**
* @deprecated in 13.0.0 remove in 14.0.0
*/
@Deprecated
public void encodeLegacyTableLayout(FacesContext context, PanelGrid grid) throws IOException {
String clientId = grid.getClientId(context);
logDevelopmentWarning(context, "Table layout is deprecated and will be removed in future release. Please switch to responsive layout. ClientId: "
+ clientId);
ResponseWriter writer = context.getResponseWriter();
int columns = grid.getColumns();
String style = grid.getStyle();
String styleClass = grid.getStyleClass();
styleClass = styleClass == null ? PanelGrid.CONTAINER_CLASS : PanelGrid.CONTAINER_CLASS + " " + styleClass;
writer.startElement("table", grid);
writer.writeAttribute("id", clientId, "id");
writer.writeAttribute("class", styleClass, "styleClass");
if (style != null) {
writer.writeAttribute("style", style, "style");
}
writer.writeAttribute("role", grid.getRole(), null);
encodeTableFacet(context, grid, columns, "header", "thead", PanelGrid.HEADER_CLASS);
encodeTableFacet(context, grid, columns, "footer", "tfoot", PanelGrid.FOOTER_CLASS);
encodeTableBody(context, grid, columns);
writer.endElement("table");
}
public void encodeGridLayout(FacesContext context, PanelGrid grid) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String clientId = grid.getClientId(context);
String layout = grid.getLayout();
int columns = grid.getColumns();
if (columns <= 0 || columns > 12 || 12 % columns != 0) {
throw new FacesException("PanelGrid \"" + clientId + "\" columns must be a number that factors into 12. For example: 1,2,3,4,6,12");
}
String style = grid.getStyle();
String containerClass = getStyleClassBuilder(context)
.add(PanelGrid.CONTAINER_CLASS)
.add(grid.getStyleClass())
.build();
writer.startElement("div", grid);
writer.writeAttribute("id", clientId, "id");
writer.writeAttribute("class", containerClass, "styleClass");
if (style != null) {
writer.writeAttribute("style", style, "style");
}
encodeGridFacet(context, grid, columns, "header", PanelGrid.HEADER_CLASS);
if (PanelGrid.LAYOUT_FLEX.equalsIgnoreCase(layout)) {
encodeFlexGridBody(context, grid, columns);
}
else {
encodeGridBody(context, grid, columns);
}
encodeGridFacet(context, grid, columns, "footer", PanelGrid.FOOTER_CLASS);
writer.endElement("div");
}
public void encodeTableBody(FacesContext context, PanelGrid grid, int columns) throws IOException {
ResponseWriter writer = context.getResponseWriter();
writer.startElement("tbody", grid);
if (columns > 0) {
encodeDynamicBody(context, grid, grid.getColumns());
}
else {
encodeStaticBody(context, grid);
}
writer.endElement("tbody");
}
public void encodeDynamicBody(FacesContext context, PanelGrid grid, int columns) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String columnClassesValue = grid.getColumnClasses();
String[] columnClasses = columnClassesValue == null ? new String[0] : columnClassesValue.split(",");
int openendRows = 0;
int closedRows = 0;
int i = 0;
for (UIComponent child : grid.getChildren()) {
if (!child.isRendered()) {
continue;
}
int colMod = i % columns;
if (colMod == 0) {
openendRows++;
writer.startElement("tr", null);
writer.writeAttribute("class", PanelGrid.TABLE_ROW_CLASS, null);
}
String columnClass = (colMod < columnClasses.length)
? PanelGrid.CELL_CLASS + " " + columnClasses[colMod].trim()
: PanelGrid.CELL_CLASS;
writer.startElement("td", null);
writer.writeAttribute("role", "gridcell", null);
writer.writeAttribute("class", columnClass, null);
child.encodeAll(context);
writer.endElement("td");
i++;
colMod = i % columns;
if (colMod == 0) {
closedRows++;
writer.endElement("tr");
}
}
// special handling for #4122, when the child count is not a multiple of the columns count
if (openendRows > closedRows) {
writer.endElement("tr");
}
}
public void encodeStaticBody(FacesContext context, PanelGrid grid) throws IOException {
context.getAttributes().put(Constants.HELPER_RENDERER, "panelGridBody");
int i = 0;
for (UIComponent child : grid.getChildren()) {
if (child instanceof Row || ComponentUtils.isUIRepeat(child)) {
// #6829 count row even though its not rendered
// #7780 count row if a UIRepeat and assume the user knows what they are doing
i++;
}
if (child.isRendered()) {
if (child instanceof Row) {
String rowStyleClass = i % 2 == 0
? PanelGrid.TABLE_ROW_CLASS + " " + PanelGrid.EVEN_ROW_CLASS
: PanelGrid.TABLE_ROW_CLASS + " " + PanelGrid.ODD_ROW_CLASS;
encodeRow(context, (Row) child, "gridcell", rowStyleClass, PanelGrid.CELL_CLASS);
}
else {
child.encodeAll(context);
}
}
}
if (i == 0) {
throw new FacesException("PanelGrid \"" + grid.getClientId(context)
+ "\" without a 'columns' attribute expects at least one element.");
}
context.getAttributes().remove(Constants.HELPER_RENDERER);
}
public void encodeRow(FacesContext context, Row row, String columnRole, String rowClass, String columnClass) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String style = row.getStyle();
writer.startElement("tr", null);
if (shouldWriteId(row)) {
writer.writeAttribute("id", row.getClientId(context), null);
}
if (row.getStyleClass() != null) {
rowClass += " " + row.getStyleClass();
}
if (style != null) {
writer.writeAttribute("style", style, null);
}
writer.writeAttribute("class", rowClass, null);
for (UIComponent child : row.getChildren()) {
if (child instanceof Column && child.isRendered()) {
Column column = (Column) child;
String userStyleClass = column.getStyleClass();
String styleClass = (userStyleClass == null) ? columnClass : columnClass + " " + userStyleClass;
writer.startElement("td", null);
if (shouldWriteId(column)) {
writer.writeAttribute("id", column.getClientId(context), null);
}
writer.writeAttribute("role", columnRole, null);
writer.writeAttribute("class", styleClass, null);
if (column.getStyle() != null) {
writer.writeAttribute("style", column.getStyle(), null);
}
if (column.getColspan() > 1) {
writer.writeAttribute("colspan", column.getColspan(), null);
}
if (column.getRowspan() > 1) {
writer.writeAttribute("rowspan", column.getRowspan(), null);
}
renderChildren(context, column);
writer.endElement("td");
}
else {
child.encodeAll(context);
}
}
writer.endElement("tr");
}
public void encodeGridBody(FacesContext context, PanelGrid grid, int columns) throws IOException {
String clientId = grid.getClientId(context);
ResponseWriter writer = context.getResponseWriter();
String columnClassesValue = grid.getColumnClasses();
String[] columnClasses = columnClassesValue == null ? new String[0] : columnClassesValue.split(",");
String contentClass = getStyleClassBuilder(context)
.add(PanelGrid.CONTENT_CLASS)
.add(GridLayoutUtils.getResponsiveClass(false))
.add(grid.getContentStyleClass())
.build();
writer.startElement("div", grid);
writer.writeAttribute("id", clientId + "_content", null);
writer.writeAttribute("class", contentClass, null);
if (grid.getContentStyle() != null) {
writer.writeAttribute("style", grid.getContentStyle(), null);
}
int i = 0;
for (UIComponent child : grid.getChildren()) {
if (!child.isRendered()) {
continue;
}
Row row = null;
if (child instanceof Row) {
if (i > 0) {
writer.endElement("div");
}
row = (Row) child;
i = 0;
}
int colMod = i % columns;
if (colMod == 0) {
writer.startElement("div", null);
String rowClass = (columnClasses.length > 0 && columnClasses[0].contains("ui-grid-col-")) ? "ui-grid-row" : PanelGrid.GRID_ROW_CLASS;
if (row != null) {
if (row.getId() != null) writer.writeAttribute("id", row.getClientId(context), null);
if (row.getStyle() != null) writer.writeAttribute("style", row.getStyle(), null);
if (row.getStyleClass() != null) rowClass = rowClass + " " + row.getStyleClass();
}
writer.writeAttribute("class", rowClass, null);
}
if (row == null) {
encodeColumn(context, columns, writer, columnClasses, child, colMod);
}
else {
int iRow = 0;
int classesLength = columnClasses.length > 0 ? columnClasses.length : 1;
for (UIComponent rowChild : row.getChildren()) {
encodeColumn(context, columns, writer, columnClasses, rowChild, iRow % classesLength);
iRow++;
}
}
i++;
colMod = i % columns;
if (colMod == 0 || row != null) {
writer.endElement("div");
i = 0;
}
}
if (i != 0 && (i % columns) != 0) {
writer.endElement("div");
}
writer.endElement("div");
}
public void encodeFlexGridBody(FacesContext context, PanelGrid grid, int columns) throws IOException {
String clientId = grid.getClientId(context);
ResponseWriter writer = context.getResponseWriter();
String columnClassesValue = grid.getColumnClasses();
String[] columnClasses = columnClassesValue == null ? new String[0] : columnClassesValue.split(",");
String contentClass = getStyleClassBuilder(context)
.add(PanelGrid.CONTENT_CLASS)
.add(GridLayoutUtils.getFlexGridClass(true))
.add(grid.getContentStyleClass())
.build();
writer.startElement("div", grid);
writer.writeAttribute("id", clientId + "_content", null);
writer.writeAttribute("class", contentClass, null);
if (grid.getContentStyle() != null) {
writer.writeAttribute("style", grid.getContentStyle(), null);
}
int i = 0;
for (UIComponent child : grid.getChildren()) {
if (!child.isRendered()) {
continue;
}
int colMod = i % columns;
String columnClass = (colMod < columnClasses.length) ? PanelGrid.CELL_CLASS + " " + columnClasses[colMod].trim() : PanelGrid.CELL_CLASS;
if (!columnClass.contains("md-") && !columnClass.contains("col-")) {
columnClass = columnClass + " " + GridLayoutUtils.getFlexColumnClass(columns);
}
writer.startElement("div", null);
Column column = child instanceof Column ? (Column) child : null;
if (column != null) {
if (column.getId() != null) writer.writeAttribute("id", column.getClientId(context), null);
if (column.getStyle() != null) writer.writeAttribute("style", column.getStyle(), null);
if (column.getStyleClass() != null) columnClass += columnClass + " " + column.getStyleClass();
}
writer.writeAttribute("class", columnClass, null);
child.encodeAll(context);
writer.endElement("div");
i++;
}
writer.endElement("div");
}
private void encodeColumn(FacesContext context,
int columns,
ResponseWriter writer,
String[] columnClasses,
UIComponent child,
int colMod) throws IOException {
String columnClass = (colMod < columnClasses.length) ? PanelGrid.CELL_CLASS + " " + columnClasses[colMod].trim() : PanelGrid.CELL_CLASS;
if (!columnClass.contains("ui-md-") && !columnClass.contains("ui-g-") && !columnClass.contains("ui-grid-col-")) {
columnClass = columnClass + " " + GridLayoutUtils.getColumnClass(columns);
}
writer.startElement("div", null);
Column column = child instanceof Column ? (Column) child : null;
if (column != null) {
if (column.getId() != null) writer.writeAttribute("id", column.getClientId(context), null);
if (column.getStyle() != null) writer.writeAttribute("style", column.getStyle(), null);
if (column.getStyleClass() != null) columnClass = PanelGrid.CELL_CLASS + " " + column.getStyleClass();
}
writer.writeAttribute("class", columnClass, null);
child.encodeAll(context);
writer.endElement("div");
}
public void encodeTableFacet(FacesContext context, PanelGrid grid, int columns, String facet, String tag, String styleClass)
throws IOException {
UIComponent component = grid.getFacet(facet);
if (ComponentUtils.shouldRenderFacet(component)) {
ResponseWriter writer = context.getResponseWriter();
writer.startElement(tag, null);
writer.writeAttribute("class", styleClass, null);
if (columns > 0) {
writer.startElement("tr", null);
writer.writeAttribute("class", "ui-widget-header", null);
writer.startElement("td", null);
writer.writeAttribute("colspan", columns, null);
writer.writeAttribute("role", "columnheader", null);
writer.writeAttribute("class", PanelGrid.CELL_CLASS + " ui-widget-header", null);
component.encodeAll(context);
writer.endElement("td");
writer.endElement("tr");
}
else {
context.getAttributes().put(Constants.HELPER_RENDERER, "panelGridFacet");
if (component instanceof Row) {
encodeRow(context, (Row) component, "columnheader", "ui-widget-header", PanelGrid.CELL_CLASS + " ui-widget-header");
}
else if (component instanceof UIPanel) {
for (UIComponent child : component.getChildren()) {
if (child.isRendered()) {
if (child instanceof Row) {
encodeRow(context, (Row) child, "columnheader", "ui-widget-header", PanelGrid.CELL_CLASS + " ui-widget-header");
}
else {
component.encodeAll(context);
}
}
}
}
else {
component.encodeAll(context);
}
context.getAttributes().remove(Constants.HELPER_RENDERER);
}
writer.endElement(tag);
}
}
public void encodeGridFacet(FacesContext context, PanelGrid grid, int columns, String facet, String styleClass) throws IOException {
UIComponent component = grid.getFacet(facet);
if (ComponentUtils.shouldRenderFacet(component)) {
ResponseWriter writer = context.getResponseWriter();
writer.startElement("div", null);
writer.writeAttribute("class", styleClass + " ui-widget-header", null);
component.encodeAll(context);
writer.endElement("div");
}
}
@Override
public void encodeChildren(FacesContext context, UIComponent component) throws IOException {
//Rendering happens on encodeEnd
}
@Override
public boolean getRendersChildren() {
return true;
}
}
