Documentation

Reference
qx:slider (qx.ui.form.Slider)

The Slider widget provides a vertical or horizontal slider.

The Slider is the classic widget for controlling a bounded value. It lets the user move a slider handle along a horizontal or vertical groove and translates the handle’s position into an integer value within the defined range.

The Slider has very few of its own functions; most of the functionality is in qx.ui.form.BaseSlider. The most useful functions are slideTo() to set the slider directly to some value; setSingleStep(), setPageStep() to set the steps; and setMinimum() and setMaximum() to define the range of the slider.

A slider accepts focus on Tab and provides both a mouse wheel and a keyboard interface. The keyboard interface is the following:

  • Left/Right move a horizontal slider by one single step.
  • Up/Down move a vertical slider by one single step.
  • PageUp moves up one page.
  • PageDown moves down one page.
  • Home moves to the start (mininum).
  • End moves to the end (maximum).

Here are the main properties of the class:

  1. value: The bounded integer that BaseSlider maintains.
  2. minimum: The lowest possible value.
  3. maximum: The highest possible value.
  4. singleStep: The smaller of two natural steps that an abstract sliders provides and typically corresponds to the user pressing an arrow key.
  5. pageStep: The larger of two natural steps that an abstract slider provides and typically corresponds to the user pressing PageUp or PageDown.
name

The name of the widget. Mainly used for serialization proposes.

Default value: Possible values:
focusable
None
Default value: true Possible values:
pageStep

The amount to increment on each event. Typically corresponds to the user pressing PageUp or PageDown.

Default value: 10 Possible values:
appearance
None
Default value: "slider" Possible values:
maximum

The maximum slider value (may be negative). This value must be larger than qx.ui.form.Slider#minimum.

Default value: 100 Possible values:
value

The current slider value.

Strictly validates according to qx.ui.form.Slider#minimum and qx.ui.form.Slider#maximum. Do not apply any value correction to the incoming value. If you depend on this, please use qx.ui.form.Slider#slideTo instead.

Default value: 0 Possible values:
singleStep

The amount to increment on each event. Typically corresponds to the user pressing an arrow key.

Default value: 1 Possible values:
minimum

The minimum slider value (may be negative). This value must be smaller than qx.ui.form.Slider#maximum.

Default value: 0 Possible values:
knobFactor

Factor to apply to the width/height of the knob in relation to the dimension of the underlying area.

Default value: Possible values:
orientation

Whether the slider is horizontal or vertical.

Default value: "horizontal" Possible values: "horizontal","vertical" 

{   u'add': {   u'*': u'add/defaultWithPosition.mako',
                u'layout': u'add/noParent.mako',
                u'qx:application': u'add/qx/application.mako',
                u'qx:split': u'add/qx/split.mako',
                u'qxt:variant': u'add/noParent.mako'},
    u'attributes': {u'*': u'attr/default.mako', u'id': u'', u'qxt:*': u''},
    u'body': {   u'*': u'body/qx/widget.mako',
                 u'qxt:component': u'body/qxt/component_root.mako'},
    u'data': {   u'attr': {},
                 u'props': {   u'class': u'qx.ui.form.Slider',
                               u'constructor-args': u'orientation'}},
    u'extends': [u'qx:slider', u'qx:widget', u'base']}

LGPL, EPL © 2008 QxTransformer | Siarhei Barysiuk & Christian Boulanger.
Site design and illustrations by Siarhei Barysiuk. | Icons by Dry Icons.

qooxdoo