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
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.
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.
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
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
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.
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
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.
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
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.
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);