java.lang.Object | ||||
↳ | java.awt.Component | |||
↳ | java.awt.Container | |||
↳ | javax.swing.JComponent | |||
↳ | javax.swing.JSlider |
A component that lets the user graphically select a value by sliding a knob within a bounded interval.
The slider can show both
major tick marks, and minor tick marks between the major ones. The number of
values between the tick marks is controlled with
setMajorTickSpacing
and setMinorTickSpacing
.
Painting of tick marks is controlled by setPaintTicks
.
Sliders can also print text labels at regular intervals (or at
arbitrary locations) along the slider track. Painting of labels is
controlled by setLabelTable
and setPaintLabels
.
For further information and examples see How to Use Sliders, a section in The Java Tutorial.
Warning: Swing is not thread safe. For more information see Swing's Threading Policy.
Warning:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeansTM
has been added to the java.beans
package.
Please see XMLEncoder
.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
JSlider.AccessibleJSlider | This class implements accessibility support for the
JSlider class. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
changeEvent | Only one ChangeEvent is needed per slider instance since the
event's only (read-only) state is the source property. |
||||||||||
changeListener | The changeListener (no suffix) is the listener we add to the slider's model. | ||||||||||
majorTickSpacing | The number of values between the major tick marks -- the larger marks that break up the minor tick marks. | ||||||||||
minorTickSpacing | The number of values between the minor tick marks -- the smaller marks that occur between the major tick marks. | ||||||||||
orientation | Whether the slider is horizontal or vertical The default is horizontal. | ||||||||||
sliderModel | The data model that handles the numeric maximum value, minimum value, and current-position value for the slider. | ||||||||||
snapToTicks | If true, the knob (and the data value it represents) resolve to the closest tick mark next to where the user positioned the knob. |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a horizontal slider with the range 0 to 100 and
an initial value of 50.
| |||||||||||
Creates a slider using the specified orientation with the
range
0 to 100 and an initial value of 50 . | |||||||||||
Creates a horizontal slider using the specified min and max
with an initial value equal to the average of the min plus max.
| |||||||||||
Creates a horizontal slider using the specified min, max and value.
| |||||||||||
Creates a slider with the specified orientation and the
specified minimum, maximum, and initial values.
| |||||||||||
Creates a horizontal slider using the specified
BoundedRangeModel.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Adds a ChangeListener to the slider.
| |||||||||||
Creates a
Hashtable of numerical text labels, starting at the
slider minimum, and using the increment specified. | |||||||||||
Creates a
Hashtable of numerical text labels, starting at the
starting point specified, and using the increment specified. | |||||||||||
Gets the AccessibleContext associated with this JSlider.
| |||||||||||
Returns an array of all the
ChangeListener s added
to this JSlider with addChangeListener(). | |||||||||||
Returns the "extent" from the
BoundedRangeModel . | |||||||||||
Returns true if the value-range shown for the slider is reversed,
| |||||||||||
Returns the dictionary of what labels to draw at which values.
| |||||||||||
This method returns the major tick spacing.
| |||||||||||
Returns the maximum value supported by the slider
from the
BoundedRangeModel . | |||||||||||
Returns the minimum value supported by the slider
from the
BoundedRangeModel . | |||||||||||
This method returns the minor tick spacing.
| |||||||||||
Returns the
BoundedRangeModel that handles the slider's three
fundamental properties: minimum, maximum, value. | |||||||||||
Return this slider's vertical or horizontal orientation.
| |||||||||||
Tells if labels are to be painted.
| |||||||||||
Tells if tick marks are to be painted.
| |||||||||||
Tells if the track (area the slider slides in) is to be painted.
| |||||||||||
Returns true if the knob (and the data value it represents)
resolve to the closest tick mark next to where the user
positioned the knob.
| |||||||||||
Gets the UI object which implements the L&F for this component.
| |||||||||||
Returns the name of the L&F class that renders this component.
| |||||||||||
Returns the slider's current value
from the
BoundedRangeModel . | |||||||||||
Returns the
valueIsAdjusting property from the model. | |||||||||||
Removes a ChangeListener from the slider.
| |||||||||||
Sets the size of the range "covered" by the knob.
| |||||||||||
Sets the font for this component.
| |||||||||||
Specify true to reverse the value-range shown for the slider and false to
put the value range in the normal order.
| |||||||||||
Used to specify what label will be drawn at any given value.
| |||||||||||
This method sets the major tick spacing.
| |||||||||||
Sets the slider's maximum value to
maximum . | |||||||||||
Sets the slider's minimum value to
minimum . | |||||||||||
This method sets the minor tick spacing.
| |||||||||||
Sets the
BoundedRangeModel that handles the slider's three
fundamental properties: minimum, maximum, value. | |||||||||||
Set the slider's orientation to either
SwingConstants.VERTICAL or
SwingConstants.HORIZONTAL . | |||||||||||
Determines whether labels are painted on the slider.
| |||||||||||
Determines whether tick marks are painted on the slider.
| |||||||||||
Determines whether the track is painted on the slider.
| |||||||||||
Specifying true makes the knob (and the data value it represents)
resolve to the closest tick mark next to where the user
positioned the knob.
| |||||||||||
Sets the UI object which implements the L&F for this component.
| |||||||||||
Sets the slider's current value to
n . | |||||||||||
Sets the model's
valueIsAdjusting property. | |||||||||||
Resets the UI property to a value from the current look and feel.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Subclasses that want to handle
ChangeEvent s
from the model differently
can override this to return
an instance of a custom ChangeListener implementation. | |||||||||||
Send a
ChangeEvent , whose source is this JSlider , to
all ChangeListener s that have registered interest in
ChangeEvent s. | |||||||||||
Returns a string representation of this JSlider.
| |||||||||||
Updates the UIs for the labels in the label table by calling
updateUI on each label. |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Only one ChangeEvent
is needed per slider instance since the
event's only (read-only) state is the source property. The source
of events generated here is always "this". The event is lazily
created the first time that an event notification is fired.
The changeListener (no suffix) is the listener we add to the
slider's model. This listener is initialized to the
ChangeListener
returned from createChangeListener
,
which by default just forwards events
to ChangeListener
s (if any) added directly to the slider.
The number of values between the major tick marks -- the larger marks that break up the minor tick marks.
The number of values between the minor tick marks -- the smaller marks that occur between the major tick marks.
Whether the slider is horizontal or vertical The default is horizontal.
The data model that handles the numeric maximum value, minimum value, and current-position value for the slider.
If true, the knob (and the data value it represents) resolve to the closest tick mark next to where the user positioned the knob. The default is false.
Creates a horizontal slider with the range 0 to 100 and an initial value of 50.
Creates a slider using the specified orientation with the
range 0
to 100
and an initial value of 50
.
The orientation can be
either SwingConstants.VERTICAL
or
SwingConstants.HORIZONTAL
.
orientation | the orientation of the slider |
---|
IllegalArgumentException | if orientation is not one of VERTICAL , HORIZONTAL |
---|
Creates a horizontal slider using the specified min and max with an initial value equal to the average of the min plus max.
The BoundedRangeModel
that holds the slider's data
handles any issues that may arise from improperly setting the
minimum and maximum values on the slider. See the
BoundedRangeModel
documentation for details.
min | the minimum value of the slider |
---|---|
max | the maximum value of the slider |
Creates a horizontal slider using the specified min, max and value.
The BoundedRangeModel
that holds the slider's data
handles any issues that may arise from improperly setting the
minimum, initial, and maximum values on the slider. See the
BoundedRangeModel
documentation for details.
min | the minimum value of the slider |
---|---|
max | the maximum value of the slider |
value | the initial value of the slider |
Creates a slider with the specified orientation and the
specified minimum, maximum, and initial values.
The orientation can be
either SwingConstants.VERTICAL
or
SwingConstants.HORIZONTAL
.
The BoundedRangeModel
that holds the slider's data
handles any issues that may arise from improperly setting the
minimum, initial, and maximum values on the slider. See the
BoundedRangeModel
documentation for details.
orientation | the orientation of the slider |
---|---|
min | the minimum value of the slider |
max | the maximum value of the slider |
value | the initial value of the slider |
IllegalArgumentException | if orientation is not one of VERTICAL , HORIZONTAL |
---|
Creates a horizontal slider using the specified BoundedRangeModel.
Adds a ChangeListener to the slider.
l | the ChangeListener to add |
---|
Creates a Hashtable
of numerical text labels, starting at the
slider minimum, and using the increment specified.
For example, if you call createStandardLabels( 10 )
and the slider minimum is zero,
then labels will be created for the values 0, 10, 20, 30, and so on.
For the labels to be drawn on the slider, the returned Hashtable
must be passed into setLabelTable
, and setPaintLabels
must be set to true
.
For further details on the makeup of the returned Hashtable
, see
the setLabelTable
documentation.
increment | distance between labels in the generated hashtable |
---|
Hashtable
of labelsIllegalArgumentException | if increment is less than or
equal to zero
|
---|
Creates a Hashtable
of numerical text labels, starting at the
starting point specified, and using the increment specified.
For example, if you call
createStandardLabels( 10, 2 )
,
then labels will be created for the values 2, 12, 22, 32, and so on.
For the labels to be drawn on the slider, the returned Hashtable
must be passed into setLabelTable
, and setPaintLabels
must be set to true
.
For further details on the makeup of the returned Hashtable
, see
the setLabelTable
documentation.
increment | distance between labels in the generated hashtable |
---|---|
start | value at which the labels will begin |
Hashtable
of labelsIllegalArgumentException | if start is
out of range, or if increment is less than or equal
to zero
|
---|
Gets the AccessibleContext associated with this JSlider. For sliders, the AccessibleContext takes the form of an AccessibleJSlider. A new AccessibleJSlider instance is created if necessary.
Returns an array of all the ChangeListener
s added
to this JSlider with addChangeListener().
ChangeListener
s added or an empty
array if no listeners have been addedReturns the "extent" from the BoundedRangeModel
.
This respresents the range of values "covered" by the knob.
Returns true if the value-range shown for the slider is reversed,
Returns the dictionary of what labels to draw at which values.
Dictionary
containing labels and
where to draw them
This method returns the major tick spacing. The number that is returned represents the distance, measured in values, between each major tick mark. If you have a slider with a range from 0 to 50 and the major tick spacing is set to 10, you will get major ticks next to the following values: 0, 10, 20, 30, 40, 50.
Returns the maximum value supported by the slider
from the BoundedRangeModel
.
Returns the minimum value supported by the slider
from the BoundedRangeModel
.
This method returns the minor tick spacing. The number that is returned represents the distance, measured in values, between each minor tick mark. If you have a slider with a range from 0 to 50 and the minor tick spacing is set to 10, you will get minor ticks next to the following values: 0, 10, 20, 30, 40, 50.
Returns the BoundedRangeModel
that handles the slider's three
fundamental properties: minimum, maximum, value.
Return this slider's vertical or horizontal orientation.
SwingConstants.VERTICAL
or
SwingConstants.HORIZONTAL
Tells if labels are to be painted.
Tells if tick marks are to be painted.
Tells if the track (area the slider slides in) is to be painted.
Returns true if the knob (and the data value it represents) resolve to the closest tick mark next to where the user positioned the knob.
Gets the UI object which implements the L&F for this component.
Returns the name of the L&F class that renders this component.
Returns the slider's current value
from the BoundedRangeModel
.
Returns the valueIsAdjusting
property from the model. For
details on how this is used, see the setValueIsAdjusting
documentation.
valueIsAdjusting
propertyRemoves a ChangeListener from the slider.
l | the ChangeListener to remove |
---|
Sets the size of the range "covered" by the knob. Most look and feel implementations will change the value by this amount if the user clicks on either side of the knob. This method just forwards the new extent value to the model.
The data model (an instance of BoundedRangeModel
)
handles any mathematical
issues arising from assigning faulty values. See the
BoundedRangeModel
documentation for details.
If the new extent value is different from the previous extent value, all change listeners are notified.
extent | the new extent |
---|
Sets the font for this component.
font | the desired Font for this component |
---|
Specify true to reverse the value-range shown for the slider and false to
put the value range in the normal order. The order depends on the
slider's ComponentOrientation
property. Normal (non-inverted)
horizontal sliders with a ComponentOrientation
value of
LEFT_TO_RIGHT
have their maximum on the right.
Normal horizontal sliders with a ComponentOrientation
value of
RIGHT_TO_LEFT
have their maximum on the left. Normal vertical
sliders have their maximum on the top. These labels are reversed when the
slider is inverted.
By default, the value of this property is false
.
b | true to reverse the slider values from their normal order |
---|
Used to specify what label will be drawn at any given value.
The key-value pairs are of this format:
{ Integer value, java.swing.JComponent label }
.
An easy way to generate a standard table of value labels is by using the
createStandardLabels
method.
Once the labels have been set, this method calls updateLabelUIs()
.
Note that the labels are only painted if the paintLabels
property is true
.
labels | new Dictionary of labels, or null to
remove all labels |
---|
This method sets the major tick spacing. The number that is passed in represents the distance, measured in values, between each major tick mark. If you have a slider with a range from 0 to 50 and the major tick spacing is set to 10, you will get major ticks next to the following values: 0, 10, 20, 30, 40, 50.
In order for major ticks to be painted, setPaintTicks
must be
set to true
.
This method will also set up a label table for you.
If there is not already a label table, and the major tick spacing is
> 0
, and getPaintLabels
returns
true
, a standard label table will be generated (by calling
createStandardLabels
) with labels at the major tick marks.
For the example above, you would get text labels: "0",
"10", "20", "30", "40", "50".
The label table is then set on the slider by calling
setLabelTable
.
n | new value for the majorTickSpacing property |
---|
Sets the slider's maximum value to maximum
. This method
forwards the new maximum value to the model.
The data model (an instance of BoundedRangeModel
)
handles any mathematical
issues arising from assigning faulty values. See the
BoundedRangeModel
documentation for details.
If the new maximum value is different from the previous maximum value, all change listeners are notified.
maximum | the new maximum |
---|
Sets the slider's minimum value to minimum
. This method
forwards the new minimum value to the model.
The data model (an instance of BoundedRangeModel
)
handles any mathematical
issues arising from assigning faulty values. See the
BoundedRangeModel
documentation for details.
If the new minimum value is different from the previous minimum value, all change listeners are notified.
minimum | the new minimum |
---|
This method sets the minor tick spacing. The number that is passed in represents the distance, measured in values, between each minor tick mark. If you have a slider with a range from 0 to 50 and the minor tick spacing is set to 10, you will get minor ticks next to the following values: 0, 10, 20, 30, 40, 50.
In order for minor ticks to be painted, setPaintTicks
must be
set to true
.
n | new value for the minorTickSpacing property |
---|
Sets the BoundedRangeModel
that handles the slider's three
fundamental properties: minimum, maximum, value.
Attempts to pass a null
model to this method result in
undefined behavior, and, most likely, exceptions.
newModel | the new, non-null BoundedRangeModel to use |
---|
Set the slider's orientation to either SwingConstants.VERTICAL
or
SwingConstants.HORIZONTAL
.
orientation | HORIZONTAL or VERTICAL |
---|
IllegalArgumentException | if orientation is not one of VERTICAL , HORIZONTAL |
---|
Determines whether labels are painted on the slider.
This method will also set up a label table for you.
If there is not already a label table, and the major tick spacing is
> 0
,
a standard label table will be generated (by calling
createStandardLabels
) with labels at the major tick marks.
The label table is then set on the slider by calling
setLabelTable
.
By default, this property is false
.
b | whether or not to paint labels |
---|
Determines whether tick marks are painted on the slider.
By default, this property is false
.
b | whether or not tick marks should be painted |
---|
Determines whether the track is painted on the slider.
By default, this property is true
.
b | whether or not to paint the slider track |
---|
Specifying true makes the knob (and the data value it represents)
resolve to the closest tick mark next to where the user
positioned the knob.
By default, this property is false
.
b | true to snap the knob to the nearest tick mark |
---|
Sets the UI object which implements the L&F for this component.
ui | the SliderUI L&F object |
---|
Sets the slider's current value to n
. This method
forwards the new value to the model.
The data model (an instance of BoundedRangeModel
)
handles any mathematical
issues arising from assigning faulty values. See the
BoundedRangeModel
documentation for details.
If the new value is different from the previous value, all change listeners are notified.
n | the new value |
---|
Sets the model's valueIsAdjusting
property. Slider look and
feel implementations should set this property to true
when
a knob drag begins, and to false
when the drag ends. The
slider model will not generate ChangeEvent
s while
valueIsAdjusting
is true
.
b | the new value for the valueIsAdjusting property |
---|
Resets the UI property to a value from the current look and feel.
Subclasses that want to handle ChangeEvent
s
from the model differently
can override this to return
an instance of a custom ChangeListener
implementation.
The default ChangeListener
simply calls the
fireStateChanged
method to forward ChangeEvent
s
to the ChangeListener
s that have been added directly to the
slider.
Send a ChangeEvent
, whose source is this JSlider
, to
all ChangeListener
s that have registered interest in
ChangeEvent
s.
This method is called each time a ChangeEvent
is received from
the model.
The event instance is created if necessary, and stored in
changeEvent
.
Returns a string representation of this JSlider. This method
is intended to be used only for debugging purposes, and the
content and format of the returned string may vary between
implementations. The returned string may be empty but may not
be null
.
Updates the UIs for the labels in the label table by calling
updateUI
on each label. The UIs are updated from
the current look and feel. The labels are also set to their
preferred size.