gwt.material.design.client.ui.MaterialScrollspy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwt-material
A Material Design look and feel for GWT Applications
The newest version!
/*
 * #%L
 * GwtMaterial
 * %%
 * Copyright (C) 2015 - 2017 GwtMaterialDesign
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package gwt.material.design.client.ui;

import com.google.gwt.dom.client.Node;
import com.google.gwt.user.client.ui.Widget;
import gwt.material.design.client.base.JsLoader;
import gwt.material.design.client.constants.CssName;
import gwt.material.design.client.js.ScrollspyOption;
import gwt.material.design.client.ui.html.Label;
import gwt.material.design.client.ui.html.ListItem;
import gwt.material.design.client.ui.html.UnorderedList;

import static gwt.material.design.client.js.JsMaterialElement.$;

//@formatter:off

/**
 * Scrollspy is a jQuery plugin that tracks certain elements and which element the user's screen is currently centered on. Our main demo of this is our table of contents on every documentation page to the right. Clicking on these links will also scroll the page to that element.
 * 
 * 
UiBinder Usage:
 *  * {@code
 * 
 *     
 *         
 *             
 *         
 *
 *         
 *             
 *         
 *
 *         
 *             
 *         
 *
 *         
 *             
 *         
 *     
 *
 *     
 *         
 *             
 *             
 *             
 *             
 *         
 *     
 * 
 *
 * }
 * 
 *
 * @author kevzlou7979
 * @author Ben Dol
 * @see Material Range
 */
//@formatter:on
public class MaterialScrollspy extends UnorderedList implements JsLoader {

    protected ScrollspyOption option;

    public MaterialScrollspy() {
        super(CssName.SECTION, CssName.TABLE_OF_CONTENTS);
    }

    @Override
    protected void onLoad() {
        super.onLoad();

        load();
    }

    @Override
    protected void onUnload() {
        super.onUnload();

        unload();
    }

    @Override
    public void load() {
        clearActiveState();

        if (option != null) {
            $(".scrollspy").scrollSpy(option);
        } else {
            $(".scrollspy").scrollSpy();
        }
    }

    @Override
    public void unload() {
        clearActiveState();
    }

    @Override
    public void reload() {
        unload();
        load();
    }

    public void setActive(String scrollSpy) {
        Widget widget = getWidget(scrollSpy);
        if (widget != null) {
            $(widget.getElement()).trigger("click", null);
        }
    }

    public void setError(String scrollSpy) {
        setError(scrollSpy, null);
    }

    public void setError(String scrollSpy, String badge) {
        Widget widget = getWidget(scrollSpy);
        if (widget != null) {
            widget.addStyleName("error");

            if (badge != null) {
                Label label = new Label(badge);
                widget.getElement().appendChild(label.getElement());
            } else {
                Node child = widget.getElement().getChild(1);
                child.removeFromParent();
            }
        }
    }

    public Widget getWidget(String scrollSpy) {
        for (Widget child : getChildren()) {
            if (child instanceof ListItem) {
                ListItem item = (ListItem) child;
                if (item.getWidgetCount() > 0 && item.getWidget(0) != null) {
                    Widget widget = item.getWidget(0);
                    if (widget.getElement().getAttribute("href").replace("#", "").equals(scrollSpy)) {
                        return widget;
                    }
                }
            }
        }
        return null;
    }

    public void clearActiveState() {
        getChildren().forEach(widget -> {
            if (widget instanceof ListItem) {
                ListItem item = (ListItem) widget;
                if (item.getWidgetCount() > 0 && item.getWidget(0) != null) {
                    item.getWidget(0).removeStyleName(CssName.ACTIVE);
                }
            }
        });
    }

    public void setOption(ScrollspyOption option) {
        this.option = option;
    }

    public ScrollspyOption getOption() {
        return option;
    }
}