ERXFlickrBatchNavigation Class Reference

Inherits er::extensions::components::ERXComponent.

Inherited by AjaxFlickrBatchNavigation.

Collaboration diagram for ERXFlickrBatchNavigation:

Collaboration graph
[legend]

List of all members.

Classes

class  PageNumber

Public Member Functions

int batchCount ()
int batchSize ()
int currentBatchIndex ()
String currentBatchSizeString ()
WODisplayGroup displayGroup ()
String displayName ()
Integer displayNameCount ()
 ERXFlickrBatchNavigation (WOContext context)
int firstIndex ()
boolean hasMultiplePages ()
boolean hasNextPage ()
boolean hasPreviousPage ()
boolean isCurrentBatchSizeSelected ()
boolean isCurrentPageNumber ()
int lastIndex ()
int maxNumberOfObjects ()
WOActionResults nextPage ()
int numberOfObjectsPerBatch ()
NSArray objects ()
NSArray< PageNumberpageNumbers ()
String parentActionName ()
NSArray< NumberpossibleBatchSizes ()
WOActionResults previousPage ()
PageNumber repetitionPageNumber ()
WOActionResults selectBatchSize ()
WOActionResults selectPage ()
void setRepetitionPageNumber (PageNumber repetitionPageNumber)
boolean showBatchSizes ()
boolean showLabels ()
boolean synchronizesVariablesWithBindings ()

Public Attributes

Integer currentBatchSize

Protected Member Functions

void addEllipsis ()
void addPageNumbers (int startIndex, int endIndex)

Private Attributes

int _lastCurrentPageNumber
int _lastPageCount
int _lastPageSize
NSMutableArray< PageNumber_pageNumbers
String _parentActionName
PageNumber _repetitionPageNumber


Detailed Description

ERXFlickrBatchNavigation is a batch navigation component that provides pagination that behaves like the paginator on Flickr.com.

Include ERXFlickrBatchNavigation.css in ERExtensions for a default stylesheet that looks (very) similar to Flickr.

Can also be used for pagination on the parent component, where the objects being paginated may be POJOs in an array, or where paging all the objects in the allObjects array is not feasible due to memory requirements.

Author:
mschrag

rob, cug (non displayGroup batching)

displayGroup the display group to paginate displayName the name of the items that are being display ("photo", "bug", etc) showPageRange if true, the page of items on the page is shown, for example "(1-7 of 200 items)" showBatchSizes if true, a menu to change the items per page is shown "Show: (10) 20 (100) (All) items per page" batchSizes can be either a string or an NSArray of numbers that define the batch sizes to chose from. The number "0" provides an "All" items batch size. For example "10,20,30" or "10,50,100,0" small if true, a compressed page count style is used

parentActionName (if you don't provide a displayGroup) the action to be executed on the parent component to get the next batch of items. currentBatchIndex (if you don't provide a displayGroup) used to get and set on the parent component the selected page index maxNumberOfObjects (if you don't provide a displayGroup) used to get the total number of objects that are being paginated. numberOfObjectsPerBatch (if you don't provide a displayGroup) the number of objects per batch (page)


Constructor & Destructor Documentation

ERXFlickrBatchNavigation ( WOContext  context  ) 


Member Function Documentation

void addEllipsis (  )  [protected]

void addPageNumbers ( int  startIndex,
int  endIndex 
) [protected]

int batchCount (  ) 

int batchSize (  ) 

int currentBatchIndex (  ) 

String currentBatchSizeString (  ) 

WODisplayGroup displayGroup (  ) 

String displayName (  ) 

Integer displayNameCount (  ) 

int firstIndex (  ) 

boolean hasMultiplePages (  ) 

boolean hasNextPage (  ) 

boolean hasPreviousPage (  ) 

boolean isCurrentBatchSizeSelected (  ) 

boolean isCurrentPageNumber (  ) 

int lastIndex (  ) 

int maxNumberOfObjects (  ) 

WOActionResults nextPage (  ) 

int numberOfObjectsPerBatch (  ) 

NSArray objects (  ) 

NSArray<PageNumber> pageNumbers (  ) 

String parentActionName (  ) 

NSArray<Number> possibleBatchSizes (  ) 

WOActionResults previousPage (  ) 

PageNumber repetitionPageNumber (  ) 

WOActionResults selectBatchSize (  ) 

WOActionResults selectPage (  ) 

void setRepetitionPageNumber ( PageNumber  repetitionPageNumber  ) 

boolean showBatchSizes (  ) 

boolean showLabels (  ) 

boolean synchronizesVariablesWithBindings (  ) 


Member Data Documentation

int _lastCurrentPageNumber [private]

int _lastPageCount [private]

int _lastPageSize [private]


The documentation for this class was generated from the following file:

Generated on Sat May 26 06:43:03 2012 for Project Wonder by  doxygen 1.5.8