123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407 |
- /*
- * Copyright 2000-2018 Vaadin Ltd.
- *
- * 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.
- */
-
- package com.vaadin.ui;
-
- import java.util.Collection;
- import java.util.Objects;
-
- import org.jsoup.nodes.Attributes;
- import org.jsoup.nodes.Element;
-
- import com.vaadin.shared.ui.slider.SliderOrientation;
- import com.vaadin.shared.ui.slider.SliderServerRpc;
- import com.vaadin.shared.ui.slider.SliderState;
- import com.vaadin.ui.declarative.DesignAttributeHandler;
- import com.vaadin.ui.declarative.DesignContext;
-
- import elemental.json.Json;
-
- /**
- * A component for selecting a numerical value within a range.
- *
- * @author Vaadin Ltd.
- */
- public class Slider extends AbstractField<Double> {
-
- private SliderServerRpc rpc = (double value) -> {
-
- /*
- * Client side updates the state before sending the event so we need to
- * make sure the cached state is updated to match the client. If we do
- * not do this, a reverting setValue() call in a listener will not cause
- * the new state to be sent to the client.
- *
- * See #12133.
- */
- updateDiffstate("value", Json.create(value));
-
- try {
- setValue(value, true);
- } catch (final ValueOutOfBoundsException e) {
- // Convert to nearest bound
- double out = e.getValue().doubleValue();
- if (out < getState().minValue) {
- out = getState().minValue;
- }
- if (out > getState().maxValue) {
- out = getState().maxValue;
- }
- Slider.super.setValue(new Double(out), false);
- }
- };
-
- /**
- * Default slider constructor.
- * <p>
- * The range of the slider is set to 0-100 and only integer values are
- * allowed.
- */
- public Slider() {
- super();
- registerRpc(rpc);
- super.setValue(new Double(getState().minValue));
- }
-
- /**
- * Create a new slider with the caption given as parameter.
- * <p>
- * The range of the slider is set to 0-100 and only integer values are
- * allowed.
- *
- * @param caption
- * the caption for this slider (e.g. "Volume")
- */
- public Slider(String caption) {
- this();
- setCaption(caption);
- }
-
- /**
- * Create a new slider with the given range and resolution.
- *
- * @param min
- * The minimum value of the slider
- * @param max
- * The maximum value of the slider
- * @param resolution
- * The number of digits after the decimal point.
- */
- public Slider(double min, double max, int resolution) {
- this();
- // Need to set resolution first in order to not round min and max
- // to the default resolution (0)
- setResolution(resolution);
- setMax(max);
- setMin(min);
- }
-
- /**
- * Create a new slider with the given range of integers.
- *
- * @param min
- * the minimum value of the slider
- * @param max
- * the maximum value of the slider
- */
- public Slider(int min, int max) {
- this();
- setMin(min);
- setMax(max);
- setResolution(0);
- }
-
- /**
- * Creates a new slider with the given caption and integer range.
- *
- * @param caption
- * the caption for the slider
- * @param min
- * the minimum value of the slider
- * @param max
- * the maximum value of the slider
- */
- public Slider(String caption, int min, int max) {
- this(min, max);
- setCaption(caption);
- }
-
- @Override
- public SliderState getState() {
- return (SliderState) super.getState();
- }
-
- @Override
- public SliderState getState(boolean markAsDirty) {
- return (SliderState) super.getState(markAsDirty);
- }
-
- /**
- * Gets the maximum slider value. The default value is 100.0.
- *
- * @return the largest value the slider can have
- */
- public double getMax() {
- return getState(false).maxValue;
- }
-
- /**
- * Sets the maximum slider value. If the current value of the slider is
- * larger than this, the value is set to the new maximum.
- *
- * @param max
- * The new maximum slider value
- */
- public void setMax(double max) {
- double roundedMax = getRoundedValue(max);
- getState().maxValue = roundedMax;
-
- if (getMin() > roundedMax) {
- getState().minValue = roundedMax;
- }
-
- if (getValue() > roundedMax) {
- setValue(roundedMax);
- }
- }
-
- /**
- * Gets the minimum slider value. The default value is 0.0.
- *
- * @return the smallest value the slider can have
- */
- public double getMin() {
- return getState(false).minValue;
- }
-
- /**
- * Sets the minimum slider value. If the current value of the slider is
- * smaller than this, the value is set to the new minimum.
- *
- * @param min
- * The new minimum slider value
- */
- public void setMin(double min) {
- double roundedMin = getRoundedValue(min);
- getState().minValue = roundedMin;
-
- if (getMax() < roundedMin) {
- getState().maxValue = roundedMin;
- }
-
- if (getValue() < roundedMin) {
- setValue(roundedMin);
- }
- }
-
- /**
- * Gets the current orientation of the slider (horizontal or vertical).
- *
- * @return {@link SliderOrientation#HORIZONTAL} or
- * {@link SliderOrientation#VERTICAL}
- */
- public SliderOrientation getOrientation() {
- return getState(false).orientation;
- }
-
- /**
- * Sets the orientation of the slider.
- *
- * @param orientation
- * the new orientation, either
- * {@link SliderOrientation#HORIZONTAL} or
- * {@link SliderOrientation#VERTICAL}
- */
- public void setOrientation(SliderOrientation orientation) {
- getState().orientation = orientation;
- }
-
- /**
- * Gets the resolution of the slider. The resolution is the number of digits
- * after the decimal point. The default resolution is 0 (only integers
- * allowed).
- *
- * @return resolution the number of digits after the decimal point
- */
- public int getResolution() {
- return getState(false).resolution;
- }
-
- /**
- * Set a new resolution for the slider. The resolution is the number of
- * digits after the decimal point.
- *
- * @throws IllegalArgumentException
- * if resolution is negative.
- *
- * @param resolution
- * the number of digits after the decimal point
- */
- public void setResolution(int resolution) {
- if (resolution < 0) {
- throw new IllegalArgumentException(
- "Cannot set a negative resolution to Slider");
- }
- getState().resolution = resolution;
- }
-
- /**
- * Sets the slider to update its value when the user clicks on it. By
- * default, the slider value is updated by dragging the slider's handle or
- * clicking arrows.
- *
- * @param updateValueOnClick
- * {@code true} to update the value of the slider on click,
- * {@code false} otherwise.
- * @since 8.8
- */
- public void setUpdateValueOnClick(boolean updateValueOnClick) {
- getState().updateValueOnClick = updateValueOnClick;
- }
-
- /**
- * Returns whether the slider updates its value on user click.
- *
- * @return {@code true} if the Slider updates its value on click. By
- * default, returns {@code false}
- * @since 8.8
- */
- public boolean isUpdateValueOnClick() {
- return getState(false).updateValueOnClick;
- }
-
- private double getRoundedValue(Double value) {
- final double v = value.doubleValue();
- final int resolution = getResolution();
-
- double ratio = Math.pow(10, resolution);
- if (v >= 0) {
- return Math.floor(v * ratio) / ratio;
- } else {
- return Math.ceil(v * ratio) / ratio;
- }
- }
-
- @Override
- protected void doSetValue(Double newValue) {
- double trimmedValue;
- if (newValue == null) {
- trimmedValue = 0.0;
- } else {
- trimmedValue = getRoundedValue(newValue);
- }
-
- if (getMin() > trimmedValue || getMax() < trimmedValue) {
- throw new ValueOutOfBoundsException(trimmedValue);
- }
-
- getState().value = trimmedValue;
- }
-
- /**
- * Sets the value of this object. If the new value is not equal to
- * {@code getValue()}, fires a {@link ValueChangeEvent}. Throws
- * {@code NullPointerException} if the value is null.
- *
- * @param value
- * the new value, not {@code null}
- * @throws NullPointerException
- * if {@code value} is {@code null}
- */
- @Override
- public void setValue(Double value) {
- Objects.requireNonNull(value, "Value cannot be null");
- super.setValue(value);
- }
-
- @Override
- public Double getValue() {
- return getState(false).value;
- }
-
- @Override
- public Double getEmptyValue() {
- return getMin();
- }
-
- /**
- * Thrown when the value of the slider is about to be set to a value that is
- * outside the valid range of the slider.
- *
- * @author Vaadin Ltd.
- *
- */
- public class ValueOutOfBoundsException extends RuntimeException {
-
- private final Double value;
-
- /**
- * Constructs an <code>ValueOutOfBoundsException</code> with the
- * specified detail message.
- *
- * @param valueOutOfBounds
- * the value of the slider
- */
- public ValueOutOfBoundsException(Double valueOutOfBounds) {
- super(String.format("Value %s is out of bounds: [%s, %s]",
- valueOutOfBounds, getMin(), getMax()));
- value = valueOutOfBounds;
- }
-
- /**
- * Gets the value that is outside the valid range of the slider.
- *
- * @return the value that is out of bounds
- */
- public Double getValue() {
- return value;
- }
- }
-
- @Override
- public void readDesign(Element design, DesignContext context) {
- super.readDesign(design, context);
- Attributes attr = design.attributes();
- if (attr.hasKey("vertical")) {
- setOrientation(SliderOrientation.VERTICAL);
- }
- if (attr.hasKey("value")) {
- Double newFieldValue = DesignAttributeHandler.readAttribute("value",
- attr, Double.class);
- setValue(newFieldValue);
- }
- }
-
- @Override
- public void writeDesign(Element design, DesignContext context) {
- super.writeDesign(design, context);
- if (getOrientation() == SliderOrientation.VERTICAL) {
- design.attr("vertical", true);
- }
- Slider defaultSlider = context.getDefaultInstance(this);
- DesignAttributeHandler.writeAttribute(this, "value",
- design.attributes(), defaultSlider, context);
- }
-
- @Override
- protected Collection<String> getCustomAttributes() {
- Collection<String> result = super.getCustomAttributes();
- result.add("orientation");
- result.add("vertical");
- return result;
- }
-
- }
|