com.holonplatform.vaadin7.components.builders.SliderInputBuilder Maven / Gradle / Ivy

/*
 * Copyright 2016-2017 Axioma srl.
 * 
 * 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.holonplatform.vaadin7.components.builders;

import com.holonplatform.vaadin7.components.Input;
import com.vaadin.shared.ui.slider.SliderOrientation;

/**
 * Builder to create Slider {@link Input}s.
 * 
 * @param  Number type
 * 
 * @since 5.0.0
 */
public interface SliderInputBuilder extends InputBuilder, SliderInputBuilder> {

	/**
	 * Set the maximum value. If the current value of the field is larger than this, the value is set to the new
	 * maximum.
	 * @param max The new maximum field value
	 * @return this
	 */
	SliderInputBuilder max(T max);

	/**
	 * Set the minimum field value. If the current value of the field is smaller than this, the value is set to the new
	 * minimum.
	 * @param min The new minimum field value
	 * @return this
	 */
	SliderInputBuilder min(T min);

	/**
	 * Set the orientation of the slider.
	 * @param orientation The new orientation, either {@link SliderOrientation#HORIZONTAL} or
	 *        {@link SliderOrientation#VERTICAL}
	 * @return this
	 */
	SliderInputBuilder orientation(SliderOrientation orientation);

	/**
	 * Set a new resolution for the slider. The resolution is the number of digits after the decimal point.
	 * 
	 * For integer type fields, this method has no effect, since resolution is always 0.
	 * 
	 * @param resolution The resolution to set
	 * @return this
	 */
	SliderInputBuilder resolution(int resolution);

}