Packageorg.axiis.layouts.scale
Classpublic class AbstractScale
InheritanceAbstractScale Inheritance flash.events.EventDispatcher
Subclasses CategoricalScale, ContinuousScale

An abstract base class that scales can extend. It provides stubs for methods defined in IScale, and sets up the necessary getters and setters to allow a user to overide minimums and maximums values. A user can set the minValue using the public setter "minValue". The protected setter "computedMinValue" allows a subclass to set the value that it determines for the minimum based only on the data. The "minValue" getter will return the user specified value if it exists. Otherwise it returns the computed value. The analogous procedure is used for maxValue.


Public Properties
 PropertyDefined By
  computedMaxValue : *
[read-only] The maximum value in the dataProvider.
AbstractScale
  computedMinValue : *
[read-only] The minimum value in the dataProvider.
AbstractScale
  dataField : String
The name of the property of the Objects in the dataProvider that should be used when computing min, max, sum, and average values.
AbstractScale
  dataProvider : Object
The DataSet, ArrayCollection, Array, XML, etc.
AbstractScale
  invalidated : Boolean
[read-only] Indicates that the scale should recalculate it's minimum and maximum values and layouts the next time either layoutToValue or valueToLayout is called.
AbstractScale
  maxLayout : Number
The maximum layout position.
AbstractScale
  maxValue : *
The maximum value allowed in this scale.
AbstractScale
  minLayout : Number
The minimum layout position.
AbstractScale
  minValue : *
The minimum value allowed in this scale.
AbstractScale
Protected Properties
 PropertyDefined By
  collection : ArrayCollection
AbstractScale
  _computedMaxValue : *
[write-only]
AbstractScale
  _computedMinValue : *
[write-only]
AbstractScale
  userMaxValue : *
The maximum value as specified by the user.
AbstractScale
  userMinValue : *
The minimum value as specified by the user.
AbstractScale
Public Methods
 MethodDefined By
  
invalidate():void
Marks this IScale as needing its minValue and maxValue recomputed.
AbstractScale
  
validate():void
Initiates the computation of minValue and maxValue.
AbstractScale
Events
 Event Summary Defined By
  
invalidate
Dispatched when the data in the becomes invalid and the new min, max, sum, and average need to be computed.AbstractScale
Property Detail
_computedMaxValueproperty
_computedMaxValue:*  [write-only]


Implementation
    protected function set _computedMaxValue(value:):void
_computedMinValueproperty 
_computedMinValue:*  [write-only]


Implementation
    protected function set _computedMinValue(value:):void
collectionproperty 
protected var collection:ArrayCollection

computedMaxValueproperty 
computedMaxValue:*  [read-only]

The maximum value in the dataProvider.

This property can be used as the source for data binding.


Implementation
    public function get computedMaxValue():*
computedMinValueproperty 
computedMinValue:*  [read-only]

The minimum value in the dataProvider.

This property can be used as the source for data binding.


Implementation
    public function get computedMinValue():*
dataFieldproperty 
dataField:String  [read-write]

The name of the property of the Objects in the dataProvider that should be used when computing min, max, sum, and average values. If this property is not set, the implementing class should use the Objects themselves.

This property can be used as the source for data binding.


Implementation
    public function get dataField():String
    public function set dataField(value:String):void
dataProviderproperty 
dataProvider:Object  [read-write]

The DataSet, ArrayCollection, Array, XML, etc. that is used to determine the range of this scale.

This property can be used as the source for data binding.


Implementation
    public function get dataProvider():Object
    public function set dataProvider(value:Object):void
invalidatedproperty 
invalidated:Boolean  [read-only]

Indicates that the scale should recalculate it's minimum and maximum values and layouts the next time either layoutToValue or valueToLayout is called.


Implementation
    public function get invalidated():Boolean
maxLayoutproperty 
maxLayout:Number  [read-write]

The maximum layout position.

This property can be used as the source for data binding.


Implementation
    public function get maxLayout():Number
    public function set maxLayout(value:Number):void
maxValueproperty 
maxValue:*  [read-write]

The maximum value allowed in this scale. If this property is not set, the implementer should compute an appropriate maximum by analyzing the contents of the dataProvider.

This property can be used as the source for data binding.


Implementation
    public function get maxValue():*
    public function set maxValue(value:any):void
minLayoutproperty 
minLayout:Number  [read-write]

The minimum layout position.

This property can be used as the source for data binding.


Implementation
    public function get minLayout():Number
    public function set minLayout(value:Number):void
minValueproperty 
minValue:*  [read-write]

The minimum value allowed in this scale. If this property is not set, the implementer should compute an appropriate minimum by analyzing the contents of the dataProvider.

This property can be used as the source for data binding.


Implementation
    public function get minValue():*
    public function set minValue(value:any):void
userMaxValueproperty 
protected var userMaxValue:*

The maximum value as specified by the user.

userMinValueproperty 
protected var userMinValue:*

The minimum value as specified by the user.

Method Detail
invalidate()method
public function invalidate():void

Marks this IScale as needing its minValue and maxValue recomputed.

validate()method 
public function validate():void

Initiates the computation of minValue and maxValue.

Event Detail
invalidate Event
Event Object Type: flash.events.Event

Dispatched when the data in the becomes invalid and the new min, max, sum, and average need to be computed.





Fri Oct 2 2009, 08:24 PM -04:00