A checkbox field. More...

Inheritance diagram for HTMLCheckField:

Collaboration diagram for HTMLCheckField:

Public Member Functions
	getInputHTML ($value)
	This function must be implemented to return the HTML to generate the input object itself.
	getLabel ()
	For a checkbox, the label goes on the right hand side, and is added in getInputHTML(), rather than HTMLFormField::getRow()
	loadDataFromRequest ($request)
Protected Member Functions
	needsLabel ()
	checkboxes don't need a label.

Detailed Description

A checkbox field.

Definition at line 1921 of file HTMLForm.php.

Member Function Documentation

HTMLCheckField::getInputHTML ( $ value )

This function must be implemented to return the HTML to generate the input object itself.

It should not implement the surrounding table cells/rows, or labels/help messages.

Parameters:

string $value the value to set the input to; eg a default text for a text input.

Reimplemented from HTMLFormField.

Definition at line 1922 of file HTMLForm.php.

HTMLCheckField::getLabel ( )

For a checkbox, the label goes on the right hand side, and is added in getInputHTML(), rather than HTMLFormField::getRow()

Reimplemented from HTMLFormField.

Definition at line 1964 of file HTMLForm.php.

HTMLCheckField::loadDataFromRequest ( $ request )

Parameters:

$request WebRequest

Reimplemented from HTMLFormField.

Definition at line 1979 of file HTMLForm.php.

HTMLCheckField::needsLabel ( ) [protected]

checkboxes don't need a label.

Reimplemented from HTMLFormField.

Definition at line 1971 of file HTMLForm.php.

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