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

Implementation of the Tide paged collection with an generic service backend.

By default the corresponding service should have the same name and expose a 'find' method
that returns a Map with the following properties :
   resultCount
   resultList
   firstResult
   maxResults
The name of the remote service can be overriden by setting the remoteComponentName property. The name of the remote method can by set by the remoteMethodName property.


Public Properties
 PropertyDefined by
 InheritedbeforeFindCall : Function = null
PagedCollection
 InheriteddispatchReplaceOnResult : Boolean
PagedCollection
 InheriteddispatchResetOnInit : Boolean
PagedCollection
 InheritedelementClass : Class
PagedCollection
  filter : Object
PagedQuery
  filterClass : Class
[write-only]
PagedQuery
 Inheritedlength : int
Get total number of elements
PagedCollection
 Inheritedlist : IList
PagedCollection
 InheritedmaxResults : int
Set the page size.
PagedCollection
  meta_name : String
[read-only]
PagedQuery
  methodName : String
[write-only]
PagedQuery
 InheritedmultipleSort : Boolean = true
PagedCollection
  object : Object
[read-only] IPropertyHolder interface
PagedQuery
  remoteComponentClass : Class
[write-only]
PagedQuery
  remoteComponentName : String
[write-only]
PagedQuery
 Inheritedsort : Sort
PagedCollection
 InheritedthrowIPEDuringResponders : Boolean = false
PagedCollection
 InheritedtriggerRefreshOnIPEWithoutResponder : Boolean = false
PagedCollection
 InheriteduidProperty : String = "uid"
PagedCollection
  usePage : Boolean
[write-only]
PagedQuery
Protected Properties
 PropertyDefined by
 Inherited_clientMax : int
PagedCollection
 Inherited_clientMaxSet : Boolean = false
PagedCollection
  _component : Component = null
PagedQuery
 Inherited_context : BaseContext = null
PagedCollection
 Inherited_initializing : Boolean = false
PagedCollection
  _methodName : String = "find"
PagedQuery
  _methodNameSet : Boolean = false
PagedQuery
  _usePage : Boolean = false
PagedQuery
Public Methods
 MethodDefined by
 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
PagedQuery
 Inherited
refresh():Boolean
Refresh collection with new filter/sort parameters
PagedCollection
Protected Methods
 MethodDefined by
  
doFind(filter:Object, first:int, max:int, sort:Sort, findResponder:PagedCollectionResponder):void
PagedQuery
  
find(first:int, last:int, merge:Boolean = false):void
Trigger a results query for the current filter
PagedQuery
  
getResult(event:TideResultEvent, first:int, max:int):Object
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
_componentproperty
protected var _component:Component = null
filterproperty 
filter:Object  [read-write]

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

Implementation
    public function get filter():Object
    public function set filter(value:Object):void
filterClassproperty 
filterClass:Class  [write-only]

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

Implementation
    public function set filterClass(value:Class):void
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
_methodNameproperty 
protected var _methodName:String = "find"
methodNameproperty 
methodName:String  [write-only]

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

Implementation
    public function set methodName(value:String):void
_methodNameSetproperty 
protected var _methodNameSet:Boolean = false
objectproperty 
object:Object  [read-only]

IPropertyHolder interface

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

Implementation
    public function get object():Object
remoteComponentClassproperty 
remoteComponentClass:Class  [write-only]

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

Implementation
    public function set remoteComponentClass(value:Class):void
remoteComponentNameproperty 
remoteComponentName:String  [write-only]

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

Implementation
    public function set remoteComponentName(value:String):void
_usePageproperty 
protected var _usePage:Boolean = false
usePageproperty 
usePage:Boolean  [write-only]

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

Implementation
    public function set usePage(value:Boolean):void
Method detail
doFind()method
protected function doFind(filter:Object, first:int, max:int, sort:Sort, findResponder:PagedCollectionResponder):voidParameters
filter:Object
 
first:int
 
max:int
 
sort:Sort
 
findResponder:PagedCollectionResponder
find()method 
protected override function find(first:int, last:int, merge:Boolean = false):void

Trigger a results query for the current filter

Parameters
first:int — : index of first required result
 
last:int — : index of last required result
 
merge:Boolean (default = false) — : should merge result with current wrapped list
getResult()method 
protected override function getResult(event:TideResultEvent, first:int, max:int):ObjectParameters
event:TideResultEvent
 
first:int
 
max:int

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):voidParameters
propName:String
 
event:ResultEvent