BoundedRangeModel JDK 1.6)

Description

public interface BoundedRangeModel

Defines the data model used by components like Sliders and ProgressBars.

Defines the data model used by components like Sliders and ProgressBars. Defines four interrelated integer properties: minimum, maximum, extent and value. These four integers define two nested ranges like this:

 minimum <= value <= value+extent <= maximum

The outer range is minimum,maximum and the inner range is value,value+extent. The inner range must lie within the outer one, i.e. value must be less than or equal to maximum and value+extent must greater than or equal to minimum, and maximum must be greater than or equal to minimum. There are a few features of this model that one might find a little surprising. These quirks exist for the convenience of the Swing BoundedRangeModel clients, such as Slider and ScrollBar.

The minimum and maximum set methods "correct" the other three properties to accommodate their new value argument. For example setting the model's minimum may change its maximum, value, and extent properties (in that order), to maintain the constraints specified above.
The value and extent set methods "correct" their argument to fit within the limits defined by the other three properties. For example if value == maximum, setExtent(10) would change the extent (back) to zero.
The four BoundedRangeModel values are defined as Java Beans properties however Swing ChangeEvents are used to notify clients of changes rather than PropertyChangeEvents. This was done to keep the overhead of monitoring a BoundedRangeModel low. Changes are often reported at MouseDragged rates.

For an example of specifying custom bounded range models used by sliders, see The Anatomy of a Swing-Based Program in The Java Tutorial.

See also: DefaultBoundedRangeModel

Methods

Hide/Show inherited methods

public void addChangeListener (ChangeListener x)

Adds a ChangeListener to the model's listener list.

public int getExtent ()

Returns the model's extent, the length of the inner range that begins at the model's value.

public int getMaximum ()

Returns the model's maximum.

public int getMinimum ()

Returns the minimum acceptable value.

public int getValue ()

Returns the model's current value.

Returns the model's current value. Note that the upper
limit on the model's value is maximum - extent
and the lower limit is minimum.
Returns: the model's value
See Also: BoundedRangeModel.setValue(int),

public boolean getValueIsAdjusting ()

Returns true if the current changes to the value property are part of a series of changes.

public void removeChangeListener (ChangeListener x)

Removes a ChangeListener from the model's listener list.

public void setExtent (int newExtent)

Sets the model's extent.

public void setMaximum (int newMaximum)

Sets the model's maximum to newMaximum.

Sets the model's maximum to newMaximum. The other three properties may be changed as well, to ensure that

 minimum <= value <= value+extent <= maximum

Notifies any listeners if the model changes.
Parameters:
- newMaximum - the model's new maximum
See Also: BoundedRangeModel.getMaximum(), BoundedRangeModel.addChangeListener(javax.swing.event.ChangeListener),

public void setMinimum (int newMinimum)

Sets the model's minimum to newMinimum.

Sets the model's minimum to newMinimum. The other three properties may be changed as well, to ensure that:

 minimum <= value <= value+extent <= maximum

Notifies any listeners if the model changes.
Parameters:
- newMinimum - the model's new minimum
See Also: BoundedRangeModel.getMinimum(), BoundedRangeModel.addChangeListener(javax.swing.event.ChangeListener),

public void setRangeProperties (int value, int extent, int min, int max, boolean adjusting)

This method sets all of the model's data with a single method call.

public void setValue (int newValue)

Sets the model's current value to newValue if newValue satisfies the model's constraints.

Sets the model's current value to newValue if newValue satisfies the model's constraints. Those constraints are:

 minimum <= value <= value+extent <= maximum

Otherwise, if newValue is less than minimum it's set to minimum, if its greater than maximum then it's set to maximum, and if it's greater than value+extent then it's set to value+extent.

When a BoundedRange model is used with a scrollbar the value specifies the origin of the scrollbar knob (aka the "thumb" or "elevator"). The value usually represents the origin of the visible part of the object being scrolled.

Notifies any listeners if the model changes.
Parameters:
- newValue - the model's new value
See Also: BoundedRangeModel.getValue(),

public void setValueIsAdjusting (boolean b)

This attribute indicates that any upcoming changes to the value of the model should be considered a single event.