Main Page | Packages | Class Tree | Index | Help
Previous | NextFrames | No Frames
Summary: Field | Property | Contructor | MethodDetail: Field | Property | Contructor | Method
mx.controls.listclasses

class DataProvider

Object
  |
  +--mx.controls.listclasses.DataProvider

class DataProvider
extends Object


Field Summary


addEventListener: Function



dispatchEvent: Function


static
evtDipatcher
make sure we have a link to the package we depend on at static time


length: Number
::: END MIXIN BLOCK ::: All code below is for class definition.

static
mixinProps: Array
::: BEGIN MIXIN BLOCK ::: All code here is for mixing in methods onto Array.

static
mixins: DataProvider
Template instance of DataProvider, from which we'll copy our methods/props.


reverse: Function



slice: Function



sort: Function



sortOn: Function



splice: Function


Fields inherited from class Object

__proto__, constructor, prototype

Constructor


DataProvider ( obj)


Method Summary


addItem ( value ): Void
add an item to the end of the array


addItemAt ( index : Number, value ): Void
add an item someplace in the array


addItemsAt ( index : Number, newItems : Array ): Void



editField ( index : Number, fieldName : String, newData ): Void



getEditingData ( index : Number, fieldName : String )



getItemAt ( index : Number )
returns the item at the specified location - relaxed return type for string / object


getItemID ( index : Number ): Number


static
Initialize ( obj: Object ): Boolean



removeAll ( Void ): Void
remove the item at the specified location - relaxed return type for string / object


removeItemAt ( index : Number )
remove the item at the specified location


removeItemsAt ( index : Number, len : Number ): Void



replaceItemAt ( index : Number, itemObj ): Void
remove the item at the specified location - relaxed return type for string / object


sortItems ( compareFunc, optionFlags ): Void
Sorts the list of items - relaxed parameter types for overloading


sortItemsBy ( fieldName, order ): Void
Sorts the list of items - relaxed parameter types for overloading


updateViews ( event, first, last ): Void


Methods inherited from class Object

addProperty, hasOwnProperty, isPropertyEnumerable, isPrototypeOf, registerClass, toLocaleString, toString, unwatch, valueOf, watch


Field Documentation

addEventListener

var addEventListener: Function

dispatchEvent

var dispatchEvent: Function

evtDipatcher

static var evtDipatcher
make sure we have a link to the package we depend on at static time

length

var length: Number
::: END MIXIN BLOCK ::: All code below is for class definition.

inherent properties of array

mixinProps

static var mixinProps: Array
::: BEGIN MIXIN BLOCK ::: All code here is for mixing in methods onto Array.

mixins

static var mixins: DataProvider
Template instance of DataProvider, from which we'll copy our methods/props.

reverse

var reverse: Function

slice

var slice: Function

sort

var sort: Function

sortOn

var sortOn: Function

splice

var splice: Function

Constructor Documentation

DataProvider

function DataProvider(obj)

Method Documentation

addItem

function addItem(value): Void
add an item to the end of the array

Parameters:
value
the item to add (relaxed type for strings / objects)

addItemAt

function addItemAt(index : Number,
 value): Void
add an item someplace in the array

Parameters:
index
index location in the array to insert
value
the item to add

addItemsAt

function addItemsAt(index : Number,
 newItems : Array): Void
Parameters:
index
index the location for the items to be inserted
newItems
newItems the array of new items to add

editField

function editField(index : Number,
 fieldName : String,
 newData): Void
Parameters:
index
index the index of the item
fieldName
fieldName the name of the field to edit
newData
the new data for the field

getEditingData

function getEditingData(index : Number,
 fieldName : String)
Parameters:
index
index the index of the item
fieldName
fieldName the name of the field to edit

getItemAt

function getItemAt(index : Number)
returns the item at the specified location - relaxed return type for string / object

Parameters:
index
index the location of the item to return
Returns:
the item at the location

getItemID

function getItemID(index : Number): Number
Parameters:
index
index the location of the item

Initialize

static function Initialize(obj: Object): Boolean
Parameters:
obj
the object whose prototype will be initialized

removeAll

function removeAll(Void): Void
remove the item at the specified location - relaxed return type for string / object

Parameters:
Void
index the location of the item to remove

removeItemAt

function removeItemAt(index : Number)
remove the item at the specified location

Parameters:
index
index the location of the item to remove
Returns:
the item being deleted - relaxed return type for string / object

removeItemsAt

function removeItemsAt(index : Number,
 len : Number): Void
Parameters:
index
index the location of the items to remove
len
len the number of items to remove

replaceItemAt

function replaceItemAt(index : Number,
 itemObj): Void
remove the item at the specified location - relaxed return type for string / object

Parameters:
index
index the location of the item to remove
itemObj

sortItems

function sortItems(compareFunc,
 optionFlags): Void
Sorts the list of items - relaxed parameter types for overloading

Parameters:
compareFunc
- the function to use for comparing items
optionFlags
the options accepted by Array.sort

sortItemsBy

function sortItemsBy(fieldName,
 order): Void
Sorts the list of items - relaxed parameter types for overloading

Parameters:
fieldName
the field (or array of fieldNames) upon which to sort
order
either "asc" or "desc", or the options accepted by Array.sort

updateViews

function updateViews(event,
 first,
 last): Void
Parameters:
event
eventObj the object to dispatch
first
last

The documentation was generated from the following file:

Copyright © 1997-2005 Macromedia, Inc. All rights reserved. Generated with AS2Doc