java.lang.Object
- eu.webtoolkit.jwt.WObject
- - eu.webtoolkit.jwt.WWidget
  - - eu.webtoolkit.jwt.WWebWidget
    - - eu.webtoolkit.jwt.WInteractWidget
      - eu.webtoolkit.jwt.WFormWidget
        
        eu.webtoolkit.jwt.WSlider

```
public class WSlider
extends WFormWidget
```
A horizontal or vertical slider control.
A slider allows the user to specify an integer value within a particular range using a visual slider.
The slider must be sized explicitly using resize() or by a layout manager. The default size is 150 x 50 pixels for a horizontal slider, and 50 x 150 pixels for a vertical slider.

Horizontal slider with ticks on both sides.

CSS

The non-native slider (HTML4, see setNativeControl()) is styled by the current CSS theme.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class WSlider.TickPosition
Enumeration that specifies the location of ticks.
- Nested classes/interfaces inherited from class eu.webtoolkit.jwt.WObject
  WObject.FormData

Field Summary

Fields
Modifier and Type	Field	Description
`protected static java.lang.String`	`INPUT_SIGNAL`
`static java.util.EnumSet<WSlider.TickPosition>`	`NoTicks`
`static java.util.EnumSet<WSlider.TickPosition>`	`TicksBothSides`

Fields inherited from class eu.webtoolkit.jwt.WInteractWidget
dragTouchEndSlot_, dragTouchSlot_, noDefault

Fields inherited from class eu.webtoolkit.jwt.WWidget
WT_GETEXTRAMS_JS

Constructor Summary

Constructors
Constructor	Description
`WSlider()`	Creates a default horizontal slider.
`WSlider(Orientation orientation)`	Creates a default slider of the given orientation.
`WSlider(Orientation orientation, WContainerWidget parentContainer)`	Creates a default slider of the given orientation.
`WSlider(WContainerWidget parentContainer)`	Creates a default horizontal slider.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`enableAjax()`	Progresses to an Ajax-enabled widget.
`protected WInteractWidget`	`getCreateHandle()`	Creates the handle (for a non-native widget)
`int`	`getHandleWidth()`	Returns the handle width.
`int`	`getMaximum()`	Returns the maximum value.
`int`	`getMinimum()`	Returns the minimum value.
`Orientation`	`getOrientation()`	Returns the slider orientation.
`int`	`getStep()`	Return the step value.
`int`	`getTickInterval()`	Returns the tick interval.
`WLength`	`getTickLength()`	Returns the tick length.
`java.util.EnumSet<WSlider.TickPosition>`	`getTickPosition()`	Returns the tick position.
`int`	`getValue()`	Returns the current slider value.
`java.lang.String`	`getValueText()`	Returns the current value.
`EventSignal`	`input()`	Signal emitted when input was captured.
`boolean`	`isNativeControl()`	Returns whether a native HTML5 control is used.
`protected void`	`layoutSizeChanged(int width, int height)`	Virtual method that indicates a size change.
`protected void`	`paintTick(WPainter painter, int value, int x, int y)`	Paints a slider ticks (for a non-native widget)
`void`	`remove()`	Destructor.
`protected void`	`render(java.util.EnumSet<RenderFlag> flags)`	Renders the widget.
`void`	`resize(WLength width, WLength height)`	Resizes the widget.
`void`	`setDisabled(boolean disabled)`	Sets whether the widget is disabled.
`protected void`	`setFormData(WObject.FormData formData)`
`void`	`setHandleWidth(int handleWidth)`	Sets the slider handle width.
`void`	`setMaximum(int maximum)`	Sets the maximum value.
`void`	`setMinimum(int minimum)`	Sets the minimum value.
`void`	`setNativeControl(boolean nativeControl)`	Configures whether a native HTML5 control should be used.
`void`	`setOrientation(Orientation orientation)`	Sets the slider orientation.
`void`	`setRange(int minimum, int maximum)`	Sets the value range.
`void`	`setStep(int step)`	Sets the step value.
`void`	`setTickInterval(int tickInterval)`	Sets the tick interval.
`void`	`setTickLength(WLength length)`	Sets the length of the ticks to be drawn.
`void`	`setTickPosition(WSlider.TickPosition tickPositio, WSlider.TickPosition... tickPosition)`	Sets the tick position.
`void`	`setTickPosition(java.util.EnumSet<WSlider.TickPosition> tickPosition)`	Sets the tick position.
`void`	`setValue(int value)`	Sets the slider value.
`void`	`setValueText(java.lang.String value)`	Sets the value text.
`JSignal1<java.lang.Integer>`	`sliderMoved()`	Signal emitted while the user drags the slider.
`Signal1<java.lang.Integer>`	`valueChanged()`	Signal emitted when the user has changed the value of the slider.

Methods inherited from class eu.webtoolkit.jwt.WFormWidget
changed, getLabel, getPlaceholderText, getRealValidator, getTabIndex, getValidator, hasValidatorChanged, isCanReceiveFocus, isReadOnly, propagateSetEnabled, refresh, setEnabled, setHidden, setPlaceholderText, setReadOnly, setToolTip, setValidator, validate, validated, validatorChanged

Methods inherited from class eu.webtoolkit.jwt.WInteractWidget
clicked, doubleClicked, enterPressed, escapePressed, gestureChanged, gestureEnded, gestureStarted, getMouseOverDelay, isEnabled, keyPressed, keyWentDown, keyWentUp, load, mouseDragged, mouseMoved, mouseWentDown, mouseWentOut, mouseWentOver, mouseWentUp, mouseWheel, setDraggable, setDraggable, setDraggable, setDraggable, setMouseOverDelay, setPopup, touchEnded, touchMoved, touchStarted, unsetDraggable

Methods inherited from class eu.webtoolkit.jwt.WWebWidget
addStyleClass, beingDeleted, blurred, callJavaScriptMember, childrenChanged, createDomElement, doJavaScript, escapeText, escapeText, escapeText, escapeText, find, findById, focussed, getAttributeValue, getBaseZIndex, getChildren, getClearSides, getDecorationStyle, getDomChanges, getFloatSide, getHeight, getHtmlTagName, getId, getJavaScriptMember, getLineHeight, getMargin, getMaximumHeight, getMaximumWidth, getMinimumHeight, getMinimumWidth, getOffset, getPositionScheme, getScrollVisibilityMargin, getStyleClass, getToolTip, getVerticalAlignment, getVerticalAlignmentLength, getWidth, hasFocus, hasStyleClass, hideToolTip, isDisabled, isHidden, isHiddenKeepsGeometry, isInline, isLoaded, isPopup, isRendered, isScrollVisibilityEnabled, isScrollVisible, isSetFirstFocus, isThemeStyleEnabled, isVisible, iterateChildren, jsStringLiteral, jsStringLiteral, manageWidget, parentResized, parentResized, propagateSetVisible, removeScript, removeStyleClass, scrollVisibilityChanged, setAttributeValue, setBaseZIndex, setCanReceiveFocus, setClearSides, setDecorationStyle, setDeferredToolTip, setFlexBox, setFloatSide, setFocus, setHiddenKeepsGeometry, setHtmlTagName, setId, setInline, setJavaScriptMember, setLineHeight, setLoadLaterWhenInvisible, setMargin, setMaximumSize, setMinimumSize, setObjectName, setOffsets, setParentWidget, setPositionScheme, setScrollVisibilityEnabled, setScrollVisibilityMargin, setSelectable, setStyleClass, setTabIndex, setThemeStyleEnabled, setVerticalAlignment, showToolTip, showToolTipOnHover, unescapeText, updateSignalConnection, voidEventSignal, widgetAdded, widgetRemoved

Methods inherited from class eu.webtoolkit.jwt.WWidget
acceptDrops, acceptDrops, addCssRule, addCssRule, addJSignal, addStyleClass, animateHide, animateShow, applyThemeStyles, boxBorder, boxPadding, createJavaScript, disable, dropEvent, enable, getDropTouch, getJsRef, getParent, hide, htmlText, isExposed, isGlobalWidget, isLayoutSizeAware, needsRerender, positionAt, positionAt, positionAt, positionAt, removeFromParent, removeStyleClass, removeWidget, render, resize, scheduleRender, scheduleRender, scheduleRender, scheduleThemeStyleApply, setClearSides, setDeferredToolTip, setFocus, setHeight, setHidden, setLayoutSizeAware, setMargin, setMargin, setMargin, setMargin, setMargin, setOffsets, setOffsets, setOffsets, setOffsets, setOffsets, setToolTip, setVerticalAlignment, setWidth, show, stopAcceptDrops, toggleStyleClass, toggleStyleClass, tr

Methods inherited from class eu.webtoolkit.jwt.WObject
getObjectName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NoTicks
```
public static final java.util.EnumSet<WSlider.TickPosition> NoTicks
```
  - TicksBothSides
```
public static final java.util.EnumSet<WSlider.TickPosition> TicksBothSides
```
  - INPUT_SIGNAL
```
protected static java.lang.String INPUT_SIGNAL
```
- Constructor Detail
  - WSlider
```
public WSlider(WContainerWidget parentContainer)
```
    Creates a default horizontal slider.
    The slider shows no ticks, has a range from 0 to 99, and has tickInterval of 0 (defaulting to three ticks over the whole range).
    The initial value is 0.
  - WSlider
```
public WSlider()
```
    Creates a default horizontal slider.
    Calls this((WContainerWidget)null)
  - WSlider
```
public WSlider(Orientation orientation,
               WContainerWidget parentContainer)
```
    Creates a default slider of the given orientation.
    The slider shows no ticks, has a range from 0 to 99, and has tickInterval of 0 (defaulting to three ticks over the whole range).
    The initial value is 0.
  - WSlider
```
public WSlider(Orientation orientation)
```
    Creates a default slider of the given orientation.
    Calls this(orientation, (WContainerWidget)null)
- Method Detail
  - remove
```
public void remove()
```
    Destructor.
    
    Overrides:
    
    remove in class WFormWidget
    
    See Also:
    
    WWidget.removeWidget(WWidget widget)
  - setNativeControl
```
public void setNativeControl(boolean nativeControl)
```
    Configures whether a native HTML5 control should be used.
    When native, the new "range" input element, specified by HTML5 and when implemented by the browser, is used rather than the built-in element. A native control is styled by the browser (usually in sync with the OS) rather than through the theme chosen. Settings like tick interval and tick position are ignored.
    
    Note: Vertically oriented sliders are in theory supported by the HTML5 input element, but in practice are usually not rendered correctly by the browser.
  - isNativeControl
```
public boolean isNativeControl()
```
    Returns whether a native HTML5 control is used.
    Taking into account the preference for a native control, configured using setNativeControl(), this method returns whether a native control is actually being used.
  - setOrientation
```
public void setOrientation(Orientation orientation)
```
    Sets the slider orientation.
    
    See Also:
    
    getOrientation()
  - getOrientation
```
public Orientation getOrientation()
```
    Returns the slider orientation.
    
    See Also:
    
    setOrientation(Orientation orientation)
  - setTickInterval
```
public void setTickInterval(int tickInterval)
```
    Sets the tick interval.
    The tick interval specifies the interval for placing ticks along the slider. The interval is specified in value units (not pixel units). A value of 0 specifies an automatic tick interval, which defaults to 3 ticks spanning the whole range.
    
    See Also:
    
    getTickInterval(), setTickPosition(EnumSet tickPosition)
  - getTickInterval
```
public int getTickInterval()
```
    Returns the tick interval.
    
    See Also:
    
    setTickInterval(int tickInterval)
  - setTickPosition
```
public void setTickPosition(java.util.EnumSet<WSlider.TickPosition> tickPosition)
```
    Sets the tick position.
    The tick position indicates if and where ticks are placed around the slider groove.
    This function has no effect if the native widget is used.
    
    See Also:
    
    getTickPosition(), setTickInterval(int tickInterval)
  - setTickPosition
```
public final void setTickPosition(WSlider.TickPosition tickPositio,
                                  WSlider.TickPosition... tickPosition)
```
    Sets the tick position.
    Calls setTickPosition(EnumSet.of(tickPositio, tickPosition))
  - getTickPosition
```
public java.util.EnumSet<WSlider.TickPosition> getTickPosition()
```
    Returns the tick position.
    
    See Also:
    
    setTickPosition(EnumSet tickPosition), setTickInterval(int tickInterval)
  - setTickLength
```
public void setTickLength(WLength length)
```
    Sets the length of the ticks to be drawn.
    This length will be either the width or height when the slider is oriented vertically or horizontally respectively.
    This function has no effect if the native widget is used.
    
    See Also:
    
    getTickLength()
  - getTickLength
```
public WLength getTickLength()
```
    Returns the tick length.
    
    See Also:
    
    setTickLength(WLength length)
  - setValue
```
public void setValue(int value)
```
    Sets the slider value.
    The value is automatically trimmed to the valid range (getMinimum() to getMaximum()).
    
    See Also:
    
    getValue()
  - getValue
```
public int getValue()
```
    Returns the current slider value.
    
    See Also:
    
    setValue(int value)
  - setMaximum
```
public void setMaximum(int maximum)
```
    Sets the maximum value.
    The maximum value defines the upper limit of the valid range. The lower limit and current value are automatically adjusted to remain valid.
    
    See Also:
    
    getMaximum(), setMinimum(int minimum), setRange(int minimum, int maximum)
  - getMaximum
```
public int getMaximum()
```
    Returns the maximum value.
    
    See Also:
    
    setMaximum(int maximum)
  - setMinimum
```
public void setMinimum(int minimum)
```
    Sets the minimum value.
    The minimum value defines the lower limit of the valid range. The upper limit and current value are automatically adjusted to remain valid.
    
    See Also:
    
    getMinimum(), setMaximum(int maximum), setRange(int minimum, int maximum)
  - getMinimum
```
public int getMinimum()
```
    Returns the minimum value.
    
    See Also:
    
    setMinimum(int minimum)
  - setRange
```
public void setRange(int minimum,
                     int maximum)
```
    Sets the value range.
    
    See Also:
    
    setMinimum(int minimum), setMaximum(int maximum)
  - getStep
```
public int getStep()
```
    Return the step value.
    The default value of the step is 1.
    
    See Also:
    
    setStep(int step)
  - setStep
```
public void setStep(int step)
```
    Sets the step value.
    This is a positive integer value that indicates by which step the slider moves between the minimum and maximum.
    It is not necessary that the slider's range can be neatly divided by the step value. Meaning a range of 50 (0 - 50), with a step of 7, is possible, but will never reach the maximum value.
    
    See Also:
    
    getStep()
  - valueChanged
```
public Signal1<java.lang.Integer> valueChanged()
```
    Signal emitted when the user has changed the value of the slider.
    The new value is passed as the argument.
    
    See Also:
    
    sliderMoved()
  - sliderMoved
```
public JSignal1<java.lang.Integer> sliderMoved()
```
    Signal emitted while the user drags the slider.
    The current dragged position is passed as the argument. Note that the slider value is not changed while dragging the slider, but only after the slider has been released.
    
    See Also:
    
    valueChanged()
  - setHandleWidth
```
public void setHandleWidth(int handleWidth)
```
    Sets the slider handle width.
    This sets the width for the handle, which is needed to accurately position the handle.
    The default value is 20 pixels.
  - getHandleWidth
```
public int getHandleWidth()
```
    Returns the handle width.
    
    See Also:
    
    setHandleWidth(int handleWidth)
  - input
```
public EventSignal input()
```
    Signal emitted when input was captured.
    The signal is only emitted when keyboard input (arrow keys) are captured.
  - setDisabled
```
public void setDisabled(boolean disabled)
```
    Description copied from class: WWidget
    
    Sets whether the widget is disabled.
    The widget can be set to being disabled, or enabled. This state will also be propagated to all its descendants. Those descendants will only be "visually" made disabled, their actual isDisabled() state will remain unaltered. All descendants will be assigned the disabled styleclass, which is dependent on the used Theme.
    The isDisabled() check will thus only return true in case setDisabled(true) has been called on the widget before. If the anscestor of a widget has been marked setDisabled(true), the widget's isDisabled() state will remain false.
    To check if a widget has been passively disabled, by one of its anscestors, use isEnabled().
    Typically, a disabled form widget will not allow changing the value, and disabled widgets will not react to mouse click events.
    
    Overrides:
    
    setDisabled in class WWebWidget
    
    See Also:
    
    WWidget.disable(), WWidget.enable()
  - resize
```
public void resize(WLength width,
                   WLength height)
```
    Description copied from class: WWidget
    Resizes the widget.
    Specifies a fixed size for this widget, setting CSS width and height properties. By default a widget has automatic width and height, which sets a size for the widget following CSS rules.
    When the widget is not managed by a layout manager, the automatic (natural) size of a widget depends on whether the widget is a block or inline widget:
    
    a block widget takes by default the width of the parent, and the height that it needs based on its contents
    an inline widget takes the width and height that it needs based on its contents (possibly wrapping over multiple lines). The width and height of an inline widget cannot be changed (by the letter of CSS, although most browsers will react to it in varying ways).
    
    When inserted in a layout manager, the size set will be used as a widget's preferred size, but the widget may be given a different size by the layout manager based on available space and stretch factors. The actual size given by a layout manager may be retrieved by making the widget "layout size aware", using setLayoutSizeAware(). If you have defined a "wtResize()" JavaScript method for the widget, then this method will also be called.
    The default width and height of a widget is WLength.Auto.
    Overrides:
    
    resize in class WWebWidget
    
    See Also:
    
    WWidget.getWidth(), WWidget.getHeight()
  - getValueText
```
public java.lang.String getValueText()
```
    Description copied from class: WFormWidget
    
    Returns the current value.
    This returns the current value as a string.
    
    Specified by:
    
    getValueText in class WFormWidget
  - setValueText
```
public void setValueText(java.lang.String value)
```
    Description copied from class: WFormWidget
    
    Sets the value text.
    This sets the current value from a string value.
    
    Specified by:
    
    setValueText in class WFormWidget
  - enableAjax
```
public void enableAjax()
```
    Description copied from class: WWidget
    
    Progresses to an Ajax-enabled widget.
    This method is called when the progressive bootstrap method is used, and support for AJAX has been detected. The default behavior will upgrade the widget's event handling to use AJAX instead of full page reloads, and propagate the call to its children.
    You may want to reimplement this method if you want to make changes to widget when AJAX is enabled. You should always call the base implementation.
    
    Overrides:
    
    enableAjax in class WFormWidget
    
    See Also:
    
    WApplication.enableAjax()
  - paintTick
```
protected void paintTick(WPainter painter,
                         int value,
                         int x,
                         int y)
```
    Paints a slider ticks (for a non-native widget)
    The default implementation draws ticks taking into account the the tickPosition.
    The mid point for the tick should be at position (x, y). The value that corresponds to the tick is also passed.
  - getCreateHandle
```
protected WInteractWidget getCreateHandle()
```
    Creates the handle (for a non-native widget)
    The default implementation creates a container widget. You may want to specialize this function if you want to have more control on the handle appearance or if you want to associate with the handle a tooltip or other information (e.g. a popup balloon).
  - layoutSizeChanged
```
protected void layoutSizeChanged(int width,
                                 int height)
```
    Description copied from class: WWidget
    
    Virtual method that indicates a size change.
    This method propagates the client-side width and height of the widget when the widget is contained by a layout manager and setLayoutSizeAware(true) was called.
    
    Overrides:
    
    layoutSizeChanged in class WWidget
    
    See Also:
    
    WWidget.setLayoutSizeAware(boolean aware)
  - render
```
protected void render(java.util.EnumSet<RenderFlag> flags)
```
    Description copied from class: WWidget
    
    Renders the widget.
    This function renders the widget (or an update for the widget), after this has been scheduled using scheduleRender().
    The default implementation will render the widget by serializing changes to JavaScript and HTML. You may want to reimplement this widget if you have been postponing some of the layout / rendering implementation until the latest moment possible. In that case you should make sure you call the base implementation however.
    
    Overrides:
    
    render in class WFormWidget
  - setFormData
```
protected void setFormData(WObject.FormData formData)
```
    Overrides:
    
    setFormData in class WObject

Class WSlider

CSS

Nested Class Summary

Nested classes/interfaces inherited from class eu.webtoolkit.jwt.WObject

Field Summary

Fields inherited from class eu.webtoolkit.jwt.WInteractWidget

Fields inherited from class eu.webtoolkit.jwt.WWidget

Constructor Summary

Method Summary

Methods inherited from class eu.webtoolkit.jwt.WFormWidget

Methods inherited from class eu.webtoolkit.jwt.WInteractWidget

Methods inherited from class eu.webtoolkit.jwt.WWebWidget

Methods inherited from class eu.webtoolkit.jwt.WWidget

Methods inherited from class eu.webtoolkit.jwt.WObject

Methods inherited from class java.lang.Object

Field Detail

NoTicks

TicksBothSides

INPUT_SIGNAL

Constructor Detail

WSlider

WSlider

WSlider

WSlider

Method Detail

remove

setNativeControl

isNativeControl

setOrientation

getOrientation

setTickInterval

getTickInterval

setTickPosition

setTickPosition

getTickPosition

setTickLength

getTickLength

setValue

getValue

setMaximum

getMaximum

setMinimum

getMinimum

setRange

getStep

setStep

valueChanged

sliderMoved

setHandleWidth

getHandleWidth

input

setDisabled

resize

getValueText

setValueText

enableAjax

paintTick

getCreateHandle

layoutSizeChanged

render

setFormData