public class

DefaultBoundedRangeModel

extends Object
implements Serializable BoundedRangeModel
java.lang.Object
   ↳ javax.swing.DefaultBoundedRangeModel

Class Overview

A generic implementation of BoundedRangeModel.

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.

See Also

Summary

Fields
protected ChangeEvent changeEvent Only one ChangeEvent is needed per model instance since the event's only (read-only) state is the source property.
protected EventListenerList listenerList The listeners waiting for model changes.
Public Constructors
DefaultBoundedRangeModel()
Initializes all of the properties with default values.
DefaultBoundedRangeModel(int value, int extent, int min, int max)
Initializes value, extent, minimum and maximum.
Public Methods
void addChangeListener(ChangeListener l)
Adds a ChangeListener.
ChangeListener[] getChangeListeners()
Returns an array of all the change listeners registered on this DefaultBoundedRangeModel.
int getExtent()
Returns the model's extent.
<T extends EventListener> T[] getListeners(Class<T> listenerType)
Returns an array of all the objects currently registered as FooListeners upon this model.
int getMaximum()
Returns the model's maximum.
int getMinimum()
Returns the model's minimum.
int getValue()
Returns the model's current value.
boolean getValueIsAdjusting()
Returns true if the value is in the process of changing as a result of actions being taken by the user.
void removeChangeListener(ChangeListener l)
Removes a ChangeListener.
void setExtent(int n)
Sets the extent to n after ensuring that n is greater than or equal to zero and falls within the model's constraints: 
     minimum <= value <= value+extent <= maximum
void setMaximum(int n)
Sets the maximum to n after ensuring that n that the other three properties obey the model's constraints: 
     minimum <= value <= value+extent <= maximum
void setMinimum(int n)
Sets the minimum to n after ensuring that n that the other three properties obey the model's constraints: 
     minimum <= value <= value+extent <= maximum
void setRangeProperties(int newValue, int newExtent, int newMin, int newMax, boolean adjusting)
Sets all of the BoundedRangeModel properties after forcing the arguments to obey the usual constraints: 
     minimum <= value <= value+extent <= maximum

At most, one ChangeEvent is generated.

void setValue(int n)
Sets the current value of the model.
void setValueIsAdjusting(boolean b)
Sets the valueIsAdjusting property.
String toString()
Returns a string that displays all of the BoundedRangeModel properties.
Protected Methods
void fireStateChanged()
Runs each ChangeListener's stateChanged method.
[Expand]
Inherited Methods
From class java.lang.Object
From interface javax.swing.BoundedRangeModel

Fields

protected ChangeEvent changeEvent

Only one ChangeEvent is needed per model instance since the event's only (read-only) state is the source property. The source of events generated here is always "this".

protected EventListenerList listenerList

The listeners waiting for model changes.

Public Constructors

public DefaultBoundedRangeModel ()

Initializes all of the properties with default values. Those values are:

  • value = 0
  • extent = 0
  • minimum = 0
  • maximum = 100
  • adjusting = false

public DefaultBoundedRangeModel (int value, int extent, int min, int max)

Initializes value, extent, minimum and maximum. Adjusting is false. Throws an IllegalArgumentException if the following constraints aren't satisfied: 

 min <= value <= value+extent <= max

Public Methods

public void addChangeListener (ChangeListener l)

Adds a ChangeListener. The change listeners are run each time any one of the Bounded Range model properties changes.

Parameters
l the ChangeListener to add
See Also

public ChangeListener[] getChangeListeners ()

Returns an array of all the change listeners registered on this DefaultBoundedRangeModel.

Returns
  • all of this model's ChangeListeners or an empty array if no change listeners are currently registered
See Also

public int getExtent ()

Returns the model's extent.

Returns
  • the model's extent
See Also

public T[] getListeners (Class<T> listenerType)

Returns an array of all the objects currently registered as FooListeners upon this model. FooListeners are registered using the addFooListener method.

You can specify the listenerType argument with a class literal, such as FooListener.class. For example, you can query a DefaultBoundedRangeModel instance m for its change listeners with the following code: 

ChangeListener[] cls = (ChangeListener[])(m.getListeners(ChangeListener.class));
If no such listeners exist, this method returns an empty array.

Parameters
listenerType the type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener
Returns
  • an array of all objects registered as FooListeners on this model, or an empty array if no such listeners have been added
Throws
ClassCastException if listenerType doesn't specify a class or interface that implements java.util.EventListener
See Also

public int getMaximum ()

Returns the model's maximum.

Returns
  • the model's maximum
See Also

public int getMinimum ()

Returns the model's minimum.

Returns
  • the model's minimum
See Also

public int getValue ()

Returns the model's current value.

Returns
  • the model's current value
See Also

public boolean getValueIsAdjusting ()

Returns true if the value is in the process of changing as a result of actions being taken by the user.

Returns
  • the value of the valueIsAdjusting property
See Also

public void removeChangeListener (ChangeListener l)

Removes a ChangeListener.

Parameters
l the ChangeListener to remove
See Also

public void setExtent (int n)

Sets the extent to n after ensuring that n is greater than or equal to zero and falls within the model's constraints: 

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

Parameters
n the model's new extent
See Also

public void setMaximum (int n)

Sets the maximum to n after ensuring that n that the other three properties obey the model's constraints: 

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

Parameters
n the model's new maximum
See Also

public void setMinimum (int n)

Sets the minimum to n after ensuring that n that the other three properties obey the model's constraints: 

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

Parameters
n the model's new minimum
See Also

public void setRangeProperties (int newValue, int newExtent, int newMin, int newMax, boolean adjusting)

Sets all of the BoundedRangeModel properties after forcing the arguments to obey the usual constraints: 

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

At most, one ChangeEvent is generated.

Parameters
newValue an int giving the current value
newExtent an int giving the amount by which the value can "jump"
newMin an int giving the minimum value
newMax an int giving the maximum value
adjusting a boolean, true if a series of changes are in progress
See Also

public void setValue (int n)

Sets the current value of the model. For a slider, that determines where the knob appears. Ensures that the new value, n falls within the model's constraints: 

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

Parameters
n the model's new value
See Also

public void setValueIsAdjusting (boolean b)

Sets the valueIsAdjusting property.

Parameters
b true if the upcoming changes to the value property are part of a series
See Also

public String toString ()

Returns a string that displays all of the BoundedRangeModel properties.

Returns
  • a string representation of the object.

Protected Methods

protected void fireStateChanged ()

Runs each ChangeListener's stateChanged method.

See Also