FORMfields.fields.SubmitField
Class SubmitField
FormField
|
+--SubmitField
public class SubmitField
extends FormField
- Since:
- FORMfields v1.0
Field Summary |
mixed |
$buttonListeners Callback classes that processes this button's click action. |
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 |
Constructor Summary |
SubmitField(string name, string label) Creates a new SubmitField. |
__construct(string name, string label) Creates a new SubmitField. |
Method Summary |
void |
addButtonListener(mixed buttonListener) Adds a callback class to processes this button's click action. |
boolean |
getButtonClicked() Returns true this button was clicked. |
string |
getDisplayFieldTag(boolean displayHelp) Returns the HTML used to display this field's value and
not within an input field. |
string |
getEditableFieldTag(mixed printId) Returns the HTML used to display the input portion 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 |
Field Detail
public mixed $buttonListeners = array()
Callback classes that processes this button's click action.
- Since:
- FORMfields v3.0
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 v1.0
Constructor Detail
SubmitField
public SubmitField(string name, string label)
Creates a new SubmitField.
- 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.
- 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 a new SubmitField.
- 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 v1.0
Method Detail
public void addButtonListener(mixed buttonListener)
Adds a callback class to processes this button's click action.
- Since:
- FORMfields v3.0
public boolean getButtonClicked()
Returns true this button was clicked.
- Returns:
- true if a submit button from this field was clicked
- Since:
- FORMfields v2.0
getDisplayFieldTag
public string getDisplayFieldTag(boolean displayHelp)
Returns the HTML used to display this field's value and
not within an input field.
- Returns:
- the HTML used to display this field's value
- Since:
- FORMfields v1.0
- Parameters:
- displayHelp - true if the field help should be displayed
getEditableFieldTag
public string getEditableFieldTag(mixed printId)
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
SubmitField is a submit button.