| Package | spark.collections |
| Class | public class NumericDataProvider |
| Inheritance | NumericDataProvider  OnDemandEventDispatcher Object |
| Implements | IList |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.6 |
| Runtime Versions: | Flash Player 11, AIR 3 |
minimum and maximum
properties. The stepSize property defines the difference between
an item and the next item.
This class is used primarily as a data provider for the SpinnerList control; for example:
<s:SpinnerList>
<s:dataProvider>
<s:NumericDataProvider minimum="0" maximum="23" stepSize="1"/>
</s:dataProvider>
</s:SpinnerList>
The advantage of this class is that the item values are calculated on demand, instead of stored.
Because the values are calculated instead of stored, the addItem(), addItemAt(),
removeAll(), removeItemAt(), itemUpdated() and setItemAt() IList methods are not
supported.
More examples
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| length : int [read-only]
The number of items in this collection. | NumericDataProvider | ||
| maximum : Number
The value of the last item. | NumericDataProvider | ||
| minimum : Number
The value of the first item. | NumericDataProvider | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| stepSize : Number
The stepSize property controls the values of items between the first and last items. | NumericDataProvider | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | NumericDataProvider | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | OnDemandEventDispatcher | |
This function is not supported. | NumericDataProvider | ||
This function is not supported. | NumericDataProvider | ||
|
Dispatches an event into the event flow. | OnDemandEventDispatcher | |
Gets the item at the specified index. | NumericDataProvider | ||
Returns the index of the item if it is in the list such that
getItemAt(index) == item. | NumericDataProvider | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | OnDemandEventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
This function is not supported. | NumericDataProvider | ||
|
Indicates whether the specified property exists and is enumerable. | Object | |
This function is not supported. | NumericDataProvider | ||
|
Removes a listener from the EventDispatcher object. | OnDemandEventDispatcher | |
This function is not supported. | NumericDataProvider | ||
This function is not supported. | NumericDataProvider | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
Returns an Array that is populated in the same order as the IList
implementation. | NumericDataProvider | ||
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | OnDemandEventDispatcher | |
length | property |
maximum | property |
maximum:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.6 |
| Runtime Versions: | Flash Player 11, AIR 3 |
The value of the last item. This value must be larger than the minimum value.
The default value is 100.
Implementation
public function get maximum():Number public function set maximum(value:Number):voidminimum | property |
minimum:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.6 |
| Runtime Versions: | Flash Player 11, AIR 3 |
The value of the first item. This value must be smaller than the minimum value.
The default value is 0.
Implementation
public function get minimum():Number public function set minimum(value:Number):voidstepSize | property |
stepSize:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.6 |
| Runtime Versions: | Flash Player 11, AIR 3 |
The stepSize property controls the values of items between the first and last items.
For each item, the value is calculated as the sum of the minimum
and the item's index multiplied by this property.
For example, if minimum is 10, maximum is 20, and this property is 3, then the
item values of this data provider are 10, 13, 16, 19, and 20.
The default value is 1.
Implementation
public function get stepSize():Number public function set stepSize(value:Number):voidNumericDataProvider | () | Constructor |
public function NumericDataProvider()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.6 |
| Runtime Versions: | Flash Player 11, AIR 3 |
Constructor.
addItem | () | method |
addItemAt | () | method |
getItemAt | () | method |
public function getItemAt(index:int, prefetch:int = 0):Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.6 |
| Runtime Versions: | Flash Player 11, AIR 3 |
Gets the item at the specified index.
Parameters
index:int — The index in the list from which to retrieve the item.
| |
prefetch:int (default = 0)int indicating both the direction
and number of items to fetch during the request if the item is
not local.
|
Object — The item at that index, or null if there is none.
|
getItemIndex | () | method |
public function getItemIndex(item:Object):intReturns the index of the item if it is in the list such that getItemAt(index) == item.
Note: unlike IViewCursor.findxxx() methods,
The getItemIndex() method cannot take a parameter with
only a subset of the fields in the item being serched for;
this method always searches for an item that exactly matches
the input parameter.
Parameters
item:Object — The item to find.
|
int — The index of the item, or -1 if the item is not in the list.
|
itemUpdated | () | method |
public function itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.6 |
| Runtime Versions: | Flash Player 11, AIR 3 |
This function is not supported.
Parameters
item:Object | |
property:Object (default = null) | |
oldValue:Object (default = null) | |
newValue:Object (default = null) |
removeAll | () | method |
public function removeAll():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.6 |
| Runtime Versions: | Flash Player 11, AIR 3 |
This function is not supported.
removeItemAt | () | method |
setItemAt | () | method |
toArray | () | method |
Mon Nov 28 2011, 06:48 AM -08:00