org.primefaces.extensions.component.fluidgrid.FluidGridRenderer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of primefaces-extensions Show documentation
PrimeFaces Extensions components and utilities for PrimeFaces.
There is a newer version: 14.0.7.1
Show newest version
/*
 * Copyright (c) 2011-2024 PrimeFaces Extensions
 *
 *  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.extensions.component.fluidgrid;

import java.io.IOException;
import java.util.Collection;

import javax.faces.FacesException;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;

import org.primefaces.expression.SearchExpressionUtils;
import org.primefaces.extensions.model.fluidgrid.FluidGridItem;
import org.primefaces.extensions.util.Attrs;
import org.primefaces.renderkit.CoreRenderer;
import org.primefaces.util.WidgetBuilder;

/**
 * Renderer for {@link FluidGrid} component.
 *
 * @author Oleg Varaksin / last modified by Melloware
 * @since 0.5
 */
public class FluidGridRenderer extends CoreRenderer {

    private static final String GRID_CLASS = "pe-fluidgrid";
    private static final String GRID_ITEM_CLASS = "pe-fluidgrid-item";

    private static final String LIST_ROLE = "list";
    private static final String LIST_ITEM_ROLE = "listitem";

    @Override
    public void decode(final FacesContext context, final UIComponent component) {
        decodeBehaviors(context, component);
    }

    @Override
    public void encodeEnd(final FacesContext fc, final UIComponent component) throws IOException {
        final FluidGrid fluidGrid = (FluidGrid) component;

        encodeMarkup(fc, fluidGrid);
        encodeScript(fc, fluidGrid);
    }

    protected void encodeMarkup(final FacesContext fc, final FluidGrid fluidGrid) throws IOException {
        final ResponseWriter writer = fc.getResponseWriter();
        final String clientId = fluidGrid.getClientId(fc);
        final String styleClass = getStyleClassBuilder(fc)
                    .add(GRID_CLASS)
                    .add(fluidGrid.getStyleClass())
                    .build();

        writer.startElement("div", fluidGrid);
        writer.writeAttribute("id", clientId, "id");
        writer.writeAttribute(Attrs.CLASS, styleClass, "styleClass");
        if (fluidGrid.getStyle() != null) {
            writer.writeAttribute(Attrs.STYLE, fluidGrid.getStyle(), Attrs.STYLE);
        }

        writer.writeAttribute("role", LIST_ROLE, null);

        if (fluidGrid.getVar() != null) {
            // dynamic items
            final Object value = fluidGrid.getValue();
            if (value != null) {
                if (!(value instanceof Collection)) {
                    throw new FacesException("Value in FluidGrid must be of type Collection / List");
                }

                for (final UIComponent kid : fluidGrid.getChildren()) {
                    if (kid.isRendered() && !(kid instanceof UIFluidGridItem)) {
                        // first render children like stamped elements, etc.
                        renderChild(fc, kid);
                    }
                }

                final Collection col = (Collection) value;
                for (final FluidGridItem fluidGridItem : col) {
                    // find ui item by type
                    final UIFluidGridItem uiItem = fluidGrid.getItem(fluidGridItem.getType());

                    if (uiItem.isRendered()) {
                        // set data in request scope
                        fluidGrid.setData(fluidGridItem);

                        // render item
                        renderItem(fc, writer, fluidGrid, uiItem);
                    }
                }
            }
        }
        else {
            // static items
            for (final UIComponent kid : fluidGrid.getChildren()) {
                if (kid.isRendered()) {
                    if (kid instanceof UIFluidGridItem) {
                        // render item
                        renderItem(fc, writer, fluidGrid, (UIFluidGridItem) kid);
                    }
                    else {
                        // render a child like stamped element, etc.
                        renderChild(fc, kid);
                    }
                }
            }
        }

        writer.endElement("div");
    }

    protected void encodeScript(final FacesContext fc, final FluidGrid fluidGrid) throws IOException {
        final WidgetBuilder wb = getWidgetBuilder(fc);
        wb.init("ExtFluidGrid", fluidGrid);
        wb.append(",opts:{");
        wb.append("isFitWidth:" + fluidGrid.isFitWidth());
        wb.append(",isOriginLeft:" + fluidGrid.isOriginLeft());
        wb.append(",isOriginTop:" + fluidGrid.isOriginTop());
        wb.append(",isResizeBound:" + fluidGrid.isResizeBound());
        wb.append(",hasImages:" + fluidGrid.isHasImages());

        if (fluidGrid.gethGutter() != 0) {
            wb.append(",gutter:" + fluidGrid.gethGutter());
        }

        final String stamp = SearchExpressionUtils.resolveClientIdsForClientSide(fc, fluidGrid, fluidGrid.getStamp());
        if (stamp != null) {
            wb.append(",stamp:'" + stamp + "'");
        }

        if (fluidGrid.getTransitionDuration() != null) {
            wb.append(",transitionDuration:'" + fluidGrid.getTransitionDuration() + "'");
        }
        else {
            wb.append(",transitionDuration:0");
        }

        wb.append("}");

        encodeClientBehaviors(fc, fluidGrid);
        wb.finish();
    }

    protected void renderItem(final FacesContext fc, final ResponseWriter writer, final FluidGrid fluidGrid,
                final UIFluidGridItem uiItem)
                throws IOException {
        writer.startElement("div", null);

        if (uiItem.getStyleClass() != null) {
            writer.writeAttribute(Attrs.CLASS, GRID_ITEM_CLASS + " " + uiItem.getStyleClass(), null);
        }
        else {
            writer.writeAttribute(Attrs.CLASS, GRID_ITEM_CLASS, null);
        }

        if (fluidGrid.getvGutter() != 0) {
            writer.writeAttribute(Attrs.STYLE, "margin-bottom: " + fluidGrid.getvGutter() + "px", null);
        }

        writer.writeAttribute("role", LIST_ITEM_ROLE, null);

        // encode content of pe:fluidGridItem
        uiItem.encodeAll(fc);

        writer.endElement("div");
    }

    @Override
    public void encodeChildren(final FacesContext context, final UIComponent component) {
        // Rendering happens on encodeEnd
    }

    @Override
    public boolean getRendersChildren() {
        return true;
    }
}