FORMfields


FORMfields.fields.ListBuilderField

Class ListBuilderField

FormField
|
+--DropDownField
|
+--ListField
|
+--MultipleListField
|
+--SetSelectorField
|
+--ListBuilderField

public class ListBuilderField
extends SetSelectorField

ListBuilderField is a field to edit a user supplied list.

Since:
FORMfields v3.0

Fields inherited from FORMfields.fields.SetSelectorField
add, addOther, defaultOptions, includeOtherChoice, otherChoice, remove, setChanged, subset, superset
Fields inherited from FORMfields.fields.MultipleListField
maxSelections, minSelections, multiValues
Constructor Summary

ListBuilderField(string name, string label, int required, int height, int maxSelections, int minSelections, array options)

Creates a new ListBuilderField.

__construct(string name, string label, int required, int height, int maxSelections, int minSelections, array options)

Creates a new ListBuilderField.

Method Summary
string

getEditableFieldTag()

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

Methods inherited from FORMfields.fields.SetSelectorField
adjustSuperset, clearValue, getALabelTag, getEditableFieldTag, getParameter, setDbValue, setValue
Methods inherited from FORMfields.fields.MultipleListField
getEditableFieldTag, isValid

Constructor Detail

ListBuilderField

public ListBuilderField(string name, string label, int required, int height, int maxSelections, int minSelections, array options)

Creates a new ListBuilderField.

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
options - a string array of options
height - the height or number of rows to display in both the superset and subset lists
maxSelections - The maximum number of slections that can be made
minSelections - The minimum number of slections that can be made if any selections were made
See Also:
FORM_FIELD_REQUIRED
FORM_FIELD_NOT_REQUIRED
FORM_FIELD_LOOKS_REQUIRED
FORM_FIELD_REQUIRED_NO_LOOK
Since:
FORMfields v1.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

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

FORMfields