Docs For Class PhpExt_Form

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

PhpExt_Form_TextField::$IsPassword

PhpExt_Component::$_layoutData

PhpExt_Component::$_ownerCollection

PhpExt_Component::$_plugins

PhpExt_Component::$_xType

Inherited From PhpExt_Observable

PhpExt_Observable::$_listeners

Inherited From PhpExt_Object

PhpExt_Object::$_extClassName

PhpExt_Object::$_extConfigProperties

PhpExt_Object::$_validExtConfigProperties

PhpExt_Object::$_varName

Inherited From PhpExt_Form_ComboBox

PhpExt_Form_ComboBox::__construct()

PhpExt_Form_ComboBox::createComboBox()

Helper function to create a ComboBox. Useful for quick adding it to a ComponentCollection

PhpExt_Form_ComboBox::getAllQuery()

The text query to send to the server to return all records for the list with no filtering (defaults to '')

PhpExt_Form_ComboBox::getAutoCreate()

A DomHelper element spec, or true for a default element spec (defaults to: {tag: "input", type: "text", size: "24", autocomplete: "off"})

PhpExt_Form_ComboBox::getDisplayField()

The underlying data field name to bind to this ComboBox (defaults to undefined if mode = {@ling PhpExt_Form_ComboBox::MODE_REMOTE} or 'text' if transforming a select)

PhpExt_Form_ComboBox::getEditable()

False to prevent the user from typing text directly into the field, just like a traditional select (defaults to true)

PhpExt_Form_ComboBox::getForceSelection()

True to restrict the selected value to one of the values in the list, false to allow the user to set arbitrary text into the field (defaults to false)

PhpExt_Form_ComboBox::getHandleHeight()

The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)

PhpExt_Form_ComboBox::getHiddenName()

If specified, a hidden form field with this name is dynamically generated to store the field's data value (defaults to the underlying DOM element's name). Required for the combo's value to automatically post during a form submission.

PhpExt_Form_ComboBox::getItemCssSelector()

A CSS selector in any format supported by Ext.DomQuery that will be used to determine what nodes this DataView will be working with.

PhpExt_Form_ComboBox::getLazyInit()

True to not initialize the list for this combo until the field is focused. (defaults to true)

PhpExt_Form_ComboBox::getLazyRender()

True to prevent the ComboBox from rendering until requested (should always be used when rendering into an Ext.Editor, defaults to false)

PhpExt_Form_ComboBox::getListAlign()

A valid anchor position value. See Ext.Element.alignTo for details on supported anchor positions (defaults to 'tl-bl')

PhpExt_Form_ComboBox::getListCssClass()

CSS class to apply to the dropdown list element (defaults to '')

PhpExt_Form_ComboBox::getListWidth()

The width in pixels of the dropdown list (defaults to the width of the ComboBox field)

PhpExt_Form_ComboBox::getLoadingText()

The text to display in the dropdown list while data is loading. Only applies when mode = {@ling PhpExt_Form_ComboBox::MODE_REMOTE} (defaults to 'Loading...')

PhpExt_Form_ComboBox::getMaxHeight()

The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)

PhpExt_Form_ComboBox::getMinChars()

The minimum number of characters the user must type before autocomplete and typeahead activate (defaults to 4 if remote or 0 if local, does not apply if editable = false)

PhpExt_Form_ComboBox::getMinListWidth()

The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if listWidth has a higher value)

PhpExt_Form_ComboBox::getMode()

Set to PhpExt_Form_ComboBox::MODE_LOCAL if the ComboBox loads local data (defaults to PhpExt_Form_ComboBox::MODE_REMOTE which loads from the server)

PhpExt_Form_ComboBox::getMultiSelect()

True to allow selection of more than one item at a time, false to allow selection of only a single item at a time or no selection at all, depending on the value of singleSelect (defaults to false).

PhpExt_Form_ComboBox::getOverCssClass()

A CSS class to apply to each item in the view on mouseover (defaults to undefined).

PhpExt_Form_ComboBox::getPageSize()

If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the filter queries will execute with page start and limit parameters. Only applies when mode = PhpExt_Form_ComboBox::MODE_REMOTE (defaults to 0)

PhpExt_Form_ComboBox::getQueryDelay()

The length of time in milliseconds to delay between the start of typing and sending the query to filter the dropdown list (defaults to 500 if mode = PhpExt_Form_ComboBox::MODE_REMOTE or 10 if mode = PhpExt_Form_ComboBox::MODE_LOCAL)

PhpExt_Form_ComboBox::getQueryParam()

Name of the query as it will be passed on the querystring (defaults to 'query')

PhpExt_Form_ComboBox::getResizable()

True to add a resize handle to the bottom of the dropdown list (defaults to false)

PhpExt_Form_ComboBox::getSelectedCssClass()

CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')

PhpExt_Form_ComboBox::getSelectOnFocus()

True to select any existing text in the field immediately on focus. Only applies when editable = true (defaults to false)

PhpExt_Form_ComboBox::getShadow()

True or PhpExt_Shadow::MODE_SIDES for the default effect, PhpExt_Shadow::MODE_FRAME for 4-way shadow, and PhpExt_Shadow::MODE_DROP for bottom-right

PhpExt_Form_ComboBox::getSimpleSelect()

True to enable multiselection by clicking on multiple items without requiring the user to hold Shift or Ctrl, false to force the user to hold Ctrl or Shift to select more than on item (defaults to false).

PhpExt_Form_ComboBox::getSingleSelect()

True to allow selection of exactly one item at a time, false to allow no selection at all (defaults to false). Note that if multiSelect = true, this value will be ignored.

PhpExt_Form_ComboBox::getStore()

The data store to which this combo is bound (defaults to undefined)

PhpExt_Form_ComboBox::getTemplate()

The template string, or PhpExt_XTemplate instance to use to display each item in the dropdown list. Use this to create custom UI layouts for items in the list.

PhpExt_Form_ComboBox::getTitle()

If supplied, a header element is created containing this text and added into the top of the dropdown list (defaults to undefined, with no header element)

PhpExt_Form_ComboBox::getTransform()

The id, DOM node or element of an existing select to convert to a ComboBox

PhpExt_Form_ComboBox::getTriggerAction()

PhpExt_Form_ComboBox::getTriggerCssClass()

An additional CSS class used to style the trigger button. The trigger will always get the class 'x-form-trigger' and triggerClass will be <em>appended</em> if specified (defaults to 'x-form-arrow-trigger' which displays a downward arrow icon).

PhpExt_Form_ComboBox::getTypeAhead()

True to populate and autoselect the remainder of the text being typed after a configurable delay (typeAheadDelay) if it matches a known value (defaults to false)

PhpExt_Form_ComboBox::getTypeAheadDelay()

The length of time in milliseconds to wait until the typeahead text is displayed if typeAhead = true (defaults to 250)

PhpExt_Form_ComboBox::getValueField()

The underlying data value name to bind to this ComboBox (defaults to undefined if mode = PhpExt_Form_ComboBox::MODE_REMOTE or 'value' if transforming a select) Note: use of a valueField requires the user to make a selection in order for a value to be mapped.

PhpExt_Form_ComboBox::getValueNotFoundText()

When using a name/value combo, if the value passed to setValue is not found in the store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)

PhpExt_Form_ComboBox::setAllQuery()

The text query to send to the server to return all records for the list with no filtering (defaults to '')

PhpExt_Form_ComboBox::setAutoCreate()

A DomHelper element spec, or true for a default element spec (defaults to: {tag: "input", type: "text", size: "24", autocomplete: "off"})

PhpExt_Form_ComboBox::setDisplayField()

The underlying data field name to bind to this ComboBox (defaults to undefined if mode = {@ling PhpExt_Form_ComboBox::MODE_REMOTE} or 'text' if transforming a select)

PhpExt_Form_ComboBox::setEditable()

False to prevent the user from typing text directly into the field, just like a traditional select (defaults to true)

PhpExt_Form_ComboBox::setForceSelection()

True to restrict the selected value to one of the values in the list, false to allow the user to set arbitrary text into the field (defaults to false)

PhpExt_Form_ComboBox::setHandleHeight()

The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)

PhpExt_Form_ComboBox::setHiddenName()

If specified, a hidden form field with this name is dynamically generated to store the field's data value (defaults to the underlying DOM element's name). Required for the combo's value to automatically post during a form submission.

PhpExt_Form_ComboBox::setItemCssSelector()

A CSS selector in any format supported by Ext.DomQuery that will be used to determine what nodes this DataView will be working with.

PhpExt_Form_ComboBox::setLazyInit()

True to not initialize the list for this combo until the field is focused. (defaults to true)

PhpExt_Form_ComboBox::setLazyRender()

True to prevent the ComboBox from rendering until requested (should always be used when rendering into an Ext.Editor, defaults to false)

PhpExt_Form_ComboBox::setListAlign()

A valid anchor position value. See Ext.Element.alignTo for details on supported anchor positions (defaults to 'tl-bl')

PhpExt_Form_ComboBox::setListCssClass()

CSS class to apply to the dropdown list element (defaults to '')

PhpExt_Form_ComboBox::setListWidth()

The width in pixels of the dropdown list (defaults to the width of the ComboBox field)

PhpExt_Form_ComboBox::setLoadingText()

The text to display in the dropdown list while data is loading. Only applies when mode = {@ling PhpExt_Form_ComboBox::MODE_REMOTE} (defaults to 'Loading...')

PhpExt_Form_ComboBox::setMaxHeight()

The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)

PhpExt_Form_ComboBox::setMinChars()

The minimum number of characters the user must type before autocomplete and typeahead activate (defaults to 4 if remote or 0 if local, does not apply if editable = false)

PhpExt_Form_ComboBox::setMinListWidth()

The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if listWidth has a higher value)

PhpExt_Form_ComboBox::setMode()

Set to PhpExt_Form_ComboBox::MODE_LOCAL if the ComboBox loads local data (defaults to PhpExt_Form_ComboBox::MODE_REMOTE which loads from the server)

PhpExt_Form_ComboBox::setMultiSelect()

True to allow selection of more than one item at a time, false to allow selection of only a single item at a time or no selection at all, depending on the value of singleSelect (defaults to false).

PhpExt_Form_ComboBox::setOverCssClass()

A CSS class to apply to each item in the view on mouseover (defaults to undefined).

PhpExt_Form_ComboBox::setPageSize()

If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the filter queries will execute with page start and limit parameters. Only applies when mode = PhpExt_Form_ComboBox::MODE_REMOTE (defaults to 0)

PhpExt_Form_ComboBox::setQueryDelay()

The length of time in milliseconds to delay between the start of typing and sending the query to filter the dropdown list (defaults to 500 if mode = PhpExt_Form_ComboBox::MODE_REMOTE or 10 if mode = PhpExt_Form_ComboBox::MODE_LOCAL)

PhpExt_Form_ComboBox::setQueryParam()

Name of the query as it will be passed on the querystring (defaults to 'query')

PhpExt_Form_ComboBox::setResizable()

True to add a resize handle to the bottom of the dropdown list (defaults to false)

PhpExt_Form_ComboBox::setSelectedCssClass()

CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')

PhpExt_Form_ComboBox::setSelectOnFocus()

True to select any existing text in the field immediately on focus. Only applies when editable = true (defaults to false)

PhpExt_Form_ComboBox::setShadow()

True or PhpExt_Shadow::MODE_SIDES for the default effect, PhpExt_Shadow::MODE_FRAME for 4-way shadow, and PhpExt_Shadow::MODE_DROP for bottom-right

PhpExt_Form_ComboBox::setSimpleSelect()

True to enable multiselection by clicking on multiple items without requiring the user to hold Shift or Ctrl, false to force the user to hold Ctrl or Shift to select more than on item (defaults to false).

PhpExt_Form_ComboBox::setSingleSelect()

True to allow selection of exactly one item at a time, false to allow no selection at all (defaults to false). Note that if multiSelect = true, this value will be ignored.

PhpExt_Form_ComboBox::setStore()

The data store to which this combo is bound (defaults to undefined)

PhpExt_Form_ComboBox::setTemplate()

The template string, or PhpExt_XTemplate instance to use to display each item in the dropdown list. Use this to create custom UI layouts for items in the list.

PhpExt_Form_ComboBox::setTitle()

If supplied, a header element is created containing this text and added into the top of the dropdown list (defaults to undefined, with no header element)

PhpExt_Form_ComboBox::setTransform()

The id, DOM node or element of an existing select to convert to a ComboBox

PhpExt_Form_ComboBox::setTriggerAction()

The action to execute when the trigger field is activated. Use PhpExt_Form_ComboBox::TRIGGER_ACTION_ALL to run the query specified by the allQuery config option (defaults to PhpExt_Form_ComboBox::TRIGGER_ACTION_QUERY)

PhpExt_Form_ComboBox::setTriggerCssClass()

An additional CSS class used to style the trigger button. The trigger will always get the class 'x-form-trigger' and triggerClass will be <em>appended</em> if specified (defaults to 'x-form-arrow-trigger' which displays a downward arrow icon).

PhpExt_Form_ComboBox::setTypeAhead()

True to populate and autoselect the remainder of the text being typed after a configurable delay (typeAheadDelay) if it matches a known value (defaults to false)

PhpExt_Form_ComboBox::setTypeAheadDelay()

The length of time in milliseconds to wait until the typeahead text is displayed if typeAhead = true (defaults to 250)

PhpExt_Form_ComboBox::setValueField()

The underlying data value name to bind to this ComboBox (defaults to undefined if mode = PhpExt_Form_ComboBox::MODE_REMOTE or 'value' if transforming a select) Note: use of a valueField requires the user to make a selection in order for a value to be mapped.

PhpExt_Form_ComboBox::setValueNotFoundText()

When using a name/value combo, if the value passed to setValue is not found in the store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)

Inherited From PhpExt_Form_TriggerField

PhpExt_Form_TriggerField::__construct()

PhpExt_Form_TriggerField::createTriggerField()

Helper function to create a TriggerField. Useful for quick adding it to a ComponentCollection

PhpExt_Form_TriggerField::getAutoCreate()

A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "16", autocomplete: "off"})

PhpExt_Form_TriggerField::getHideTrigger()

True to hide the trigger element and display only the base text field (defaults to false)

PhpExt_Form_TriggerField::getTriggerCssClass()

A CSS class to apply to the trigger

PhpExt_Form_TriggerField::setAutoCreate()

A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "16", autocomplete: "off"})

PhpExt_Form_TriggerField::setHideTrigger()

True to hide the trigger element and display only the base text field (defaults to false)

PhpExt_Form_TriggerField::setTriggerCssClass()

A CSS class to apply to the trigger

Inherited From PhpExt_Form_TextField

PhpExt_Form_TextField::__construct()

PhpExt_Form_TextField::createTextField()

Helper function to create a TextField. Useful for quick adding it to a ComponentCollection

PhpExt_Form_TextField::getAllowBlank()

False to validate that the value length > 0 (defaults to true)

PhpExt_Form_TextField::getBlankText()

Error text to display if the allow blank validation fails (defaults to "This field is required")

PhpExt_Form_TextField::getDisableKeyFilter()

True to disable input keystroke filtering (defaults to false)

PhpExt_Form_TextField::getEmptyCssClass()

The CSS class to apply to an empty field to style the emptyText (defaults to 'x-form-empty-field'). This class is automatically added and removed as needed depending on the current field value.

PhpExt_Form_TextField::getEmptyText()

The default text to display in an empty field (defaults to null).

PhpExt_Form_TextField::getGrow()

True if this field should automatically grow and shrink to its content

PhpExt_Form_TextField::getGrowMax()

The maximum width to allow when grow = true (defaults to 800)

PhpExt_Form_TextField::getGrowMin()

The minimum width to allow when grow = true (defaults to 30)

PhpExt_Form_TextField::getMaskRegEx()

An input mask regular expression (Javascript RegEx) that will be used to filter keystrokes that don't match (defaults to null)

PhpExt_Form_TextField::getMaxLength()

Maximum input field length allowed (defaults to Number.MAX_VALUE)

PhpExt_Form_TextField::getMaxLengthText()

Error text to display if the maximum length validation fails (defaults to "The maximum length for this field is {maxLength}")

PhpExt_Form_TextField::getMinLength()

Minimum input field length required (defaults to 0)

PhpExt_Form_TextField::getMinLengthText()

Error text to display if the minimum length validation fails (defaults to "The minimum length for this field is {minLength}")

PhpExt_Form_TextField::getRegEx()

A JavaScript RegExp object to be tested against the field value during validation (defaults to null). If available, this regex will be evaluated only after the basic validators all return true, and will be passed the current field value. If the test fails, the field will be marked invalid using regexText.

PhpExt_Form_TextField::getRegExText()

The error text to display if regex is used and the test fails during validation (defaults to "")

PhpExt_Form_TextField::getSelectOnFocus()

True to automatically select any existing field text when the field receives input focus (defaults to false)

PhpExt_Form_TextField::getValidator()

A custom validation function to be called during field validation (defaults to null). If available, this function will be called only after the basic validators all return true, and will be passed the current field value and expected to return boolean true if the value is valid or a string error message if invalid.

PhpExt_Form_TextField::getVType()

A validation type name as defined in PhpExt_Form_FormPanel (defaults to null). Posible values are:

PhpExt_Form_TextField::getVTypeText()

A custom error message to display in place of the default message provided for the vtype currently set for this field (defaults to ''). Only applies if vtype is set, else ignored.

PhpExt_Form_TextField::setAllowBlank()

False to validate that the value length > 0 (defaults to true)

PhpExt_Form_TextField::setBlankText()

Error text to display if the allow blank validation fails (defaults to "This field is required")

PhpExt_Form_TextField::setDisableKeyFilter()

True to disable input keystroke filtering (defaults to false)

PhpExt_Form_TextField::setEmptyCssClass()

The CSS class to apply to an empty field to style the emptyText (defaults to 'x-form-empty-field'). This class is automatically added and removed as needed depending on the current field value.

PhpExt_Form_TextField::setEmptyText()

The default text to display in an empty field (defaults to null).

PhpExt_Form_TextField::setGrow()

True if this field should automatically grow and shrink to its content

PhpExt_Form_TextField::setGrowMax()

The maximum width to allow when grow = true (defaults to 800)

PhpExt_Form_TextField::setGrowMin()

The minimum width to allow when grow = true (defaults to 30)

PhpExt_Form_TextField::setMaskRegEx()

An input mask regular expression (Javascript RegEx) that will be used to filter keystrokes that don't match (defaults to null)

PhpExt_Form_TextField::setMaxLength()

Maximum input field length allowed (defaults to Number.MAX_VALUE)

PhpExt_Form_TextField::setMaxLengthText()

Error text to display if the maximum length validation fails (defaults to "The maximum length for this field is {maxLength}")

PhpExt_Form_TextField::setMinLength()

Minimum input field length required (defaults to 0)

PhpExt_Form_TextField::setMinLengthText()

Error text to display if the minimum length validation fails (defaults to "The minimum length for this field is {minLength}")

PhpExt_Form_TextField::setRegEx()

A JavaScript RegExp object to be tested against the field value during validation (defaults to null). If available, this regex will be evaluated only after the basic validators all return true, and will be passed the current field value. If the test fails, the field will be marked invalid using regexText.

PhpExt_Form_TextField::setRegExText()

The error text to display if regex is used and the test fails during validation (defaults to "")

PhpExt_Form_TextField::setSelectOnFocus()

True to automatically select any existing field text when the field receives input focus (defaults to false)

PhpExt_Form_TextField::setValidator()

A custom validation function to be called during field validation (defaults to null). If available, this function will be called only after the basic validators all return true, and will be passed the current field value and expected to return boolean true if the value is valid or a string error message if invalid.

PhpExt_Form_TextField::setVType()

A validation type name as defined in PhpExt_Form_FormPanel (defaults to null). Posible values are:

PhpExt_Form_TextField::setVTypeText()

A custom error message to display in place of the default message provided for the vtype currently set for this field (defaults to ''). Only applies if vtype is set, else ignored.

Inherited From PhpExt_Form_Field

PhpExt_Form_Field::__construct()

PhpExt_Form_Field::getAutoCreate()

A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "20", autocomplete: "off"})

PhpExt_Form_Field::getClearCssClass()

The CSS class used to provide field clearing (defaults to 'x-form-clear-left')

PhpExt_Form_Field::getCssClass()

A CSS class to apply to the field's underlying element.

PhpExt_Form_Field::getDisabled()

True to disable the field (defaults to false).

PhpExt_Form_Field::getFieldCssClass()

The default CSS class for the field (defaults to "x-form-field")

PhpExt_Form_Field::getFieldLabel()

The label text to display next to this field (defaults to '')

PhpExt_Form_Field::getFocusCssClass()

The CSS class to use when the field receives focus (defaults to "x-form-focus")

PhpExt_Form_Field::getHideLabel()

True to completely hide the label element (defaults to false)

PhpExt_Form_Field::getInputType()

The type attribute for input fields -- e.g. radio, text, password (defaults to "text").

PhpExt_Form_Field::getInvalidCssClass()

The CSS class to use when marking a field invalid (defaults to "x-form-invalid")

PhpExt_Form_Field::getInvalidText()

The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid")

PhpExt_Form_Field::getItemCssClass()

An additional CSS class to apply to this field (defaults to the container's itemCls value if set, or '')

PhpExt_Form_Field::getLabelCssStyle()

A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if set, or ''). For example: 'font-weight:bold;'.

PhpExt_Form_Field::getLabelSeparator()

The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.labelSeparator, which is a colon ':' by default). To display no separator for this field's label specify empty string ''.

PhpExt_Form_Field::getMsgFx()

Experimental The effect used when displaying a validation message under the field (defaults to 'normal').

PhpExt_Form_Field::getMsgTarget()

The location where error text should display. Should be one of the following values (defaults to 'qtip'):

PhpExt_Form_Field::getName()

The field's HTML name attribute.

PhpExt_Form_Field::getReadOnly()

True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.

PhpExt_Form_Field::getTabIndex()

The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).

PhpExt_Form_Field::getValidateOnBlur()

Whether the field should validate when it loses focus (defaults to true).

PhpExt_Form_Field::getValidationDelay()

The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)

PhpExt_Form_Field::getValidationEvent()

The event that should initiate field validation. Set to false to disable automatic validation (defaults to "keyup").

PhpExt_Form_Field::getValue()

A value to initialize this field with.

PhpExt_Form_Field::setAutoCreate()

A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "20", autocomplete: "off"})

PhpExt_Form_Field::setClearCssClass()

The CSS class used to provide field clearing (defaults to 'x-form-clear-left')

PhpExt_Form_Field::setCssClass()

A CSS class to apply to the field's underlying element.

PhpExt_Form_Field::setDisabled()

True to disable the field (defaults to false).

PhpExt_Form_Field::setFieldCssClass()

The default CSS class for the field (defaults to "x-form-field")

PhpExt_Form_Field::setFieldLabel()

The label text to display next to this field (defaults to '')

PhpExt_Form_Field::setFocusCssClass()

The CSS class to use when the field receives focus (defaults to "x-form-focus")

PhpExt_Form_Field::setHideLabel()

True to completely hide the label element (defaults to false)

PhpExt_Form_Field::setInputType()

The type attribute for input fields -- e.g. radio, text, password (defaults to "text").

PhpExt_Form_Field::setInvalidCssClass()

The CSS class to use when marking a field invalid (defaults to "x-form-invalid")

PhpExt_Form_Field::setInvalidText()

The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid")

PhpExt_Form_Field::setItemCssClass()

An additional CSS class to apply to this field (defaults to the container's itemCls value if set, or '')

PhpExt_Form_Field::setLabelCssStyle()

A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if set, or ''). For example: 'font-weight:bold;'.

PhpExt_Form_Field::setLabelSeparator()

The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.labelSeparator, which is a colon ':' by default). To display no separator for this field's label specify empty string ''.

PhpExt_Form_Field::setMsgFx()

Experimental The effect used when displaying a validation message under the field (defaults to 'normal').

PhpExt_Form_Field::setMsgTarget()

The location where error text should display. Should be one of the following values (defaults to 'qtip'):

PhpExt_Form_Field::setName()

The field's HTML name attribute.

PhpExt_Form_Field::setReadOnly()

True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.

PhpExt_Form_Field::setTabIndex()

The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).

PhpExt_Form_Field::setValidateOnBlur()

Whether the field should validate when it loses focus (defaults to true).

PhpExt_Form_Field::setValidationDelay()

The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)

PhpExt_Form_Field::setValidationEvent()

The event that should initiate field validation. Set to false to disable automatic validation (defaults to "keyup").

PhpExt_Form_Field::setValue()

A value to initialize this field with.

Inherited From PhpExt_BoxComponent

PhpExt_BoxComponent::__construct()

PhpExt_BoxComponent::getAutoHeight()

True to use height:'auto', false to use fixed height (defaults to false).

PhpExt_BoxComponent::getAutoWidth()

True to use width:'auto', false to use fixed width (defaults to false).

PhpExt_BoxComponent::getHeight()

The height of this component in pixels (defaults to auto).

PhpExt_BoxComponent::getWidth()

The width of this component in pixels (defaults to auto).

PhpExt_BoxComponent::setAutoHeight()

True to use height:'auto', false to use fixed height (defaults to false).

PhpExt_BoxComponent::setAutoWidth()

True to use width:'auto', false to use fixed width (defaults to false).

PhpExt_BoxComponent::setHeight()

The height of this component in pixels (defaults to auto).

PhpExt_BoxComponent::setWidth()

The width of this component in pixels (defaults to auto).

Inherited From PhpExt_Component

PhpExt_Component::__construct()

** Overrides ***

PhpExt_Component::getAllowDomMove()

Whether the component can move the Dom node when rendering (defaults to true).

PhpExt_Component::getApplyTo()

The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component. When applyTo is used, constituent parts of the component can also be specified by id or CSS class name within the main element, and the component being created may attempt to create its subcomponents from that markup if applicable. Using this config, a call to render() is not required. If applyTo is specified, any value passed for renderTo will be ignored and the target element's parent node will automatically be used as the component's container.

PhpExt_Component::getAutoShow()

True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render (defaults to false).

PhpExt_Component::getConfigParams()

PhpExt_Component::getContainerCssClass()

An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.

PhpExt_Component::getCssClass()

An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules.

PhpExt_Component::getCssStyle()

A custom style specification to be applied to this component's Element.

PhpExt_Component::getDisabledCssClass()

CSS class added to the component when it is disabled (defaults to "x-item-disabled").

PhpExt_Component::getEl()

The DOM element to which this component show be rendered to. This should be used instead of renderTo or applyTo if using lazy render.

PhpExt_Component::getHideMode()

How this component should hidden. Supported values are
PhpExt_Component::HIDE_MODE_VISIBILITY

(css visibility),
PhpExt_Component::HIDE_MODE_OFFSETS

(negative offset position) and
PhpExt_Component::HIDE_MODE_DISPLAY

(css display) - defaults to
PhpExt_Component::HIDE_MODE_DISPLAY

.

PhpExt_Component::getHideParent()

True to hide and show the component's container when hide/show is called on the component, false to hide and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide button on a window by setting hide:true on the button when adding it to its parent container.

PhpExt_Component::getId()

The unique id of this component (defaults to an auto-assigned id).

PhpExt_Component::getLayoutData()

PhpExt_Component::getOwnerCollection()

PhpExt_Component::getPlugins()

An object or array of objects that will provide custom functionality for this component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.

PhpExt_Component::getRenderTo()

The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required.

PhpExt_Component::render()

** Ext Object Methods ***

PhpExt_Component::setAllowDomMove()

Whether the component can move the Dom node when rendering (defaults to true).

PhpExt_Component::setApplyTo()

The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component. When applyTo is used, constituent parts of the component can also be specified by id or CSS class name within the main element, and the component being created may attempt to create its subcomponents from that markup if applicable. Using this config, a call to render() is not required. If applyTo is specified, any value passed for renderTo will be ignored and the target element's parent node will automatically be used as the component's container.

PhpExt_Component::setAutoShow()

True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render (defaults to false).

PhpExt_Component::setContainerCssClass()

An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.

PhpExt_Component::setCssClass()

An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules.

PhpExt_Component::setCssStyle()

A custom style specification to be applied to this component's Element.

PhpExt_Component::setDisabledCssClass()

CSS class added to the component when it is disabled (defaults to "x-item-disabled").

PhpExt_Component::setEl()

The DOM element to which this component show be rendered to. This should be used instead of renderTo or applyTo if using lazy render.

PhpExt_Component::setExtClassInfo()

PhpExt_Component::setHideMode()

How this component should hidden. Supported values are
PhpExt_Component::HIDE_MODE_VISIBILITY

(css visibility),
PhpExt_Component::HIDE_MODE_OFFSETS

(negative offset position) and
PhpExt_Component::HIDE_MODE_DISPLAY

(css display) - defaults to
PhpExt_Component::HIDE_MODE_DISPLAY

.

PhpExt_Component::setHideParent()

True to hide and show the component's container when hide/show is called on the component, false to hide and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide button on a window by setting hide:true on the button when adding it to its parent container.

PhpExt_Component::setId()

The unique id of this component (defaults to an auto-assigned id).

PhpExt_Component::setLayoutData()

Layout specific properties for the corresponding layout of the container.

PhpExt_Component::setOwnerCollection()

PhpExt_Component::setRenderTo()

The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required.

Inherited From PhpExt_Observable

PhpExt_Observable::__construct()

PhpExt_Observable::attachListener()

Adds a PhpExt_Listener to the specified $eventName. This lintener will execute when the Javascript object fires that event.

PhpExt_Observable::getConfigParams()

PhpExt_Observable::getListeners()

Inherited From PhpExt_Object

PhpExt_Object::__construct()

PhpExt_Object::addValidConfigProperties()

PhpExt_Object::createMethodSignature()

PhpExt_Object::getConfigParams()

PhpExt_Object::getExtConfigProperty()

PhpExt_Object::getJavascript()

PhpExt_Object::getMethodInvokeStm()

PhpExt_Object::isExtObject()

PhpExt_Object::paramToString()

PhpExt_Object::setExtClassInfo()

PhpExt_Object::setExtConfigProperty()

PhpExt_Object::__get()

PhpExt_Object::__set()

Inherited From PhpExt_Form_ComboBox

PhpExt_Form_ComboBox::MODE_LOCAL

PhpExt_Form_ComboBox::MODE_REMOTE

PhpExt_Form_ComboBox::SHADOW_DROP

PhpExt_Form_ComboBox::SHADOW_FRAME

PhpExt_Form_ComboBox::SHADOW_SIDES

PhpExt_Form_ComboBox::TRIGGER_ACTION_ALL

PhpExt_Form_ComboBox::TRIGGER_ACTION_QUERY

Inherited From PhpExt_Component

PhpExt_Component::HIDE_MODE_DISPLAY

PhpExt_Component::HIDE_MODE_OFFSETS

PhpExt_Component::HIDE_MODE_VISIBILITY

[ Top ]

Methods

static method createTimeField [line 195]

static PhpExt_Form_TimeField createTimeField(
string
$name, [string
$label = null], [string
$id = null] 
)

Helper function to create a TimeField. Useful for quick adding it to a ComponentCollection

Parameters:

string	$name:	The field's HTML name attribute.
string	$label:	The label text to display next to this field (defaults to '')
string	$id:	The unique id of this component (defaults to an auto-assigned id).

API Tags:

Access:

public

[ Top ]

Constructor __construct [line 170]

PhpExt_Form_TimeField __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Form_ComboBox::__construct()

[ Top ]

getAltFormats [line 40]

string getAltFormats(
)

Multiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined format (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').

API Tags:

Access:

public

[ Top ]

getFormat [line 58]

string getFormat(
)

The default date format string which can be overriden for localization support. The format must be valid according to Date.parseDate (defaults to 'm/d/y').

API Tags:

Access:

public

[ Top ]

getIncrement [line 76]

integer getIncrement(
)

The number of minutes between each time value in the list (defaults to 15).

API Tags:

Access:

public

[ Top ]

getInvalidText [line 94]

string getInvalidText(
)

The error text to display when the time in the field is invalid (defaults to '{value} is not a valid time - it must be in the format {format}').

API Tags:

Access:

public

Redefinition of:

PhpExt_Form_Field::getInvalidText(): The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid")

[ Top ]

getMaxText [line 112]

string getMaxText(
)

The error text to display when the time is after maxValue (defaults to 'The time in this field must be equal to or before {0}').

API Tags:

Access:

public

[ Top ]

getMaxValue [line 130]

string|PhpExt_JavascriptStm getMaxValue(
)

The maximum allowed time. Can be either a Javascript date object or a string date in a valid format (defaults to null).

API Tags:

Access:

public

[ Top ]

getMinText [line 148]

string getMinText(
)

The error text to display when the date in the cell is before minValue (defaults to 'The time in this field must be equal to or after {0}').

API Tags:

Access:

public

[ Top ]

getMinValue [line 166]

string|PhpExt_JavascriptStm getMinValue(
)

The minimum allowed time. Can be either a Javascript date object or a string date in a valid format (defaults to null).

API Tags:

Access:

public

[ Top ]

setAltFormats [line 32]

PhpExt_Form_TimeField setAltFormats(
string
$value 
)

Multiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined format (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setFormat [line 50]

PhpExt_Form_TimeField setFormat(
string
$value 
)

The default date format string which can be overriden for localization support. The format must be valid according to Date.parseDate (defaults to 'm/d/y').

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setIncrement [line 68]

PhpExt_Form_TimeField setIncrement(
integer
$value 
)

The number of minutes between each time value in the list (defaults to 15).

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setInvalidText [line 86]

PhpExt_Form_TimeField setInvalidText(
string
$value 
)

The error text to display when the time in the field is invalid (defaults to '{value} is not a valid time - it must be in the format {format}').

Parameters:

string

$value:

API Tags:

Access:

public

Redefinition of:

PhpExt_Form_Field::setInvalidText(): The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid")

[ Top ]

setMaxText [line 104]

PhpExt_Form_TimeField setMaxText(
string
$value 
)

The error text to display when the time is after maxValue (defaults to 'The time in this field must be equal to or before {0}').

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setMaxValue [line 122]

PhpExt_Form_TimeField setMaxValue(
string|PhpExt_JavascriptStm
$value 
)

The maximum allowed time. Can be either a Javascript date object or a string date in a valid format (defaults to null).

Parameters:

string|PhpExt_JavascriptStm

$value:

API Tags:

Access:

public

[ Top ]

setMinText [line 140]

PhpExt_Form_TimeField setMinText(
string
$value 
)

The error text to display when the date in the cell is before minValue (defaults to 'The time in this field must be equal to or after {0}').

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setMinValue [line 158]

PhpExt_Form_TimeField setMinValue(
string|PhpExt_JavascriptStm
$value 
)

The minimum allowed time. Can be either a Javascript date object or a string date in a valid format (defaults to null).

Parameters:

string|PhpExt_JavascriptStm

$value:

API Tags:

Access:

public

[ Top ]

Class: PhpExt_Form_TimeField

Class PhpExt_Form_TimeField