A combobox control with support for autocomplete, remote-loading, paging and many other features.
| |
ComboBox(Object config) |
ComboBox |
| Create a new ComboBox. |
| |
addEvents(Object object) : void |
Observable |
| Copies any events from the passed object onto this object if they do not already exist. The passed object
must also ... |
| |
addListener(String eventName, Function handler, [Object scope], [Object options]) : void |
Observable |
| Appends an event handler to this component |
| |
applyTo(String/HTMLElement/Element el) : Ext.form.Field |
Field |
| Apply the behaviors of this component to an existing element. This is used instead of render(). |
| |
autoSize() : void |
TextField |
| Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.
This only ta... |
| |
clearInvalid() : void |
Field |
| Clear any invalid styles/messages for this field |
| |
clearValue() : void |
ComboBox |
| Clears any text/value currently set in the field |
| |
collapse() : void |
ComboBox |
| Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion. |
| |
disable() : void |
Component |
| Disable this component |
| |
doQuery(String query, Boolean forceAll) : void |
ComboBox |
| Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the
query allowing the ... |
| |
enable() : void |
Component |
| Enable this component |
| |
expand() : void |
ComboBox |
| Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion. |
| |
fireEvent(String eventName, Object... args) : Boolean |
Observable |
| Fires the specified event with the passed parameters (minus the event name). |
| |
focus(Boolean selectText) : void |
Component |
| Try to focus this component |
| |
getEl() : Ext.Element |
Component |
| Returns the underlying Ext.Element |
| |
getId() : String |
Component |
| Returns the id of this component |
| |
getName() : String |
Field |
| Returns the name attribute of the field if available |
| |
getRawValue() : Mixed |
Field |
| Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue. |
| |
getValue() : String |
ComboBox |
| Returns the currently-selected field value or empty string if no value is set. |
| |
hasListener(String eventName) : Boolean |
Observable |
| Checks to see if this object is currently listening for a specified event |
| |
hide() : void |
Component |
| Hide this component |
| |
isExpanded() : void |
ComboBox |
| Returns true if the dropdown list is expanded, else false. |
| |
isValid(Boolean preventMark) : Boolean |
Field |
| Returns whether or not the field value is currently valid |
| |
isVisible() : void |
Component |
| Returns true if this component is visible |
| |
markInvalid(String msg) : void |
Field |
| Mark this field as invalid |
| |
on(String eventName, Function handler, [Object options]) : void |
Observable |
| Appends an event handler to this element (shorthand for addListener) |
| |
onTriggerClick(EventObject e) : void |
TriggerField |
| The function that should handle the trigger's click event. This method does nothing by default until overridden
by a... |
| |
purgeListeners() : void |
Observable |
| Removes all listeners for this object |
| |
removeListener(String eventName, Function handler, [Object scope]) : void |
Observable |
| Removes a listener |
| |
render([String/HTMLElement/Element container]) : void |
Component |
| If this is a lazy rendering component, render it to its container element |
| |
reset() : void |
Field |
| Resets the current field value to the originally-loaded value and clears any validation messages |
| |
select(Number index, Boolean scrollIntoView) : void |
ComboBox |
| Select an item in the dropdown list by its numeric index in the list |
| |
selectByValue(String value, Boolean scrollIntoView) : Boolean |
ComboBox |
| Select an item in the dropdown list by its data value |
| |
selectNext() : void |
ComboBox |
| Select the next item in the dropdown list (selects the first item by default if no items are currently selected) |
| |
selectPrev() : void |
ComboBox |
| Select the previous item in the dropdown list (selects the first item by default if no items are currently selected) |
| |
selectText([Number start], [Number end]) : void |
TextField |
| Selects text in this field |
| |
setDisabled(Boolean disabled) : void |
Component |
| Convenience function for setting disabled/enabled by boolean |
| |
setEditable() : void |
ComboBox |
| Allow or prevent the user from directly editing the field text. If false is passed in,
the user will only be able to... |
| |
setRawValue(Mixed value) : void |
Field |
| Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue. |
| |
setSize(Number width, Number height) : void |
Field |
| Sets the height and width of the field |
| |
setValue(String value) : void |
ComboBox |
| Sets the specified value into the field. If the value finds a match, the corresponding record text
will be displayed... |
| |
setVisible(Boolean visible) : void |
Component |
| Convenience function to hide or show this component by boolean |
| |
show() : void |
Component |
| Show this component |
| |
un(String eventName, Function handler, [Object scope]) : void |
Observable |
| Removes a listener (shorthand for removeListener) |
| |
validate() : Boolean |
Field |
| Validates the field value |
| |
validateValue(Mixed value) : Boolean |
TextField |
| Validates a value according to the field's validation rules and marks the field as invalid
if the validation fails |
| |
autosize : (Ext.form.Field this, Number width) |
TextField |
| Fires when the autosize function is triggered. The field may or may not have actually changed size
according to the ... |
| |
beforedestroy : (Ext.Component this) |
Component |
| Fires before the component is destroyed |
| |
beforehide : (Ext.Component this) |
Component |
| Fires before the component is hidden |
| |
beforequery : (Object e) |
ComboBox |
| Fires before all queries are processed. Return false to cancel the query or set cancel to true.
The event object pass... |
| |
beforerender : (Ext.Component this) |
Component |
| Fires before the component is rendered |
| |
beforeselect : (Ext.form.ComboBox combo, Ext.data.Record record, Number index) |
ComboBox |
| Fires before a list item is selected. Return false to cancel the selection. |
| |
beforeshow : (Ext.Component this) |
Component |
| Fires before the component is shown |
| |
blur : (Ext.form.Field this) |
Field |
| Fires when |
| |
change : (Ext.form.Field this, Mixed value, Mixed value) |
Field |
| Fires just before the field blurs if the field value has changed |
| |
collapse : (Ext.form.ComboBox combo) |
ComboBox |
| Fires when the dropdown list is collapsed |
| |
destroy : (Ext.Component this) |
Component |
| Fires after the component is destroyed |
| |
disable : (Ext.Component this) |
Component |
| Fires after the component is disabled |
| |
enable : (Ext.Component this) |
Component |
| Fires after the component is enabled |
| |
expand : (Ext.form.ComboBox combo) |
ComboBox |
| Fires when the dropdown list is expanded |
| |
focus : (Ext.form.Field this) |
Field |
| Fires when this field receives input focus |
| |
hide : (Ext.Component this) |
Component |
| Fires after the component is hidden |
| |
invalid : (Ext.form.Field this, String msg) |
Field |
| Fires after the field has been marked as invalid |
| |
render : (Ext.Component this) |
Component |
| Fires after the component is rendered |
| |
select : (Ext.form.ComboBox combo, Ext.data.Record record, Number index) |
ComboBox |
| Fires when a list item is selected |
| |
show : (Ext.Component this) |
Component |
| Fires after the component is shown |
| |
specialkey : (Ext.form.Field this, Ext.EventObject e) |
Field |
| Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check
Ext.EventObject.g... |
| |
valid : (Ext.form.Field this) |
Field |
| Fires after the field has been validated with no errors |
| |
allQuery : String |
ComboBox |
| The text query to send to the server to return all records for the list with no filtering (defaults to '') |
| |
allowBlank : Boolean |
TextField |
| False to validate that the value length > 0 (defaults to true) |
| |
autoCreate : Boolean/Object |
ComboBox |
| A DomHelper element spec, or true for a default element spec (defaults to: {tag: "input", type: "text", size: "24", a... |
| |
blankText : String |
TextField |
| Error text to display if the allow blank validation fails (defaults to "This field is required") |
| |
disableKeyFilter : Boolean |
TextField |
| True to disable input keystroke filtering (defaults to false) |
| |
displayField : String |
ComboBox |
| The underlying data field name to bind to this CombBox (defaults to undefined if mode = 'remote' or 'text' if mode = ... |
| |
editable : Boolean |
ComboBox |
| False to prevent the user from typing text directly into the field, just like a traditional select (defaults to true) |
| |
emptyClass : String |
TextField |
| The CSS class to apply to an empty field to style the emptyText (defaults to 'x-form-empty-field'). This class is aut... |
| |
emptyText : String |
TextField |
| The default text to display in an empty field (defaults to null). |
| |
fieldClass : String |
Field |
| The default CSS class for the field (defaults to "x-form-field") |
| |
focusClass : String |
Field |
| The CSS class to use when the field receives focus (defaults to "x-form-focus") |
| |
forceSelection : Boolean |
ComboBox |
| True to restrict the selected value to one of the values in the list, false to allow the user to set arbitrary text i... |
| |
grow : Boolean |
TextField |
| True if this field should automatically grow and shrink to its content |
| |
growMax : Number |
TextField |
| The maximum width to allow when grow = true (defaults to 800) |
| |
growMin : Number |
TextField |
| The minimum width to allow when grow = true (defaults to 30) |
| |
handleHeight : Number |
ComboBox |
| The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8) |
| |
hiddenName : String |
ComboBox |
| If specified, a hidden form field with this name is dynamically generated to store the field's data value (defaults t... |
| |
hideTrigger : Boolean |
TriggerField |
| True to hide the trigger element and display only the base text field (defaults to false) |
| |
inputType : String |
Field |
| The type attribute for input fields - e.g. radio, text, password. (defaults to "text") |
| |
invalidClass : String |
Field |
| The CSS class to use when marking a field invalid (defaults to "x-form-invalid") |
| |
invalidText : String |
Field |
| The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field i... |
| |
lazyRender : Boolean |
ComboBox |
| True to prevent the ComboBox from rendering until requested (should always be used when rendering into an Ext.Editor,... |
| |
listAlign : String |
ComboBox |
| A valid anchor position value. See Ext.Element.alignTo for details on supported anchor positions (defaults to 'tl-bl') |
| |
listClass : String |
ComboBox |
| CSS class to apply to the dropdown list element (defaults to '') |
| |
listWidth : Number |
ComboBox |
| The width in pixels of the dropdown list (defaults to the width of the ComboBox field) |
| |
loadingText : String |
ComboBox |
| The text to display in the dropdown list while data is loading. Only applies when mode = 'remote' (defaults to 'Loadi... |
| |
maskRe : String |
TextField |
| An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null) |
| |
maxHeight : Number |
ComboBox |
| The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300) |
| |
maxLength : Number |
TextField |
| Maximum input field length allowed (defaults to Number.MAX_VALUE) |
| |
maxLengthText : String |
TextField |
| Error text to display if the maximum length validation fails (defaults to "The maximum length for this field is {maxL... |
| |
minChars : Number |
ComboBox |
| The minimum number of characters the user must type before autocomplete and typeahead activate (defaults to 4, does n... |
| |
minLength : Number |
TextField |
| Minimum input field length required (defaults to 0) |
| |
minLengthText : String |
TextField |
| Error text to display if the minimum length validation fails (defaults to "The minimum length for this field is {minL... |
| |
minListWidth : Number |
ComboBox |
| The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if listWidth has a higher value) |
| |
mode : String |
ComboBox |
| Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server) |
| |
msgFx : String |
Field |
| Experimental The effect used when displaying a validation message under the field (defaults to 'normal'). |
| |
msgTarget : String |
Field |
| The location where error text should display. Should be one of the following values (defaults to 'qtip'): Value Desc... |
| |
pageSize : Number |
ComboBox |
| If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the filter queries will execu... |
| |
queryDelay : Number |
ComboBox |
| The length of time in milliseconds to delay between the start of typing and sending the query to filter the dropdown ... |
| |
queryParam : String |
ComboBox |
| Name of the query as it will be passed on the querystring (defaults to 'query') |
| |
regex : RegExp |
TextField |
| A JavaScript RegExp object to be tested against the field value during validation (defaults to null). If available, t... |
| |
regexText : String |
TextField |
| The error text to display if regex is used and the test fails during validation (defaults to "") |
| |
resizable : Boolean |
ComboBox |
| True to add a resize handle to the bottom of the dropdown list (defaults to false) |
| |
selectOnFocus : Boolean |
ComboBox |
| True to select any existing text in the field immediately on focus. Only applies when editable = true (defaults to fa... |
| |
selectedClass : String |
ComboBox |
| CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected') |
| |
shadow : Boolean/String |
ComboBox |
| True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right |
| |
transform : String/HTMLElement/Element |
ComboBox |
| The id, DOM node or element of an existing select to convert to a ComboBox |
| |
triggerAction : String |
ComboBox |
| The action to execute when the trigger field is activated. Use 'all' to run the query specified by the allQuery confi... |
| |
triggerClass : String |
ComboBox |
| An additional CSS class used to style the trigger button. The trigger will always get the class 'x-form-trigger' and ... |
| |
typeAhead : Boolean |
ComboBox |
| True to populate and autoselect the remainder of the text being typed after a configurable delay (typeAheadDelay) if ... |
| |
typeAheadDelay : Number |
ComboBox |
| The length of time in milliseconds to wait until the typeahead text is displayed if typeAhead = true (defaults to 250) |
| |
validateOnBlur : String/Boolean |
Field |
| Defaults to true. |
| |
validationDelay : Number |
Field |
| The length of time in milliseconds after user input begins until validation is initiated (defaults to 250) |
| |
validationEvent : String/Boolean |
Field |
| The event that should initiate field validation. Set to false to disable automatic validation. (defaults to "keyup") |
| |
validator : Function |
TextField |
| A custom validation function to be called during field validation (defaults to null). If available, this function wil... |
| |
value : Mixed |
Field |
| A value to initialize this field with |
| |
valueField : String |
ComboBox |
| The underlying data value name to bind to this CombBox (defaults to undefined if mode = 'remote' or 'value' if mode =... |
| |
valueNotFoundText : String |
ComboBox |
| When using a name/value combo, if the value passed to setValue is not found in the store, valueNotFoundText will be d... |
| |
vtype : String |
TextField |
| A validation type name as defined in Ext.form.VTypes (defaults to null) |