Class org.aswing.DefaultBoundedRangeModel

Implemented Interfaces

BoundedRangeModel

Description

Field Index

Inherited from EventDispatcher

Method Index

new DefaultBoundedRangeModel()
addChangeListener(), fireStateChanged(), getExtent(), getMaximum(), getMinimum(), getValue(), getValueIsAdjusting(), setExtent(), setMaximum(), setMinimum(), setRangeProperties(), setValue(), setValueIsAdjusting(), toString()

Inherited from EventDispatcher

Constructor Detail

DefaultBoundedRangeModel

public function DefaultBoundedRangeModel(value:Number, extent:Number, min:Number, max:Number)

Throws

Errorwhen invalid range properties

Method Detail

getValue

public function getValue():Number

Description copied from BoundedRangeModel

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.

Specified By

getValue() in org.aswing.BoundedRangeModel

getExtent

public function getExtent():Number

Description copied from BoundedRangeModel

Returns the model's extent, the length of the inner range that begins at the model's value.

Specified By

getExtent() in org.aswing.BoundedRangeModel

getMinimum

public function getMinimum():Number

Description copied from BoundedRangeModel

Returns the minimum acceptable value.

Specified By

getMinimum() in org.aswing.BoundedRangeModel

getMaximum

public function getMaximum():Number

Description copied from BoundedRangeModel

Returns the model's maximum. Note that the upper limit on the model's value is (maximum - extent).

Specified By

getMaximum() in org.aswing.BoundedRangeModel

setValue

public function setValue(n:Number):Void

Description copied from BoundedRangeModel

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.

Specified By

setValue() in org.aswing.BoundedRangeModel

setExtent

public function setExtent(n:Number):Void

Description copied from BoundedRangeModel

Sets 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.

Specified By

setExtent() in org.aswing.BoundedRangeModel

setMinimum

public function setMinimum(n:Number):Void

Description copied from BoundedRangeModel

Sets 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.

Specified By

setMinimum() in org.aswing.BoundedRangeModel

setMaximum

public function setMaximum(n:Number):Void

Description copied from BoundedRangeModel

Sets 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.

Specified By

setMaximum() in org.aswing.BoundedRangeModel

setValueIsAdjusting

public function setValueIsAdjusting(b:Boolean):Void

Description copied from BoundedRangeModel

This 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.

Specified By

setValueIsAdjusting() in org.aswing.BoundedRangeModel

getValueIsAdjusting

public function getValueIsAdjusting():Boolean

Description copied from BoundedRangeModel

Returns true if the current changes to the value property are part of a series of changes.

Specified By

getValueIsAdjusting() in org.aswing.BoundedRangeModel

setRangeProperties

public function setRangeProperties(newValue:Number, newExtent:Number, newMin:Number, newMax:Number, adjusting:Boolean):Void

Description copied from BoundedRangeModel

This 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.

Specified By

setRangeProperties() in org.aswing.BoundedRangeModel

addChangeListener

public function addChangeListener(func:Function, obj:Object):Object

Description copied from BoundedRangeModel

addChangeListener(func:Function)
addChangeListener(func:Function, obj:Object)

Add a listener to listen the Model's change event.

The state is all about:

  • value
  • extent
  • min
  • max
  • adjusting

onStateChanged Event{source:BoundedRangeModel}

Specified By

addChangeListener() in org.aswing.BoundedRangeModel

fireStateChanged

public function fireStateChanged():Void

toString

public function toString():String