Summary: Field | Method | Constr Detail: Field | Method | Constr

FORMfields.fields.DescriptionField

Class DescriptionField

FormField
  |
  +--DescriptionField

public class DescriptionField
extends FormField

DescriptionField is a field that prints any HTML description and spans both the label and field value columns. This field is often used to provide instructions on how to complete a certain section of the form.

Since:: FORMfields v2.0

Field Summary
mixed	$data False since this field should not be considered data and the field value should not be read from a database and written to a database.

Field Summary

mixed

$data

False since this field should not be considered data and the field value should not be read from a database and written to a database.

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

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

Constructor Summary
DescriptionField(string name, string label) Creates new DescriptionField.
__construct(string name, string label) Creates new DescriptionField.

Constructor Summary

DescriptionField(string name, string label)

Creates new DescriptionField.

__construct(string name, string label)

Creates new DescriptionField.

Method Summary
string	getDisplayFieldTag(boolean displayHelp) Returns the HTML used to draw the display field.
string	getEditableFieldTag() Returns the HTML used to draw the edit field.
string	getFieldTag() Returns the HTML to display this field.

Method Summary

string

getDisplayFieldTag(boolean displayHelp)

Returns the HTML used to draw the display field.

string

getEditableFieldTag()

Returns the HTML used to draw the edit field.

string

getFieldTag()

Returns the HTML to display 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

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

Field Detail

data

public mixed $data = false

False since this field should not be considered data and the field value should not be read from a database and written to a database.

Since:: FORMfields v2.0

Constructor Detail

DescriptionField

public DescriptionField(string name, string label)

Creates new DescriptionField.

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.
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

__construct

public __construct(string name, string label)

Creates new DescriptionField.

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.
Since:: FORMfields v2.0

Method Detail

getDisplayFieldTag

public string getDisplayFieldTag(boolean displayHelp)

Returns the HTML used to draw the display field.

Returns:: the HTML used to draw the display field
Since:: FORMfields v2.0
Parameters:: displayHelp - true if the field help should be displayed

getEditableFieldTag

public string getEditableFieldTag()

Returns the HTML used to draw the edit field.

Returns:: the HTML used to draw the edit field
Since:: FORMfields v2.0

getFieldTag

public string getFieldTag()

Returns the HTML to display this field.

Returns:: the HTML to display this field
Since:: FORMfields v1.0

Frames No frames

Summary: Field | Method | Constr Detail: Field | Method | Constr