Packageqnx.ui.events
Classpublic class DataProviderEvent
InheritanceDataProviderEvent Inheritance flash.events.Event

Dispatched when data is modified.

A DataProviderEvent object is dispatched into the event flow whenever a DataProvider change occurs. A change occurs through modification of the DataProvider by adding, removing, replacing, or updating.

See also

DataProvider
SectionDataProvider

Public Properties
 PropertyDefined By
  changeType : String
[read-only] Gets the type of change that occured on the data provider.
DataProviderEvent
  childEndIndex : int
[read-only] Gets the end index of the child items that were modified in a SectionDataProvider.
DataProviderEvent
  childStartIndex : int
[read-only] Gets the start index of the child items that were modified in a SectionDataProvider.
DataProviderEvent
  endIndex : int
[read-only] Gets the end index of the items that were modified.
DataProviderEvent
  items : Array
[read-only] Gets the items that have been modified
DataProviderEvent
  startIndex : int
[read-only] Gets the start index of the items that were modified.
DataProviderEvent
Public Methods
 MethodDefined By
  
DataProviderEvent(changeType:String, items:Array, startIndex:int, endIndex:int, childStartIndex:int = -1, childEndIndex:int = -1)
Constructs a DataProviderEvent object.
DataProviderEvent
Public Constants
 ConstantDefined By
  ADD_CHILD : String = addChild
[static] Dispatched when children have been added to an item in a section data provider.
DataProviderEvent
  ADD_ITEM : String = addItem
[static] Dispatched when items have been added to a data provider.
DataProviderEvent
  DATA_CHANGE : String = dataChange
[static] Dispatched when the DataProvider is modified.
DataProviderEvent
  REMOVE_ALL : String = removeAll
[static] Dispatched when all items have been removed from the data provider.
DataProviderEvent
  REMOVE_ALL_CHILDREN : String = removeChildren
[static] Dispatched when all children have been removed from an item in a section data provider.
DataProviderEvent
  REMOVE_CHILD : String = removeChild
[static] Dispatched when children have been removed from an item in a section data provider.
DataProviderEvent
  REMOVE_ITEM : String = removeItem
[static] Dispatched when items have been removed from a data provider.
DataProviderEvent
  REPLACE_CHILD : String = replaceChild
[static] Dispatched when children have been replaced within an item in a section data provider.
DataProviderEvent
  REPLACE_ITEM : String = replaceItem
[static] Dispatched when items have been replaced in the data provider.
DataProviderEvent
  UPDATE_ALL : String = updateAll
[static] Dispatched when all the items have been updated in the data provider.
DataProviderEvent
  UPDATE_ALL_CHILDREN : String = updateChildren
[static] Dispatched when all children have been updated within an item in a section data provider.
DataProviderEvent
  UPDATE_CHILD : String = updateChild
[static] Dispatched when a child has been updated in an item in a section data provider.
DataProviderEvent
  UPDATE_ITEM : String = updateItem
[static] Dispatched when items have been updated in the data provider.
DataProviderEvent
Property Detail
changeTypeproperty
changeType:String  [read-only]

Gets the type of change that occured on the data provider.


Implementation
    public function get changeType():String

See also

ADD_ITEM
REPLACE_ITEM
REMOVE_ITEM
UPDATE_ALL
UPDATE_ITEM
REMOVE_ALL
ADD_CHILD
REMOVE_CHILD
REPLACE_CHILD
UPDATE_ALL_CHILDREN
REMOVE_ALL_CHILDREN
UPDATE_CHILD
childEndIndexproperty 
childEndIndex:int  [read-only]

Gets the end index of the child items that were modified in a SectionDataProvider.


Implementation
    public function get childEndIndex():int

See also

SectionDataProvider
childStartIndexproperty 
childStartIndex:int  [read-only]

Gets the start index of the child items that were modified in a SectionDataProvider.


Implementation
    public function get childStartIndex():int

See also

SectionDataProvider
endIndexproperty 
endIndex:int  [read-only]

Gets the end index of the items that were modified.


Implementation
    public function get endIndex():int
itemsproperty 
items:Array  [read-only]

Gets the items that have been modified


Implementation
    public function get items():Array
startIndexproperty 
startIndex:int  [read-only]

Gets the start index of the items that were modified.


Implementation
    public function get startIndex():int
Constructor Detail
DataProviderEvent()Constructor
public function DataProviderEvent(changeType:String, items:Array, startIndex:int, endIndex:int, childStartIndex:int = -1, childEndIndex:int = -1)

Constructs a DataProviderEvent object.

Parameters
changeType:String — The type of change that occured.
 
items:Array — An Array of the items that where modified.
 
startIndex:int — The start index of the items that were modified in the data provider.
 
endIndex:int — The end index of the items that were modified in the data provider.
 
childStartIndex:int (default = -1) — The start index of the children items that were modified in the data provider.
 
childEndIndex:int (default = -1) — The end index of the children items that were modified in the data provider.
Constant Detail
ADD_CHILDConstant
public static const ADD_CHILD:String = addChild

Dispatched when children have been added to an item in a section data provider.

See also

addChildToItem()
addChildToItemAtIndex()
addChildToIndex()
addChildToIndexAt()
ADD_ITEMConstant 
public static const ADD_ITEM:String = addItem

Dispatched when items have been added to a data provider.

See also

addItem()
addItemAt()
DATA_CHANGEConstant 
public static const DATA_CHANGE:String = dataChange

Dispatched when the DataProvider is modified.

REMOVE_ALLConstant 
public static const REMOVE_ALL:String = removeAll

Dispatched when all items have been removed from the data provider.

See also

removeAll()
REMOVE_ALL_CHILDRENConstant 
public static const REMOVE_ALL_CHILDREN:String = removeChildren

Dispatched when all children have been removed from an item in a section data provider.

See also

removeAllChildrenFromIndex()
REMOVE_CHILDConstant 
public static const REMOVE_CHILD:String = removeChild

Dispatched when children have been removed from an item in a section data provider.

See also

removeChildFromItem()
removeChildFromItemAt()
removeChildFromIndex()
removeChildFromIndexAt()
REMOVE_ITEMConstant 
public static const REMOVE_ITEM:String = removeItem

Dispatched when items have been removed from a data provider.

See also

removeItem()
removeItemAt()
REPLACE_CHILDConstant 
public static const REPLACE_CHILD:String = replaceChild

Dispatched when children have been replaced within an item in a section data provider.

See also

replaceChildInItem()
replaceChildInItemAt()
replaceChildInIndex()
replaceChildInIndexAt()
REPLACE_ITEMConstant 
public static const REPLACE_ITEM:String = replaceItem

Dispatched when items have been replaced in the data provider.

See also

replaceItem()
replaceItemAt()
UPDATE_ALLConstant 
public static const UPDATE_ALL:String = updateAll

Dispatched when all the items have been updated in the data provider.

See also

setItems()
UPDATE_ALL_CHILDRENConstant 
public static const UPDATE_ALL_CHILDREN:String = updateChildren

Dispatched when all children have been updated within an item in a section data provider.

See also

setChildrenForItem()
UPDATE_CHILDConstant 
public static const UPDATE_CHILD:String = updateChild

Dispatched when a child has been updated in an item in a section data provider.

See also

updateChildInItem()
updateChildInItemAt()
updateChildInIndex()
updateChildInIndexAt()
UPDATE_ITEMConstant 
public static const UPDATE_ITEM:String = updateItem

Dispatched when items have been updated in the data provider.

See also

updateItem()
updateItemAt()
updateItemsAt()



Copyright 2012 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Mon Jan 23 2012, 01:04 PM -05:00