FormField
|
+--DropDownField
|
+--ListField
|
+--MultipleListField
|
+--SetSelectorField
public class SetSelectorField
extends MultipleListField
| Field Summary | |
|---|---|
| mixed | The sub field for the add button. |
| mixed | The sub field for the add button. |
| mixed | A string array of default options used in the superset list. |
| mixed | True if other options can be added to the subset list. |
| mixed | The sub field used for editing the other choice. |
| mixed | The sub field for the remove button |
| mixed | True if the sub list selection has changed since the last form data post. |
| mixed | The sub field for the subset list. |
| mixed | The sub field for the superset list. |
| Fields inherited from FORMfields.fields.MultipleListField | |
|---|---|
| maxSelections, minSelections, multiValues | |
| Constructor Summary | |
|---|---|
SetSelectorField(string name, string supersetLabel, string subsetLabel, array options, int height, mixed height2, int required, int maxSelections, int minSelections, boolean includeOtherChoice) Creates a new SetSelectorField. |
|
__construct(string name, string supersetLabel, string subsetLabel, array options, int height, mixed height2, int required, int maxSelections, int minSelections, boolean includeOtherChoice) Creates a new SetSelectorField. |
|
| Method Summary | |
|---|---|
| void | Adjust the values in the options and values arrays according to the selected values. |
| void | Sets this field's value to null. |
| string | getALabelTag(FormField formField) A static method that returns the HTML to display a form field label. |
| string | Returns the HTML used to display the input portion of this field. |
| void | Retrieves the posted field value. |
| void | setDbValue(string value) Sets the database value of this field. |
| void | setValue(array value) Sets the value of this field. |
| Methods inherited from FORMfields.fields.MultipleListField | |
|---|---|
| getEditableFieldTag, isValid | |
public mixed $add = null
The sub field for the add button.
public mixed $addOther = null
The sub field for the add button.
public mixed $defaultOptions = null
A string array of default options used in the superset list.
public mixed $includeOtherChoice = false
True if other options can be added to the subset list.
public mixed $otherChoice = null
The sub field used for editing the other choice.
public mixed $remove = null
The sub field for the remove button
public mixed $setChanged = false
True if the sub list selection has changed since the last form data post.
public mixed $subset = null
The sub field for the subset list.
public mixed $superset = null
The sub field for the superset list.
public SetSelectorField(string name, string supersetLabel, string subsetLabel, array options, int height, mixed height2, int required, int maxSelections, int minSelections, boolean includeOtherChoice)
Creates a new SetSelectorField. Note: The selectedOptions parameter was removed in v3.0. The default values should be set outside of this class. Remove height2 in next release.
public void adjustSuperset()
Adjust the values in the options and values arrays according to the selected values.
public void clearValue()
Sets this field's value to null. This includes setting the values of any sub fields.
public string getALabelTag(FormField formField)
A static method that returns the HTML to display a form field label.
public string getEditableFieldTag()
Returns the HTML used to display the input portion of this field.
public void getParameter()
Retrieves the posted field value. In other words, sets this field value using the appropriate values in $_REQUEST.
public void setDbValue(string value)
Sets the database value of this field. A database value can be different than the field's actual value. For example a phone number may have the value "973-746-3233" but its database value would be "9737463233"
public void setValue(array value)
Sets the value of this field.
SetSelectorField is a field for selecting a list of choices.