javax.swing.JSlider — clojure-interop/javax.swing 1.0.5

A component that lets the user graphically select a value by sliding a knob within a bounded interval. The knob is always positioned at the points that match integer values within the specified 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 JavaBeans™ has been added to the java.beans package. Please see XMLEncoder.

->j-slider clj

(->j-slider)

(->j-slider orientation)

(->j-slider min max)

(->j-slider min max value)

(->j-slider orientation min max value)

Constructor.

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 - int min - the minimum value of the slider - int max - the maximum value of the slider - int value - the initial value of the slider - int

throws: java.lang.IllegalArgumentException - if orientation is not one of VERTICAL, HORIZONTAL

add-change-listener clj

(add-change-listener this l)

Adds a ChangeListener to the slider.

l - the ChangeListener to add - javax.swing.event.ChangeListener

create-standard-labels clj

(create-standard-labels this increment)

(create-standard-labels this increment start)

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 - int start - value at which the labels will begin - int

returns: a new Hashtable of labels - java.util.Hashtable

throws: java.lang.IllegalArgumentException - if start is out of range, or if increment is less than or equal to zero

get-accessible-context clj

(get-accessible-context this)

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 AccessibleJSlider that serves as the AccessibleContext of this JSlider - javax.accessibility.AccessibleContext

get-change-listeners clj

(get-change-listeners this)

Returns an array of all the ChangeListeners added to this JSlider with addChangeListener().

returns: all of the ChangeListeners added or an empty array if no listeners have been added - javax.swing.event.ChangeListener[]

get-extent clj

(get-extent this)

Returns the "extent" from the BoundedRangeModel. This represents the range of values "covered" by the knob.

returns: an int representing the extent - int

get-inverted? clj

(get-inverted? this)

Returns true if the value-range shown for the slider is reversed,

returns: true if the slider values are reversed from their normal order - boolean

get-label-table clj

(get-label-table this)

Returns the dictionary of what labels to draw at which values.

returns: the Dictionary containing labels and where to draw them - java.util.Dictionary

get-major-tick-spacing clj

(get-major-tick-spacing this)

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 number of values between major ticks - int

get-maximum clj

(get-maximum this)

Returns the maximum value supported by the slider from the BoundedRangeModel.

returns: the value of the model's maximum property - int

get-minimum clj

(get-minimum this)

Returns the minimum value supported by the slider from the BoundedRangeModel.

returns: the value of the model's minimum property - int

get-minor-tick-spacing clj

(get-minor-tick-spacing this)

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 number of values between minor ticks - int

get-model clj

(get-model this)

Returns the BoundedRangeModel that handles the slider's three fundamental properties: minimum, maximum, value.

returns: the data model for this component - javax.swing.BoundedRangeModel

get-orientation clj

(get-orientation this)

Return this slider's vertical or horizontal orientation.

returns: SwingConstants.VERTICAL or SwingConstants.HORIZONTAL - int

get-paint-labels? clj

(get-paint-labels? this)

Tells if labels are to be painted.

returns: true if labels are painted, else false - boolean

get-paint-ticks? clj

(get-paint-ticks? this)

Tells if tick marks are to be painted.

returns: true if tick marks are painted, else false - boolean

get-paint-track? clj

(get-paint-track? this)

Tells if the track (area the slider slides in) is to be painted.

returns: true if track is painted, else false - boolean

get-snap-to-ticks? clj

(get-snap-to-ticks? this)

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.

returns: true if the value snaps to the nearest tick mark, else false - boolean

get-ui clj

(get-ui this)

Gets the UI object which implements the L&F for this component.

returns: the SliderUI object that implements the Slider L&F - javax.swing.plaf.SliderUI

get-ui-class-id clj

(get-ui-class-id this)

Returns the name of the L&F class that renders this component.

returns: "SliderUI" - java.lang.String

get-value clj

(get-value this)

Returns the slider's current value from the BoundedRangeModel.

returns: the current value of the slider - int

get-value-is-adjusting? clj

(get-value-is-adjusting? this)

Returns the valueIsAdjusting property from the model. For details on how this is used, see the setValueIsAdjusting documentation.

returns: the value of the model's valueIsAdjusting property - boolean

image-update clj

(image-update this img infoflags x y w h)

Repaints the component when the image has changed. This imageUpdate method of an ImageObserver is called when more information about an image which had been previously requested using an asynchronous routine such as the drawImage method of Graphics becomes available. See the definition of imageUpdate for more information on this method and its arguments.

The imageUpdate method of Component incrementally draws an image on the component as more of the bits of the image are available.

If the system property awt.image.incrementaldraw is missing or has the value true, the image is incrementally drawn. If the system property has any other value, then the image is not drawn until it has been completely loaded.

Also, if incremental drawing is in effect, the value of the system property awt.image.redrawrate is interpreted as an integer to give the maximum redraw rate, in milliseconds. If the system property is missing or cannot be interpreted as an integer, the redraw rate is once every 100ms.

The interpretation of the x, y, width, and height arguments depends on the value of the infoflags argument.

img - the image being observed - java.awt.Image infoflags - see imageUpdate for more information - int x - the x coordinate - int y - the y coordinate - int w - the width - int h - the height - int

returns: false if the infoflags indicate that the image is completely loaded; true otherwise. - boolean

remove-change-listener clj

(remove-change-listener this l)

Removes a ChangeListener from the slider.

l - the ChangeListener to remove - javax.swing.event.ChangeListener

set-extent clj

(set-extent this extent)

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 - int

set-font clj

(set-font this font)

Sets the font for this component.

font - the desired Font for this component - java.awt.Font

set-inverted clj

(set-inverted this b)

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 - boolean

set-label-table clj

(set-label-table this labels)

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 - java.util.Dictionary

set-major-tick-spacing clj

(set-major-tick-spacing this n)

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 - int

set-maximum clj

(set-maximum this maximum)

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 - int

set-minimum clj

(set-minimum this minimum)

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 - int

set-minor-tick-spacing clj

(set-minor-tick-spacing this n)

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 - int

set-model clj

(set-model this new-model)

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.

new-model - the new, non-null BoundedRangeModel to use - javax.swing.BoundedRangeModel

set-orientation clj

(set-orientation this orientation)

Set the slider's orientation to either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL.

orientation - HORIZONTAL or VERTICAL - int

throws: java.lang.IllegalArgumentException - if orientation is not one of VERTICAL, HORIZONTAL

set-paint-labels clj

(set-paint-labels this b)

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 - boolean

set-paint-ticks clj

(set-paint-ticks this b)

Determines whether tick marks are painted on the slider. By default, this property is false.

b - whether or not tick marks should be painted - boolean

set-paint-track clj

(set-paint-track this b)

Determines whether the track is painted on the slider. By default, this property is true.

b - whether or not to paint the slider track - boolean

set-snap-to-ticks clj

(set-snap-to-ticks this b)

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 - boolean

set-ui clj

(set-ui this ui)

Sets the UI object which implements the L&F for this component.

ui - the SliderUI L&F object - javax.swing.plaf.SliderUI

set-value clj

(set-value this n)

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 - int

set-value-is-adjusting clj

(set-value-is-adjusting this b)

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.

b - the new value for the valueIsAdjusting property - boolean

update-ui clj

(update-ui this)

Resets the UI property to a value from the current look and feel.