Packagemx.data
Classpublic final class PageInformation
InheritancePageInformation Inheritance Object

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

The PageInformation class provides detailed data about what pages of a collection have been loaded, how many there are, and what the current page size is.

View the examples


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  loadedPages : Object
[read-only] The loaded page information for the collection.
PageInformation
  pageCount : int
[read-only] The current number of pages in the collection.
PageInformation
  pageSize : int
[read-only] The current page size for the collection.
PageInformation
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
Public Methods
 MethodDefined By
  
PageInformation(pageSize:int, pageCount:int, loadedPages:Object)
Constructor.
PageInformation
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail
loadedPagesproperty
loadedPages:Object  [read-only]

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

The loaded page information for the collection. This is a sparse array that contains only entries for pages that are loaded.



Implementation
    public function get loadedPages():Object

Example  ( How to use this example ) 
        var pagesLoaded:Array = []
        for (var i:int in pageInfo.loadedPages)
             pagesLoaded.push(i);
        trace("pages loaded: "+pagesLoaded.join());
pageCountproperty 
pageCount:int  [read-only]

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

The current number of pages in the collection.



Implementation
    public function get pageCount():int
pageSizeproperty 
pageSize:int  [read-only]

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

The current page size for the collection.



Implementation
    public function get pageSize():int
Constructor Detail
PageInformation()Constructor
public function PageInformation(pageSize:int, pageCount:int, loadedPages:Object)

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

Constructor.

Parameters
pageSize:int — The page size for the collection.
 
pageCount:int — The number of pages in the collection.
 
loadedPages:Object — The loaded page information for the collection.
Examples (  How to use this example  )
    var pageInfo:PageInformation = myDataService.getPageInformation(myCollection);
    trace("current page size: "+pageInfo.pageSize);
    trace("current page count: "+pageInfo.pageCount);
    var pagesLoaded:Array = []
    for (var i:int in pageInfo.loadedPages)
         pagesLoaded.push(i);
    trace("pages loaded: "+pagesLoaded.join());



© 2009 Adobe Systems Incorporated. All rights reserved.
Sat Oct 3 2009, 04:15 AM -07:00