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

Go to download
/*
 * #%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.Document;
import com.google.gwt.user.client.ui.Widget;
import gwt.material.design.client.base.HasDurationTransition;
import gwt.material.design.client.base.HasFullscreen;
import gwt.material.design.client.base.JsLoader;
import gwt.material.design.client.base.MaterialWidget;
import gwt.material.design.client.base.mixin.FullscreenMixin;
import gwt.material.design.client.constants.CssName;
import gwt.material.design.client.js.JsSliderOptions;
import gwt.material.design.client.ui.html.UnorderedList;

import static gwt.material.design.client.js.JsMaterialElement.$;
//@formatter:off

/**
 * Our slider is a simple and elegant image carousel.
 * You can also have captions that will be transitioned on their own depending on their alignment.
 * You can also have indicators that show up on the bottom of the slider.
 * Note: This is also Hammer.js compatible! Try swiping with your finger to scroll through the slider.
 *
 * 
 * 
UiBinder Usage:
 *  * {@code 
 * 
 *     
 *         
 *         
 *             
 *         
 *     
 *
 *     
 *         
 *         
 *             
 *         
 *     
 *
 *     
 *         
 *         
 *             
 *         
 *     
 * 
 * }
 * 
 *
 * @author kevzlou7979
 * @author Ben Dol
 * @see Material Slider
 */
//@formatter:on
public class MaterialSlider extends MaterialWidget implements JsLoader, HasDurationTransition, HasFullscreen {

    private UnorderedList listContainer = new UnorderedList();
    private JsSliderOptions options = new JsSliderOptions();

    private FullscreenMixin fullscreenMixin;

    public MaterialSlider() {
        super(Document.get().createDivElement(), CssName.SLIDER);
    }

    @Override
    protected void onLoad() {
        listContainer.setStyleName(CssName.SLIDES);
        super.add(listContainer);

        super.onLoad();

        load();
    }

    @Override
    public void load() {
        $(getElement()).slider(options);
    }

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

        unload();
    }

    @Override
    public void unload() {

    }

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

    @Override
    public void add(Widget child) {
        listContainer.add(child);
    }

    public void pause() {
        $(getElement()).slider("pause");
    }

    public void start() {
        $(getElement()).slider("start");
    }

    @Override
    public void setHeight(String height) {
        super.setHeight(height);
        listContainer.setHeight(height);
    }

    /**
     * Set the image slider to fullscreen view.
     */
    @Override
    public void setFullscreen(boolean fullscreen) {
        getFullscreenMixin().setFullscreen(fullscreen);
    }

    @Override
    public boolean isFullscreen() {
        return getFullscreenMixin().isFullscreen();
    }

    public boolean isFullWidth() {
        return options.full_width;
    }

    public void setFullWidth(boolean fullWidth) {
        this.options.full_width = fullWidth;
    }

    public UnorderedList getListContainer() {
        return listContainer;
    }

    @Override
    public void setDuration(int duration) {
        this.options.transition = duration;
    }

    @Override
    public int getDuration() {
        return options.transition;
    }

    public int getInterval() {
        return options.interval;
    }

    /**
     * Set the duration between transitions in ms. (Default: 6000)
     */
    public void setInterval(int interval) {
        this.options.interval = interval;
    }

    protected FullscreenMixin getFullscreenMixin() {
        if (fullscreenMixin == null) {
            fullscreenMixin = new FullscreenMixin(this);
        }
        return fullscreenMixin;
    }
}