gwt.material.design.addins.client.circularprogress.MaterialCircularProgress Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwt-material-addins
Extra Components of GWT Material Framework
There is a newer version: 2.8.3
/*
 * #%L
 * GwtMaterial
 * %%
 * Copyright (C) 2015 - 2016 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.addins.client.circularprogress;

import com.google.gwt.core.client.Scheduler;
import com.google.gwt.dom.client.Document;
import gwt.material.design.addins.client.MaterialAddins;
import gwt.material.design.addins.client.base.constants.AddinsCssName;
import gwt.material.design.addins.client.circularprogress.events.*;
import gwt.material.design.addins.client.circularprogress.js.JsCircularProgressOptions;
import gwt.material.design.addins.client.circularprogress.ui.CircularProgressLabel;
import gwt.material.design.client.MaterialDesignBase;
import gwt.material.design.client.base.AbstractValueWidget;
import gwt.material.design.client.base.JsLoader;
import gwt.material.design.client.base.MaterialWidget;
import gwt.material.design.client.base.helper.ColorHelper;
import gwt.material.design.client.base.mixin.FontSizeMixin;
import gwt.material.design.client.base.mixin.ToggleStyleMixin;
import gwt.material.design.client.constants.Color;

import static gwt.material.design.addins.client.circularprogress.js.JsCircularProgress.$;

/**
 * Circular Progress that draws an animated circular progress bar. Good for dashboards.
 * 
 * 
XML Namespace Declaration
 *  * {@code
 * xmlns:ma='urn:import:gwt.material.design.addins.client'
 * }
 * 
 * 
 * 
UiBinder Usage:
 *  * {@code
 * 
 * 
 * 
 * 
 * 
 * 
 * }
 * 
 *
 * @author kevzlou7979
 * @see Material Circular Progress
 * @see jquery-circle-progress 1.2.2
 */
public class MaterialCircularProgress extends AbstractValueWidget implements JsLoader, HasCircularProgressHandlers {

    static {
        if (MaterialAddins.isDebug()) {
            MaterialDesignBase.injectDebugJs(MaterialCircularProgressDebugClientBundle.INSTANCE.circularProgressDebugJs());
            MaterialDesignBase.injectCss(MaterialCircularProgressDebugClientBundle.INSTANCE.circularProgressDebugCss());
        } else {
            MaterialDesignBase.injectJs(MaterialCircularProgressClientBundle.INSTANCE.circularProgressJs());
            MaterialDesignBase.injectCss(MaterialCircularProgressClientBundle.INSTANCE.circularProgressCss());
        }
    }


    private CircularProgressLabel label = new CircularProgressLabel();
    private Color fillColor = Color.BLUE;
    private Color emptyFillColor = Color.GREY_LIGHTEN_2;

    private ToggleStyleMixin responsiveMixin;
    private JsCircularProgressOptions options = JsCircularProgressOptions.create();
    private FontSizeMixin fontSizeMixin;

    public MaterialCircularProgress() {
        super(Document.get().createDivElement(), AddinsCssName.CIRCULAR_PROGRESS);
    }

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


        label.setSize(getSize(), isResponsive());
        add(label);


        $(getElement()).on(CircularProgressEvents.PROGRESS, (e, progress, step) -> {
            ProgressEvent.fire(this, (double) progress, (double) step);
            return true;
        });
        $(getElement()).on(CircularProgressEvents.START, (e, param1) -> {
            StartEvent.fire(this, getValue());
            return true;
        });

        $(getElement()).on(CircularProgressEvents.COMPLETED, (e, param1) -> {
            CompleteEvent.fire(this, getValue());
            return true;
        });

        load();
    }

    @Override
    public void load() {
        Scheduler.get().scheduleDeferred(() -> $(getElement()).circleProgress(options));
    }

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

        unload();
    }

    @Override
    public void unload() {
        $(getElement()).off(CircularProgressEvents.START);
        $(getElement()).off(CircularProgressEvents.PROGRESS);
        $(getElement()).off(CircularProgressEvents.COMPLETED);
    }

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

    @Override
    public void reset() {
        super.reset();

        reload();
    }

    public void redraw() {
        $(getElement()).circleProgress("redraw");
    }

    @Override
    public Double getValue() {
        return options.value;
    }

    @Override
    public void setValue(Double value) {
        setValue(value, false);
    }

    @Override
    public void setValue(Double value, boolean fireEvents) {
        super.setValue(value, fireEvents);

        if (!isAttached()) {
            options.value = value;
        } else {
            $(getElement()).circleProgress("value", value);
        }
    }

    /**
     * This is the only required option. It should be from 0.0 to 1.0 (Default: 0)
     */
    public Color getFillColor() {
        return fillColor;
    }

    /**
     * Set the fillColor of the circular progress
     */
    public void setFillColor(Color fillColor) {
        this.fillColor = fillColor;
        options.fill = ColorHelper.setupComputedBackgroundColor(fillColor);
    }

    public Color getEmptyFillColor() {
        return emptyFillColor;
    }

    /**
     * Set the empty fill color of the circular progress
     */
    public void setEmptyFillColor(Color emptyFillColor) {
        this.emptyFillColor = emptyFillColor;
        options.emptyFill = ColorHelper.setupComputedBackgroundColor(emptyFillColor);
    }

    public double getSize() {
        return options.size;
    }

    /**
     * Set the size of the circle / canvas in pixels
     */
    public void setSize(int size) {
        options.size = size;
    }

    public int getThickness() {
        return (int) options.thickness;
    }

    /**
     * Thickness width of the arc. (Default : 8)
     */
    public void setThickness(int thickness) {
        options.thickness = thickness;
    }

    public double getStartAngle() {
        return options.startAngle;
    }

    /**
     * Initial angle of the circular progress component (Default : -Math.PI);
     */
    public void setStartAngle(double startAngle) {
        options.startAngle = startAngle;
    }

    public boolean isReverse() {
        return options.reverse;
    }

    /**
     * Reverse animation and arc draw (Default : false)
     */
    public void setReverse(boolean reverse) {
        options.reverse = reverse;
    }

    /**
     * Set the text of the circular progress
     */
    public void setText(String text) {
        label.setText(text);
    }

    public boolean isResponsive() {
        return getResponsiveMixin().isOn();
    }

    /**
     * Enable Responsive circular progress
     * If responsive we will set the size to maximum value = 1000,
     * else set it to the default size = 100
     **/
    public void setResponsive(boolean responsive) {
        options.size = responsive == true ? 1000 : 100;
        getResponsiveMixin().setOn(responsive);
    }

    public CircularProgressLabel getLabel() {
        return label;
    }

    public ToggleStyleMixin getResponsiveMixin() {
        if (responsiveMixin == null) {
            responsiveMixin = new ToggleStyleMixin(this, AddinsCssName.RESPONSIVE);
        }
        return responsiveMixin;
    }

    @Override
    protected FontSizeMixin getFontSizeMixin() {
        if (fontSizeMixin == null) {
            fontSizeMixin = new FontSizeMixin<>(label);
        }
        return fontSizeMixin;
    }

    @Override
    public void addProgressHandler(ProgressEvent.ProgressHandler handler) {
        addHandler(handler, ProgressEvent.TYPE);
    }

    @Override
    public void addStartHandler(StartEvent.StartHandler handler) {
        addHandler(handler, StartEvent.TYPE);
    }

    @Override
    public void addCompleteHandler(CompleteEvent.CompleteHandler handler) {
        addHandler(handler, CompleteEvent.TYPE);
    }
}