com.vaadin.ui
Class Slider

java.lang.Object
  com.vaadin.server.AbstractClientConnector
      com.vaadin.ui.AbstractComponent
          com.vaadin.ui.AbstractField<java.lang.Double>
              com.vaadin.ui.Slider

All Implemented Interfaces:

Buffered, BufferedValidatable, Property<java.lang.Double>, Property.Editor, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer, Validatable, Action.ShortcutNotifier, MethodEventSource, ClientConnector, Sizeable, com.vaadin.shared.Connector, Component, Component.Focusable, Field<java.lang.Double>, java.io.Serializable

public class Slider
extends AbstractField<java.lang.Double>

A component for selecting a numerical value within a range.

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary

class

Slider.ValueOutOfBoundsException Thrown when the value of the slider is about to be set to a value that is outside the valid range of the slider.

Nested classes/interfaces inherited from class com.vaadin.ui.AbstractField

AbstractField.FocusShortcut, AbstractField.ReadOnlyStatusChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.ui.Field

Field.ValueChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.data.Buffered

Buffered.SourceException

Nested classes/interfaces inherited from interface com.vaadin.data.Property

Property.Editor, Property.ReadOnlyException, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.Transactional<T>, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

Sizeable.Unit

Field Summary

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Slider()
Default slider constructor.

Slider(double min, double max, int resolution)
Create a new slider with the given range and resolution.

Slider(int min, int max)
Create a new slider with the given range that only allows integer values.

Slider(java.lang.String caption)
Create a new slider with the caption given as parameter.

Slider(java.lang.String caption, int min, int max)
Create a new slider with the given caption and range that only allows integer values.

Method Summary

void	clear() Clears the value of the field.
protected java.util.Collection<java.lang.String>	getCustomAttributes() Returns a collection of attributes that should not be handled by the basic implementation of the readDesign and writeDesign methods.
double	getMax() Gets the maximum slider value
double	getMin() Gets the minimum slider value
com.vaadin.shared.ui.slider.SliderOrientation	getOrientation() Get the current orientation of the slider (horizontal or vertical).
int	getResolution() Get the current resolution of the slider.
com.vaadin.shared.ui.slider.SliderState	getState() Returns the shared state bean with information to be sent from the server to the client.
com.vaadin.shared.ui.slider.SliderState	getState(boolean markAsDirty) Returns the shared state for this connector.
java.lang.Class<java.lang.Double>	getType() Returns the type of the Field.
boolean	isEmpty() Is the field empty? In general, "empty" state is same as null.
void	readDesign(org.jsoup.nodes.Element design, DesignContext context) Reads the component state from the given design.
protected void	setInternalValue(java.lang.Double newValue) Sets the internal field value.
void	setMax(double max) Set the maximum slider value.
void	setMin(double min) Set the minimum slider value.
void	setOrientation(com.vaadin.shared.ui.slider.SliderOrientation orientation) Set the orientation of the slider.
void	setResolution(int resolution) Set a new resolution for the slider.
void	setValue(java.lang.Double newFieldValue) Sets the value of the field.
protected void	setValue(java.lang.Double value, boolean repaintIsNotNeeded) Sets the value of the slider.
void	writeDesign(org.jsoup.nodes.Element design, DesignContext context) Writes the component state to the given design.

Methods inherited from class com.vaadin.ui.AbstractField

addListener, addListener, addReadOnlyStatusChangeListener, addValidator, addValueChangeListener, attach, beforeClientResponse, commit, detach, discard, fireReadOnlyStatusChange, fireValueChange, focus, getConversionError, getConversionError, getConvertedValue, getConverter, getCurrentBufferedSourceException, getErrorMessage, getInternalValue, getModelType, getPropertyDataSource, getRequiredError, getTabIndex, getValidators, getValue, isBuffered, isImmediate, isInvalidAllowed, isInvalidCommitted, isModified, isReadOnly, isRequired, isValid, isValidationVisible, readOnlyStatusChange, removeAllValidators, removeListener, removeListener, removeReadOnlyStatusChangeListener, removeValidator, removeValueChangeListener, setBuffered, setConversionError, setConvertedValue, setConverter, setConverter, setCurrentBufferedSourceException, setInvalidAllowed, setInvalidCommitted, setLocale, setPropertyDataSource, setReadOnly, setRequired, setRequiredError, setTabIndex, setValidationVisible, shouldHideErrors, toString, validate, validate, valueChange

Methods inherited from class com.vaadin.ui.AbstractComponent

addListener, addShortcutListener, addStyleName, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getExplicitImmediateValue, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isResponsive, isVisible, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setParent, setPrimaryStyleName, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface com.vaadin.event.Action.ShortcutNotifier

addShortcutListener, removeShortcutListener

Constructor Detail

Slider

public Slider()

Default slider constructor. Sets all values to defaults and the slide handle at minimum value.

Slider

public Slider(java.lang.String caption)

Create a new slider with the caption given as parameter. The range of the slider is set to 0-100 and only integer values are allowed.

Parameters:

caption - The caption for this slider (e.g. "Volume").

Slider

public Slider(double min,
              double max,
              int resolution)

Create a new slider with the given range and resolution.

Parameters:

min - The minimum value of the slider

max - The maximum value of the slider

resolution - The number of digits after the decimal point.

Slider

public Slider(int min,
              int max)

Create a new slider with the given range that only allows integer values.

Parameters:

min - The minimum value of the slider

max - The maximum value of the slider

Slider

public Slider(java.lang.String caption,
              int min,
              int max)

Create a new slider with the given caption and range that only allows integer values.

Parameters:

caption - The caption for the slider

min - The minimum value of the slider

max - The maximum value of the slider

Method Detail

getState

public com.vaadin.shared.ui.slider.SliderState getState()

Description copied from class: AbstractComponent

Returns the shared state bean with information to be sent from the server to the client. Subclasses should override this method and set any relevant fields of the state returned by super.getState().

Overrides:

getState in class AbstractField<java.lang.Double>

Returns:

updated component shared state

getState

public com.vaadin.shared.ui.slider.SliderState getState(boolean markAsDirty)

Description copied from class: AbstractClientConnector

Returns the shared state for this connector.

Overrides:

getState in class AbstractField<java.lang.Double>

Parameters:

markAsDirty - true if the connector should automatically be marked dirty, false otherwise

Returns:

The shared state for this connector. Never null.

See Also:

AbstractClientConnector.getState()

getMax

public double getMax()

Gets the maximum slider value

Returns:

the largest value the slider can have

setMax

public void setMax(double max)

Set the maximum slider value. If the current value of the slider is larger than this, the value is set to the new maximum.

Parameters:

max - The new maximum slider value

getMin

public double getMin()

Gets the minimum slider value

Returns:

the smallest value the slider can have

setMin

public void setMin(double min)

Set the minimum slider value. If the current value of the slider is smaller than this, the value is set to the new minimum.

Parameters:

min - The new minimum slider value

getOrientation

public com.vaadin.shared.ui.slider.SliderOrientation getOrientation()

Get the current orientation of the slider (horizontal or vertical).

Returns:

SliderOrientation.HORIZONTAL or SliderOrientation.VERTICAL

setOrientation

public void setOrientation(com.vaadin.shared.ui.slider.SliderOrientation orientation)

Set the orientation of the slider.

Parameters:

orientation - The new orientation, either SliderOrientation.HORIZONTAL or SliderOrientation.VERTICAL

getResolution

public int getResolution()

Get the current resolution of the slider. The resolution is the number of digits after the decimal point.

Returns:

resolution

setResolution

public void setResolution(int resolution)

Set a new resolution for the slider. The resolution is the number of digits after the decimal point.

Parameters:

resolution -

Throws:

java.lang.IllegalArgumentException - if resolution is negative.

setValue

protected void setValue(java.lang.Double value,
                        boolean repaintIsNotNeeded)

Sets the value of the slider.

Overrides:

setValue in class AbstractField<java.lang.Double>

Parameters:

value - The new value of the slider.

repaintIsNotNeeded - If true, client-side is not requested to repaint itself.

Throws:

Slider.ValueOutOfBoundsException - If the given value is not inside the range of the slider.

See Also:

{@link #setMax(double)}

setValue

public void setValue(java.lang.Double newFieldValue)

Description copied from class: AbstractField

Sets the value of the field.

Specified by:

setValue in interface Property<java.lang.Double>

Overrides:

setValue in class AbstractField<java.lang.Double>

Parameters:

newFieldValue - the New value of the field.

setInternalValue

protected void setInternalValue(java.lang.Double newValue)

Description copied from class: AbstractField

Sets the internal field value. This is purely used by AbstractField to change the internal Field value. It does not trigger valuechange events. It can be overridden by the inheriting classes to update all dependent variables. Subclasses can also override AbstractField.getInternalValue() if necessary.

Overrides:

setInternalValue in class AbstractField<java.lang.Double>

Parameters:

newValue - the new value to be set.

getType

public java.lang.Class<java.lang.Double> getType()

Description copied from class: AbstractField

Returns the type of the Field. The methods getValue and setValue must be compatible with this type: one must be able to safely cast the value returned from getValue to the given type and pass any variable assignable to this type as an argument to setValue.

Specified by:

getType in interface Property<java.lang.Double>

Specified by:

getType in class AbstractField<java.lang.Double>

Returns:

the type of the Field

clear

public void clear()

Description copied from interface: Field

Clears the value of the field.

The field value is typically reset to the initial value of the field. Calling Field.isEmpty() on a cleared field must always returns true.

Specified by:

clear in interface Field<java.lang.Double>

Overrides:

clear in class AbstractField<java.lang.Double>

isEmpty

public boolean isEmpty()

Description copied from interface: Field

Is the field empty? In general, "empty" state is same as null. As an exception, TextField also treats empty string as "empty".

Specified by:

isEmpty in interface Field<java.lang.Double>

Overrides:

isEmpty in class AbstractField<java.lang.Double>

Returns:

true if the field is empty, false otherwise

readDesign

public void readDesign(org.jsoup.nodes.Element design,
                       DesignContext context)

Description copied from interface: Component

Reads the component state from the given design.

The component is responsible not only for updating its own state but also for ensuring that its children update their state based on the design.

It is assumed that the component is in its default state when this method is called. Reading should only take into consideration attributes specified in the design and not reset any unspecified attributes to their defaults.

This method must not modify the design.

Specified by:

readDesign in interface Component

Overrides:

readDesign in class AbstractField<java.lang.Double>

Parameters:

design - The element to obtain the state from

context - The DesignContext instance used for parsing the design

writeDesign

public void writeDesign(org.jsoup.nodes.Element design,
                        DesignContext context)

Description copied from interface: Component

Writes the component state to the given design.

The component is responsible not only for writing its own state but also for ensuring that its children write their state to the design.

This method must not modify the component state.

Specified by:

writeDesign in interface Component

Overrides:

writeDesign in class AbstractField<java.lang.Double>

Parameters:

design - The element to write the component state to. Any previous attributes or child nodes are not cleared.

context - The DesignContext instance used for writing the design

getCustomAttributes

protected java.util.Collection<java.lang.String> getCustomAttributes()

Description copied from class: AbstractComponent

Returns a collection of attributes that should not be handled by the basic implementation of the readDesign and writeDesign methods. Typically these are handled in a custom way in the overridden versions of the above methods

Overrides:

getCustomAttributes in class AbstractField<java.lang.Double>

Returns:

the collection of attributes that are not handled by the basic implementation