FORMfields

Frames No frames
Summary: Field | Method | Constr Detail: Field | Method | Constr
FORMfields.fields.TextAreaField

Class TextAreaField

FormField
  |
  +--TextField
       |
       +--TextAreaField

public class TextAreaField
extends TextField

TextAreaField is a field for editing multiple lines of text.

Since:
FORMfields v1.0
Field Summary
mixed

$cols

The number of columns or height of the text area.
mixed

$rows

The number of rows or width of the text area.
Fields inherited from FORMfields.fields.TextField
maxLength, minLength, size
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

TextAreaField(string name, string label, int required, int maxLength, int minLength, int rows, int cols)

Constructs a new TextAreaField.

__construct(string name, string label, int required, int maxLength, int minLength, int rows, int cols)

Constructs a new TextAreaField.
Method Summary
string

getEditableFieldTag()

Returns the HTML used to display the input portion of this field.
Methods inherited from FORMfields.fields.TextField
getEditableFieldTag, isValid
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

cols

public mixed $cols

The number of columns or height of the text area.

Since:
FORMfields v1.0

rows

public mixed $rows

The number of rows or width of the text area.

Since:
FORMfields v1.0

Constructor Detail

TextAreaField

public TextAreaField(string name, string label, int required, int maxLength, int minLength, int rows, int cols)

Constructs a new TextAreaField.

See Also:
FORMfields.fields.FormField#required
FORM_FIELD_REQUIRED
FORM_FIELD_NOT_REQUIRED
FORM_FIELD_LOOKS_REQUIRED
FORM_FIELD_REQUIRED_NO_LOOK
Parameters:
name - the name of the field
label - the field label
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
maxLength - the maximum permitted length of the text
minLength - the minimum permitted length of the text
rows - the number of rows or width of the text area
cols - the number of cols or height of the text area
Since:
FORMfields v1.0
Deprecated:
deprecated as constructor syntax is not expected in PHP 5 - will be removed once PHP 5 becomes a minimum requirement for FORMfields

Method Detail

getEditableFieldTag

public string getEditableFieldTag()

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

Returns:
the HTML used to display the input portion of this field
Since:
FORMfields v1.0

FORMfields

Frames No frames
Summary: Field | Method | Constr Detail: Field | Method | Constr