javax.swing
Class DefaultBoundedRangeModel

java.lang.Object
  extended by javax.swing.DefaultBoundedRangeModel
All Implemented Interfaces:
Serializable, BoundedRangeModel

public class DefaultBoundedRangeModel
extends Object
implements BoundedRangeModel, Serializable

The default implementation of BoundedRangeModel.

See Also:
Serialized Form

Field Summary
protected  ChangeEvent changeEvent
          An event that is sent to all registered ChangeListeners when the state of this range model has changed.
protected  EventListenerList listenerList
          The list of the currently registered EventListeners.
 
Constructor Summary
DefaultBoundedRangeModel()
          Constructs a DefaultBoundedRangeModel with default values for the properties.
DefaultBoundedRangeModel(int value, int extent, int minimum, int maximum)
          Constructs a DefaultBoundedRangeModel with the specified values for some properties.
 
Method Summary
 void addChangeListener(ChangeListener listener)
          Subscribes a ChangeListener to state changes.
protected  void fireStateChanged()
          Sends a ChangeEvent to any registered ChangeListeners.
 ChangeListener[] getChangeListeners()
          Returns all ChangeListeners that are currently subscribed for changes to this DefaultBoundedRangeModel.
 int getExtent()
          Returns the current extent of this bounded range model, which is a number greater than or equal to zero.
<T extends EventListener>
T[]
getListeners(Class<T> listenerType)
          Retrieves the current listeners of the specified class.
 int getMaximum()
          Returns the current maximal value of this bounded range model.
 int getMinimum()
          Returns the current minimal value of this bounded range model.
 int getValue()
          Returns the current value of this bounded range model.
 boolean getValueIsAdjusting()
          Returns whether or not the value of this bounded range model is going to change in the immediate future.
 void removeChangeListener(ChangeListener listener)
          Cancels the subscription of a ChangeListener.
 void setExtent(int extent)
          Changes the current extent of this bounded range model.
 void setMaximum(int maximum)
          Changes the current maximal value of this bounded range model.
 void setMinimum(int minimum)
          Changes the current minimal value of this bounded range model.
 void setRangeProperties(int value, int extent, int minimum, int maximum, boolean isAdjusting)
          Sets all properties.
 void setValue(int value)
          Changes the current value of this bounded range model.
 void setValueIsAdjusting(boolean isAdjusting)
          Specifies whether or not the value of this bounded range model is going to change in the immediate future.
 String toString()
          Returns a string with all relevant properties of this range model.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

changeEvent

protected transient ChangeEvent changeEvent
An event that is sent to all registered ChangeListeners when the state of this range model has changed.

The event object is created on demand, the first time it is actually needed.

See Also:
fireStateChanged()

listenerList

protected EventListenerList listenerList
The list of the currently registered EventListeners.

Constructor Detail

DefaultBoundedRangeModel

public DefaultBoundedRangeModel()
Constructs a DefaultBoundedRangeModel with default values for the properties. The properties value, extent and minimum will be initialized to zero; maximum will be set to 100; the property valueIsAdjusting will be false.


DefaultBoundedRangeModel

public DefaultBoundedRangeModel(int value,
                                int extent,
                                int minimum,
                                int maximum)
Constructs a DefaultBoundedRangeModel with the specified values for some properties.

Parameters:
value - the initial value of the range model, which must be a number between minimum and (maximum - extent). In a scroll bar visualization of a BoundedRangeModel, the value is displayed as the position of the thumb.
extent - the initial extent of the range model, which is a number greater than or equal to zero. In a scroll bar visualization of a BoundedRangeModel, the extent is displayed as the size of the thumb.
minimum - the initial minimal value of the range model.
maximum - the initial maximal value of the range model.
Throws:
IllegalArgumentException - if the following condition is not satisfied: minimum <= value <= value + extent <= maximum.
Method Detail

toString

public String toString()
Returns a string with all relevant properties of this range model.

Overrides:
toString in class Object
Returns:
a string representing the object
See Also:
Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)

getValue

public int getValue()
Returns the current value of this bounded range model. In a scroll bar visualization of a BoundedRangeModel, the value is displayed as the position of the thumb.

Specified by:
getValue in interface BoundedRangeModel
Returns:
the value
See Also:
BoundedRangeModel.setValue(int)

setValue

public void setValue(int value)
Changes the current value of this bounded range model. In a scroll bar visualization of a BoundedRangeModel, the value is displayed as the position of the thumb; changing the value of a scroll bar's model thus moves the thumb to a different position.

Specified by:
setValue in interface BoundedRangeModel
Parameters:
value - the value
See Also:
BoundedRangeModel.getValue()

getExtent

public int getExtent()
Returns the current extent of this bounded range model, which is a number greater than or equal to zero. In a scroll bar visualization of a BoundedRangeModel, the extent is displayed as the size of the thumb.

Specified by:
getExtent in interface BoundedRangeModel
Returns:
the extent
See Also:
BoundedRangeModel.setExtent(int)

setExtent

public void setExtent(int extent)
Changes the current extent of this bounded range model. In a scroll bar visualization of a BoundedRangeModel, the extent is displayed as the size of the thumb.

Specified by:
setExtent in interface BoundedRangeModel
Parameters:
extent - the new extent of the range model, which is a number greater than or equal to zero.
See Also:
BoundedRangeModel.getExtent()

getMinimum

public int getMinimum()
Returns the current minimal value of this bounded range model.

Specified by:
getMinimum in interface BoundedRangeModel
Returns:
The lower bound for the model.
See Also:
BoundedRangeModel.setMinimum(int), BoundedRangeModel.getMaximum()

setMinimum

public void setMinimum(int minimum)
Changes the current minimal value of this bounded range model.

Specified by:
setMinimum in interface BoundedRangeModel
Parameters:
minimum - the new minimal value.
See Also:
BoundedRangeModel.getMinimum()

getMaximum

public int getMaximum()
Returns the current maximal value of this bounded range model.

Specified by:
getMaximum in interface BoundedRangeModel
Returns:
the maximum
See Also:
BoundedRangeModel.setMaximum(int), BoundedRangeModel.getMinimum()

setMaximum

public void setMaximum(int maximum)
Changes the current maximal value of this bounded range model.

Specified by:
setMaximum in interface BoundedRangeModel
Parameters:
maximum - the new maximal value.
See Also:
BoundedRangeModel.getMaximum()

getValueIsAdjusting

public boolean getValueIsAdjusting()
Returns whether or not the value of this bounded range model is going to change in the immediate future. Scroll bars set this property to true while the thumb is being dragged around; when the mouse is relased, they set the property to false and post a final ChangeEvent.

Specified by:
getValueIsAdjusting in interface BoundedRangeModel
Returns:
true if the value will change soon again; false if the value will probably not change soon.
See Also:
BoundedRangeModel.setValueIsAdjusting(boolean)

setValueIsAdjusting

public void setValueIsAdjusting(boolean isAdjusting)
Specifies whether or not the value of this bounded range model is going to change in the immediate future. Scroll bars set this property to true while the thumb is being dragged around; when the mouse is relased, they set the property to false.

Specified by:
setValueIsAdjusting in interface BoundedRangeModel
Parameters:
isAdjusting - true if the value will change soon again; false if the value will probably not change soon.
See Also:
BoundedRangeModel.getValueIsAdjusting()

setRangeProperties

public void setRangeProperties(int value,
                               int extent,
                               int minimum,
                               int maximum,
                               boolean isAdjusting)
Sets all properties.

Specified by:
setRangeProperties in interface BoundedRangeModel
Parameters:
value - the new value of the range model. In a scroll bar visualization of a BoundedRangeModel, the value is displayed as the position of the thumb.
extent - the new extent of the range model, which is a number greater than or equal to zero. In a scroll bar visualization of a BoundedRangeModel, the extent is displayed as the size of the thumb.
minimum - the new minimal value of the range model.
maximum - the new maximal value of the range model.
isAdjusting - whether or not the value of this bounded range model is going to change in the immediate future. Scroll bars set this property to true while the thumb is being dragged around; when the mouse is relased, they set the property to false.

addChangeListener

public void addChangeListener(ChangeListener listener)
Subscribes a ChangeListener to state changes.

Specified by:
addChangeListener in interface BoundedRangeModel
Parameters:
listener - the listener to be subscribed.
See Also:
BoundedRangeModel.removeChangeListener(ChangeListener)

removeChangeListener

public void removeChangeListener(ChangeListener listener)
Cancels the subscription of a ChangeListener.

Specified by:
removeChangeListener in interface BoundedRangeModel
Parameters:
listener - the listener to be unsubscribed.
See Also:
BoundedRangeModel.addChangeListener(ChangeListener)

fireStateChanged

protected void fireStateChanged()
Sends a ChangeEvent to any registered ChangeListeners.

See Also:
addChangeListener(ChangeListener), removeChangeListener(ChangeListener)

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)
Retrieves the current listeners of the specified class.

Parameters:
listenerType - the class of listeners; usually ChangeListener.class.
Returns:
an array with the currently subscribed listeners, or an empty array if there are currently no listeners.
Since:
1.3

getChangeListeners

public ChangeListener[] getChangeListeners()
Returns all ChangeListeners that are currently subscribed for changes to this DefaultBoundedRangeModel.

Returns:
an array with the currently subscribed listeners, or an empty array if there are currently no listeners.
Since:
1.4