org.primefaces.component.scrolltop.ScrollTopRenderer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of primefaces Show documentation
There is a newer version: 14.0.7
/*
 * 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.scrolltop;

import org.primefaces.renderkit.CoreRenderer;
import org.primefaces.util.WidgetBuilder;

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

import java.io.IOException;

public class ScrollTopRenderer extends CoreRenderer {
    @Override
    public void encodeEnd(FacesContext context, UIComponent component) throws IOException {
        ScrollTop scrollTop = (ScrollTop) component;

        encodeMarkup(context, scrollTop);
        encodeScript(context, scrollTop);
    }

    protected void encodeMarkup(FacesContext context, ScrollTop scrollTop) throws IOException {
        ResponseWriter writer = context.getResponseWriter();
        String styleClass = getStyleClassBuilder(context)
                    .add(ScrollTop.STYLE_CLASS)
                    .add(scrollTop.getStyleClass())
                    .add("parent".equals(scrollTop.getTarget()), ScrollTop.STICKY_CLASS)
                    .build();
        String style = scrollTop.getStyle() != null ? "display: none;" + scrollTop.getStyle() : "display: none;";

        writer.startElement("a", null);
        writer.writeAttribute("id", scrollTop.getClientId(context), "id");
        writer.writeAttribute("href", "#", null);
        writer.writeAttribute("tabindex", "0", "tabindex");
        writer.writeAttribute("class", styleClass, "styleClass");
        writer.writeAttribute("style", style, "style");

        writer.startElement("span", scrollTop);
        writer.writeAttribute("class", ScrollTop.ICON_CLASS + " " + scrollTop.getIcon(), null);
        writer.endElement("span");
        writer.endElement("a");
    }

    protected void encodeScript(FacesContext context, ScrollTop scrollTop) throws IOException {
        WidgetBuilder wb = getWidgetBuilder(context);
        wb.init("ScrollTop", scrollTop)
                .attr("target", scrollTop.getTarget())
                .attr("threshold", scrollTop.getThreshold())
                .attr("behavior", scrollTop.getBehavior());
        wb.finish();
    }
}