Class: PhpExt_Form_Field

Source Location: /PhpExt/Form/Field.php

Class PhpExt_Form_Field

Class Overview

Implements interfaces:

PhpExt_Toolbar_IToolbarItem

Located in /PhpExt/Form/Field.php [line 33]

PhpExt_Object
   |
   --PhpExt_Observable
      |
      --PhpExt_Component
         |
         --PhpExt_BoxComponent
            |
            --PhpExt_Form_Field

Methods

[ Top ]

Descendants

Child Class	Description
PhpExt_Form_Checkbox	Single checkbox field. Can be used as a direct replacement for traditional checkbox fields.
PhpExt_Form_Hidden	A basic hidden field for storing hidden values in forms that need to be passed in the form submit.
PhpExt_Form_HtmlEditor	Provides a lightweight HTML Editor component.
PhpExt_Form_TextField	Basic text field. Can be used as a direct replacement for traditional text inputs, or as the base class for more sophisticated input controls (like PhpExt_Form_TextArea and PhpExt_Form_ComboBox).

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From PhpExt_Component

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_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_Component

PhpExt_Component::HIDE_MODE_DISPLAY

PhpExt_Component::HIDE_MODE_OFFSETS

PhpExt_Component::HIDE_MODE_VISIBILITY

[ Top ]

Method Summary

PhpExt_Form_Field	__construct()
PhpExt_Config_ConfigObject	getAutoCreate()	A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "20", autocomplete: "off"})
string	getClearCssClass()	The CSS class used to provide field clearing (defaults to 'x-form-clear-left')
string	getCssClass()	A CSS class to apply to the field's underlying element.
boolean	getDisabled()	True to disable the field (defaults to false).
string	getFieldCssClass()	The default CSS class for the field (defaults to "x-form-field")
string	getFieldLabel()	The label text to display next to this field (defaults to '')
string	getFocusCssClass()	The CSS class to use when the field receives focus (defaults to "x-form-focus")
boolean	getHideLabel()	True to completely hide the label element (defaults to false)
string	getInputType()	The type attribute for input fields -- e.g. radio, text, password (defaults to "text").
string	getInvalidCssClass()	The CSS class to use when marking a field invalid (defaults to "x-form-invalid")
string	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")
boolean	getItemCssClass()	An additional CSS class to apply to this field (defaults to the container's itemCls value if set, or '')
string	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;'.
string	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 ''.
boolean	getMsgFx()	Experimental The effect used when displaying a validation message under the field (defaults to 'normal').
string	getMsgTarget()	The location where error text should display. Should be one of the following values (defaults to 'qtip'):
string	getName()	The field's HTML name attribute.
boolean	getReadOnly()	True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.
integer	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).
boolean	getValidateOnBlur()	Whether the field should validate when it loses focus (defaults to true).
integer	getValidationDelay()	The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)
string\|boolean	getValidationEvent()	The event that should initiate field validation. Set to false to disable automatic validation (defaults to "keyup").
mixed	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.

[ Top ]

Properties

Methods

Constructor __construct [line 475]

PhpExt_Form_Field __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_BoxComponent::__construct()

Redefined in descendants as:

[ Top ]

getAutoCreate [line 49]

PhpExt_Config_ConfigObject getAutoCreate(
)

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

API Tags:

Access:

public

Redefined in descendants as:

PhpExt_Form_Checkbox::getAutoCreate() : A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "checkbox", autocomplete: "off"})
PhpExt_Form_TextArea::getAutoCreate() : A DomHelper element spec, or true for a default element spec (defaults to {tag: "textarea", style: "width:100px;height:60px;", autocomplete: "off"})
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_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_DateField::getAutoCreate() : A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "10", autocomplete: "off"})

[ Top ]

getClearCssClass [line 67]

string getClearCssClass(
)

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

API Tags:

Access:

public

[ Top ]

getCssClass [line 84]

string getCssClass(
)

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

API Tags:

Access:

public

Redefinition of:

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.

[ Top ]

getDisabled [line 102]

boolean getDisabled(
)

True to disable the field (defaults to false).

API Tags:

Access:

public

[ Top ]

getFieldCssClass [line 120]

string getFieldCssClass(
)

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

API Tags:

Access:

public

Redefined in descendants as:

PhpExt_Form_Checkbox::getFieldCssClass() : The default CSS class for the checkbox (defaults to "x-form-field")
PhpExt_Form_NumberField::getFieldCssClass() : The default CSS class for the field (defaults to "x-form-field x-form-num-field")

[ Top ]

getFieldLabel [line 138]

string getFieldLabel(
)

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

API Tags:

Access:

public

[ Top ]

getFocusCssClass [line 156]

string getFocusCssClass(
)

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

API Tags:

Access:

public

[ Top ]

getHideLabel [line 174]

boolean getHideLabel(
)

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

API Tags:

Access:

public

[ Top ]

getInputType [line 192]

string getInputType(
)

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

API Tags:

Access:

public

[ Top ]

getInvalidCssClass [line 210]

string getInvalidCssClass(
)

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

API Tags:

Access:

public

[ Top ]

getInvalidText [line 228]

string 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")

API Tags:

Access:

public

Redefined in descendants as:

PhpExt_Form_TimeField::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}').
PhpExt_Form_DateField::getInvalidText() : The error text to display when the date in the field is invalid (defaults to '{value} is not a valid date - it must be in the format {format}').

[ Top ]

getItemCssClass [line 246]

boolean getItemCssClass(
)

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

API Tags:

Access:

public

[ Top ]

getLabelCssStyle [line 282]

string 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;'.

API Tags:

Access:

public

[ Top ]

getLabelSeparator [line 264]

string 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 ''.

API Tags:

Access:

public

[ Top ]

getMsgFx [line 300]

boolean getMsgFx(
)

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

API Tags:

Access:

public

[ Top ]

getMsgTarget [line 344]

string getMsgTarget(
)

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

 Value                                           Description
 --------------------------------------------    ----------------------------------------------------------------------
 PhpExt_Form_FormPanel::MSG_TARGET_QTIP          Display a quick tip when the user hovers over the field
 PhpExt_Form_FormPanel::MSG_TARGET_TITLE         Display a default browser title attribute popup
 PhpExt_Form_FormPanel::MSG_TARGET_UNDER         Add a block div beneath the field containing the error text
 PhpExt_Form_FormPanel::MSG_TARGET_SIDE          Add an error icon to the right of the field with a popup on hover
 [element id]                                    Add the error text directly to the innerHTML of the specified element

API Tags:

Access:	public
Uses:	PhpExt_Form_FormPanel::MSG_TARGET_UNDER
Uses:	PhpExt_Form_FormPanel::MSG_TARGET_TITLE
Uses:	PhpExt_Form_FormPanel::MSG_TARGET_SIDE
Uses:	PhpExt_Form_FormPanel::MSG_TARGET_QTIP

[ Top ]

getName [line 362]

string getName(
)

The field's HTML name attribute.

API Tags:

Access:

public

[ Top ]

getReadOnly [line 380]

boolean getReadOnly(
)

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

API Tags:

Access:

public

[ Top ]

getTabIndex [line 398]

integer 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).

API Tags:

Access:

public

[ Top ]

getValidateOnBlur [line 416]

boolean getValidateOnBlur(
)

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

API Tags:

Access:

public

[ Top ]

getValidationDelay [line 434]

integer getValidationDelay(
)

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

API Tags:

Access:

public

[ Top ]

getValidationEvent [line 452]

string|boolean getValidationEvent(
)

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

API Tags:

Access:

public

[ Top ]

getValue [line 470]

mixed getValue(
)

A value to initialize this field with.

API Tags:

Access:

public

[ Top ]

setAutoCreate [line 41]

PhpExt_Form_Field setAutoCreate(
PhpExt_Config_ConfigObject
$value 
)

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

Parameters:

PhpExt_Config_ConfigObject

$value:

API Tags:

Access:

public

Redefined in descendants as:

PhpExt_Form_Checkbox::setAutoCreate() : A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "checkbox", autocomplete: "off"})
PhpExt_Form_TextArea::setAutoCreate() : A DomHelper element spec, or true for a default element spec (defaults to {tag: "textarea", style: "width:100px;height:60px;", autocomplete: "off"})
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_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_DateField::setAutoCreate() : A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "10", autocomplete: "off"})

[ Top ]

setClearCssClass [line 59]

PhpExt_Form_Field setClearCssClass(
string
$value 
)

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

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setCssClass [line 77]

PhpExt_Form_Field setCssClass(
string
$value 
)

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

Parameters:

string

$value:

API Tags:

Access:

public

Redefinition of:

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.

[ Top ]

setDisabled [line 94]

PhpExt_Form_Field setDisabled(
boolean
$value 
)

True to disable the field (defaults to false).

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setFieldCssClass [line 112]

PhpExt_Form_Field setFieldCssClass(
string
$value 
)

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

Parameters:

string

$value:

API Tags:

Access:

public

Redefined in descendants as:

PhpExt_Form_Checkbox::setFieldCssClass() : The default CSS class for the checkbox (defaults to "x-form-field")
PhpExt_Form_NumberField::setFieldCssClass() : The default CSS class for the field (defaults to "x-form-field x-form-num-field")

[ Top ]

setFieldLabel [line 130]

PhpExt_Form_Field setFieldLabel(
string
$value 
)

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

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setFocusCssClass [line 148]

PhpExt_Form_Field setFocusCssClass(
string
$value 
)

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

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setHideLabel [line 166]

PhpExt_Form_Field setHideLabel(
boolean
$value 
)

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

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setInputType [line 184]

PhpExt_Form_Field setInputType(
string
$value 
)

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

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setInvalidCssClass [line 202]

PhpExt_Form_Field setInvalidCssClass(
string
$value 
)

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

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setInvalidText [line 220]

PhpExt_Form_Field setInvalidText(
string
$value 
)

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

Parameters:

string

$value:

API Tags:

Access:

public

Redefined in descendants as:

PhpExt_Form_TimeField::setInvalidText() : 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}').
PhpExt_Form_DateField::setInvalidText() : The error text to display when the date in the field is invalid (defaults to '{value} is not a valid date - it must be in the format {format}').

[ Top ]

setItemCssClass [line 238]

PhpExt_Form_Field setItemCssClass(
boolean
$value 
)

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

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setLabelCssStyle [line 274]

PhpExt_Form_Field setLabelCssStyle(
string
$value 
)

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;'.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setLabelSeparator [line 256]

PhpExt_Form_Field setLabelSeparator(
string
$value 
)

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setMsgFx [line 292]

PhpExt_Form_Field setMsgFx(
boolean
$value 
)

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

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setMsgTarget [line 323]

PhpExt_Form_Field setMsgTarget(
string
$value 
)

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

 Value                                           Description
 --------------------------------------------    ----------------------------------------------------------------------
 PhpExt_Form_FormPanel::MSG_TARGET_QTIP          Display a quick tip when the user hovers over the field
 PhpExt_Form_FormPanel::MSG_TARGET_TITLE         Display a default browser title attribute popup
 PhpExt_Form_FormPanel::MSG_TARGET_UNDER         Add a block div beneath the field containing the error text
 PhpExt_Form_FormPanel::MSG_TARGET_SIDE          Add an error icon to the right of the field with a popup on hover
 [element id]                                    Add the error text directly to the innerHTML of the specified element

Parameters:

string

$value:

API Tags:

Access:	public
Uses:	PhpExt_Form_FormPanel::MSG_TARGET_UNDER
Uses:	PhpExt_Form_FormPanel::MSG_TARGET_TITLE
Uses:	PhpExt_Form_FormPanel::MSG_TARGET_SIDE
Uses:	PhpExt_Form_FormPanel::MSG_TARGET_QTIP

[ Top ]

setName [line 354]

PhpExt_Form_Field setName(
string
$value 
)

The field's HTML name attribute.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setReadOnly [line 372]

PhpExt_Form_Field setReadOnly(
boolean
$value 
)

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

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setTabIndex [line 390]

PhpExt_Form_Field setTabIndex(
integer
$value 
)

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

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setValidateOnBlur [line 408]

PhpExt_Form_Field setValidateOnBlur(
boolean
$value 
)

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

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setValidationDelay [line 426]

PhpExt_Form_Field setValidationDelay(
integer
$value 
)

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

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setValidationEvent [line 444]

PhpExt_Form_Field setValidationEvent(
string|boolean
$value 
)

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

Parameters:

string|boolean

$value:

API Tags:

Access:

public

[ Top ]

setValue [line 462]

PhpExt_Form_Field setValue(
mixed
$value 
)

A value to initialize this field with.

Parameters:

mixed

$value:

API Tags:

Access:

public

[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:53:25 -0500 by phpDocumentor 1.4.0