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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwt-material Show documentation
A Material Design look and feel for GWT Applications
There is a newer version: 2.8.3
/*
 * #%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.dom.client.Element;
import com.google.gwt.event.dom.client.ChangeEvent;
import com.google.gwt.event.dom.client.ChangeHandler;
import com.google.gwt.event.dom.client.HasChangeHandlers;
import com.google.gwt.event.shared.HandlerRegistration;
import gwt.material.design.client.base.AbstractValueWidget;
import gwt.material.design.client.base.HasError;
import gwt.material.design.client.base.mixin.ErrorMixin;
import gwt.material.design.client.constants.CssName;
import gwt.material.design.client.constants.InputType;
import gwt.material.design.client.ui.html.Paragraph;
import gwt.material.design.client.ui.html.Span;

import static gwt.material.design.jquery.client.api.JQuery.$;

//@formatter:off

/**
 * Material Range - a slider that initialize the minimum and maximum values.
 * 
 * 
UiBinder Usage:
 *  * {@code }
 * 
 *
 * @author kevzlou7979
 * @author Ben Dol
 * @see Material Range
 * @see Material Design Specification
 */
//@formatter:on
public class MaterialRange extends AbstractValueWidget implements HasChangeHandlers, HasError {

    private Paragraph paragraph = new Paragraph();
    private MaterialInput rangeInputElement = new MaterialInput();
    private Span thumb = new Span();
    private Span value = new Span();
    private static String VALUE = "value";
    private static String MAX = "max";
    private static String MIN = "min";
    private MaterialLabel errorLabel = new MaterialLabel();
    private ErrorMixin errorMixin;

    /**
     * Creates a range
     */
    public MaterialRange() {
        super(Document.get().createFormElement());
    }

    /**
     * Creates a range with specified values
     *
     * @param min   - start min value
     * @param max   - end max value
     * @param value - default range value
     */
    public MaterialRange(Integer min, Integer max, Integer value) {
        this();
        setMin(min);
        setMax(max);
        setValue(value);
    }

    public void reset() {
        setValue(getMin());
        clearErrorOrSuccess();
    }

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

        getElement().setAttribute("action", "#");
        errorLabel.setVisible(false);
        paragraph.setStyleName(CssName.RANGE_FIELD);
        rangeInputElement.setType(InputType.RANGE);
        paragraph.add(rangeInputElement);
        thumb.getElement().setClassName(CssName.THUMB);
        value.getElement().setClassName(CssName.VALUE);
        thumb.add(value);
        paragraph.add(thumb);
        add(paragraph);
        add(errorLabel);

        registerHandler(addChangeHandler(changeEvent -> setValue(getValue(), true)));
    }

    /**
     * Retrieve the Integer value from the given Attribute of the range element
     *
     * @param attribute The name of the attribute on the range element
     * @return The Integer vaulue read from the given attribute or null
     */
    protected Integer getIntFromRangeElement(String attribute) {
        Element ele = $(rangeInputElement).asElement();
        if (ele != null) {
            return ele.getPropertyInt(attribute);
        }
        return null;
    }

    /**
     * Set the given Integer value to the attribute of the range element.
     */
    protected void setIntToRangeElement(String attribute, Integer val) {
        Element ele = $(rangeInputElement).asElement();
        if (ele != null) {
            ele.setPropertyInt(attribute, val);
        }
    }

    /**
     * Read the current value
     *
     * @return The Integer value or null
     */
    @Override
    public Integer getValue() {
        return getIntFromRangeElement(VALUE);
    }

    @Override
    public void setValue(Integer value, boolean fireEvents) {
        if (value == null) {
            throw new IllegalArgumentException("Value must not be null");
        }
        if (value < getMin()) {
            throw new IllegalArgumentException("Value must not be less than the minimum range value.");
        }
        if (value > getMax()) {
            throw new IllegalArgumentException("Value must not be greater than the maximum range value");
        }
        setIntToRangeElement(VALUE, value);

        super.setValue(value, fireEvents);
    }

    /**
     * Read the min value
     *
     * @return The Integer or null
     */
    public Integer getMin() {
        return getIntFromRangeElement(MIN);
    }

    /**
     * Write the current min value
     *
     * @param min value must be < max
     */
    public void setMin(Integer min) {
        setIntToRangeElement(MIN, min);
    }

    /**
     * Read the max value
     *
     * @return The Integer or null
     */
    public Integer getMax() {
        return getIntFromRangeElement(MAX);
    }

    /**
     * Write the current max value
     *
     * @param max value must be > min
     */
    public void setMax(Integer max) {
        setIntToRangeElement(MAX, max);
    }

    @Override
    public void setError(String error) {
        getErrorMixin().setError(error);
    }

    @Override
    public void setSuccess(String success) {
        getErrorMixin().setSuccess(success);
    }

    @Override
    public void setHelperText(String helperText) {
        getErrorMixin().setHelperText(helperText);
    }

    @Override
    public void clearErrorOrSuccess() {
        getErrorMixin().clearErrorOrSuccess();
    }

    public MaterialLabel getErrorLabel() {
        return errorLabel;
    }

    public MaterialInput getRangeInputElement() {
        return rangeInputElement;
    }

    public Paragraph getParagraph() {
        return paragraph;
    }

    public Span getThumb() {
        return thumb;
    }

    /**
     * Register the ChangeHandler to become notified if the user changes the slider.
     * The Handler is called when the user releases the mouse only at the end of the slide
     * operation.
     */
    @Override
    public HandlerRegistration addChangeHandler(final ChangeHandler handler) {
        return getRangeInputElement().addDomHandler(handler, ChangeEvent.getType());
    }

    @Override
    public ErrorMixin getErrorMixin() {
        if (errorMixin == null) {
            errorMixin = new ErrorMixin<>(this, errorLabel, null);
        }
        return errorMixin;
    }
}