Docs For Class IteratorResultPrinter

Description

Print out an Iterator of items in rows and columns of TEXT_BLOCK widgets spread over multiple pages.

version: $Id: IteratorResultPrinter.class.php,v 1.30 2007/09/19 14:04:49 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /polyphony/main/library/ResultPrinter/IteratorResultPrinter.class.php (line 26)

ResultPrinter
   |
   --IteratorResultPrinter

Method Summary

IteratorResultPrinter IteratorResultPrinter (object $iterator, integer $numColumns, integer $numResultsPerPage, string $callbackFunction, optional 4)

object Layout getLayout ([optional $shouldPrintFunction = NULL])

void setRenderDirection (string $direction)

Methods

Constructor IteratorResultPrinter (line 44)

Constructor

access: public

IteratorResultPrinter IteratorResultPrinter (object $iterator, integer $numColumns, integer $numResultsPerPage, string $callbackFunction, optional 4)

object $iterator: The iterator to print.
integer $numColumns: The number of result columns to print on each page.
integer $numResultsPerPage: The number of iterator items to print on a page.
string $callbackFunction: The name of the function that will be called to to print each result.
optional 4: mixed $callbackArgs Any additional arguements will be stored and passed on to the callback function.

getLayout (line 99)

Returns a layout of the Results

return: A layout containing the results/page links
access: public

object Layout getLayout ([optional $shouldPrintFunction = NULL])

optional $shouldPrintFunction: string $shouldPrintFunction The name of a function that will return a boolean specifying whether or not to filter a given result. If null, all results are printed.

setRenderDirection (line 85)

Set the direction of component rendering from the default of Left-Right/Top-Bottom.

Allowed values: Left-Right/Top-Bottom Top-Bottom/Left-Right Right-Left/Top-Bottom Top-Bottom/Right-Left

The other possible directions, listed below, are not implemented due to lack of utility: Left-Right/Bottom-Top Bottom-Top/Left-Right Right-Left/Bottom-Top Bottom-Top/Right-Left

since: 8/18/06
access: public

void setRenderDirection (string $direction)

string $direction

Inherited Methods

Inherited From ResultPrinter

ResultPrinter::getPageLinks()
ResultPrinter::getStartingNumber()
ResultPrinter::setNamespace()
ResultPrinter::setStartingNumber()
ResultPrinter::startingNumberParam()