FORMfields


FORMfields.fields.EinField

Class EinField

FormField
|
+--EinField

public class EinField
extends FormField

EinField is a field for editing a Employer Identification Number.

Since:
FORMfields v3.0

Field Summary
mixed

$p1

The sub field for the 1st part of the EIN.

mixed

$p2

The sub field for the 2nd part of the EIN.

mixed

$subFieldDisplayValueSeparator

A string that separates parts of the display value.

mixed

$subFieldSeparator

A string that separates parts of the field.

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

EinField(string name, string label, int required)

Creates a new EinField.

__construct(string name, string label, int required)

Creates a new EinField.

Method Summary
void

setValue(string value)

Sets the value of this form 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

p1

public mixed $p1 = null

The sub field for the 1st part of the EIN.

Since:
FORMfields v3.0

p2

public mixed $p2 = null

The sub field for the 2nd part of the EIN.

Since:
FORMfields v3.0

subFieldDisplayValueSeparator

public mixed $subFieldDisplayValueSeparator = "-"

A string that separates parts of the display value.

Since:
FORMfields v3.0

subFieldSeparator

public mixed $subFieldSeparator = " - "

A string that separates parts of the field.

Since:
FORMfields v3.0

Constructor Detail

EinField

public EinField(string name, string label, int required)

Creates a new EinField.

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
See Also:
FORM_FIELD_REQUIRED
FORM_FIELD_NOT_REQUIRED
FORM_FIELD_LOOKS_REQUIRED
FORM_FIELD_REQUIRED_NO_LOOK
Since:
FORMfields v3.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

setValue

public void setValue(string value)

Sets the value of this form field.

Parameters:
value - the EIN in the format "XXXYYYYYY", where X and Y are digits
Since:
FORMfields v3.0

FORMfields