Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.data 
UpdateCollectionRange 
Packagemx.data
Classpublic class UpdateCollectionRange
InheritanceUpdateCollectionRange Inheritance Object

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

The UpdateCollectionRange class provides specific information about a range of add and remove operations made to a collection. These objects are associated with a specific UpdateCollectionMessage and are carried in an Array on its body property.

View the examples

See also



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  identities : Array
An Array of identity objects that represent which items were either deleted or inserted in the associated collection starting at the position indicated by the position property.
UpdateCollectionRange
  position : int
Indicates the beginning index for the range of updates made to the associated collection.
UpdateCollectionRange
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  size : int
Indicates the increase in collection size.
UpdateCollectionRange
  updateType : int
Indicates what operation this range represents.
UpdateCollectionRange
Public Methods
 MethodDefined By
  
Constructs an empty UpdateCollectionRange.
UpdateCollectionRange
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  DECREMENT_COLLECTION_SIZE : int = 3
[static] Indicates a derease in the collection size.
UpdateCollectionRange
  DELETE_FROM_COLLECTION : int = 1
[static] Indicates a range of items that have been deleted from the collection.
UpdateCollectionRange
  INCREMENT_COLLECTION_SIZE : int = 2
[static] Indicates an increase in the collection size.
UpdateCollectionRange
  INSERT_INTO_COLLECTION : int = 0
[static] Indicates a range of items have been inserted into the collection.
UpdateCollectionRange
  UPDATE_COLLECTION_SIZE : int = 4
[static] Indicates an update to the collection size sent by the server.
UpdateCollectionRange
Property Detail

identities

property
public var identities:Array

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

An Array of identity objects that represent which items were either deleted or inserted in the associated collection starting at the position indicated by the position property.

position

property 
public var position:int

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates the beginning index for the range of updates made to the associated collection. The updateType indicates if the range was an insert or a remove operation.

size

property 
public var size:int

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates the increase in collection size. Only applicatble when update type is INCREMENT_COLLECTION_SIZE or DECREMENT_COLLECTION_SIZE

updateType

property 
public var updateType:int

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates what operation this range represents. Valid values are:

  • UpdateCollectionRange.INSERT_INTO_COLLECTION
  • UpdateCollectionRange.DELETE_FROM_COLLECTION
  • UpdateCollectionRange.INCREMENT_COLLECTION_SIZE
  • UpdateCollectionRange.DECREMENT_COLLECTION_SIZE
  • UpdateCollectionRange.UPDATE_COLLECTION_SIZE

Constructor Detail

UpdateCollectionRange

()Constructor
public function UpdateCollectionRange()

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructs an empty UpdateCollectionRange.

Constant Detail

DECREMENT_COLLECTION_SIZE

Constant
public static const DECREMENT_COLLECTION_SIZE:int = 3

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates a derease in the collection size. The size property will contain an increase amount

DELETE_FROM_COLLECTION

Constant 
public static const DELETE_FROM_COLLECTION:int = 1

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates a range of items that have been deleted from the collection. The identities property will contain an Array of item identity objects for each item that was inserted into the collection. The position property indicates at what index the insertion operation began. Inspect the identityies.length to determine how many items were inserted.

INCREMENT_COLLECTION_SIZE

Constant 
public static const INCREMENT_COLLECTION_SIZE:int = 2

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates an increase in the collection size. The size property will contain an increase amount

INSERT_INTO_COLLECTION

Constant 
public static const INSERT_INTO_COLLECTION:int = 0

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates a range of items have been inserted into the collection. The identities property will contain an Array of item identity objects for each item that was inserted into the collection. The position property indicates at what index the insertion operation began. Inspect the identityies.length to determine how many items were inserted.

UPDATE_COLLECTION_SIZE

Constant 
public static const UPDATE_COLLECTION_SIZE:int = 4

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates an update to the collection size sent by the server. This will occur when a paged-fill is refreshed on the server. The size property will contain an increase amount

     var ucm:UpdateCollectionMessage = UpdateCollectionMessage(msg);
     var ucr:UpdateCollectionRange = UpdateCollectionRange(ucm.body[0]);
     trace("First change to the collection was "+ ucr.updateType +" at "+
            ucr.position);