javax.swing

Interface BoundedRangeModel

Known Implementing Classes:: DefaultBoundedRangeModel

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 JProgressBar and 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 `ChangeEvent` to all registered listeners.
`void`	`setMaximum(int maximum)` Sets the upper bound for the model and sends a `ChangeEvent` to all registered listeners.
`void`	`setMinimum(int minimum)` Sets the lower bound for the model and sends a `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 `ChangeEvent` to all registered listeners.
`void`	`setValueIsAdjusting(boolean adjusting)` Sets the `valueIsAdjusting` property.

addChangeListener

public void addChangeListener(ChangeListener listener)

Adds a ChangeListener to this object.
Parameters:
listener - the listener to add
See Also:
removeChangeListener(ChangeListener)

getExtent

public int getExtent()

Returns the current extent.
Returns:
the extent
See Also:
setExtent(int)

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 (getValue() + getExtent()).
Returns:
The upper bound for the model.
See Also:
setMaximum(int), getMinimum()

getMinimum

public int getMinimum()

Returns the lower bound for the model. The start of the model's range (see getValue()) cannot be less than this lower bound.
Returns:
The lower bound for the model.
See Also:
setMinimum(int), getMaximum()

getValue

public int getValue()

Returns the current value for the model.
Returns:
The current value for the model.
See Also:
setValue(int)

getValueIsAdjusting

public boolean getValueIsAdjusting()

Returns the value of the valueIsAdjusting property.
Returns:
true if value is adjusting, otherwise false
See Also:
setValueIsAdjusting(boolean)

removeChangeListener

public void removeChangeListener(ChangeListener listener)

Removes a ChangeListener from this object.
Parameters:
listener - the listener to remove
See Also:
addChangeListener(ChangeListener)

setExtent

public void setExtent(int extent)

Sets the extent, which is the length of the model's range, and sends a ChangeEvent to all registered listeners.
Parameters:
extent - the extent
See Also:
getExtent()

setMaximum

public void setMaximum(int maximum)

Sets the upper bound for the model and sends a 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 getValue() + getExtent()).
Parameters:
maximum - the maximum value
See Also:
getMaximum()

setMinimum

public void setMinimum(int minimum)

Sets the lower bound for the model and sends a 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 getValue()).
Parameters:
minimum - the minimum value
See Also:
getMinimum()

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 ChangeEvent to all registered listeners. The new value must satisfy the constraint min <= value <= value + extent <= max.
Parameters:
value - the value
See Also:
getValue()

setValueIsAdjusting

public void setValueIsAdjusting(boolean adjusting)

Sets the valueIsAdjusting property.
Parameters:
adjusting - true if adjusting, false otherwise
See Also:
getValueIsAdjusting()

BoundedRangeModel.java -- Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About
Prev Class \| Next Class		Frames \| No Frames
Summary: Nested \| Field \| Method \| Constr	Detail: Nested \| Field \| Method \| Constr