FORMfields


FORMfields.fields.ZipPlus4Field

Class ZipPlus4Field

FormField
|
+--ZipPlus4Field

public class ZipPlus4Field
extends FormField

ZipPlus4Field is a field for editing a full length American zip code of the form "XXXXX-YYYY". The ZipPlus4Field code was contributed by Mark Nance.

Since:
FORMfields v2.0

Field Summary
mixed

$p1

The sub field for the 1st part of the zip code.

mixed

$p2

The sub field for the 2nd part of the zip code.

mixed

$subFieldDisplayValueSeparator

The string used to separate the parts of the display value.

mixed

$subFieldSeparator

The string used to separate the sub fields.

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

ZipPlus4Field(string name, string label, int required)

Creates a new ZipPlus4Field.

__construct(string name, string label, int required)

Creates a new ZipPlus4Field.

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 zip code.

Since:
FORMfields v2.0

p2

public mixed $p2 = null

The sub field for the 2nd part of the zip code.

Since:
FORMfields v2.0

subFieldDisplayValueSeparator

public mixed $subFieldDisplayValueSeparator = "-"

The string used to separate the parts of the display value.

Since:
FORMfields v2.0

subFieldSeparator

public mixed $subFieldSeparator = " - "

The string used to separate the sub fields.

Since:
FORMfields v2.0

Constructor Detail

ZipPlus4Field

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

Creates a new ZipPlus4Field.

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 v2.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 - a full length Zip code in the form "XXXXXYYYY", where X and Y are digits
Since:
FORMfields v2.0

FORMfields