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.
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.
- | Component | |
| autoCreate : String/Object A DomHelper element spec, or true for a default
+ | Component | |
| autoCreate : String/Object A DomHelper element spec, or true for a default
element spec. Used to create the Element which will encapsulate this ... | ComboBox | |
| autoScroll : Boolean true to use overflow:'auto' on the components layout element and show scroll bars automatically when
+ | 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 | |
| autoShow : Boolean True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
+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 | |
| boxMaxHeight : Number The maximum value in pixels which this BoxComponent will set its height to.
+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: | 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 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 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 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 | |
| clearCls : String The CSS class used to to apply to the special clearing div rendered
+ Warning: This will override any size management applied by layout managers. | BoxComponent | |
| 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'). @@ -107,7 +201,7 @@ which has been configured to use the 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 | |
| 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
+(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
items.Add either the
-x-hidden or the x-hide-display CSS class to
prevent a brief flicker of the content before it is rendered to the panel. | Component | |
| ctCls : String An optional extra CSS class that will be added to this component's container. This can be useful for
+ | 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. @@ -134,11 +228,11 @@ To configure the above Class with an extra CSS class append to the default. For for BoxLayout (Hbox and Vbox): | 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).
+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 'field1' if
+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 '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
@@ -146,16 +240,16 @@ 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,
+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).
+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. @@ -169,28 +263,34 @@ 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).
+resizable = true (defaults to 8) | ComboBox | |
| height : Number The height of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset s... The height of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset see Ext.Component.anchor. | BoxComponent | |
| hidden : Boolean Render this component hidden (default is false). If true, the
-hide method will be called internally. | Component | |
| hiddenId : String If hiddenName is specified, hiddenId can also be provided
+hide method will be called internally. | Component | |
| hiddenId : String If hiddenName is specified, hiddenId can also be provided
to give the hidden field a unique id (defaults to the hidde... If hiddenName is specified, hiddenId can also be provided
to give the hidden field a unique id (defaults to the hiddenName). The hiddenId
and combo id should be different, since no two DOM
-nodes should share the same id. | ComboBox | |
| hiddenName : String If specified, a hidden form field with this name is dynamically generated to store the
+nodes should share the same id. | ComboBox | |
| hiddenName : String If specified, a hidden form field with this name is dynamically generated to store the
field's data value (defaults t... 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. See also valueField.
Note: the hidden field's id will also default to this name if hiddenId is not specified. The ComboBox id and the hiddenId should be different, since no two DOM nodes should share the same id. So, if the ComboBox name and -hiddenName are the same, you should specify a unique hiddenId. | ComboBox | |
| hiddenValue : String Sets the initial value of the hidden field if hiddenName is
+hiddenName are the same, you should specify a unique hiddenId. | ComboBox | |
| hiddenValue : String Sets the initial value of the hidden field if hiddenName is
specified to contain the selected valueField, from the St... Sets the initial value of the hidden field if hiddenName is
specified to contain the selected valueField, from the Store. Defaults to the configured
-value. | ComboBox | |
| hideLabel : Boolean true to completely hide the label element
-(label and separator). Defaults to false.
+value. | ComboBox | |
| hideLabel : Boolean true to completely hide the label element
+(label and separator). Defaults to false.
By default, even if you do not sp... true to completely hide the label element (label and separator). Defaults to false. By default, even if you do not specify a fieldLabel the space will still be @@ -204,21 +304,21 @@ Example use: | Component | |
| hideMode : String How this component should be hidden. Supported values are 'visibility'
+}); | Component | |
| hideMode : String How this component should be hidden. Supported values are 'visibility'
(css visibility), 'offsets' (negative offset p... How this component should be hidden. Supported values are 'visibility' (css visibility), 'offsets' (negative offset position) and 'display' (css display). Note: the default of 'display' is generally preferred since items are automatically laid out when they are first shown (no sizing -is done while hidden). | Component | |
| hideParent : Boolean True to hide and show the component's container when hide/show is called on the component, false to hide
+is done while hidden). | Component | |
| hideParent : Boolean True to hide and show the component's container when hide/show is called on the component, false to hide
and show the... 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 | |
| html : String/Object An HTML fragment, or a DomHelper specification to use as the layout element
+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).
+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). @@ -228,13 +328,13 @@ rules to style the specific instance of this component uniquely, and also to sel 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
+ 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
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
+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
+(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'). @@ -263,7 +363,7 @@ Example use: | Component | |
| itemId : String An itemId can be used as an alternative way to get a reference to a component
+}); | 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 Note: to access the container of an item see ownerCt. | Component | |
| itemSelector : String A simple CSS selector (e.g. div.some-class or span:first-child) that will be
+ Note: to access the container of an item see ownerCt. | Component | |
| itemSelector : String A simple CSS selector (e.g. div.some-class or span:first-child) that will be
used to determine what nodes the Ext.Dat... A simple CSS selector (e.g. div.some-class or span:first-child) that will be used to determine what nodes the Ext.DataView which handles the dropdown display will be working with. Note: this setting is required if a custom XTemplate has been specified in tpl which assigns a class other than 'x-combo-list-item'-to dropdown list items | ComboBox | |
| labelSeparator : String The separator to display after the text of each
-fieldLabel. This property may be configured at various levels.
+to dropdown list items | ComboBox | |
| labelSeparator : String The separator to display after the text of each
+fieldLabel. This property may be configured at various levels.
The o... The separator to display after the text of each fieldLabel. This property may be configured at various levels. The order of precedence is: @@ -327,7 +427,7 @@ Example use: | Component | |
| labelStyle : String A CSS style specification string to apply directly to this field's
+}); | Component | |
| labelStyle : String A CSS style specification string to apply directly to this field's
label. Defaults to the container's labelStyle val... A CSS style specification string to apply directly to this field's label. Defaults to the container's labelStyle value if set (e.g., Ext.layout.FormLayout.labelStyle , or ''). @@ -343,16 +443,18 @@ Example use: | Component | |
| lazyInit : Boolean true to not initialize the list for this combo until the field is focused
-(defaults to true) | ComboBox | |
| lazyRender : Boolean true to prevent the ComboBox from rendering until requested
+(defaults to true) | 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.
+ | 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
+(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
-list (defaults to the width of the ComboBox field). See also minListWidth | ComboBox | |
| listeners : Object A config object containing one or more event handlers to be added to this
+list (defaults to the width of the ComboBox field). See also minListWidth | ComboBox | |
| listeners : Object A config object containing one or more event handlers to be added to this
object during initialization. This should ... A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once. @@ -407,9 +509,9 @@ Ext.DomObserver = Ext.extend(Object, { typeAhead: true, mode: 'local', triggerAction: 'all' -}); | Observable | |
| loadingText : String The text to display in the dropdown list while data is loading. Only applies
+}); | Observable | |
| loadingText : String The text to display in the dropdown list while data is loading. Only applies
when mode = 'remote' (defaults to 'Load... The text to display in the dropdown list while data is loading. Only applies
-when mode = 'remote' (defaults to 'Loading...') | ComboBox | |
| margins : Object Note: this config is only used when this BoxComponent is rendered
+when mode = 'remote' (defaults to 'Loading...') | ComboBox | |
| margins : Object Note: this config is only used when this BoxComponent is rendered
by a Container which has been configured to use the... Note: this config is only used when this BoxComponent is rendered by a Container which has been configured to use the BorderLayout or one of the two BoxLayout subclasses. @@ -432,7 +534,7 @@ to the second, and the bottom is set to the third.Defaults to: | BoxComponent | |
| maskRe : RegExp An input mask regular expression that will be used to filter keystrokes that do
not match (defaults to null) | TextField | |
| maxHeight : Number The maximum height in pixels of the dropdown list before scrollbars are shown
-(defaults to 300) | ComboBox | |
| maxLength : Number Maximum input field length allowed by validation (defaults to Number.MAX_VALUE).
+(defaults to 300) | ComboBox | |
| maxLength : Number Maximum input field length allowed by validation (defaults to Number.MAX_VALUE).
This behavior is intended to provide... Maximum input field length allowed by validation (defaults to Number.MAX_VALUE).
This behavior is intended to provide instant feedback to the user by improving usability to allow pasting
and editing or overtyping and back tracking. To restrict the maximum number of characters that can be
@@ -443,20 +545,20 @@ any attributes you want to a field, for example: | TextField | |
| maxLengthText : String Error text to display if the maximum length
+}); | TextField | |
| maxLengthText : String Error text to display if the maximum length
validation fails (defaults to 'The maximum length for this field is {maxL... Error text to display if the maximum length
-validation fails (defaults to 'The maximum length for this field is {maxLength}') | TextField | |
| minChars : Number The minimum number of characters the user must type before autocomplete and
+validation fails (defaults to 'The maximum length for this field is {maxLength}') | TextField | |
| minChars : Number The minimum number of characters the user must type before autocomplete and
typeAhead activate (defaults to 4 if mode... | ComboBox | |
| minHeight : Number The minimum height in pixels of the dropdown list when the list is constrained by its
+editable = false). | ComboBox | |
| minHeight : Number The minimum height in pixels of the dropdown list when the list is constrained by its
distance to the viewport edges ... The minimum height in pixels of the dropdown list when the list is constrained by its
-distance to the viewport edges (defaults to 90) | ComboBox | |
| minLength : Number Minimum input field length required (defaults to 0) | TextField | |
| minLengthText : String Error text to display if the minimum length
+distance to the viewport edges (defaults to 90) | ComboBox | |
| minLength : Number Minimum input field length required (defaults to 0) | TextField | |
| minLengthText : String Error text to display if the minimum length
validation fails (defaults to 'The minimum length for this field is {minL... Error text to display if the minimum length
validation fails (defaults to 'The minimum length for this field is {minLength}') | TextField | |
| minListWidth : Number The minimum width of the dropdown list in pixels (defaults to 70, will
-be ignored if listWidth has a higher value) | ComboBox | |
| mode : String Acceptable values are:
-<div class="mdetail-params">
-'remote' : Default
+be ignored if listWidth has a higher value) | ComboBox | |
| mode : String Acceptable values are:
+<div class="mdetail-params">
+'remote' : Default
<p class="sub-desc">Automatically loads the st... Acceptable values are:
| ComboBox | |
| msgFx : String Experimental The effect used when displaying a validation message under the field
-(defaults to 'normal'). | Field | |
| msgTarget<p>The : String location where the message text set through markInvalid should display.
-Must be one of the following values:
-<div cl... location where the message text set through markInvalid should display.
+(defaults to 'normal'). | Field | |
| msgTarget<p>The : String location where the message text set through markInvalid should display.
+Must be one of the following values:
+<div cla... 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 '').
+ | 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
+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
over the Element, and removed when the mouse moves out. (defaults to ''). This can be
-useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. | Component | |
| pageSize : Number If greater than 0, a Ext.PagingToolbar is displayed in the
+useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. | Component | |
| pageSize : Number If greater than 0, a Ext.PagingToolbar is displayed in the
footer of the dropdown list and the filter queries will ex... If greater than 0, a Ext.PagingToolbar 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 = 'remote'
-(defaults to 0). | ComboBox | |
| pageX : Number The page level x coordinate for this component if contained within a positioning container. | BoxComponent | |
| pageY : Number The page level y coordinate for this component if contained within a positioning container. | BoxComponent | |
| plugins : Object/Array An object or array of objects that will provide custom functionality for this component. The only
+(defaults to 0). | ComboBox | |
| pageX : Number The page level x coordinate for this component if contained within a positioning container. | BoxComponent | |
| pageY : Number The page level y coordinate for this component if contained within a positioning container. | BoxComponent | |
| plugins : Object/Array An object or array of objects that will provide custom functionality for this component. The only
requirement for a ... 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. | 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
+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
@@ -518,14 +620,14 @@ object. The ptype will be looked up at render time up to determine
type of Plugin to create. If you create your own Plugins, you may register them using Ext.ComponentMgr.registerPlugin in order to be able to -take advantage of lazy instantiation and rendering. | Component | |
| queryDelay : Number The length of time in milliseconds to delay between the start of typing and
+take advantage of lazy instantiation and rendering. | Component | |
| queryDelay : Number The length of time in milliseconds to delay between the start of typing and
sending the query to filter the dropdown ... | 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 prevent the user from changing the field, and
+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
+(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. @@ -549,16 +651,16 @@ For example, to put a reference to a Toolbar Button into the Panel which owns In the code above, if the | Component | |
| regex : RegExp | 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
-test fails during validation (defaults to '') | TextField | |
| region : String Note: this config is only used when this BoxComponent is rendered
+test fails during validation (defaults to '') | TextField | |
| region : String Note: this config is only used when this BoxComponent is rendered
by a Container which has been configured to use the... Note: this config is only used when this BoxComponent is rendered by a Container which has been configured to use the BorderLayout layout manager (e.g. specifying layout:'border'). - See Ext.layout.BorderLayout also. | BoxComponent | |
| renderTo : Mixed Specify the id of the element, a DOM element or an existing Element that this component
-will be rendered into.
+ See Ext.layout.BorderLayout also. | BoxComponent | |
| renderTo : Mixed Specify the id of the element, a DOM element or an existing Element that this component
+will be rendered into.
Notes ... Specify the id of the element, a DOM element or an existing Element that this component will be rendered into.
When using this config, a call to render() is not required.
See render also. | Component | |
| resizable : Boolean true to add a resize handle to the bottom of the dropdown list
-(creates an Ext.Resizable with 'se' pinned handles).
+ See render also. | Component | |
| resizable : Boolean true to add a resize handle to the bottom of the dropdown list
+(creates an Ext.Resizable with 'se' pinned handles).
D... true to add a resize handle to the bottom of the dropdown list
(creates an Ext.Resizable with 'se' pinned handles).
-Defaults to false. | ComboBox | |
| selectOnFocus : Boolean true to select any existing text in the field immediately on focus.
-Only applies when editable = true (defaults to
+Defaults to false. | ComboBox | |
| selectOnFocus : Boolean true to select any existing text in the field immediately on focus.
+Only applies when editable = true (defaults to
fa... true to select any existing text in the field immediately on focus.
Only applies when editable = true (defaults to
false). | ComboBox | |
| selectedClass : String CSS class to apply to the selected item in the dropdown list
(defaults to 'x-combo-selected') | ComboBox | |
| shadow : Boolean/String true or "sides" for the default effect, "frame" for
-4-way shadow, and "drop" for bottom-right | ComboBox | |
| stateEvents : Array An array of events that, when fired, should trigger this component to
+4-way shadow, and "drop" for bottom-right | ComboBox | |
| stateEvents : Array An array of events that, when fired, should trigger this component to
save its state (defaults to none). stateEvents ... An array of events that, when fired, should trigger this component to
save its state (defaults to none). See | Component | |
| stateId : String The unique id for this component to use for state management purposes
+restoring Component state. | Component | |
| stateId : String The unique id for this component to use for state management purposes
(defaults to the component id if one was set, o... The unique id for this component to use for state management purposes
(defaults to the component id if one was set, otherwise null if the
component is using a generated id).
See | Component | |
| stateful : Boolean A flag which causes the Component to attempt to restore the state of
+restoring Component state. | Component | |
| stateful : Boolean A flag which causes the Component to attempt to restore the state of
internal properties from a saved state on startu... A flag which causes the Component to attempt to restore the state of
internal properties from a saved state on startup. The component must have
either a You can perform extra processing on state save and restore by attaching handlers to the beforestaterestore, staterestore, -beforestatesave and statesave events. | Component | |
| store : Ext.data.Store/Array The data source to which this combo is bound (defaults to undefined).
-Acceptable values for this property are:
+beforestatesave and statesave events. | Component | |
| store : Ext.data.Store/Array The data source to which this combo is bound (defaults to undefined).
+Acceptable values for this property are:
<div c... The data source to which this combo is bound (defaults to undefined).
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
+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
Ext.Element.ap... A custom style specification to be applied to this component's Element. Should be a valid argument to
Ext.Element.applyStyles.
A custom style specification to be appl
}
})
]
-}); | Component | |
| submitValue : Boolean False to clear the name attribute on the field so that it is not submitted during a form post.
+}); | 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,
+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 | |
| tabTip : String Note: this config is only used when this BoxComponent is a child item of a TabPanel.
+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
+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
+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 use to display each item in the dropdown list. The dropdown list is displayed in a DataView. See view. @@ -689,16 +791,16 @@ names from the Combo's 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'
+ 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.
+(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.
-<div class="mdetail-params">
-'query' : Default
+Ext.form.FormPanel, you must also set lazyRender = true. | ComboBox | |
| triggerAction : String The action to execute when the trigger is clicked.
+<div class="mdetail-params">
+'query' : Default
<p class="sub-desc"... The action to execute when the trigger is clicked.
See also | ComboBox | |
| triggerClass : String An additional CSS class used to style the trigger button. The trigger will always
+ See also | ComboBox | |
| triggerClass : String An additional CSS class used to style the trigger button. The trigger will always
get the class 'x-form-trigger' and... An additional CSS class used to style the trigger button. The trigger will always
get the class 'x-form-trigger' and triggerClass will be appended if specified
-(defaults to 'x-form-arrow-trigger' which displays a downward arrow icon). | ComboBox | |
| triggerConfig : Mixed A DomHelper config object specifying the structure of the
-trigger element for this Field. (Optional).
+(defaults to 'x-form-arrow-trigger' which displays a downward arrow icon). | ComboBox | |
| triggerConfig : Mixed A DomHelper config object specifying the structure of the
+trigger element for this Field. (Optional).
Specify this wh... A DomHelper config object specifying the structure of the trigger element for this Field. (Optional). Specify this when you need a customized element to act as the trigger button for a TriggerField. Note that when using this option, it is the developer's responsibility to ensure correct sizing, positioning and appearance of the trigger. Defaults to: - | TriggerField | |
| typeAhead : Boolean true to populate and autoselect the remainder of the text being
+ | TriggerField | |
| typeAhead : Boolean true to populate and autoselect the remainder of the text being
typed after a configurable delay (typeAheadDelay) if ... 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) | ComboBox | |
| typeAheadDelay : Number The length of time in milliseconds to wait until the typeahead text is displayed
+to false) | ComboBox | |
| typeAheadDelay : Number The length of time in milliseconds to wait until the typeahead text is displayed
if typeAhead = true (defaults to 250... The length of time in milliseconds to wait until the typeahead text is displayed
if typeAhead = true (defaults to 250) | 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
+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 (validateValue)
+ 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. @@ -739,23 +841,23 @@ developer to override the default validation process.true if the value is validmsg: String
An error message if the value is 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 'field2' if
+ | 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
+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
the store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined). If this
-default text is used, it means there is no value set and no validation will occur on this field. | ComboBox | |
| vtype : String A validation type name as defined in Ext.form.VTypes (defaults to null) | TextField | |
| vtypeText : String A custom error message to display in place of the default message provided
+default text is used, it means there is no value set and no validation will occur on this field. | ComboBox | |
| vtype : String A validation type name as defined in Ext.form.VTypes (defaults to null) | TextField | |
| vtypeText : String A custom error message to display in place of the default message provided
for the vtype currently set for this field... | TextField | |
| width : Number The width of this component in pixels (defaults to auto).
+only applies if vtype is set, else ignored. | TextField | |
| width : Number The width of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset se... The width of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset see Ext.Component.anchor. | BoxComponent | |
| wrapFocusClass : String The class added to the to the wrap of the trigger element. Defaults to
-x-trigger-wrap-focus. | TriggerField | |
| x : Number The local x (left) coordinate for this component if contained within a positioning container. | BoxComponent | |
| xtype : String The registered xtype to create. This config option is not used when passing
+x-trigger-wrap-focus. | TriggerField | |
| x : Number The local x (left) coordinate for this component if contained within a positioning container. | BoxComponent | |
| xtype : String The registered xtype to create. This config option is not used when passing
a config object into a constructor. This ... The registered xtype 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 child item of a Container is being
@@ -766,7 +868,7 @@ The predefined xtypes are listed Ext.ComponentMgr.registerType in order to be able to
-take advantage of lazy instantiation and rendering. | Component | |
| y : Number The local y (top) coordinate for this component if contained within a positioning container. | BoxComponent | |
| Property | Defined By | |
|---|---|---|
| disabled : Boolean True if this component is disabled. Read-only. | Component | |
| el : Ext.Element The Ext.Element which encapsulates this Component. Read-only.
+take advantage of lazy instantiation and rendering. | Component | |
| y : Number The local y (top) coordinate for this component if contained within a positioning container. | BoxComponent | |
| Property | Defined By | |
|---|---|---|
| disabled : Boolean True if this component is disabled. Read-only. | Component | |
| el : Ext.Element The Ext.Element which encapsulates this Component. Read-only.
This will usually be a <DIV> element created by the ... The Ext.Element which encapsulates this Component. Read-only. This will usually be a <DIV> element created by the class's onRender method, but
that may be overridden using the 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 | |
| label : Ext.Element The label Element associated with this Field. Only available after this Field has been rendered by a
+ 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 | |
| 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:
+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:
| ComboBox | |
| originalValue : mixed The original value of the field as configured in the value configuration, or
+}); | 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 This Component's owner Container (defaults to undefined, and is set automatically when
+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
+ Note: to access items within the Container see itemId. | 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
+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. )
- :
+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] )
- :
+Usage:
| 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()
- :
- void Clear any invalid styles/messages for this field Clear any invalid styles/messages for this field Parameters:
| Field | |
| clearValue()
- :
- void Clears any text/value currently set in the field Clears any text/value currently set in the field Parameters:
| ComboBox | |
cloneConfig( Object overrides )
- :
+});Returns:
| 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()
+ :
+ void Clear any invalid styles/messages for this field Clear any invalid styles/messages for this field Parameters:
| Field | |
| clearValue()
+ :
+ void Clears any text/value currently set in the field Clears any text/value currently set in the field Parameters:
| ComboBox | |
cloneConfig( Object overrides )
+ :
Ext.ComponentClone the current component using the original config values passed into this instance by default. Clone the current component using the original config values passed into this instance by default. Parameters:
| Component | |
| collapse()
- :
- void Hides the dropdown list if it is currently expanded. Fires the collapse event on completion. Hides the dropdown list if it is currently expanded. Fires the collapse event on completion. Parameters:
| ComboBox | |
| destroy()
- :
- void Destroys this component by purging any event listeners, removing the component's element from the DOM,
+An id property can be passed on this object, otherwise one will be generated to avoid duplicates. Returns:
| Component | |
| collapse()
+ :
+ void Hides the dropdown list if it is currently expanded. Fires the collapse event on completion. Hides the dropdown list if it is currently expanded. Fires the collapse event on completion. Parameters:
| ComboBox | |
| destroy()
+ :
+ void Destroys this component by purging any event listeners, removing the component's element from the DOM,
removing the c... Destroys this component by purging any event listeners, removing the component's element from the DOM,
removing the component from its Ext.Container (if applicable) and unregistering it from
Ext.ComponentMgr. Destruction is generally handled automatically by the framework and this method
-should usually not need to be called directly. Parameters:
| Component | |
| disable()
- :
- Ext.Component Disable this component and fire the 'disable' event. Disable this component and fire the 'disable' event. Parameters:
| Component | |
doQuery( String query, Boolean forceAll )
- :
- voidExecute a query to filter the dropdown list. Fires the beforequery event prior to performing the
+should usually not need to be called directly. Parameters:
| Component | |
| disable()
+ :
+ Ext.Component Disable this component and fire the 'disable' event. Disable this component and fire the 'disable' event. Parameters:
| Component | |
doQuery( String query, Boolean forceAll )
+ :
+ voidExecute a query to filter the dropdown list. Fires the beforequery event prior to performing the
query allowing the ... Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the
query allowing the query action to be canceled if needed. Parameters:
| ComboBox | |
| enable()
- :
- 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
+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( 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 @@ -938,30 +1040,30 @@ access the required target more quickly. myForm.header.setStyle('color', 'red'); } } -});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 )
- :
- Ext.ContainerFind a container above this component at any level by a custom function. If the passed function returns
+}); 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 )
+ :
+ Ext.ContainerFind a container above this component at any level by a custom function. If the passed function returns
true, the con... Find a container above this component at any level by a custom function. If the passed function returns
-true, the container will be returned. Parameters:
| Component | |
findParentByType( String/Class xtype )
- :
- Ext.ContainerFind a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class Parameters:
| Component | |
fireEvent( String eventName, Object... args )
- :
- BooleanFires the specified event with the passed parameters (minus the event name).
+true, the container will be returned. Parameters:
| Component | |
findParentByType( String/Class xtype )
+ :
+ Ext.ContainerFind a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class Parameters:
| Component | |
fireEvent( String eventName, Object... args )
+ :
+ BooleanFires the specified event with the passed parameters (minus the event name).
An event may be set to bubble up an Obse... Fires the specified event with the passed parameters (minus the event name). 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 | |
| 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()
- :
- Ext.Container Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Parameters:
| Component | |
| getEl()
- :
- Ext.Element Returns the Ext.Element which encapsulates this Component.
+by calling enableBubble. Parameters:
| Observable | |
focus( [Boolean selectText], [Boolean/Number delay] )
+ :
+ 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()
+ :
+ Ext.Container Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Parameters:
| Component | |
| getEl()
+ :
+ Ext.Element Returns the Ext.Element which encapsulates this Component.
This will usually be a <DIV> element created by the cla... Returns the Ext.Element which encapsulates this Component. This will usually be a <DIV> element created by the class's onRender method, but that may be overridden using the autoEl config. @@ -977,21 +1079,21 @@ or use a render listener directly:Parameters:
| Component | |
| 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()
- :
- String Returns the id of this component or automatically generates and
+}); Parameters:
| Component | |
| 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()
+ :
+ String Returns the id of this component or automatically generates and
returns an id if an id is not defined yet:'ext-comp-'... Returns the id of this component or automatically generates and
-returns an id if an id is not defined yet:Parameters:
| Component | |
| getItemId()
- :
- String Returns the itemId of this component. If an
-itemId was not assigned through configuration the
+returns an id if an id is not defined yet:Parameters:
| Component | |
| getItemId() + : + String | Component | |
| getListParent()
- :
- void Returns the element used to house this ComboBox's pop-up list. Defaults to the document body.
+ id is returned using getId.Parameters:
| Component | |
| getListParent()
+ :
+ void Returns the element used to house this ComboBox's pop-up list. Defaults to the document body.
A custom implementation... Returns the element used to house this ComboBox's pop-up list. Defaults to the document body. A custom implementation may be provided as a configuration option if the floating list needs to be rendered to a different Element. An example might be rendering the list inside a Menu so that clicking @@ -1025,19 +1127,19 @@ the list does not hide the Menu:Parameters:
| ComboBox | |
| getName()
- :
- String Returns the name or hiddenName
+}); Parameters:
| ComboBox | |
| getName()
+ :
+ String Returns the name or hiddenName
attribute of the field if available. Returns the name or hiddenName
-attribute of the field if available. Parameters:
| Field | |
| getOuterSize()
- :
- Object Gets the current size of the component's underlying element, including space taken by its margins. Gets the current size of the component's underlying element, including space taken by its margins. Parameters:
| BoxComponent | |
getPosition( [Boolean local] )
- :
- ArrayGets the current XY position of the component's underlying element. Gets the current XY position of the component's underlying element. Parameters:
| BoxComponent | |
| getRawValue()
- :
- 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()
- :
- Ext.Element Returns the outermost Element of this Component which defines the Components overall size.
+attribute of the field if available. Parameters:
| Field | |
| getOuterSize()
+ :
+ Object Gets the current size of the component's underlying element, including space taken by its margins. Gets the current size of the component's underlying element, including space taken by its margins. Parameters:
| BoxComponent | |
getPosition( [Boolean local] )
+ :
+ ArrayGets the current XY position of the component's underlying element. Gets the current XY position of the component's underlying element. Parameters:
| BoxComponent | |
| getRawValue()
+ :
+ 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()
+ :
+ 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()
- :
- Object Gets the current size of the component's underlying element. Gets the current size of the component's underlying element. Parameters:
| BoxComponent | |
| getStore()
- :
- Ext.data.Store Returns the store associated with this combo. Returns the store associated with this combo. Parameters:
| ComboBox | |
| getValue()
- :
- String Returns the currently selected field value or empty string if no value is set. Returns the currently selected field value or empty string if no value is set. Parameters:
| ComboBox | |
| getWidth()
- :
- Number Gets the current width of the component's underlying element. Gets the current width of the component's underlying element. Parameters:
| BoxComponent | |
| getXType()
- :
- String Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
+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()
+ :
+ Ext.data.Store Returns the store associated with this combo. Returns the store associated with this combo. Parameters:
| ComboBox | |
| getValue()
+ :
+ String Returns the currently selected field value or empty string if no value is set. Returns the currently selected field value or empty string if no value is set. Parameters:
| ComboBox | |
| getWidth()
+ :
+ Number Gets the current width of the component's underlying element. Gets the current width of the component's underlying element. Parameters:
| BoxComponent | |
| getXType()
+ :
+ String Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
available xtypes, see the Ex... Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
available xtypes, see the Ext.Component header. Example usage:
Parameters:
| Component | |
| getXTypes()
- :
- String Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
+alert(t.getXType()); // alerts 'textfield' Parameters:
| Component | |
| getXTypes()
+ :
+ String Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
available xtypes, see the Ext... Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the Ext.Component header. If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes. Example usage: Parameters:
| Component | |
hasListener( String eventName )
- :
- BooleanChecks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters:
| Observable | |
| hide()
- :
- Ext.Component Hide this component. Listen to the 'beforehide' event and return
+alert(t.getXTypes()); // alerts 'component/box/field/textfield' Parameters:
| Component | |
hasListener( String eventName )
+ :
+ BooleanChecks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters:
| Observable | |
| hide()
+ :
+ Ext.Component Hide this component. Listen to the 'beforehide' event and return
false to cancel hiding the component. Fires the 'h... Hide this component. Listen to the 'beforehide' event and return
false to cancel hiding the component. Fires the 'hide'
event after hiding the component. Note this method is called internally if
-the component is configured to be hidden.Parameters:
| Component | |
| isDirty()
- :
- Boolean Returns true if the value of this Field has been changed from its original value.
+the component is configured to be hidden.Parameters:
| Component | |
| isDirty()
+ :
+ Boolean Returns true if the value of this Field has been changed from its original value.
Will return false if the field is d... Returns true if the value of this Field has been changed from its original value. Will return false if the field is disabled or has not been rendered yet. Note that if the owning form was configured with Ext.form.BasicForm.trackResetOnLoad then the original value is updated when the values are loaded by -Ext.form.BasicForm.setValues. Parameters:
| Field | |
| isExpanded()
- :
- void 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 by
-validating the processed value
+Ext.form.BasicForm.setValues. Parameters:
| Field | |
| isExpanded()
+ :
+ void 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 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] )
- :
- BooleanTests whether or not this Component is of a specific xtype. This can test whether this Component is descended
+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] )
+ :
+ BooleanTests whether or not this Component is of a specific xtype. This can test whether this Component is descended
from th... Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended from the xtype (default) or whether it is directly of the xtype specified (shallow = true). If using your own subclasses, be aware that a Component must register its own xtype @@ -1108,17 +1210,17 @@ to participate in determination of inherited xtypes. var isText = t.isXType('textfield'); // true var isBoxSubclass = t.isXType('box'); // true, descended from BoxComponent var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instanceParameters:
| Component | |
markInvalid( [String msg] )
- :
- voidDisplay an error message associated with this field, using msgTarget to determine how to
+the default), or true to check whether this Component is directly of the specified xtype. Returns:
| Component | |
markInvalid( [String msg] )
+ :
+ voidDisplay 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
+invalid. 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: Parameters:
| Component | |
mun( Observable|Element item, Object|String ename, Function fn, Object scope )
- :
+is the addListener options.Returns:
| 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] )
- :
+is the scope (this reference) in which the handler function is executed.Returns:
| 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 | |
processValue( Mixed value )
- :
- voidThis method should only be overridden if necessary to prepare raw values
+If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration.
| Observable | |
| previousSibling()
+ :
+ 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 )
- :
- voidRelays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. Parameters:
| Observable | |
removeClass( string cls )
- :
- Ext.ComponentRemoves a CSS class from the component's underlying element. Removes a CSS class from the component's underlying element. Parameters:
| Component | |
removeListener( String eventName, Function handler, [Object scope] )
- :
- voidRemoves an event handler. Removes an event handler. Parameters:
| Observable | |
render( [Element/HTMLElement/String container], [String/Number position] )
- :
- voidRender this Component into the passed HTML element.
+be used for validation (see validateValue method). Parameters:
| Field | |
| purgeListeners()
+ :
+ void Removes all listeners for this object Removes all listeners for this object Parameters:
| Observable | |
relayEvents( Object o, Array events )
+ :
+ voidRelays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. Parameters:
| Observable | |
removeClass( string cls )
+ :
+ Ext.ComponentRemoves a CSS class from the component's underlying element. Removes a CSS class from the component's underlying element. Parameters:
| Component | |
removeListener( String eventName, Function handler, [Object scope] )
+ :
+ voidRemoves an event handler. Removes an event handler. Parameters:
| Observable | |
render( [Element/HTMLElement/String container], [String/Number position] )
+ :
+ voidRender this Component into the passed HTML element.
If you are using a Container object to house this Component, then... Render this Component into the passed HTML element. If you are using a Container object to house this Component, then do not use the render method. @@ -1180,63 +1282,63 @@ have in mind. layout manager is used which does nothing but render child components sequentially into the Container. No sizing or positioning will be performed in this situation.Parameters:
| Component | |
| reset()
- :
- void Resets the current field value to the originally-loaded value and clears any validation messages.
+which this component will be inserted (defaults to appending to the end of the container) Returns:
| Component | |
| reset()
+ :
+ void Resets the current field value to the originally-loaded value and clears any validation messages.
Also adds emptyText... Resets the current field value to the originally-loaded value and clears any validation messages.
Also adds emptyText and emptyClass if the
-original value was blank. Parameters:
| TextField | |
| resumeEvents()
- :
- void Resume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
+original value was blank. Parameters:
| TextField | |
| resumeEvents()
+ :
+ void Resume firing events. (see suspendEvents)
+If events were suspended using the queueSuspended parameter, then all
event... Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
-events fired during event suspension will be sent to any listeners now. Parameters:
| Observable | |
select( Number index, Boolean scrollIntoView )
- :
+events fired during event suspension will be sent to any listeners now.Parameters:
| Observable | |
select( Number index, Boolean scrollIntoView )
+ :
voidSelect an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event t... Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.
The store must be loaded and the list expanded for this function to work, otherwise use setValue. Parameters:
| ComboBox | |
selectByValue( String value, Boolean scrollIntoView )
- :
- BooleanSelect an item in the dropdown list by its data value. This function does NOT cause the select event to fire.
+selected item if it is not currently in view (defaults to true) Returns:
| ComboBox | |
selectByValue( String value, Boolean scrollIntoView )
+ :
+ BooleanSelect an item in the dropdown list by its data value. This function does NOT cause the select event to fire.
The sto... Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.
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 | |
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 )
- :
+selected item if it is not currently in view (defaults to true)Returns:
| ComboBox | |
selectText( [Number start], [Number end] )
+ :
+ voidSelects text in this field Selects text in this field Parameters:
| TextField | |
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 )
+ :
voidParameters:
| TriggerField | |
setHeight( Number height )
- :
+is the runtime equivalent of setting the 'editable' config option at config time.Returns:
| TriggerField | |
setHeight( Number 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 )
- :
- Ext.BoxComponentSets the page XY position of the component. To set the left and top instead, use setPosition.
+
| BoxComponent | |
setPagePosition( Number x, Number y )
+ :
+ Ext.BoxComponentSets the page XY position of the component. To set the left and top instead, use setPosition.
This method fires the ... Sets the page XY position of the component. To set the left and top instead, use setPosition.
-This method fires the move event. Parameters:
| BoxComponent | |
setPosition( Number left, Number top )
- :
- Ext.BoxComponentSets the left and top of the component. To set the page XY position instead, use setPagePosition.
+This method fires the move event. Parameters:
| BoxComponent | |
setPosition( Number left, Number top )
+ :
+ Ext.BoxComponentSets the left and top of the component. To set the page XY position instead, use setPagePosition.
This method fires ... 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 | |
setReadOnly( Boolean value )
- :
+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 | |
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
+is the runtime equivalent of setting the 'readOnly' config option at config time. Returns:
| 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
either width and height as separate arguments, or you can pass a size object like {width:10, height:20}.Parameters:
| BoxComponent | |
setValue( String value )
- :
- Ext.form.FieldSets the specified value into the field. If the value finds a match, the corresponding record text
+
| BoxComponent | |
setValue( String value )
+ :
+ Ext.form.FieldSets the specified value into the field. If the value finds a match, the corresponding record text
will be displayed... Sets the specified value into the field. If the value finds a match, the corresponding record text
will be displayed in the field. If the value does not match the data value of an existing item,
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 )
- :
+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.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()
- :
- Ext.Component Show this component. Listen to the 'beforeshow' event and return
+
| BoxComponent | |
| show()
+ :
+ Ext.Component Show this component. Listen to the 'beforeshow' event and return
false to cancel showing the component. Fires the '... Show this component. Listen to the 'beforeshow' event and return
false to cancel showing the component. Fires the 'show'
-event after showing the component. Parameters:
| Component | |
suspendEvents( Boolean queueSuspended )
- :
+event after showing the component.Parameters:
| Component | |
suspendEvents( Boolean queueSuspended )
+ :
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:
| Observable | |
| syncSize()
- :
- Ext.BoxComponent 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 | |
update( Mixed htmlOrData, [Boolean loadScripts], [Function callback] )
- :
+after the resumeEvents call instead of discarding all suspended events;Returns:
| Observable | |
| syncSize()
+ :
+ Ext.BoxComponent 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 | |
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 a value according to the field's validation rules and marks the field as invalid
+content area will be updated via Ext.Element update loadScripts : Boolean(optional) Only legitimate when using the html configuration. Defaults to false callback : Function(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading
| 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 a value according to the field's validation rules and marks the field as invalid
if the validation fails. V... Validates a value according to the field's validation rules and marks the field as invalid if the validation fails. Validation rules are processed in the following order: Parameters:
| TextField | |
| 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.
+ Parameters:
| TextField | |
| 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. The afterrender event is fired after this Component has been rendered, been postprocesed by any afterRender method defined for the Component, and, if stateful, after state -has been restored. Listeners will be called with the following arguments:
| Component | |
autosize :
- ( Ext.form.Field this, Number width )
- Fires when the autoSize function is triggered. The field may or
+has been restored. Listeners will be called with the following arguments:
| Component | |
autosize :
+ ( Ext.form.Field this, Number width )
+ Fires when the autoSize function is triggered. The field may or
may not have actually changed size according to the d... Fires when the autoSize function is triggered. The field may or
may not have actually changed size according to the default logic, but this event provides
-a hook for the developer to apply additional logic at runtime to resize the field if needed. Listeners will be called with the following arguments:
| TextField | |
beforedestroy :
- ( Ext.Component this )
- | Component | |
beforehide :
- ( Ext.Component this )
- Fires before the component is hidden by calling the hide method.
+a hook for the developer to apply additional logic at runtime to resize the field if needed. Listeners will be called with the following arguments:
| TextField | |
beforedestroy :
+ ( Ext.Component this )
+ | Component | |
beforehide :
+ ( Ext.Component this )
+ Fires before the component is hidden by calling the hide method.
Return false from an event handler to stop the hide. Fires before the component is hidden by calling the hide method.
-Return false from an event handler to stop the hide. Listeners will be called with the following arguments:
| Component | |
beforequery :
- ( Object queryEvent )
- Fires before all queries are processed. Return false to cancel the query or set the queryEvent's
+Return false from an event handler to stop the hide. Listeners will be called with the following arguments:
| Component | |
beforequery :
+ ( Object queryEvent )
+ Fires before all queries are processed. Return false to cancel the query or set the queryEvent's
cancel property to t... Fires before all queries are processed. Return false to cancel the query or set the queryEvent's
cancel property to true. Listeners will be called with the following arguments:
| ComboBox | |
beforerender :
- ( Ext.Component this )
- Fires before the component is rendered. Return false from an
+ | ComboBox | |
beforerender :
+ ( Ext.Component this )
+ | Component | |
beforeselect :
- ( Ext.form.ComboBox combo, Ext.data.Record record, Number index )
- Fires before a list item is selected. Return false to cancel the selection. Fires before a list item is selected. Return false to cancel the selection. Listeners will be called with the following arguments:
| ComboBox | |
beforeshow :
- ( Ext.Component this )
- Fires before the component is shown by calling the show method.
+event handler to stop the render. Listeners will be called with the following arguments:
| Component | |
beforeselect :
+ ( Ext.form.ComboBox combo, Ext.data.Record record, Number index )
+ Fires before a list item is selected. Return false to cancel the selection. Fires before a list item is selected. Return false to cancel the selection. Listeners will be called with the following arguments:
| ComboBox | |
beforeshow :
+ ( Ext.Component this )
+ Fires before the component is shown by calling the show method.
Return false from an event handler to stop the show. Fires before the component is shown by calling the show method.
-Return false from an event handler to stop the show. Listeners will be called with the following arguments:
| Component | |
beforestaterestore :
- ( Ext.Component this, Object state )
+Return false from an event handler to stop the show.Listeners will be called with the following arguments:
| Component | |
beforestaterestore :
+ ( Ext.Component this, Object state )
Fires before the state of the component is restored. Return false from an event handler to stop the restore. Fires before the state of the component is restored. Return false from an event handler to stop the restore. Listeners will be called with the following arguments:
| Component | |
beforestatesave :
- ( Ext.Component this, Object state )
+provide custom state restoration. | Component | |
beforestatesave :
+ ( Ext.Component this, Object state )
Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Listeners will be called with the following arguments:
| Component | |
blur :
- ( Ext.form.Field this )
- Fires when this field loses input focus. Fires when this field loses input focus. Listeners will be called with the following arguments:
| Field | |
change :
- ( Ext.form.Field this, Mixed newValue, Mixed oldValue )
- Fires just before the field blurs if the field value has changed. Fires just before the field blurs if the field value has changed. Listeners will be called with the following arguments:
| Field | |
collapse :
- ( Ext.form.ComboBox combo )
- Fires when the dropdown list is collapsed Fires when the dropdown list is collapsed Listeners will be called with the following arguments:
| ComboBox | |
destroy :
- ( Ext.Component this )
- Fires after the component is destroyed. Fires after the component is destroyed. Listeners will be called with the following arguments:
| Component | |
disable :
- ( Ext.Component this )
- Fires after the component is disabled. Fires after the component is disabled. Listeners will be called with the following arguments:
| Component | |
enable :
- ( Ext.Component this )
- Fires after the component is enabled. Fires after the component is enabled. Listeners will be called with the following arguments:
| Component | |
expand :
- ( Ext.form.ComboBox combo )
- Fires when the dropdown list is expanded Fires when the dropdown list is expanded Listeners will be called with the following arguments:
| ComboBox | |
focus :
- ( Ext.form.Field this )
- Fires when this field receives input focus. Fires when this field receives input focus. Listeners will be called with the following arguments:
| Field | |
hide :
- ( Ext.Component this )
- Fires after the component is hidden.
+has a null implementation. | Component | |
blur :
+ ( Ext.form.Field this )
+ Fires when this field loses input focus. Fires when this field loses input focus. Listeners will be called with the following arguments:
| Field | |
change :
+ ( Ext.form.Field this, Mixed newValue, Mixed oldValue )
+ Fires just before the field blurs if the field value has changed. Fires just before the field blurs if the field value has changed. Listeners will be called with the following arguments:
| Field | |
collapse :
+ ( Ext.form.ComboBox combo )
+ Fires when the dropdown list is collapsed Fires when the dropdown list is collapsed Listeners will be called with the following arguments:
| ComboBox | |
destroy :
+ ( Ext.Component this )
+ Fires after the component is destroyed. Fires after the component is destroyed. Listeners will be called with the following arguments:
| Component | |
disable :
+ ( Ext.Component this )
+ Fires after the component is disabled. Fires after the component is disabled. Listeners will be called with the following arguments:
| Component | |
enable :
+ ( Ext.Component this )
+ Fires after the component is enabled. Fires after the component is enabled. Listeners will be called with the following arguments:
| Component | |
expand :
+ ( Ext.form.ComboBox combo )
+ Fires when the dropdown list is expanded Fires when the dropdown list is expanded Listeners will be called with the following arguments:
| ComboBox | |
focus :
+ ( Ext.form.Field this )
+ Fires when this field receives input focus. Fires when this field receives input focus. Listeners will be called with the following arguments:
| Field | |
hide :
+ ( Ext.Component this )
+ Fires after the component is hidden.
Fires after the component is hidden when calling the hide method. Fires after the component is hidden.
-Fires after the component is hidden when calling the hide method. Listeners will be called with the following arguments:
| Component | |
invalid :
- ( Ext.form.Field this, String msg )
- Fires after the field has been marked as invalid. Fires after the field has been marked as invalid. Listeners will be called with the following arguments:
| Field | |
keydown :
- ( Ext.form.TextField this, Ext.EventObject e )
- Keydown input field event. This event only fires if enableKeyEvents
+Fires after the component is hidden when calling the hide method. Listeners will be called with the following arguments:
| Component | |
invalid :
+ ( Ext.form.Field this, String msg )
+ Fires after the field has been marked as invalid. Fires after the field has been marked as invalid. Listeners will be called with the following arguments:
| Field | |
keydown :
+ ( Ext.form.TextField this, Ext.EventObject e )
+ Keydown input field event. This event only fires if enableKeyEvents
is set to true. Keydown input field event. This event only fires if enableKeyEvents
-is set to true. Listeners will be called with the following arguments:
| TextField | |
keypress :
- ( Ext.form.TextField this, Ext.EventObject e )
- Keypress input field event. This event only fires if enableKeyEvents
+is set to true. Listeners will be called with the following arguments:
| TextField | |
keypress :
+ ( Ext.form.TextField this, Ext.EventObject e )
+ Keypress input field event. This event only fires if enableKeyEvents
is set to true. Keypress input field event. This event only fires if enableKeyEvents
-is set to true. Listeners will be called with the following arguments:
| TextField | |
keyup :
- ( Ext.form.TextField this, Ext.EventObject e )
- Keyup input field event. This event only fires if enableKeyEvents
+is set to true. Listeners will be called with the following arguments:
| TextField | |
keyup :
+ ( Ext.form.TextField this, Ext.EventObject e )
+ Keyup input field event. This event only fires if enableKeyEvents
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 | |
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 )
- Fires after the component is resized. Fires after the component is resized. Listeners will be called with the following arguments:
| BoxComponent | |
select :
- ( Ext.form.ComboBox combo, Ext.data.Record record, Number index )
- Fires when a list item is selected Fires when a list item is selected Listeners will be called with the following arguments:
| ComboBox | |
show :
- ( Ext.Component this )
- Fires after the component is shown when calling the show method. Fires after the component is shown when calling the show method. Listeners will be called with the following arguments:
| Component | |
specialkey :
- ( Ext.form.Field this, Ext.EventObject e )
- Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.
+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 | |
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 )
+ Fires after the component is resized. Fires after the component is resized. Listeners will be called with the following arguments:
| BoxComponent | |
select :
+ ( Ext.form.ComboBox combo, Ext.data.Record record, Number index )
+ Fires when a list item is selected Fires when a list item is selected Listeners will be called with the following arguments:
| ComboBox | |
show :
+ ( Ext.Component this )
+ Fires after the component is shown when calling the show method. Fires after the component is shown when calling the show method. Listeners will be called with the following arguments:
| Component | |
specialkey :
+ ( Ext.form.Field this, Ext.EventObject e )
+ Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.
To handle other keys see Ext.Pan... Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.
To handle other keys see Ext.Panel.keys or Ext.KeyMap.
You can check Ext.EventObject.getKey to determine which key was pressed.
@@ -1460,15 +1562,15 @@ For example: Listeners will be called with the following arguments:
| Field | |
staterestore :
- ( Ext.Component this, Object state )
+});Listeners will be called with the following arguments:
| Field | |
staterestore :
+ ( Ext.Component this, Object state )
Fires after the state of the component is restored. Fires after the state of the component is restored. Listeners will be called with the following arguments:
| Component | |
statesave :
- ( Ext.Component this, Object state )
+Component. The method maybe overriden to provide custom state restoration. | Component | |
statesave :
+ ( Ext.Component this, Object state )
Fires after the state of the component is saved to the configured state provider. Fires after the state of the component is saved to the configured state provider. Listeners will be called with the following arguments:
| Component | |
valid :
- ( Ext.form.Field this )
+has a null implementation. | Component | |
valid :
+ ( Ext.form.Field this )
Fires after the field has been validated with no errors. Fires after the field has been validated with no errors. Listeners will be called with the following arguments:
| Field | |