mx.data.PageInformation - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.data
Class	public final class PageInformation
Inheritance	PageInformation 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

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : 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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		PageInformation(pageSize:int, pageCount:int, loadedPages:Object) Constructor.	PageInformation
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Property Detail

loadedPages

property

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

pageCount

property

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

pageSize

property

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