org.primefaces.component.dataview.DataViewRenderer Maven / Gradle / Ivy
/*
* The MIT License
*
* Copyright (c) 2009-2024 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.dataview;
import java.io.IOException;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import org.primefaces.renderkit.DataRenderer;
import org.primefaces.util.*;
public class DataViewRenderer extends DataRenderer {
private static final Logger LOGGER = Logger.getLogger(DataViewRenderer.class.getName());
@Override
public void decode(FacesContext context, UIComponent component) {
decodeBehaviors(context, component);
}
@Override
public void encodeEnd(FacesContext context, UIComponent component) throws IOException {
DataView dataview = (DataView) component;
String clientId = dataview.getClientId(context);
Map params = context.getExternalContext().getRequestParameterMap();
dataview.findViewItems();
if (dataview.isPaginationRequest(context)) {
dataview.updatePaginationData(context);
if (dataview.isLazy()) {
dataview.loadLazyData();
}
encodeLayout(context, dataview);
if (dataview.isMultiViewState()) {
saveMultiViewState(dataview);
}
}
else if (dataview.isLayoutRequest(context)) {
String layout = params.get(clientId + "_layout");
dataview.setLayout(layout);
encodeLayout(context, dataview);
if (dataview.isMultiViewState()) {
saveMultiViewState(dataview);
}
}
else {
if (dataview.isMultiViewState()) {
dataview.restoreMultiViewState();
}
encodeMarkup(context, dataview);
encodeScript(context, dataview);
if (dataview.isPaginator() && dataview.getRows() == 0) {
LOGGER.log(Level.WARNING, "DataView with paginator=true should also set the rows attribute. ClientId: {0}", dataview.getClientId());
}
}
}
protected void encodeMarkup(FacesContext context, DataView dataview) throws IOException {
if (dataview.isLazy()) {
dataview.loadLazyData();
}
ResponseWriter writer = context.getResponseWriter();
String clientId = dataview.getClientId(context);
String layout = dataview.getLayout();
boolean hasPaginator = dataview.isPaginator();
String paginatorPosition = dataview.getPaginatorPosition();
String style = dataview.getStyle();
String styleClass = getStyleClassBuilder(context)
.add(DataView.DATAVIEW_CLASS, dataview.getStyleClass())
.add(layout.contains("grid"), DataView.GRID_LAYOUT_CLASS, DataView.LIST_LAYOUT_CLASS)
.build();
if (hasPaginator) {
dataview.calculateFirst();
}
writer.startElement("div", dataview);
writer.writeAttribute("id", clientId, "id");
writer.writeAttribute("class", styleClass, null);
if (style != null) {
writer.writeAttribute("style", style, "style");
}
encodeHeader(context, dataview);
if (hasPaginator && !"bottom".equalsIgnoreCase(paginatorPosition)) {
encodePaginatorMarkup(context, dataview, "top");
}
encodeContent(context, dataview);
if (hasPaginator && !"top".equalsIgnoreCase(paginatorPosition)) {
encodePaginatorMarkup(context, dataview, "bottom");
}
encodeFacet(context, dataview, "footer", DataView.FOOTER_CLASS);
writer.endElement("div");
}
protected void encodeHeader(FacesContext context, DataView dataview) throws IOException {
ResponseWriter writer = context.getResponseWriter();
UIComponent fHeader = dataview.getFacet("header");
writer.startElement("div", dataview);
writer.writeAttribute("class", DataView.HEADER_CLASS, null);
if (FacetUtils.shouldRenderFacet(fHeader)) {
fHeader.encodeAll(context);
}
encodeLayoutOptions(context, dataview);
writer.endElement("div");
}
protected void encodeContent(FacesContext context, DataView dataview) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String clientId = dataview.getClientId(context);
writer.startElement("div", dataview);
writer.writeAttribute("id", clientId + "_content", null);
writer.writeAttribute("class", DataView.CONTENT_CLASS, null);
encodeLayout(context, dataview);
writer.endElement("div");
}
protected void encodeLayoutOptions(FacesContext context, DataView dataview) throws IOException {
ResponseWriter writer = context.getResponseWriter();
boolean hasGridItem = (dataview.getGridItem() != null);
boolean hasListItem = (dataview.getListItem() != null);
String layout = dataview.getLayout();
boolean isGridLayout = layout.contains("grid");
String containerClass = DataView.BUTTON_CONTAINER_CLASS;
writer.startElement("div", null);
writer.writeAttribute("class", containerClass, null);
if (hasGridItem && hasListItem) {
String listIcon = dataview.getListIcon() != null ? dataview.getListIcon() : "ui-icon-grip-dotted-horizontal";
encodeButton(context, dataview, "list", listIcon, !isGridLayout);
String gridIcon = dataview.getGridIcon() != null ? dataview.getGridIcon() : "ui-icon-grip-dotted-vertical";
encodeButton(context, dataview, "grid", gridIcon, isGridLayout);
}
writer.endElement("div");
}
protected void encodeButton(FacesContext context, DataView dataview, String layout, String icon, boolean isActive) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String clientId = dataview.getClientId(context);
String buttonClass = isActive ? DataView.BUTTON_CLASS + " ui-state-active" : DataView.BUTTON_CLASS;
//button
writer.startElement("div", null);
writer.writeAttribute("class", buttonClass, null);
writer.writeAttribute("tabindex", 0, null);
//input
writer.startElement("input", null);
writer.writeAttribute("id", clientId + "_" + layout, null);
writer.writeAttribute("name", clientId, null);
writer.writeAttribute("type", "radio", null);
writer.writeAttribute("value", layout, null);
writer.writeAttribute("class", "ui-helper-hidden-accessible", null);
writer.writeAttribute("tabindex", "-1", null);
if (isActive) {
writer.writeAttribute("checked", "checked", null);
}
writer.endElement("input");
//icon
writer.startElement("span", null);
writer.writeAttribute("class", HTML.BUTTON_LEFT_ICON_CLASS + " " + icon, null);
writer.endElement("span");
//label
writer.startElement("span", null);
writer.writeAttribute("class", HTML.BUTTON_TEXT_CLASS, null);
writer.write("ui-button");
writer.endElement("span");
writer.endElement("div");
}
protected void encodeLayout(FacesContext context, DataView dataview) throws IOException {
String layout = dataview.getLayout();
if (dataview.getRowCount() == 0) {
ResponseWriter writer = context.getResponseWriter();
UIComponent emptyFacet = dataview.getFacet("emptyMessage");
if (FacetUtils.shouldRenderFacet(emptyFacet)) {
emptyFacet.encodeAll(context);
}
else {
writer.writeText(dataview.getEmptyMessage(), "emptyMessage");
}
}
else {
if (layout.contains("grid")) {
encodeGridLayout(context, dataview);
}
else {
encodeListLayout(context, dataview);
}
}
}
protected void encodeGridLayout(FacesContext context, DataView dataview) throws IOException {
DataViewGridItem grid = dataview.getGridItem();
if (grid != null) {
ResponseWriter writer = context.getResponseWriter();
int columns = grid.getColumns();
int rowIndex = dataview.getFirst();
int rows = dataview.getRows();
int itemsToRender = rows != 0 ? rows : dataview.getRowCount();
int numberOfRowsToRender = (itemsToRender + columns - 1) / columns;
boolean flex = ComponentUtils.isFlex(context, dataview);
String rowClass = getStyleClassBuilder(context)
.add(DataView.GRID_LAYOUT_ROW_CLASS)
.add(GridLayoutUtils.getFlexGridClass(flex))
.build();
String columnClass = getStyleClassBuilder(context)
.add(DataView.GRID_LAYOUT_COLUMN_CLASS)
.add(GridLayoutUtils.getColumnClass(flex, columns))
.add(dataview.getGridRowStyleClass())
.build();
String columnInlineStyle = dataview.getGridRowStyle();
writer.startElement("div", null);
writer.writeAttribute("class", rowClass, null);
writer.writeAttribute("title", dataview.getRowTitle(), null);
int renderedCount = 0;
for (int i = 0; i < numberOfRowsToRender; i++) {
dataview.setRowIndex(rowIndex);
if (!dataview.isRowAvailable()) {
break;
}
for (int j = 0; j < columns; j++) {
if (renderedCount >= itemsToRender) {
break;
}
renderedCount++;
writer.startElement("div", null);
writer.writeAttribute("class", columnClass, null);
if (!LangUtils.isEmpty(columnInlineStyle)) {
writer.writeAttribute("style", columnInlineStyle, null);
}
dataview.setRowIndex(rowIndex);
if (dataview.isRowAvailable()) {
renderChildren(context, grid);
}
rowIndex++;
writer.endElement("div");
}
}
writer.endElement("div");
dataview.setRowIndex(-1); //cleanup
}
}
protected void encodeListLayout(FacesContext context, DataView dataview) throws IOException {
DataViewListItem list = dataview.getListItem();
if (list != null) {
ResponseWriter writer = context.getResponseWriter();
int first = dataview.getFirst();
int rows = dataview.getRows() == 0 ? dataview.getRowCount() : dataview.getRows();
int pageSize = first + rows;
writer.startElement("ul", null);
writer.writeAttribute("class", DataView.LIST_LAYOUT_CONTAINER_CLASS, null);
for (int i = first; i < pageSize; i++) {
dataview.setRowIndex(i);
if (!dataview.isRowAvailable()) {
break;
}
writer.startElement("li", null);
writer.writeAttribute("class", DataView.ROW_CLASS, null);
dataview.setRowIndex(i);
if (dataview.isRowAvailable()) {
renderChildren(context, list);
}
writer.endElement("li");
}
writer.endElement("ul");
//cleanup
dataview.setRowIndex(-1);
}
}
protected void encodeScript(FacesContext context, DataView dataview) throws IOException {
WidgetBuilder wb = getWidgetBuilder(context);
wb.init("DataView", dataview);
if (dataview.isPaginator()) {
encodePaginatorConfig(context, dataview, wb);
}
encodeClientBehaviors(context, dataview);
wb.finish();
}
@Override
public void encodeChildren(FacesContext context, UIComponent component) throws IOException {
//Do Nothing
}
@Override
public boolean getRendersChildren() {
return true;
}
private void saveMultiViewState(DataView dataview) {
if (dataview.isMultiViewState()) {
DataViewState viewState = dataview.getMultiViewState(true);
viewState.setFirst(dataview.getFirst());
viewState.setRows(dataview.getRows());
viewState.setLayout(dataview.getLayout());
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy