Class CheckboxField

FormField
  |
  +--CheckboxField

public class CheckboxField
extends FormField

CheckboxField is a check box (yes or no) field.

Fields inherited from FORMfields.fields.FormField
autoPropagate, data, disableEnterHandler, displayValuesOnNewLine, editable, enabled, endingString, enterTabHandler, enterTabs, error, extraHtml, fieldBelowLabel, formError, help, hidden, htmlify, id, isData, label, labelForId, multiValues, name, required, subFieldDisplayValueSeparator, subFieldSeparator, subFieldValueSeparator, subFields, subFieldsCannotBeEmpty, trimWhitespace, validators, value, valueIsHtml

Fields inherited from FORMfields.fields.FormField

Constructor Summary
CheckboxField(string name, string label, int required) Creates a new CheckboxField.
__construct(string name, string label, int required) Creates a new CheckboxField.

Constructor Summary

CheckboxField(string name, string label, int required)

Creates a new CheckboxField.

__construct(string name, string label, int required)

Creates a new CheckboxField.

Method Summary
string	getDisplayValue() Returns the display value of this field.
string	getEditableFieldTag() Returns the HTML used to display the input portion of this field.
string	getLabelSimpleTag() Returns the HTML to display a basic label for the checkbox
string	getRawDbValue() Returns the raw database value of this field.

Methods inherited from FORMfields.fields.FormField
addFieldValidator, addSubField, checkForBlank, clearValue, disable, formatRequestParameter, formatText, getButtonClicked, getData, getDbValue, getDisableFieldJs, getDisableJs, getDisableLabelJs, getDisplayFieldTag, getDisplayHtmlValue, getDisplayLabelTag, getDisplayValue, getEditable, getEditableFieldTag, getEditableLabelTag, getEnabled, getError, getExtraHtml, getFieldTag, getFormError, getHelp, getHelpTag, getHidden, getHiddenFieldTag, getId, getIsData, getIsHidden, getLabel, getLabelHtml, getLabelTag, getName, getOrNull, getParameter, getRawDbValue, getRequired, getValue, isBlank, isEmpty, isValid, setAutoPropagate, setData, setDbValue, setDisplayValuesOnNewLine, setEditable, setEnabled, setEndingString, setError, setExtraHtml, setFieldBelowLabel, setFormError, setHelp, setHidden, setHtmlify, setId, setIsData, setIsHidden, setLabel, setName, setRequired, setTrimWhitespace, setValue, setValueIsHtml, validate

Methods inherited from FORMfields.fields.FormField

Constructor Detail

public CheckboxField(string name, string label, int required)

Creates a new CheckboxField.

Parameters:: name - the name of the form field. This value must not be a SQL reserved word and should follow all the standard variable naming conventions in PHP.; label - this form field's label. The label is the printable text that is typically displayed on the left side of the field.; required - Sets whether the field must be filled in and whether it looks like it must be filled in: FORM_FIELD_REQUIRED, FORM_FIELD_NOT_REQUIRED, FORM_FIELD_LOOKS_REQUIRED or FORM_FIELD_REQUIRED_NO_LOOK. Defaulted to FORM_FIELD_NOT_REQUIRED.
See Also:: FORM_FIELD_REQUIRED; FORM_FIELD_NOT_REQUIRED; FORM_FIELD_LOOKS_REQUIRED; FORM_FIELD_REQUIRED_NO_LOOK
Since:: FORMfields v2.0
Deprecated:: deprecated as this constructor syntax is not expected in PHP 5 - will be removed once PHP 5 becomes a minimum requirement for FORMfields

public string getDisplayValue()

Returns the display value of this field. The display value is either "True" or "False".

public string getEditableFieldTag()

Returns the HTML used to display the input portion of this field.

public string getLabelSimpleTag()

Returns the HTML to display a basic label for the checkbox

public string getRawDbValue()

Returns the raw database value of this field. The DB value is either "True" or null.