Docs For Class Bitmask

Description

a table of checkboxes for different options that are condensed into a single value by bitmask

Located in /inc/formslib/bitmask.php (line 43)

Field
   |
   --TextField
      |
      --Bitmask

Variable Summary

array $footer

boolean $includeSelectAll

integer $numcols

integer $numExtraInfoCols

CheckBoxTableList $select

boolean $showHideButtons

string $tableclass

array $tableHeading

string $tdlclass

string $tdrclass

string $trclass

Method Summary

Bitmask Bitmask (string $name, $title, [string $description = ''], $checkbox_description)

void displayInTable ([ $numCols = 3])

void set ( $value)

void setChecks ( $value)

void setTableHeadings (array $headings)

void setValuesArray (array $list, [ $idfield = 'id'], [ $valfield = 'iv'])

void update ( $data)

string wrapHTMLBuffer ( $contents)

void __clone ()

Variables

array $footer (line 65)

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

boolean $includeSelectAll = false (line 67)

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

integer $numcols = '' (line 51)

var: number of columns in the table

integer $numExtraInfoCols = '' (line 53)

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

CheckBoxTableList $select (line 48)

var: the actual check box list that will be shown

boolean $showHideButtons = false (line 45)

var: show "expand" and "collapse" links

string $tableclass = 'selectlist' (line 61)

var: html/css class for entire table

array $tableHeading (line 63)

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

string $tdlclass = 'itemL' (line 57)

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

string $tdrclass = 'checkBoxEntry' (line 59)

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

string $trclass = 'itemrow' (line 55)

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

Inherited Variables

Inherited from Field

Field::$attr
Field::$changed
Field::$DEBUG
Field::$defaultValue
Field::$description
Field::$duplicateName
Field::$editable
Field::$errorclass
Field::$hidden
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 Bitmask (line 75)

Create a new BitmaskPopup

Bitmask Bitmask (string $name, $title, [string $description = ''], $checkbox_description)

string $name: the name of the field (db name, and html field name
string $description: used in the html title of the list
$title
$checkbox_description

displayInTable (line 208)

void displayInTable ([ $numCols = 3])

$numCols

Redefinition of:

TextField::displayInTable()

set (line 145)

void set ( $value)

$value

Redefinition of:

Field::set(): set the value of this field

setChecks (line 155)

void setChecks ( $value)

$value

setTableHeadings (line 107)

Accessor method to set the table column headings

void setTableHeadings (array $headings)

array $headings: new headings to use for the table

setValuesArray (line 96)

Provides a set of values for the droplist rather than filling it from a db query

cf. ChoiceList::connectDB

void setValuesArray (array $list, [ $idfield = 'id'], [ $valfield = 'iv'])

array $list: List of label=>value pairs
$idfield
$valfield

update (line 113)

void update ( $data)

$data

Redefinition of:

Field::update(): update the value of the object with the user-supplied data in $data

wrapHTMLBuffer (line 172)

embed the html within a div to enable some creative js folding

return: html snippet that will open a new window with the html report

string wrapHTMLBuffer ( $contents)

$contents

__clone (line 235)

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:

Field::__clone(): PHP5 clone method

Inherited Methods

Inherited From TextField

TextField::TextField()
TextField::displayInTable()
TextField::hidden()
TextField::selectable()
TextField::selectedValue()
TextField::_textCleaner()

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