(Adobe® Flex™ Data Services 2 only)
Packagemx.data
Classpublic final class PageInformation
InheritancePageInformation Inheritance Object

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


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


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] Provides read-only access to the loaded page information for the collection.
PageInformation
  pageCount : int
[read-only] Provides read-only access to the current number of pages in the collection.
PageInformation
  pageSize : int
[read-only] Provides read-only access to 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)
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
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]

Provides read-only access to 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 
        var pagesLoaded:Array = []
        for (var i:int in pageInfo.loadedPages)
             pagesLoaded.push(i);
        trace("pages loaded: "+pagesLoaded.join());

pageCountproperty 
pageCount:int  [read-only]

Provides read-only access to the current number of pages in the collection.

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

Provides read-only access to 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)Parameters
pageSize:int
 
pageCount:int
 
loadedPages:Object



© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Thu Jun 22 2006, 10:21 PM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flex/2/langref/mx/data/PageInformation.html