| Package | com.jwopitz.controls.pagination |
| Class | public class PaginatedItemsControlBase |
| Inheritance | PaginatedItemsControlBase  mx.containers.Box |
| Implements | IPaginatedItemsControl |
In order to facilitate a variety of design implementations, the developer should extend PaginatedItemsControlBase and add the actual controls for changing the selectedIndex.
| Property | Defined by | ||
|---|---|---|---|
| dataProvider : Object
The set of data to be paginated based on items per page.
| PaginatedItemsControlBase | ||
| itemsPerPage : int
The number of items per page of data.
| PaginatedItemsControlBase | ||
| selectedIndex : int
The index value of the current set of data represented by the selected items.
| PaginatedItemsControlBase | ||
| selectedItems : Array [read-only]
The current set of data represented by the selected index.
| PaginatedItemsControlBase | ||
| Property | Defined by | ||
|---|---|---|---|
| formattedDataProvider : Array
The internal data set used by the component in order to represent the paginated data.
| PaginatedItemsControlBase | ||
| pgSets : int
A convenience accessor for subclasses to use in order to calculate the selectedIndex based on various control implementations.
| PaginatedItemsControlBase | ||
| Method | Defined by | ||
|---|---|---|---|
|
generateFormattedDataProvider(source:Object):Array
Takes a data source and formats it into a new array based on the itemsPerPage.
| PaginatedItemsControlBase | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| PaginatedItemsControlBase | ||||
| PaginatedItemsControlBase | ||||
| PaginatedItemsControlBase | ||||
| PaginatedItemsControlBase | ||||
| dataProvider | property |
dataProvider:Object [read-write]The set of data to be paginated based on items per page. This value must be of type Array or mx.collections.IList or a runtime error will occur.
This property can be used as the source for data binding.
Implementation public function get dataProvider():Object
public function set dataProvider(value:Object):void
| formattedDataProvider | property |
protected var formattedDataProvider:ArrayThe internal data set used by the component in order to represent the paginated data.
| itemsPerPage | property |
itemsPerPage:int [read-write]The number of items per page of data.
This property can be used as the source for data binding.
Implementation public function get itemsPerPage():int
public function set itemsPerPage(value:int):void
| pgSets | property |
protected var pgSets:intA convenience accessor for subclasses to use in order to calculate the selectedIndex based on various control implementations.
This property can be used as the source for data binding.
| selectedIndex | property |
selectedIndex:int [read-write]The index value of the current set of data represented by the selected items.
This property can be used as the source for data binding.
Implementation public function get selectedIndex():int
public function set selectedIndex(value:int):void
| selectedItems | property |
selectedItems:Array [read-only]The current set of data represented by the selected index. Other UI componenets will use this to render the data.
This property can be used as the source for data binding.
Implementation public function get selectedItems():Array
| generateFormattedDataProvider | () | method |
protected function generateFormattedDataProvider(source:Object):ArrayTakes a data source and formats it into a new array based on the itemsPerPage.
Parameterssource:Object — The data source to be formatted.
|
Array |
| dataProviderChanged | event |
| itemsPerPageChanged | event |
| selectedIndexChanged | event |
| selectedItemsChanged | event |