PhpExt : Form [ class tree ] [ index ] [ all elements ]

Class: PhpExt_Form_ComboBox

Source Location: /PhpExt/Form/ComboBox.php

Class PhpExt_Form_ComboBox

Class Overview
Descendants
Child Class Description
PhpExt_Form_TimeField Provides a time input field with a time dropdown and automatic time validation.

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From PhpExt_Form_TextField

PhpExt_Form_TextField::$IsPassword

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_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
  1. PhpExt_Component::HIDE_MODE_VISIBILITY
(css visibility),
  1. PhpExt_Component::HIDE_MODE_OFFSETS
(negative offset position) and
  1. PhpExt_Component::HIDE_MODE_DISPLAY
(css display) - defaults to
  1. 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
  1. PhpExt_Component::HIDE_MODE_VISIBILITY
(css visibility),
  1. PhpExt_Component::HIDE_MODE_OFFSETS
(negative offset position) and
  1. PhpExt_Component::HIDE_MODE_DISPLAY
(css display) - defaults to
  1. 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
static PhpExt_Form_ComboBox   createComboBox()   Helper function to create a ComboBox. Useful for quick adding it to a ComponentCollection
PhpExt_Form_ComboBox   __construct()  
string   getAllQuery()   The text query to send to the server to return all records for the list with no filtering (defaults to '')
PhpExt_Config_Config   getAutoCreate()   A DomHelper element spec, or true for a default element spec (defaults to: {tag: "input", type: "text", size: "24", autocomplete: "off"})
string   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)
boolean   getEditable()   False to prevent the user from typing text directly into the field, just like a traditional select (defaults to true)
boolean   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)
integer   getHandleHeight()   The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)
string   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.
string   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.
boolean   getLazyInit()   True to not initialize the list for this combo until the field is focused. (defaults to true)
boolean   getLazyRender()   True to prevent the ComboBox from rendering until requested (should always be used when rendering into an Ext.Editor, defaults to false)
string   getListAlign()   A valid anchor position value. See Ext.Element.alignTo for details on supported anchor positions (defaults to 'tl-bl')
string   getListCssClass()   CSS class to apply to the dropdown list element (defaults to '')
integer   getListWidth()   The width in pixels of the dropdown list (defaults to the width of the ComboBox field)
string   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...')
integer   getMaxHeight()   The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)
integer   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)
integer   getMinListWidth()   The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if listWidth has a higher value)
string   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)
boolean   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).
string   getOverCssClass()   A CSS class to apply to each item in the view on mouseover (defaults to undefined).
integer   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)
integer   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)
string   getQueryParam()   Name of the query as it will be passed on the querystring (defaults to 'query')
boolean   getResizable()   True to add a resize handle to the bottom of the dropdown list (defaults to false)
string   getSelectedCssClass()   CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')
boolean   getSelectOnFocus()   True to select any existing text in the field immediately on focus. Only applies when editable = true (defaults to false)
boolean|string   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
boolean   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).
boolean   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_Data_Store   getStore()   The data store to which this combo is bound (defaults to undefined)
PhpExt_XTemplate|string   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.
boolean   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)
string|PhpExt_JavascriptStm   getTransform()   The id, DOM node or element of an existing select to convert to a ComboBox
string   getTriggerAction()  
string   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).
boolean   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)
integer   getTypeAheadDelay()   The length of time in milliseconds to wait until the typeahead text is displayed if typeAhead = true (defaults to 250)
string   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.
string   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)

[ Top ]
Methods
static method createComboBox  [line 826]

  static PhpExt_Form_ComboBox createComboBox( string $name, [ $label = null], [string $id = null], [string $hiddenName = null], string $labelThe  )

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

Parameters:
string   $name:  The field's HTML name attribute.
string   $labelThe:  label text to display next to this field (defaults to '')
string   $id:  The unique id of this component (defaults to an auto-assigned id).
string   $hiddenName:  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.
   $label: 

API Tags:
Access:  public


[ Top ]
Constructor __construct  [line 768]

  PhpExt_Form_ComboBox __construct( )


API Tags:
Access:  public


Redefinition of:
PhpExt_Form_TriggerField::__construct()

Redefined in descendants as:

[ Top ]
getAllQuery  [line 53]

  string getAllQuery( )

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


API Tags:
Access:  public


[ Top ]
getAutoCreate  [line 70]

  PhpExt_Config_Config getAutoCreate( )

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


API Tags:
Access:  public


Redefinition of:
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"})

[ Top ]
getDisplayField  [line 88]

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


API Tags:
Access:  public


[ Top ]
getEditable  [line 106]

  boolean getEditable( )

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


API Tags:
Access:  public


[ Top ]
getForceSelection  [line 124]

  boolean 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)


API Tags:
Access:  public


[ Top ]
getHandleHeight  [line 142]

  integer getHandleHeight( )

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


API Tags:
Access:  public


[ Top ]
getHiddenName  [line 160]

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


API Tags:
Access:  public


[ Top ]
getItemCssSelector  [line 691]

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

Internal DataView Config Option:

The ComboBox uses a PhpExt_DataView to render the dropdown list. DataView options may be included in the ComboBox Configuration for customization


API Tags:
Access:  public


[ Top ]
getLazyInit  [line 178]

  boolean getLazyInit( )

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


API Tags:
Access:  public


[ Top ]
getLazyRender  [line 196]

  boolean getLazyRender( )

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


API Tags:
Access:  public


[ Top ]
getListAlign  [line 214]

  string getListAlign( )

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


API Tags:
Access:  public


[ Top ]
getListCssClass  [line 232]

  string getListCssClass( )

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


API Tags:
Access:  public


[ Top ]
getListWidth  [line 250]

  integer getListWidth( )

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


API Tags:
Access:  public


[ Top ]
getLoadingText  [line 268]

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


API Tags:
Access:  public


[ Top ]
getMaxHeight  [line 286]

  integer getMaxHeight( )

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


API Tags:
Access:  public


[ Top ]
getMinChars  [line 304]

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


API Tags:
Access:  public


[ Top ]
getMinListWidth  [line 322]

  integer getMinListWidth( )

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


API Tags:
Access:  public


[ Top ]
getMode  [line 340]

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


API Tags:
Access:  public


[ Top ]
getMultiSelect  [line 709]

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

Internal DataView Config Option:

The ComboBox uses a PhpExt_DataView to render the dropdown list. DataView options may be included in the ComboBox Configuration for customization


API Tags:
Access:  public


[ Top ]
getOverCssClass  [line 727]

  string getOverCssClass( )

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

Internal DataView Config Option:

The ComboBox uses a PhpExt_DataView to render the dropdown list. DataView options may be included in the ComboBox Configuration for customization


API Tags:
Access:  public


[ Top ]
getPageSize  [line 358]

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


API Tags:
Access:  public


[ Top ]
getQueryDelay  [line 376]

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


API Tags:
Access:  public


[ Top ]
getQueryParam  [line 394]

  string getQueryParam( )

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


API Tags:
Access:  public


[ Top ]
getResizable  [line 412]

  boolean getResizable( )

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


API Tags:
Access:  public


[ Top ]
getSelectedCssClass  [line 448]

  string getSelectedCssClass( )

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


API Tags:
Access:  public


[ Top ]
getSelectOnFocus  [line 430]

  boolean getSelectOnFocus( )

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


API Tags:
Access:  public


Redefinition of:
PhpExt_Form_TextField::getSelectOnFocus()
True to automatically select any existing field text when the field receives input focus (defaults to false)

[ Top ]
getShadow  [line 472]

  boolean|string 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


API Tags:
Access:  public
Uses:  PhpExt_Shadow::MODE_SIDES
Uses:  PhpExt_Shadow::MODE_FRAME
Uses:  PhpExt_Shadow::MODE_DROP


[ Top ]
getSimpleSelect  [line 745]

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

Internal DataView Config Option:

The ComboBox uses a PhpExt_DataView to render the dropdown list. DataView options may be included in the ComboBox Configuration for customization


API Tags:
Access:  public


[ Top ]
getSingleSelect  [line 763]

  boolean 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.

Internal DataView Config Option:

The ComboBox uses a PhpExt_DataView to render the dropdown list. DataView options may be included in the ComboBox Configuration for customization


API Tags:
Access:  public


[ Top ]
getStore  [line 490]

  PhpExt_Data_Store getStore( )

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


API Tags:
Access:  public


[ Top ]
getTemplate  [line 536]

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

If you wish to preserve the default visual look of list items, add the CSS class name: 'x-combo-list-item' to the template's container element.

<em>The template must contain one or more substitution parameters using field names from the Combo's Store.</em> An example of a custom template would be adding an ext:qtip attribute which might display other fields from the Store.

The dropdown list is displayed in a PhpExt_DataView. See PhpExt_DataView for details.


API Tags:
Access:  public
Uses:  PhpExt_XTemplate


[ Top ]
getTitle  [line 508]

  boolean 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)


API Tags:
Access:  public


[ Top ]
getTransform  [line 554]

  string|PhpExt_JavascriptStm getTransform( )

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


API Tags:
Access:  public


[ Top ]
getTriggerAction  [line 574]

  string getTriggerAction( )


API Tags:
Access:  public


[ Top ]
getTriggerCssClass  [line 592]

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


API Tags:
Access:  public


Redefinition of:
PhpExt_Form_TriggerField::getTriggerCssClass()
A CSS class to apply to the trigger

[ Top ]
getTypeAhead  [line 610]

  boolean 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)


API Tags:
Access:  public


[ Top ]
getTypeAheadDelay  [line 628]

  integer getTypeAheadDelay( )

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


API Tags:
Access:  public


[ Top ]
getValueField  [line 646]

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


API Tags:
Access:  public


[ Top ]
getValueNotFoundText  [line 664]

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


API Tags:
Access:  public


[ Top ]
setAllQuery  [line 45]

  PhpExt_Form_ComboBox setAllQuery( string $value  )

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

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setAutoCreate  [line 63]

  PhpExt_Form_ComboBox setAutoCreate( PhpExt_Config_ConfigObject $value  )

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

Parameters:
PhpExt_Config_Config   $value: 

API Tags:
Access:  public


Redefinition of:
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"})

[ Top ]
setDisplayField  [line 80]

  PhpExt_Form_ComboBox setDisplayField( string $value  )

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)

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setEditable  [line 98]

  PhpExt_Form_ComboBox setEditable( boolean $value  )

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

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setForceSelection  [line 116]

  PhpExt_Form_ComboBox setForceSelection( boolean $value  )

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)

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setHandleHeight  [line 134]

  PhpExt_Form_ComboBox setHandleHeight( integer $value  )

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

Parameters:
integer   $value: 

API Tags:
Access:  public


[ Top ]
setHiddenName  [line 152]

  PhpExt_Form_ComboBox setHiddenName( string $value  )

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.

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setItemCssSelector  [line 683]

  PhpExt_Form_ComboBox setItemCssSelector( string $value  )

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

Internal DataView Config Option:

The ComboBox uses a PhpExt_DataView to render the dropdown list. DataView options may be included in the ComboBox Configuration for customization

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setLazyInit  [line 170]

  PhpExt_Form_ComboBox setLazyInit( boolean $value  )

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

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setLazyRender  [line 188]

  PhpExt_Form_ComboBox setLazyRender( boolean $value  )

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

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setListAlign  [line 206]

  PhpExt_Form_ComboBox setListAlign( string $value  )

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

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setListCssClass  [line 224]

  PhpExt_Form_ComboBox setListCssClass( string $value  )

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

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setListWidth  [line 242]

  PhpExt_Form_ComboBox setListWidth( integer $value  )

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

Parameters:
integer   $value: 

API Tags:
Access:  public


[ Top ]
setLoadingText  [line 260]

  PhpExt_Form_ComboBox setLoadingText( string $value  )

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

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setMaxHeight  [line 278]

  PhpExt_Form_ComboBox setMaxHeight( integer $value  )

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

Parameters:
integer   $value: 

API Tags:
Access:  public


[ Top ]
setMinChars  [line 296]

  PhpExt_Form_ComboBox setMinChars( integer $value  )

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)

Parameters:
integer   $value: 

API Tags:
Access:  public


[ Top ]
setMinListWidth  [line 314]

  PhpExt_Form_ComboBox setMinListWidth( integer $value  )

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

Parameters:
integer   $value: 

API Tags:
Access:  public


[ Top ]
setMode  [line 332]

  PhpExt_Form_ComboBox setMode( string $value  )

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)

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setMultiSelect  [line 701]

  PhpExt_Form_ComboBox setMultiSelect( boolean $value  )

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

Internal DataView Config Option:

The ComboBox uses a PhpExt_DataView to render the dropdown list. DataView options may be included in the ComboBox Configuration for customization

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setOverCssClass  [line 719]

  PhpExt_Form_ComboBox setOverCssClass( string $value  )

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

Internal DataView Config Option:

The ComboBox uses a PhpExt_DataView to render the dropdown list. DataView options may be included in the ComboBox Configuration for customization

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setPageSize  [line 350]

  PhpExt_Form_ComboBox setPageSize( integer $value  )

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)

Parameters:
integer   $value: 

API Tags:
Access:  public


[ Top ]
setQueryDelay  [line 368]

  PhpExt_Form_ComboBox setQueryDelay( integer $value  )

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)

Parameters:
integer   $value: 

API Tags:
Access:  public


[ Top ]
setQueryParam  [line 386]

  PhpExt_Form_ComboBox setQueryParam( string $value  )

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

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setResizable  [line 404]

  PhpExt_Form_ComboBox setResizable( boolean $value  )

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

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setSelectedCssClass  [line 440]

  PhpExt_Form_ComboBox setSelectedCssClass( string $value  )

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

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setSelectOnFocus  [line 422]

  PhpExt_Form_ComboBox setSelectOnFocus( boolean $value  )

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

Parameters:
boolean   $value: 

API Tags:
Access:  public


Redefinition of:
PhpExt_Form_TextField::setSelectOnFocus()
True to automatically select any existing field text when the field receives input focus (defaults to false)

[ Top ]
setShadow  [line 461]

  PhpExt_Form_ComboBox setShadow( boolean|string $value  )

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

Parameters:
boolean|string   $value: 

API Tags:
Access:  public
Uses:  PhpExt_Shadow::MODE_SIDES
Uses:  PhpExt_Shadow::MODE_FRAME
Uses:  PhpExt_Shadow::MODE_DROP


[ Top ]
setSimpleSelect  [line 737]

  PhpExt_Form_ComboBox setSimpleSelect( boolean $value  )

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

Internal DataView Config Option:

The ComboBox uses a PhpExt_DataView to render the dropdown list. DataView options may be included in the ComboBox Configuration for customization

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setSingleSelect  [line 755]

  PhpExt_Form_ComboBox setSingleSelect( boolean $value  )

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.

Internal DataView Config Option:

The ComboBox uses a PhpExt_DataView to render the dropdown list. DataView options may be included in the ComboBox Configuration for customization

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setStore  [line 482]

  PhpExt_Form_ComboBox setStore( PhpExt_Data_Store $value  )

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

Parameters:
PhpExt_Data_Store   $value: 

API Tags:
Access:  public


[ Top ]
setTemplate  [line 523]

  PhpExt_Form_ComboBox setTemplate( PhpExt_XTemplate|string $value  )

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.

If you wish to preserve the default visual look of list items, add the CSS class name: 'x-combo-list-item' to the template's container element.

<em>The template must contain one or more substitution parameters using field names from the Combo's Store.</em> An example of a custom template would be adding an ext:qtip attribute which might display other fields from the Store.

The dropdown list is displayed in a PhpExt_DataView. See PhpExt_DataView for details.

Parameters:
PhpExt_XTemplate|string   $value: 

API Tags:
Access:  public
Uses:  PhpExt_XTemplate


[ Top ]
setTitle  [line 500]

  PhpExt_Form_ComboBox setTitle( boolean $value  )

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)

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setTransform  [line 546]

  PhpExt_Form_ComboBox setTransform( string|PhpExt_JavascriptStm $value  )

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

Parameters:
string|PhpExt_JavascriptStm   $value: 

API Tags:
Access:  public


[ Top ]
setTriggerAction  [line 566]

  PhpExt_Form_ComboBox setTriggerAction( string $value  )

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)

Parameters:
string   $value: 

API Tags:
Access:  public
Uses:  PhpExt_Form_ComboBox::TRIGGER_ACTION_ALL
Uses:  PhpExt_Form_ComboBox::TRIGGER_ACTION_ALL


[ Top ]
setTriggerCssClass  [line 584]

  PhpExt_Form_ComboBox setTriggerCssClass( string $value  )

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

Parameters:
string   $value: 

API Tags:
Access:  public


Redefinition of:
PhpExt_Form_TriggerField::setTriggerCssClass()
A CSS class to apply to the trigger

[ Top ]
setTypeAhead  [line 602]

  PhpExt_Form_ComboBox setTypeAhead( boolean $value  )

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)

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setTypeAheadDelay  [line 620]

  PhpExt_Form_ComboBox setTypeAheadDelay( integer $value  )

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

Parameters:
integer   $value: 

API Tags:
Access:  public


[ Top ]
setValueField  [line 638]

  PhpExt_Form_ComboBox setValueField( string $value  )

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.

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setValueNotFoundText  [line 656]

  PhpExt_Form_ComboBox setValueNotFoundText( string $value  )

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)

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
Constants
MODE_LOCAL = 'local' [line 28]

[ Top ]
MODE_REMOTE = 'remote' [line 29]

[ Top ]
SHADOW_DROP = 'drop' [line 36]

[ Top ]
SHADOW_FRAME = 'frame' [line 35]

[ Top ]
SHADOW_SIDES = 'sides' [line 34]

[ Top ]
TRIGGER_ACTION_ALL = 'all' [line 32]
API Tags:
Usedby:  PhpExt_Form_ComboBox::setTriggerAction()
Usedby:  PhpExt_Form_ComboBox::setTriggerAction()


[ Top ]
TRIGGER_ACTION_QUERY = 'query' [line 31]

[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:51:37 -0500 by phpDocumentor 1.4.0