javax.swing

Interface BoundedRangeModel

public interface BoundedRangeModel

The data model that represents a range that is constrained to fit within specified bounds. The range is defined as value to value + extent, where both value and extent are integers, and extent >= 0. The bounds are defined by integers minimum and maximum.

This type of model is used in components that display a range of values, like {@link JProgressBar} and {@link JSlider}.

Method Summary
void	addChangeListener(ChangeListener listener) Adds a `ChangeListener` to this object.
int	getExtent() Returns the current extent.
int	getMaximum() Returns the upper bound for the model.
int	getMinimum() Returns the lower bound for the model.
int	getValue() Returns the current value for the model.
boolean	getValueIsAdjusting() Returns the value of the `valueIsAdjusting` property.
void	removeChangeListener(ChangeListener listener) Removes a `ChangeListener` from this object.
void	setExtent(int extent) Sets the extent, which is the length of the model's range, and sends a {@link ChangeEvent} to all registered listeners.
void	setMaximum(int maximum) Sets the upper bound for the model and sends a {@link ChangeEvent} to all registered listeners.
void	setMinimum(int minimum) Sets the lower bound for the model and sends a {@link ChangeEvent} to all registered listeners.
void	setRangeProperties(int value, int extent, int minimum, int maximum, boolean adjusting) Sets all the properties for the model in a single call.
void	setValue(int value) Sets the value for the model and sends a {@link ChangeEvent} to all registered listeners.
void	setValueIsAdjusting(boolean adjusting) Sets the `valueIsAdjusting` property.

Method Detail

addChangeListener

public void addChangeListener(ChangeListener listener)

Adds a ChangeListener to this object.

Parameters: listener the listener to add

getExtent

public int getExtent()

Returns the current extent.

Returns: the extent

getMaximum

public int getMaximum()

Returns the upper bound for the model. This sets an upper limit for the end value of the model's range ({@link #getValue()} + {@link #getExtent()}).

Returns: The upper bound for the model.

getMinimum

public int getMinimum()

Returns the lower bound for the model. The start of the model's range (see {@link #getValue()}) cannot be less than this lower bound.

Returns: The lower bound for the model.

getValue

public int getValue()

Returns the current value for the model.

Returns: The current value for the model.

getValueIsAdjusting

public boolean getValueIsAdjusting()

Returns the value of the valueIsAdjusting property.

Returns: true if value is adjusting, otherwise false

removeChangeListener

public void removeChangeListener(ChangeListener listener)

Removes a ChangeListener from this object.

Parameters: listener the listener to remove

setExtent

public void setExtent(int extent)

Sets the extent, which is the length of the model's range, and sends a {@link ChangeEvent} to all registered listeners.

Parameters: extent the extent

setMaximum

public void setMaximum(int maximum)

Sets the upper bound for the model and sends a {@link ChangeEvent} to all registered listeners. The new maximum must be greater than or equal to the end value of the model's range (as returned by {@link #getValue()} + {@link #getExtent()}).

Parameters: maximum the maximum value

setMinimum

public void setMinimum(int minimum)

Sets the lower bound for the model and sends a {@link ChangeEvent} to all registered listeners. The new minimum must be less than or equal to the start value of the model's range (as returned by {@link #getValue()}).

Parameters: minimum the minimum value

setRangeProperties

public void setRangeProperties(int value, int extent, int minimum, int maximum, boolean adjusting)

Sets all the properties for the model in a single call.

Parameters: value the value extent the extent minimum the minimum value maximum the maximum value adjusting a flag that indicates the model is being adjusted continuously.

setValue

public void setValue(int value)

Sets the value for the model and sends a {@link ChangeEvent} to all registered listeners. The new value must satisfy the constraint min <= value <= value + extent <= max.

Parameters: value the value

setValueIsAdjusting

public void setValueIsAdjusting(boolean adjusting)

Sets the valueIsAdjusting property.

Parameters: adjusting true if adjusting, false otherwise