Docs For Class CheckBoxTableList

Description

a table of checkboxes for different options

Located in /inc/formslib/checkboxtablelist.php (line 30)

Field
   |
   --ChoiceList
      |
      --CheckBoxTableList

Variable Summary

array $boxMatrix

array $checkboxes

mixed $currentNumCols

mixed $currentRow

Field $followHidden

string $followHiddenField

array $footer

TextField $hidden

boolean $includeSelectAll

integer $numcols

integer $numExtraInfoCols

string $tableclass

array $tableHeading

string $tdlclass

string $tdrclass

string $trclass

array $valueList

Method Summary

CheckBoxTableList CheckBoxTableList (string $name, [string $description = ''], [integer $numExtraInfoCols = -1])

void addCheckBox (CheckBox $cb)

void addFollowHidden (Field $h, [string $follow = 'id'])

void addFooter (array $f)

void addSelectAllFooter (boolean $bool)

void display ()

void displayInTable ([ $numCols = 3])

void format ( $data)

void MakeBoxMatrix ([ $force = false])

void setTableHeadings (array $headings)

string _getSelectAllFooter (integer $col)

void __clone ()

Variables

array $boxMatrix = NULL (line 58)

var: of arary of checkboxes for individual customisation of boxes before display

array $checkboxes (line 46)

var: list of checkboxes (each checkbox added creates a new column)

mixed $currentNumCols (line 61)

mixed $currentRow (line 62)

Field $followHidden (line 48)

var: a hidden field that takes a different user-supplied value for each row in the table

string $followHiddenField (line 50)

var: the key in $data used to populated the $this->followHidden field

array $footer (line 54)

var: list of strings to be included in the footer of the table

TextField $hidden (line 52)

var: a hidden field that takes a programatically-generated value for each row in the table

Redefinition of:

Field::$hidden

boolean $includeSelectAll = false (line 56)

var: generate select/deselect links at the bottom of each column

integer $numcols = '' (line 32)

var: number of columns in the table

integer $numExtraInfoCols = '' (line 34)

var: number of extra columns to be added to the table

string $tableclass = 'selectlist' (line 42)

var: html/css class for entire table

array $tableHeading (line 44)

var: list of table headings to be put at the top of the table

string $tdlclass = 'itemL' (line 38)

var: html/css class for left-side table cell

string $tdrclass = 'checkBoxEntry' (line 40)

var: html/css class for right-side table cell

string $trclass = 'itemrow' (line 36)

var: html/css class for each row in the table

array $valueList = array() (line 60)

var: list of values thar are checked

Inherited Variables

Inherited from ChoiceList

ChoiceList::$deleted
ChoiceList::$extendable
ChoiceList::$formatid
ChoiceList::$formatter
ChoiceList::$list

Inherited from Field

Field::$attr
Field::$changed
Field::$DEBUG
Field::$defaultValue
Field::$description
Field::$duplicateName
Field::$editable
Field::$errorclass
Field::$isValid
Field::$isValidTest
Field::$longname
Field::$name
Field::$namebase
Field::$notifyIdChange
Field::$oob_errorMessage
Field::$oob_status
Field::$ovalue
Field::$required
Field::$requiredTwoStage
Field::$sqlHidden
Field::$suppressValidation
Field::$useNullValues
Field::$value
Field::$valueCleaner

Methods

Constructor CheckBoxTableList (line 71)

Create a new AnchorTableList

CheckBoxTableList CheckBoxTableList (string $name, [string $description = ''], [integer $numExtraInfoCols = -1])

string $name: the name of the field (db name, and html field name
string $description: used in the html title of the list
integer $numExtraInfoCols: (optional) number of *extra* columns in the table

addCheckBox (line 94)

Add a new column of checkboxes to the table

void addCheckBox (CheckBox $cb)

CheckBox $cb: checkbox Field to add

addFollowHidden (line 105)

Add an extra hidden field to each row to record further details about what the selections mean

void addFollowHidden (Field $h, [string $follow = 'id'])

Field $h: hidden field to replicate throughout table
string $follow: index in the $data provided to CheckBoxTableList::format to use for the field's value

addFooter (line 125)

Include an additional footer in the table

void addFooter (array $f)

array $f: array of fields to be included at the bottom of the table

addSelectAllFooter (line 116)

Toggle the creation of a footer with javascript select all/deselect all buttons

void addSelectAllFooter (boolean $bool)

boolean $bool: include the footer

display (line 191)

void display ()

Redefinition of:

ChoiceList::display()

displayInTable (line 200)

void displayInTable ([ $numCols = 3])

$numCols

Redefinition of:

ChoiceList::displayInTable(): Display the field inside a table

format (line 129)

void format ( $data)

$data

Redefinition of:

ChoiceList::format(): A test text-based format function for the object.

MakeBoxMatrix (line 178)

void MakeBoxMatrix ([ $force = false])

$force

setTableHeadings (line 85)

Accessor method to set the table column headings

void setTableHeadings (array $headings)

array $headings: new headings to use for the table

_getSelectAllFooter (line 270)

create a pair of select/deselect all quick buttons or links

return: html for links
todo: //TODO: include interface for groups of instruments.
uses: jsfunctions.php

string _getSelectAllFooter (integer $col)

integer $col: the column number to run the quick select sequence on.

__clone (line 280)

PHP5 clone method

PHP5 clone statement will perform only a shallow copy of the object. Any subobjects must also be cloned

void __clone ()

Redefinition of:

ChoiceList::__clone(): PHP5 clone method

Inherited Methods

Inherited From ChoiceList

ChoiceList::ChoiceList()
ChoiceList::append()
ChoiceList::connectDB()
ChoiceList::display()
ChoiceList::displayInTable()
ChoiceList::format()
ChoiceList::getValue()
ChoiceList::isValid()
ChoiceList::prepend()
ChoiceList::selectedValue()
ChoiceList::set()
ChoiceList::setDefault()
ChoiceList::setFormat()
ChoiceList::setValuesArray()
ChoiceList::sqlSetStr()
ChoiceList::text_dump()
ChoiceList::update()
ChoiceList::__clone()

Inherited From Field

Field::Field()
Field::display()
Field::displayInTable()
Field::getValue()
Field::hidden()
Field::isValid()
Field::log()
Field::selectable()
Field::selectedValue()
Field::set()
Field::setattr()
Field::setEditable()
Field::setNamebase()
Field::sqlSetStr()
Field::text_dump()
Field::update()
Field::__clone()