X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..c8256059947f3aa8f5b0a9a2acf55e2142bb4742:/docs/output/Ext.form.ComboBox.html diff --git a/docs/output/Ext.form.ComboBox.html b/docs/output/Ext.form.ComboBox.html index 725f6979..c44f8beb 100644 --- a/docs/output/Ext.form.ComboBox.html +++ b/docs/output/Ext.form.ComboBox.html @@ -1,4 +1,4 @@ -
Package: | Ext.form |
Defined In: | Combo.js |
Class: | ComboBox |
Subclasses: | TimeField |
Extends: | TriggerField |
xtype: | combo |
A combobox control with support for autocomplete, remote-loading, paging and many other features.
+Package: | Ext.form |
Defined In: | Combo.js |
Class: | ComboBox |
Subclasses: | TimeField |
Extends: | TriggerField |
A combobox control with support for autocomplete, remote-loading, paging and many other features.
A ComboBox works in a similar manner to a traditional HTML <select> field. The difference is that to submit the valueField, you must specify a hiddenName to create a hidden input field to hold the value of the valueField. The displayField is shown in the text field @@ -60,14 +60,14 @@ Ext.util.Format.comboRenderer = function(combo){
A ComboBox uses filtering itself, for information about filtering the ComboBox store manually see lastQuery.
Config Options | Defined By | ||
---|---|---|---|
allQuery : String The text query to send to the server to return all records for the list
with no filtering (defaults to '') | ComboBox | ||
allowBlank : Boolean Specify false to validate that the value's length is > 0 (defaults to
-true) | TextField | ||
allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component | ||
anchor : String Note: this config is only used when this Component is rendered
+true) | TextField | ||
allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component | ||
anchor : String Note: this config is only used when this Component is rendered
by a Container which has been configured to use an Anc... Note: this config is only used when this Component is rendered -by a Container which has been configured to use an AnchorLayout +by a Container which has been configured to use an AnchorLayout (or subclass thereof). based layout manager, for example:
See Ext.layout.AnchorLayout.anchor also. | Component | ||
applyTo : Mixed Specify the id of the element, a DOM element or an existing Element corresponding to a DIV
+ See Ext.layout.AnchorLayout.anchor also. | BoxComponent | ||
applyTo : Mixed Specify the id of the element, a DOM element or an existing Element corresponding to a DIV
that is already present in... Specify the id of the element, a DOM element or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component.
| ComboBox | ||
autoShow : Boolean True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
+
| ComboBox | ||
autoEl : Mixed A tag name or DomHelper spec used to create the Element which will
+encapsulate this Component.
+You do not normally ne... A tag name or DomHelper spec used to create the Element which will +encapsulate this Component. +You do not normally need to specify this. For the base classes Ext.Component, Ext.BoxComponent, +and Ext.Container, this defaults to 'div'. The more complex Ext classes use a more complex +DOM structure created by their own onRender methods. +This is intended to allow the developer to create application-specific utility Components encapsulated by +different DOM elements. Example usage:
| Component | ||
autoHeight : Boolean True to use height:'auto', false to use fixed height (or allow it to be managed by its parent
+Container's layout mana... True to use height:'auto', false to use fixed height (or allow it to be managed by its parent +Container's layout manager. Defaults to false. +Note: Although many components inherit this config option, not all will +function as expected with a height of 'auto'. Setting autoHeight:true means that the +browser will manage height based on the element's contents, and that Ext will not manage it at all. +If the browser is managing the height, be aware that resizes performed by the browser in response +to changes within the structure of the Component cannot be detected. Therefore changes to the height might +result in elements needing to be synchronized with the new height. Example:
| BoxComponent | ||
autoScroll : Boolean true to use overflow:'auto' on the components layout element and show scroll bars automatically when
+necessary, false... true to use overflow:'auto' on the components layout element and show scroll bars automatically when
+necessary, false to clip any overflowing content (defaults to false ). | BoxComponent | ||
autoSelect : Boolean true to select the first result gathered by the data store (defaults
+to true). A false value would require a manual ... true to select the first result gathered by the data store (defaults
+to true). A false value would require a manual selection from the dropdown list to set the components value
+unless the value of (typeAheadDelay) were true. | ComboBox | ||
autoShow : Boolean True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
them on render... 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). | Component | ||
blankText : String The error text to display if the allowBlank validation
-fails (defaults to 'This field is required') | TextField | ||
clearCls : String The CSS class used to to apply to the special clearing div rendered
+them on render (defaults to false). | Component | ||
autoWidth : Boolean True to use width:'auto', false to use fixed width (or allow it to be managed by its parent
+Container's layout manage... True to use width:'auto', false to use fixed width (or allow it to be managed by its parent +Container's layout manager. Defaults to false. +Note: Although many components inherit this config option, not all will +function as expected with a width of 'auto'. Setting autoWidth:true means that the +browser will manage width based on the element's contents, and that Ext will not manage it at all. +If the browser is managing the width, be aware that resizes performed by the browser in response +to changes within the structure of the Component cannot be detected. Therefore changes to the width might +result in elements needing to be synchronized with the new width. For example, where the target element is:
+A Panel rendered into that target element must listen for browser window resize in order to relay its
+child items when the browser changes its width:
| BoxComponent | ||
blankText : String The error text to display if the allowBlank validation
+fails (defaults to 'This field is required') | TextField | ||
boxMaxHeight : Number The maximum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size mana... The maximum value in pixels which this BoxComponent will set its height to. +Warning: This will override any size management applied by layout managers. | BoxComponent | ||
boxMaxWidth : Number The maximum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size manag... The maximum value in pixels which this BoxComponent will set its width to. +Warning: This will override any size management applied by layout managers. | BoxComponent | ||
boxMinHeight : Number The minimum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size mana... The minimum value in pixels which this BoxComponent will set its height to. +Warning: This will override any size management applied by layout managers. | BoxComponent | ||
boxMinWidth : Number The minimum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size manag... The minimum value in pixels which this BoxComponent will set its width to. +Warning: This will override any size management applied by layout managers. | BoxComponent | ||
bubbleEvents : Array An array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.... An array of events that, when fired, should be bubbled to any parent container. +See Ext.util.Observable.enableBubble. +Defaults to []. | Component | ||
clearCls : String The CSS class used to to apply to the special clearing div rendered
directly after each form field wrapper to provide... The CSS class used to to apply to the special clearing div rendered directly after each form field wrapper to provide field clearing (defaults to 'x-form-clear-left'). @@ -96,7 +203,22 @@ directly after each form field wrapper to provide field clearing (defaults to which has been configured to use the FormLayout layout manager (e.g. Ext.form.FormPanel or specifying layout:'form') and either a fieldLabel is specified or isFormField=true is specified.- See Ext.layout.FormLayout.fieldTpl also. | Component | ||
cls : String A custom CSS class to apply to the field's underlying element (defaults to ""). | Field | ||
ctCls : String An optional extra CSS class that will be added to this component's container. This can be useful for
+ See Ext.layout.FormLayout.fieldTpl also. | Component | ||
clearFilterOnReset : Boolean true to clear any filters on the store (when in local mode) when reset is called
+(defaults to true) | ComboBox | ||
cls : String A custom CSS class to apply to the field's underlying element (defaults to ''). | Field | ||
contentEl : String Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
+for this comp... Optional. Specify an existing HTML element, or the
| Component | ||
ctCls : String An optional extra CSS class that will be added to this component's container. This can be useful for
adding customize... An optional extra CSS class that will be added to this component's container. This can be useful for adding customized styles to the container or any of its children using standard CSS rules. See Ext.layout.ContainerLayout.extraCls also. @@ -107,28 +229,30 @@ which assigns a value by default:
- | Component | ||
disableKeyFilter : Boolean Specify true to disable input keystroke filtering (defaults
+ | Component | ||
data : Mixed The initial set of data to apply to the tpl to
+update the content area of the Component. | Component | ||
disableKeyFilter : Boolean Specify true to disable input keystroke filtering (defaults
to false) | TextField | ||
disabled : Boolean True to disable the field (defaults to false).
Be aware that conformant with the <a href="http://www.w3.org/TR/html40... True to disable the field (defaults to false).
Be aware that conformant with the HTML specification, disabled Fields will not be submitted. | Field | ||
disabledClass : String CSS class added to the component when it is disabled (defaults to 'x-item-disabled'). | Component | ||
displayField : String The underlying data field name to bind to this
-ComboBox (defaults to undefined if mode = 'remote' or 'text' if
-transf... The underlying data field name to bind to this
-ComboBox (defaults to undefined if mode = 'remote' or 'text' if
-transforming a select a select).
+ComboBox (defaults to undefined if mode = 'remote' or 'field1' if
+tran... The underlying data field name to bind to this
+ComboBox (defaults to undefined if mode = 'remote' or 'field1' if
+transforming a select or if the field name is autogenerated based on
+the store configuration).
See also valueField. Note: if using a ComboBox in an Editor Grid a renderer will be needed to show the displayField when the editor is not active. | ComboBox | ||
editable : Boolean false to prevent the user from typing text directly into the field,
the field will only respond to a click on the tri... false to prevent the user from typing text directly into the field,
-the field will only respond to a click on the trigger to set the value. (defaults to true) | TriggerField | ||
emptyClass : String The CSS class to apply to an empty field to style the emptyText
+the field will only respond to a click on the trigger to set the value. (defaults to true). | TriggerField | ||
emptyClass : String The CSS class to apply to an empty field to style the emptyText
(defaults to 'x-form-empty-field'). This class is au... 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. | TextField | ||
emptyText : String The default text to place into an empty field (defaults to null).
Note: that this value will be submitted to the serv... The default text to place into an empty field (defaults to null).
Note: that this value will be submitted to the server if this field is enabled and configured
with a name. | TextField | ||
enableKeyEvents : Boolean true to enable the proxying of key events for the HTML input
-field (defaults to false) | TextField | ||
fieldClass : String The default CSS class for the field (defaults to "x-form-field") | Field | ||
fieldLabel : String The label text to display next to this Component (defaults to '').
+field (defaults to false) | TextField | ||
fieldClass : String The default CSS class for the field (defaults to 'x-form-field') | Field | ||
fieldLabel : String The label text to display next to this Component (defaults to '').
Note: this config is only used when this Component... The label text to display next to this Component (defaults to ''). Note: this config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager (e.g. @@ -142,7 +266,13 @@ Example use:
| Component | ||
focusClass : String The CSS class to use when the field receives focus (defaults to "x-form-focus") | Field | ||
forceSelection : Boolean true to restrict the selected value to one of the values in the list,
+}); | Component | ||
flex : Number Note: this config is only used when this Component is rendered
+by a Container which has been configured to use a BoxL... Note: this config is only used when this Component is rendered
+by a Container which has been configured to use a BoxLayout.
+Each child Component with a | BoxComponent | ||
focusClass : String The CSS class to use when the field receives focus (defaults to 'x-form-focus') | Field | ||
forceSelection : Boolean true to restrict the selected value to one of the values in the list,
false to allow the user to set arbitrary text i... 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) | ComboBox | ||
handleHeight : Number The height in pixels of the dropdown list resize handle if
resizable = true (defaults to 8) | ComboBox | ||
height : Number The height of this component in pixels (defaults to auto).
@@ -187,7 +317,11 @@ is done while hidden). | 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. | Component | |
hideTrigger : Boolean true to hide the trigger element and display only the base
-text field (defaults to false) | TriggerField | ||
id : String The unique id of this component (defaults to an auto-assigned id).
+text field (defaults to false) | TriggerField | ||
html : String/Object An HTML fragment, or a DomHelper specification to use as the layout element
+content (defaults to ''). The HTML conten... An HTML fragment, or a DomHelper specification to use as the layout element
+content (defaults to ''). The HTML content is added after the component is rendered,
+so the document will not contain this HTML at the time the render event is fired.
+This content is inserted into the body before any configured contentEl is appended. | Component | ||
id : String The unique id of this component (defaults to an auto-assigned id).
You should assign an id if you need to be able to ... The unique id of this component (defaults to an auto-assigned id). You should assign an id if you need to be able to access the component later and you do not have an object reference available (e.g., using Ext.getCmp). @@ -198,13 +332,16 @@ sub-elements using this component's id as the parent.Note: to avoid complications imposed by a unique id also see
Note: to access the container of an item see | Component | ||
inputType : String The type attribute for input fields -- e.g. radio, text, password, file (defaults
-to "text"). The types "file" and "p... The type attribute for input fields -- e.g. radio, text, password, file (defaults
-to "text"). The types "file" and "password" must be used to render those field types currently -- there are
+to 'text'). The types 'file' and 'p... The type attribute for input fields -- e.g. radio, text, password, file (defaults
+to 'text'). The types 'file' and 'password' must be used to render those field types currently -- there are
no separate Ext components for those. Note that if you use inputType:'file', emptyText
-is not supported and should be avoided. | Field | ||
invalidClass : String The CSS class to use when marking a field invalid (defaults to "x-form-invalid") | Field | ||
invalidText : String The error text to use when marking a field invalid and no message is provided
-(defaults to "The value in this field i... The error text to use when marking a field invalid and no message is provided
-(defaults to "The value in this field is invalid") | Field | ||
itemCls : String An additional CSS class to apply to the div wrapping the form item
-element of this field. If supplied, itemCls at th... An additional CSS class to apply to the div wrapping the form item +is not supported and should be avoided. | Field | ||
invalidClass : String The CSS class to use when marking a field invalid (defaults to 'x-form-invalid') | Field | ||
invalidText : String The error text to use when marking a field invalid and no message is provided
+(defaults to 'The value in this field i... The error text to use when marking a field invalid and no message is provided
+(defaults to 'The value in this field is invalid') | Field | ||
itemCls : String Note: this config is only used when this Component is rendered by a Container which
+has been configured to use the Fo... Note: this config is only used when this Component is rendered by a Container which +has been configured to use the FormLayout layout manager (e.g. +Ext.form.FormPanel or specifying layout:'form'). + An additional CSS class to apply to the div wrapping the form item element of this field. If supplied, itemCls at the field level will override the default itemCls supplied at the container level. The value specified for itemCls will be added to the default class ('x-form-item'). @@ -213,22 +350,22 @@ the default itemCls supplied at the container level. The value s you to write standard CSS rules that can apply to the field, the label (if specified), or any other element within the markup for the field.Note: see the note for fieldLabel. -Example use:
| Component | ||
itemId : String An itemId can be used as an alternative way to get a reference to a component
when no object reference is available. ... An itemId can be used as an alternative way to get a reference to a component
when no object reference is available. Instead of using an
| ComboBox | ||
lazyRender : Boolean true to prevent the ComboBox from rendering until requested
(should always be used when rendering into an Ext.Editor ... true to prevent the ComboBox from rendering until requested
(should always be used when rendering into an Ext.Editor (e.g. Grids),
-defaults to false). | ComboBox | ||
listAlign : String A valid anchor position value. See Ext.Element.alignTo for details
-on supported anchor positions (defaults to 'tl-bl?... A valid anchor position value. See Ext.Element.alignTo for details
-on supported anchor positions (defaults to 'tl-bl?') | ComboBox | ||
listClass : String The CSS class to add to the predefined 'x-combo-list' class
+defaults to false). | ComboBox | ||
listAlign : String/Array A valid anchor position value. See Ext.Element.alignTo for details
+on supported anchor positions and offsets. To spec... A valid anchor position value. See Ext.Element.alignTo for details
+on supported anchor positions and offsets. To specify x/y offsets as well, this value
+may be specified as an Array of Ext.Element.alignTo method arguments.
+ (defaults to 'tl-bl?') | ComboBox | ||
listClass : String The CSS class to add to the predefined 'x-combo-list' class
applied the dropdown list element (defaults to ''). | ComboBox | ||
listEmptyText : String The empty text to display in the data view if no items are found.
(defaults to '') | ComboBox | ||
listWidth : Number The width (used as a parameter to Ext.Element.setWidth) of the dropdown
list (defaults to the width of the ComboBox f... The width (used as a parameter to Ext.Element.setWidth) of the dropdown
@@ -448,21 +587,19 @@ clicked, set to 'local' and manually load the store. To force a requer
triggerAction: 'all'
});
| ComboBox | ||
msgFx : String Experimental The effect used when displaying a validation message under the field
-(defaults to 'normal'). | Field | ||
msgTarget : String The location where error text should display. Should be one of the following values
-(defaults to 'qtip'):
-
-Value ... The location where error text should display. Should be one of the following values
-(defaults to 'qtip'):
- -Value Description ------------ ---------------------------------------------------------------------- -qtip Display a quick tip when the user hovers over the field -title Display a default browser title attribute popup -under Add a block div beneath the field containing the error text -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 - | Field | ||
name : String The field's HTML name attribute (defaults to "").
-Note: this property must be set if this field is to be automaticall... The field's HTML name attribute (defaults to "").
+(defaults to 'normal'). | Field | ||
msgTarget : String The location where the message text set through markInvalid should display.
+Must be one of the following values:
+<div... The location where the message text set through markInvalid should display. +Must be one of the following values: +
| Field | ||
name : String The field's HTML name attribute (defaults to '').
+Note: this property must be set if this field is to be automaticall... The field's HTML name attribute (defaults to '').
Note: this property must be set if this field is to be automatically included with
form submit(). | Field | ||
overCls : String An optional extra CSS class that will be added to this component's Element when the mouse moves
over the Element, and... An optional extra CSS class that will be added to this component's Element when the mouse moves
@@ -476,7 +613,8 @@ requirement for a ... An object or array of objects that
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. | Component | ||
ptype : String The registered ptype to create. This config option is not used when passing
+component as needed to provide its functionality. | Component | ||
preventMark : Boolean true to disable marking the field invalid.
+Defaults to false. | Field | ||
ptype : String The registered ptype to create. This config option is not used when passing
a config object into a constructor. This ... The registered ptype to create. This config option is not used when passing
a config object into a constructor. This config option is used only when
lazy instantiation is being used, and a Plugin is being
@@ -489,17 +627,12 @@ take advantage of lazy instantiation and rendering. | 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 = 'remote' or 10 if mode = 'local') | ComboBox | |
queryParam : String Name of the query (baseParam name for the store)
-as it will be passed on the querystring (defaults to 'query') | ComboBox | ||
readOnly : Boolean true to mark the field as readOnly in HTML
-(defaults to false).
-Note: this only sets the element's readOnly DOM attri... true to mark the field as readOnly in HTML
-(defaults to false).
- Note: this only sets the element's readOnly DOM attribute.
-Setting | Field | ||
ref : String A path specification, relative to the Component's ownerCt specifying into which
-ancestor Container to place a named r... A path specification, relative to the Component's ownerCt specifying into which -ancestor Container to place a named reference to this Component. +as it will be passed on the querystring (defaults to 'query') | ComboBox | ||
readOnly : Boolean true to prevent the user from changing the field, and
+hides the trigger. Superceeds the editable and hideTrigger opt... true to prevent the user from changing the field, and
+hides the trigger. Superceeds the editable and hideTrigger options if the value is true.
+(defaults to false) | TriggerField | ||
ref : String A path specification, relative to the Component's ownerCt
+specifying into which ancestor Container to place a named r... A path specification, relative to the Component's The ancestor axis can be traversed by using '/' characters in the path. For example, to put a reference to a Toolbar Button into the Panel which owns the Toolbar:
-In the code above, if the ref had been | Component | ||
regex : RegExp A JavaScript RegExp object to be tested against the field value during validation
+ In the code above, if the | Component | ||
regex : RegExp A JavaScript RegExp object to be tested against the field value during validation
(defaults to null). If the test fai... A JavaScript RegExp object to be tested against the field value during validation
(defaults to null). If the test fails, the field will be marked invalid using
regexText. | TextField | ||
regexText : String The error text to display if regex is used and the
@@ -603,14 +737,15 @@ Acceptable values for this property are:
Acceptable values for this property are:
See also mode. | ComboBox | ||
stripCharsRe : RegExp A JavaScript RegExp object used to strip unwanted content from the value
before validation (defaults to null). | TextField | ||
style : String A custom style specification to be applied to this component's Element. Should be a valid argument to
@@ -636,9 +771,16 @@ Ext.Element.ap... A custom style specification to be appl
}
})
]
-}); | Component | ||
tabIndex : Number The tabIndex for this field. Note this only applies to fields that are rendered,
+}); | Component | ||
submitValue : Boolean False to clear the name attribute on the field so that it is not submitted during a form post.
+If a hiddenName is spe... False to clear the name attribute on the field so that it is not submitted during a form post.
+If a hiddenName is specified, setting this to true will cause both the hidden field and the element to be submitted.
+Defaults to undefined. | ComboBox | ||
tabIndex : Number The tabIndex for this field. Note this only applies to fields that are rendered,
not those which are built via applyT... The tabIndex for this field. Note this only applies to fields that are rendered,
-not those which are built via applyTo (defaults to undefined). | Field | ||
title : String If supplied, a header element is created containing this text and added into the top of
+not those which are built via applyTo (defaults to undefined). | Field | ||
tabTip : String Note: this config is only used when this BoxComponent is a child item of a TabPanel.
+A string to be used as innerHTML... Note: this config is only used when this BoxComponent is a child item of a TabPanel. +A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over +the associated tab selector element. Ext.QuickTips.init() +must be called in order for the tips to render. | BoxComponent | ||
title : String If supplied, a header element is created containing this text and added into the top of
the dropdown list (defaults t... 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) | ComboBox | ||
tpl : String/Ext.XTemplate The template string, or Ext.XTemplate instance to
use to display each item in the dropdown list. The dropdown list is... The template string, or Ext.XTemplate instance to @@ -652,7 +794,11 @@ names from the Combo's itemSelector for additional details. | ComboBox | ||
transform : Mixed The id, DOM node or element of an existing HTML SELECT to convert to a ComboBox.
+ Also see itemSelector for additional details. | ComboBox | ||
tplWriteMode : String The Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.X... The Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.XTemplate.overwrite ). | Component | ||
transform : Mixed The id, DOM node or element of an existing HTML SELECT to convert to a ComboBox.
Note that if you specify this and th... The id, DOM node or element of an existing HTML SELECT to convert to a ComboBox.
Note that if you specify this and the combo is going to be in an Ext.form.BasicForm or
Ext.form.FormPanel, you must also set lazyRender = true. | ComboBox | ||
triggerAction : String The action to execute when the trigger is clicked.
@@ -682,17 +828,28 @@ to false) | ComboBox | ||
ComboBox | |||
validateOnBlur : Boolean Whether the field should validate when it loses focus (defaults to true). | Field | ||
validationDelay : Number The length of time in milliseconds after user input begins until validation
is initiated (defaults to 250) | Field | ||
validationEvent : String/Boolean The event that should initiate field validation. Set to false to disable
- automatic validation (defaults to "key... The event that should initiate field validation. Set to false to disable
- automatic validation (defaults to "keyup"). | Field | ||
validator : Function A custom validation function to be called during field validation
-(defaults to null). If specified, this function wil... A custom validation function to be called during field validation
+ automatic validation (defaults to 'key... The event that should initiate field validation. Set to false to disable
+ automatic validation (defaults to 'keyup'). | Field | ||
validator : Function A custom validation function to be called during field validation (validateValue)
+(defaults to null). If specified, t... A custom validation function to be called during field validation (validateValue) (defaults to null). If specified, this function will be called first, allowing the -developer to override the default validation process. This function 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. | TextField | ||
value : Mixed A value to initialize this field with (defaults to undefined). | Field | ||
valueField : String The underlying data value name to bind to this
-ComboBox (defaults to undefined if mode = 'remote' or 'value' if
-trans... The underlying data value name to bind to this
-ComboBox (defaults to undefined if mode = 'remote' or 'value' if
-transforming a select).
+developer to override the default validation process.
+ This function will be passed the following Parameters: +
This function is to Return: +
| TextField | ||
value : Mixed A value to initialize this field with (defaults to undefined). | Field | ||
valueField : String The underlying data value name to bind to this
+ComboBox (defaults to undefined if mode = 'remote' or 'field2' if
+tran... The underlying data value name to bind to this
+ComboBox (defaults to undefined if mode = 'remote' or 'field2' if
+transforming a select or if the field name is autogenerated based on
+the store configuration).
Note: use of a valueField requires the user to make a selection in order for a value to be mapped. See also hiddenName, hiddenValue, and displayField. | ComboBox | ||
valueNotFoundText : String When using a name/value combo, if the value passed to setValue is not found in
the store, valueNotFoundText will be d... When using a name/value combo, if the value passed to setValue is not found in
@@ -731,7 +888,22 @@ config for a suggestion, or use a render listener directly:
-See also getEl | Component | ||
hidden : Boolean True if this component is hidden. Read-only. | Component | ||
initialConfig : Object This Component's initial configuration specification. Read-only. | Component | ||
lastQuery : String The value of the match string used to filter the store. Delete this property to force a requery.
+ See also getEl | Component | ||
hidden : Boolean True if this component is hidden. Read-only. | Component | ||
initialConfig : Object This Component's initial configuration specification. Read-only. | Component | ||
keyNav : Ext.KeyNav +<p>A {@link Ext.KeyNav KeyNav} object which handles navigation keys for this ComboBox. This performs actions +based on keystrokes typed when the input field is focused.</p> +<p><b>After the ComboBox has been rendered</b>, you may override existing navigation key functionality, +or add your own based upon key names as specified in the {@link Ext.KeyNav KeyNav} class.</p> +<p>The function is executed in the scope (<code>this</code> reference of the ComboBox. Example:</p><pre><code> +myCombo.keyNav.esc = function(e) { // Override ESC handling function + this.collapse(); // Standard behaviour of Ext's ComboBox. + this.setValue(this.startValue); // We reset to starting value on ESC +}; +myCombo.keyNav.tab = function() { // Override TAB handling function + this.onViewClick(false); // Select the currently highlighted row +}; +</code></pre> | ComboBox | ||
label : Ext.Element The label Element associated with this Field. Only available after this Field has been rendered by a
+Ext.layout.FormL... The label Element associated with this Field. Only available after this Field has been rendered by a +Ext.layout.FormLayout layout manager. | Field | ||
lastQuery : String The value of the match string used to filter the store. Delete this property to force a requery.
Example use:
var com... The value of the match string used to filter the store. Delete this property to force a requery.
Example use:
@@ -757,15 +929,22 @@ configure the combo with lastQuery=''. Example use:
}); | ComboBox | ||
originalValue : mixed The original value of the field as configured in the value configuration, or
as loaded by the last form load operatio... The original value of the field as configured in the value configuration, or
as loaded by the last form load operation if the form's trackResetOnLoad
-setting is true . | Field | ||
ownerCt : Ext.Container The component's owner Ext.Container (defaults to undefined, and is set automatically when
-the component is added to a... The component's owner Ext.Container (defaults to undefined, and is set automatically when
-the component is added to a container). Read-only.
- Note: to access items within the container see itemId. | Component | ||
rendered : Boolean True if this component has been rendered. Read-only. | Component | ||
view : Ext.DataView The DataView used to display the ComboBox's options. | ComboBox |
Method | Defined By | |||
---|---|---|---|---|
ComboBox( Object config )
- Create a new ComboBox. Create a new ComboBox. Parameters:
| ComboBox | |||
addClass( string cls )
- :
- Ext.ComponentAdds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. Parameters:
| Component | |||
addEvents( Object object )
- :
- voidUsed to define events on this Observable Used to define events on this Observable Parameters:
| Observable | |||
addListener( String eventName , Function handler , [Object scope ], [Object options ] )
+setting is true . | Field | |||
ownerCt : Ext.Container This Component's owner Container (defaults to undefined, and is set automatically when
+this Component is added to a C... | Component | |||
refOwner : Ext.Container The ancestor Container into which the ref reference was inserted if this Component
+is a child of a Container, and has... The ancestor Container into which the ref reference was inserted if this Component
+is a child of a Container, and has been configured with a ref . | Component | |||
rendered : Boolean True if this component has been rendered. Read-only. | Component | |||
startValue : mixed The value that the Field had at the time it was last focused. This is the value that is passed
+to the change event wh... The value that the Field had at the time it was last focused. This is the value that is passed +to the change event which is fired if the value has been changed when the Field is blurred. +This will be undefined until the Field has been visited. Compare originalValue. | Field | |||
view : Ext.DataView The DataView used to display the ComboBox's options. | ComboBox |
Method | Defined By | ||
---|---|---|---|
ComboBox( Object config )
+ Create a new ComboBox. Create a new ComboBox. Parameters:
| ComboBox | ||
addClass( string cls )
+ :
+ Ext.ComponentAdds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. Parameters:
| Component | ||
addEvents( Object|String o , string Optional. )
+ :
+ voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. Parameters:
| Observable | ||
addListener( String eventName , Function handler , [Object scope ], [Object options ] )
:
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:
| Observable | ||
applyToMarkup( String/HTMLElement el )
:
voidApply this component to existing markup that is valid. With this function, no call to render() is required. Apply this component to existing markup that is valid. With this function, no call to render() is required. Parameters:
| Component | ||
clearInvalid()
@@ -843,9 +1022,41 @@ query allowing the query action to be canceled if needed. minChars config option. It
also clears any filter previously saved in the current store (defaults to false) Returns:
| ComboBox | ||
enable()
:
- Ext.Component Enable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. Parameters:
| Component | ||
enableBubble( Object events )
- :
- voidUsed to enable bubbling of events Used to enable bubbling of events Parameters:
| Observable | ||
expand()
+ Ext.Component Enable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. Parameters:
| Component | ||
enableBubble( String/Array events )
+ :
+ voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present.... Enables events fired by this Observable to bubble up an owner hierarchy by calling
+ This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default +implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to +access the required target more quickly. +Example:
Parameters:
| Observable | ||
expand()
:
void Expands the dropdown list if it is currently hidden. Fires the expand event on completion. Expands the dropdown list if it is currently hidden. Fires the expand event on completion. Parameters:
| ComboBox | ||
findParentBy( Function fn )
:
@@ -860,7 +1071,9 @@ An event may be set to bubble up an Obse...Fires the An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble. Parameters:
| Observable | ||
focus( [Boolean selectText ], [Boolean/Number delay ] )
:
- Ext.ComponentTry to focus this component. Try to focus this component. Parameters:
| Component | ||
getBox( [Boolean local ] )
+ Ext.ComponentTry to focus this component. Try to focus this component. Parameters:
| Component | ||
getActiveError()
+ :
+ String Gets the active error message for this field. Gets the active error message for this field. Parameters:
| Field | ||
getBox( [Boolean local ] )
:
ObjectGets the current box measurements of the component's underlying element. Gets the current box measurements of the component's underlying element. Parameters:
| BoxComponent | ||
getBubbleTarget()
:
@@ -882,7 +1095,63 @@ or use a render listener directly:
Parameters:
| Component | ||
getHeight()
+}); Parameters:
| Component | ||
getErrors( Mixed value )
+ :
+ ArrayValidates a value according to the field's validation rules and returns an array of errors
+for any failing validation... Validates a value according to the field's validation rules and returns an array of errors +for any failing validations. Validation rules are processed in the following order: +
Parameters: | TextField | ||
getHeight()
:
Number Gets the current height of the component's underlying element. Gets the current height of the component's underlying element. Parameters:
| BoxComponent | ||
getId()
:
@@ -942,7 +1211,7 @@ attribute of the field if available. Paramete
:
Mixed Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue... Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue. Parameters:
| Field | ||
getResizeEl()
:
- void Returns the outermost Element of this Component which defines the Components overall size.
+ Ext.Element Returns the outermost Element of this Component which defines the Components overall size.
Usually this will return t... Returns the outermost Element of this Component which defines the Components overall size. Usually this will return the same Element as An example is a ComboBox. It is encased in a wrapping Element which
contains both the Parameters:
| BoxComponent | ||
getSize()
+This Element is returned as the resizeEl .Parameters:
| BoxComponent | ||
getSize()
:
Object Gets the current size of the component's underlying element. Gets the current size of the component's underlying element. Parameters:
| BoxComponent | ||
getStore() : @@ -994,7 +1263,11 @@ is not disabled), false otherwise. | Returns true if the dropdown list is expanded, else false. Returns true if the dropdown list is expanded, else false. Parameters:
| ComboBox | |
isValid( Boolean preventMark )
:
- BooleanReturns whether or not the field value is currently valid Returns whether or not the field value is currently valid Parameters:
| Field | ||
isVisible()
+ Boolean Returns whether or not the field value is currently valid by
+validating the processed value
+of the field. Note: disab... Returns whether or not the field value is currently valid by
+validating the processed value
+of the field. Note: disabled fields are ignored. Parameters:
| Field | ||
isVisible()
:
Boolean Returns true if this component is visible. Returns true if this component is visible. Parameters:
| Component | ||
isXType( String xtype , [Boolean shallow ] )
:
@@ -1011,16 +1284,45 @@ to participate in determination of inherited xtypes.
var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instanceParameters:
| Component | ||
markInvalid( [String msg ] )
:
- voidMark this field as invalid, using msgTarget to determine how to display the error and
-applying invalidClass to the fi... Mark this field as invalid, using msgTarget to determine how to display the error and
-applying invalidClass to the field's element. Parameters:
| Field | ||
nextSibling()
+ void Display an error message associated with this field, using msgTarget to determine how to
+display the message and appl... Display an error message associated with this field, using msgTarget to determine how to +display the message and applying invalidClass to the field's UI element. +Note: this method does not cause the Field's validate method to return Parameters:
| Field | ||
mon( Observable|Element item , Object|String ename , Function fn , Object scope , Object opt )
+ :
+ voidAdds listeners to any Observable object (or Elements) which are automatically removed when this Component
+is destroye... Adds listeners to any Observable object (or Elements) which are automatically removed when this Component +is destroyed. Usage:
+or:
Parameters:
| Component | ||
mun( Observable|Element item , Object|String ename , Function fn , Object scope )
+ :
+ voidRemoves listeners that were added by the mon method. Removes listeners that were added by the mon method. Parameters:
| Component | ||
nextSibling()
:
Ext.Component Returns the next component in the owning container Returns the next component in the owning container Parameters:
| Component | ||
on( String eventName , Function handler , [Object scope ], [Object options ] )
:
voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:
| Observable | ||
previousSibling()
:
- Ext.Component Returns the previous component in the owning container Returns the previous component in the owning container Parameters:
| Component | ||
purgeListeners()
+ Ext.Component Returns the previous component in the owning container Returns the previous component in the owning container Parameters:
| Component | ||
processValue( Mixed value )
+ :
+ voidThis method should only be overridden if necessary to prepare raw values
+for validation (see validate and isValid). ... | Field | ||
purgeListeners()
:
void Removes all listeners for this object Removes all listeners for this object Parameters:
| Observable | ||
relayEvents( Object o , Array events )
:
@@ -1074,17 +1376,25 @@ The sto...Select an item in the dropdown list by its dat
The store must be loaded and the list expanded for this function to work, otherwise use setValue. Parameters:
| ComboBox | ||
selectText( [Number start ], [Number end ] )
:
- voidSelects text in this field Selects text in this field Parameters:
| TextField | ||
setDisabled( Boolean disabled )
+ voidSelects text in this field Selects text in this field Parameters:
| TextField | ||
setActiveError( String msg , Boolean suppressEvent )
+ :
+ voidSets the current activeError to the given string. Fires the 'invalid' event.
+This does not set up the error icon, onl... Sets the current activeError to the given string. Fires the 'invalid' event.
+This does not set up the error icon, only sets the message and fires the event. To show the error icon,
+use markInvalid instead, which calls this method internally Parameters:
| Field | ||
setAutoScroll( Boolean scroll )
+ :
+ Ext.BoxComponentSets the overflow on the content element of the component. Sets the overflow on the content element of the component. Parameters:
| BoxComponent | ||
setDisabled( Boolean disabled )
:
Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. Parameters:
| Component | ||
setEditable( Boolean value )
:
- voidAllow or prevent the user from directly editing the field text. If false is passed,
-the user will only be able to mo... Allow or prevent the user from directly editing the field text. If false is passed,
-the user will only be able to modify the field using the trigger. This method
-is the runtime equivalent of setting the 'editable' config option at config time. Parameters:
| TriggerField | ||
setHeight( Number height )
+ voidParameters:
| TriggerField | ||
setHeight( Mixed height )
:
- Ext.BoxComponentSets the height of the component. This method fires the resize event. Sets the height of the component. This method fires the resize event. Parameters:
| BoxComponent | ||
setPagePosition( Number x , Number y )
@@ -1097,7 +1407,13 @@ This method fires the Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
This method fires the move event.Parameters:
| BoxComponent | ||
setRawValue( Mixed value )
:
- MixedSets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue. Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue. Parameters:
| Field | ||
setSize( Mixed width , Mixed height )
+ MixedSets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue. Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue. Parameters:
| Field | ||
setReadOnly( Boolean value )
+ :
+ voidParameters:
| TriggerField | ||
setSize( Mixed width , Mixed height )
:
Ext.BoxComponentSets the width and height of this BoxComponent. This method fires the resize event. This method can accept
either wid... Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept
@@ -1119,10 +1435,10 @@ will be displayed in the field. If the value does not match the data value of a
and the valueNotFoundText config option is defined, it will be displayed as the default field text.
Otherwise the field will be blank (although the value will still be set). Parameters:
| ComboBox | ||
setVisible( Boolean visible )
:
- Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters:
| Component | ||
setWidth( Number width )
+ Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters:
| Component | ||
setWidth( Mixed width )
:
- Ext.BoxComponentSets the width of the component. This method fires the resize event. Sets the width of the component. This method fires the resize event. Parameters:
| BoxComponent | ||
show()
:
@@ -1136,15 +1452,28 @@ after the Force the component's size to recalculate based on the underlying element's current height and width. Force the component's size to recalculate based on the underlying element's current height and width. Parameters:
| BoxComponent | ||
un( String eventName , Function handler , [Object scope ] )
:
- voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable | ||
updateBox( Object box )
+ voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable | ||
unsetActiveError( Boolean suppressEvent )
+ :
+ voidClears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not
+usually n... Clears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not
+usually need to be called manually Parameters:
| Field | ||
update( Mixed htmlOrData , [Boolean loadScripts ], [Function callback ] )
+ :
+ voidUpdate the content area of a component. Update the content area of a component. Parameters:
| Component | ||
updateBox( Object box )
:
Ext.BoxComponentSets the current box measurements of the component's underlying element. Sets the current box measurements of the component's underlying element. Parameters:
| BoxComponent | ||
validate()
:
- Boolean Validates the field value Validates the field value Parameters:
| Field | ||
validateValue( Mixed value )
+ BooleanValidates the field value Validates the field value Parameters:
| Field | ||
validateValue( Mixed The )
:
- BooleanValidates a value according to the field's validation rules and marks the field as invalid
-if the validation fails Validates a value according to the field's validation rules and marks the field as invalid
-if the validation fails Parameters:
| TextField |
Event | Defined By | |
---|---|---|
afterrender :
+ Boolean Uses getErrors to build an array of validation errors. If any errors are found, markInvalid is called
+with the first ... Uses getErrors to build an array of validation errors. If any errors are found, markInvalid is called
+with the first and false is returned, otherwise true is returned. Previously, subclasses were invited
+to provide an implementation of this to process validations - from 3.2 onwards getErrors should be
+overridden instead. Parameters:
| Field |
Event | Defined By | |
---|---|---|
added :
+ ( Ext.Component this , Ext.Container ownerCt , number index )
+ Fires when a component is added to an Ext.Container Fires when a component is added to an Ext.Container Listeners will be called with the following arguments:
| Component | |
afterrender :
( Ext.Component this )
Fires after the component rendering is finished.
The afterrender event is fired after this Component has been rendere... Fires after the component rendering is finished. @@ -1226,7 +1555,9 @@ is set to true.
is set to true. Keyup input field event. This event only fires if enableKeyEvents
is set to true. Listeners will be called with the following arguments:
| TextField | |
move :
( Ext.Component this , Number x , Number y )
- Fires after the component is moved. Fires after the component is moved. Listeners will be called with the following arguments:
| BoxComponent | |
render :
+ Fires after the component is moved. Fires after the component is moved. Listeners will be called with the following arguments:
| BoxComponent | |
removed :
+ ( Ext.Component this , Ext.Container ownerCt )
+ Fires when a component is removed from an Ext.Container Fires when a component is removed from an Ext.Container Listeners will be called with the following arguments:
| Component | |
render :
( Ext.Component this )
Fires after the component markup is rendered. Fires after the component markup is rendered. Listeners will be called with the following arguments:
| Component | |
resize :
( Ext.Component this , Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight )
|