| Package | org.aswing |
| Interface | public interface BoundedRangeModel |
| Implementors | DefaultBoundedRangeModel |
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 <= maximumThe 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.
value == maximum, setExtent(10)
would change the extent (back) to zero.
Only setValue and setRangeProperties can indicate programmatic property,
other set methods all will always go with programmatic=true except setValueIsAdjusting.
See also
| Method | Defined by | ||
|---|---|---|---|
|
addStateListener(listener:Function, priority:int = 0, useWeakReference:Boolean = false):void
Adds a listener to listen the Model's state change event.
| BoundedRangeModel | ||
|
getExtent():int
Returns the model's extent, the length of the inner range that
begins at the model's value.
| BoundedRangeModel | ||
|
getMaximum():int
Returns the model's maximum.
| BoundedRangeModel | ||
|
getMinimum():int
Returns the minimum acceptable value.
| BoundedRangeModel | ||
|
getValue():int
Returns the model's current value.
| BoundedRangeModel | ||
|
getValueIsAdjusting():Boolean
Returns true if the current changes to the value property are part
of a series of changes.
| BoundedRangeModel | ||
|
removeStateListener(listener:Function):void
Removes a state listener.
| BoundedRangeModel | ||
|
setExtent(newExtent:int):void
Sets the model's extent.
| BoundedRangeModel | ||
|
setMaximum(newMaximum:int):void
Sets the model's maximum to newMaximum.
| BoundedRangeModel | ||
|
setMinimum(newMinimum:int):void
Sets the model's minimum to newMinimum.
| BoundedRangeModel | ||
|
setRangeProperties(value:int, extent:int, min:int, max:int, adjusting:Boolean, programmatic:Boolean = true):void
This method sets all of the model's data with a single method call.
| BoundedRangeModel | ||
|
setValue(newValue:int, programmatic:Boolean = true):void
Sets the model's current value to
newValue if newValue
satisfies the model's constraints. | BoundedRangeModel | ||
|
setValueIsAdjusting(b:Boolean):void
This attribute indicates that any upcoming changes to the value
of the model should be considered a single event.
| BoundedRangeModel | ||
| addStateListener | () | method |
public function addStateListener(listener:Function, priority:int = 0, useWeakReference:Boolean = false):voidAdds a listener to listen the Model's state change event.
Parameterslistener:Function — the listener
|
|
priority:int (default = 0) |
|
useWeakReference:Boolean (default = false) |
See also
| getExtent | () | method |
public function getExtent():intReturns the model's extent, the length of the inner range that begins at the model's value.
Returnsint — the value of the model's extent property
|
See also
| getMaximum | () | method |
public function getMaximum():intReturns the model's maximum. Note that the upper limit on the model's value is (maximum - extent).
Returnsint — the value of the maximum property.
|
See also
| getMinimum | () | method |
public function getMinimum():intReturns the minimum acceptable value.
Returnsint — the value of the minimum property
|
See also
| getValue | () | method |
public function getValue():int
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.
int — the model's value
|
See also
| getValueIsAdjusting | () | method |
public function getValueIsAdjusting():BooleanReturns true if the current changes to the value property are part of a series of changes.
ReturnsBoolean — the valueIsAdjustingProperty.
|
See also
| removeStateListener | () | method |
public function removeStateListener(listener:Function):voidRemoves a state listener.
Parameterslistener:Function — the listener to be removed.
|
See also
| setExtent | () | method |
public function setExtent(newExtent:int):voidSets the model's extent. The newExtent is forced to be greater than or equal to zero and less than or equal to maximum - value.
When a BoundedRange model is used with a scrollbar the extent defines the length of the scrollbar knob (aka the "thumb" or "elevator"). The extent usually represents how much of the object being scrolled is visible. When used with a slider, the extent determines how much the value can "jump", for example when the user presses PgUp or PgDn.
Notifies any listeners if the model changes. Parameters
newExtent:int — newExtent the model's new extent
|
See also
| setMaximum | () | method |
public function setMaximum(newMaximum:int):voidSets 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:int — the model's new maximum
|
See also
| setMinimum | () | method |
public function setMinimum(newMinimum:int):voidSets 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:int — the model's new minimum
|
See also
| setRangeProperties | () | method |
public function setRangeProperties(value:int, extent:int, min:int, max:int, adjusting:Boolean, programmatic:Boolean = true):voidThis method sets all of the model's data with a single method call. The method results in a single change event being generated. This is convenient when you need to adjust all the model data simultaneously and do not want individual change events to occur.
Parametersvalue:int — an int giving the current value
|
|
extent:int — an int giving the amount by which the value can "jump"
|
|
min:int — an int giving the minimum value
|
|
max:int — an int giving the maximum value
|
|
adjusting:Boolean — a boolean, true if a series of changes are in
progress
|
|
programmatic:Boolean (default = true) |
See also
| setValue | () | method |
public function setValue(newValue:int, programmatic:Boolean = true):void
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:int — the model's new value
|
|
programmatic:Boolean (default = true) |
See also
| setValueIsAdjusting | () | method |
public function setValueIsAdjusting(b:Boolean):voidThis attribute indicates that any upcoming changes to the value of the model should be considered a single event. This attribute will be set to true at the start of a series of changes to the value, and will be set to false when the value has finished changing. Normally this allows a listener to only take action when the final value change in committed, instead of having to do updates for all intermediate values.
Sliders and scrollbars use this property when a drag is underway.
Parametersb:Boolean — true if the upcoming changes to the value property are part of a series
|