Framework  3.9
PagedList Class Reference

The PagedList class provides a simple User Interface control to allow pagination of HTML lists of DataItems. More...

+ Inheritance diagram for PagedList:
+ Collaboration diagram for PagedList:

Public Member Functions

 PagedList ($items, $id="paged_list", $format=null)
 Creates a new PagedList control. More...
 
 getID ()
 
 addFacetTaggingHandler ($handler)
 Adds a row tagging handler. More...
 
 writeScript ()
 
 drawList ()
 
 formatIdTag ($item)
 
 drawListToString ()
 Helpful utility function - generates the list HTML in an output buffer and returns the string representation. More...
 

Public Attributes

 $items
 The items to be displayed in the list. More...
 
 $id
 The HTML id of the list. More...
 
 $format
 The formatter used to display the list items (either a format string or a callback function or method) More...
 
 $pageSize = 10
 The number of items per page. More...
 
 $listTag = "ul"
 The HTML list tag type. More...
 
 $CSSclass = null
 CSS class(es) to be applied to the list. More...
 
 $styles = null
 Specific CSS styles to be applied to the list. More...
 
 $emptyList = "No items in the list"
 Message to display when the list is empty. More...
 
 $paginate = true
 Specifies whether list should be paginated (false for view only pages) More...
 
 $writeIdTag = false
 whether to include an id tag for each li item More...
 
 $tagRowCallbacks
 Array of callbacks for adding extra attributes to each row. More...
 
 $onStartRow
 Callback for setting the CSS class / visibility of each item in the list. More...
 
 $displayMode = "list-item"
 CSS display type for visible items. More...
 

Detailed Description

The PagedList class provides a simple User Interface control to allow pagination of HTML lists of DataItems.

Author
andy

Definition at line 43 of file paged_list.inc.


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