Docs For Class ArrayResultPrinter

Description

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

version: $Id: ArrayResultPrinter.class.php,v 1.27 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/ArrayResultPrinter.class.php (line 25)

ResultPrinter
   |
   --ArrayResultPrinter

Method Summary

ArrayResultPrinter ArrayResultPrinter (mixed $array, integer $numColumns, integer $numResultsPerPage, [mixed $callbackFunction = NULL], object $iterator, optional 4)

void addLinksStyleProperty (object StyleProperty $styleProperty)

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

void setRenderDirection (string $direction)

void setTdStyles (string $tdStyles)

Methods

Constructor ArrayResultPrinter (line 44)

Constructor

access: public

ArrayResultPrinter ArrayResultPrinter (mixed $array, integer $numColumns, integer $numResultsPerPage, [mixed $callbackFunction = NULL], object $iterator, 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.
mixed $callbackFunction: The name of the function that will be called to to print each result. If null, the first parameter is assumed to be an array of gui components that can be rendered without further processing.
optional 4: mixed $callbackArgs Any additional arguements will be stored and passed on to the callback function.

addLinksStyleProperty (line 122)

Add style properties to the links

since: 9/19/06
access: public

void addLinksStyleProperty (object StyleProperty $styleProperty)

object StyleProperty $styleProperty

getLayout (line 136)

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 98)

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

setTdStyles (line 110)

Set the tdStyles

since: 9/18/06
access: public

void setTdStyles (string $tdStyles)

string $tdStyles

Inherited Methods

Inherited From ResultPrinter

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