Packageorg.granite.tide.seam.framework
Classpublic class PagedQuery
InheritancePagedQuery Inheritance PagedCollection Inheritance mx.collections.ListCollectionView
ImplementsIComponent, org.granite.tide.IPropertyHolder

Implementation of the Tide paged collection backed by a Seam Query component.

The Seam component should have the same name as the Tide client component.
It must have a max-results set either in components.xml or in its constructor,
and its value must be greater than the maximum number of elements displayed.

This component also implements ListCollectionView and can be directly used as a data provider.
for Flex UI components such as DataGrid.



Public Properties
 PropertyDefined by
 InheritedbeforeFindCall : Function = null
PagedCollection
 InheriteddispatchReplaceOnResult : Boolean
PagedCollection
 InheriteddispatchResetOnInit : Boolean
PagedCollection
 InheritedelementClass : Class
PagedCollection
 Inheritedlength : int
Get total number of elements
PagedCollection
 Inheritedlist : IList
PagedCollection
 InheritedmaxResults : int
Set the page size.
PagedCollection
  meta_name : String
[read-only]
PagedQuery
 InheritedmultipleSort : Boolean = true
PagedCollection
  object : Object
[read-only] IPropertyHolder interface, wrapped object
PagedQuery
  remoteComponentName : String
[write-only]
PagedQuery
 Inheritedsort : Sort
PagedCollection
 InheritedthrowIPEDuringResponders : Boolean = false
PagedCollection
 InheritedtriggerRefreshOnIPEWithoutResponder : Boolean = false
PagedCollection
 InheriteduidProperty : String = "uid"
PagedCollection
Protected Properties
 PropertyDefined by
 Inherited_clientMax : int
PagedCollection
 Inherited_clientMaxSet : Boolean = false
PagedCollection
 Inherited_context : BaseContext = null
PagedCollection
 Inherited_initializing : Boolean = false
PagedCollection
Public Methods
 MethodDefined by
  
PagedQuery
 Inherited
clear():void
Clear collection content
PagedCollection
 Inherited
dispatchEvent(event:Event):Boolean
PagedCollection
 Inherited
fullRefresh():Boolean
Force refresh of collection when filter/sort have been changed
PagedCollection
 Inherited
getItemAt(index:int, prefetch:int = 0):Object
Override of getItemAt with ItemPendingError management
PagedCollection
 Inherited
getItemIndex(obj:Object):int
Override of getItemIndex
PagedCollection
  
meta_clear():void
PagedQuery
  
meta_init(componentName:String, context:BaseContext):void
PagedQuery
  
meta_propertyResultHandler(propName:String, event:ResultEvent):void
IPropertyHolder interface, property change handler
PagedQuery
 Inherited
refresh():Boolean
Refresh collection with new filter/sort parameters
PagedCollection
Protected Methods
 MethodDefined by
 Inherited
find(first:int, last:int, merge:Boolean = false):void
Abstract method: trigger a results query for the current filter
PagedCollection
  
getResult(event:TideResultEvent, first:int, max:int):Object
Get the current result for the collection Here we get it from the wrapped component
PagedQuery
 Inherited
itemUpdateHandler(event:PropertyChangeEvent):void
PagedCollection
 Inherited
startTrackUpdates(item:Object):void
PagedCollection
 Inherited
stopTrackUpdates(item:Object):void
PagedCollection
Public Constants
 ConstantDefined by
 InheritedCOLLECTION_PAGE_CHANGE : String = "collectionPageChange"
[static]
PagedCollection
 InheritedFAULT : String = "fault"
[static]
PagedCollection
 InheritedRESULT : String = "result"
[static]
PagedCollection
Property detail
meta_nameproperty
meta_name:String  [read-only]

This property can be used as the source for data binding.

Implementation
    public function get meta_name():String
objectproperty 
object:Object  [read-only]

IPropertyHolder interface, wrapped object

This property can be used as the source for data binding.

Implementation
    public function get object():Object
remoteComponentNameproperty 
remoteComponentName:String  [write-only]

This property can be used as the source for data binding.

Implementation
    public function set remoteComponentName(value:String):void
Constructor detail
PagedQuery()constructor
public function PagedQuery()
Method detail
getResult()method
protected override function getResult(event:TideResultEvent, first:int, max:int):Object

Get the current result for the collection Here we get it from the wrapped component

Parameters
event:TideResultEvent — result event
 
first:int — first index
 
max:int — max number of elements

Returns
Object
meta_clear()method 
public function meta_clear():void
meta_init()method 
public override function meta_init(componentName:String, context:BaseContext):voidParameters
componentName:String
 
context:BaseContext
meta_propertyResultHandler()method 
public function meta_propertyResultHandler(propName:String, event:ResultEvent):void

IPropertyHolder interface, property change handler

Parameters
propName:String — property name
 
event:ResultEvent — result event