FORMfields


FORMfields.fields.CanadianProvinceField

Class CanadianProvinceField

FormField
|
+--DropDownField
|
+--CanadianProvinceField

public class CanadianProvinceField
extends DropDownField

CanadianProvinceField a drop down list of Canadian provinces.

Since:
FORMfields v1.0

Field Summary
mixed

$provinces

An array of full province names.

Fields inherited from FORMfields.fields.DropDownField
OR_STRING_MAX_SIZE, blankString, fieldEnabled, height, includeNewChoice, newChoice, options, subFieldsCannotBeEmpty, values
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

CanadianProvinceField(string name, string label, int required, string blankString)

Creates a new CanadianProvinceField.

__construct(string name, string label, int required, string blankString)

Creates a new CanadianProvinceField.

Methods inherited from FORMfields.fields.DropDownField
getEditableFieldTag, getParameter, setValue
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

provinces

public mixed $provinces = array("Alberta"

An array of full province names.

Since:
FORMfields v1.0

Constructor Detail

CanadianProvinceField

public CanadianProvinceField(string name, string label, int required, string blankString)

Creates a new CanadianProvinceField.

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
blankString - the default display value of the drop down field. Defaulted to a blank string.
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

FORMfields