X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6e39d509471fe9b4e2660e0d1631b350d0c66f40..c8256059947f3aa8f5b0a9a2acf55e2142bb4742:/docs/output/Ext.form.TimeField.html diff --git a/docs/output/Ext.form.TimeField.html b/docs/output/Ext.form.TimeField.html index 26e2fc37..6577eca8 100644 --- a/docs/output/Ext.form.TimeField.html +++ b/docs/output/Ext.form.TimeField.html @@ -1,20 +1,20 @@ -
Package: | Ext.form |
Defined In: | TimeField.js |
Class: | TimeField |
Extends: | ComboBox |
new Ext.form.TimeField({
- minValue: '9:00 AM',
- maxValue: '6:00 PM',
- increment: 30
+Class Ext.form.TimeField
Package: Ext.form Defined In: TimeField.js Class: TimeField Extends: ComboBox
Provides a time input field with a time dropdown and automatic time validation. Example usage:
+new Ext.form.TimeField({
+ minValue: '9:00 AM',
+ maxValue: '6:00 PM',
+ increment: 30
});
Config Options
Config Options Defined By allQuery : StringThe text query to send to the server to return all records for the list
with no filtering (defaults to '') ComboBox allowBlank : BooleanSpecify false to validate that the value's length is > 0 (defaults to
-true) TextField allowDomMove : BooleanWhether the component can move the Dom node when rendering (defaults to true). Component altFormats : StringMultiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined
-forma...Multiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined
-format (defaults to 'g:ia|g:iA|g:i a|g:i A|h:i|g:i|H:i|ga|ha|gA|h a|g a|g A|gi|hi|gia|hia|g|H'). TimeField anchor : StringNote: this config is only used when this Component is rendered
+true) TextField allowDomMove : BooleanWhether the component can move the Dom node when rendering (defaults to true). Component altFormats : StringMultiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined
+format...Multiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined
+format (defaults to 'g:ia|g:iA|g:i a|g:i A|h:i|g:i|H:i|ga|ha|gA|h a|g a|g A|gi|hi|gia|hia|g|H|gi a|hi a|giA|hiA|gi A|hi A'). TimeField anchor : StringNote: 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:
- Ext.form.FormPanel
- specifying
layout: 'anchor' // or 'form', or 'absolute'
-See Ext.layout.AnchorLayout.anchor also.
Component applyTo : MixedSpecify the id of the element, a DOM element or an existing Element corresponding to a DIV
+See Ext.layout.AnchorLayout.anchor also.
BoxComponent applyTo : MixedSpecify 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.
@@ -28,12 +28,12 @@ to create its subcomponents from that markup if applicable.
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/ObjectA DomHelper element spec, or true for a default
+ Component autoCreate : String/ObjectA DomHelper element spec, or true for a default
element spec. Used to create the Element which will encapsulate this ... ComboBox autoEl : MixedA tag name or DomHelper spec used to create the Element which will
-encapsulate this Component.
+{tag: "input", type: "text", size: "24", autocomplete: "off"}
ComboBox autoEl : MixedA 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,
@@ -61,7 +61,7 @@ different DOM elements. Example usage:
{
autoEl: 'li',
html: 'First list item'
}
-}
Component autoHeight : BooleanTrue to use height:'auto', false to use fixed height (or allow it to be managed by its parent
+} Component autoHeight : BooleanTrue 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
@@ -93,11 +93,14 @@ result in elements needing to be synchronized with the new height. Example:
<
}
}
}
-}).show(); BoxComponent autoScroll : Booleantrue to use overflow:'auto' on the components layout element and show scroll bars automatically when
+}).show(); BoxComponent autoScroll : Booleantrue 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 : BooleanTrue 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 : Booleantrue 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 : BooleanTrue 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 autoWidth : BooleanTrue to use width:'auto', false to use fixed width (or allow it to be managed by its parent
+them on render (defaults to false). Component autoWidth : BooleanTrue 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
@@ -128,15 +131,18 @@ child items when the browser changes its width:
var myPanel = <
title: 'Box 3'
}],
});
BoxComponent blankText : StringThe error text to display if the allowBlank validation
-fails (defaults to 'This field is required') TextField boxMaxHeight : NumberThe maximum value in pixels which this BoxComponent will set its height to.
+fails (defaults to 'This field is required') TextField boxMaxHeight : NumberThe 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 : NumberThe 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 : NumberThe 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 : NumberThe 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 : NumberThe 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 : NumberThe 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 : NumberThe 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 : StringThe CSS class used to to apply to the special clearing div rendered
+Warning: This will override any size management applied by layout managers.
BoxComponent bubbleEvents : ArrayAn array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble....An array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.
+Defaults to [].
Component clearCls : StringThe 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').
@@ -145,7 +151,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 : Booleantrue to clear any filters on the store (when in local mode) when reset is called
-(defaults to true) ComboBox cls : StringA custom CSS class to apply to the field's underlying element (defaults to ''). Field contentEl : StringOptional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
+(defaults to true) ComboBox cls : StringA custom CSS class to apply to the field's underlying element (defaults to ''). Field contentEl : StringOptional. 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 id
of an existing HTML element to use as the content
for this component.
@@ -159,7 +165,7 @@ of a new component (it simply moves the specified DOM element after the Compo
scheme that the Component may use. It is just HTML. Layouts operate on child 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 : StringAn optional extra CSS class that will be added to this component's container. This can be useful for
+ Component ctCls : StringAn 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.
@@ -172,11 +178,11 @@ To configure the above Class with an extra CSS class append to the default. For
for BoxLayout (Hbox and Vbox):ctCls: 'x-box-layout-ct custom-class'
Component data : MixedThe initial set of data to apply to the tpl
to
update the content area of the Component. Component disableKeyFilter : BooleanSpecify true to disable input keystroke filtering (defaults
-to false) TextField disabled : BooleanTrue to disable the field (defaults to false).
+to false) TextField disabled : BooleanTrue 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 : StringCSS class added to the component when it is disabled (defaults to 'x-item-disabled'). Component displayField : StringThe 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 : StringCSS class added to the component when it is disabled (defaults to 'x-item-disabled'). Component displayField : StringThe 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
@@ -184,16 +190,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 : Booleanfalse to prevent the user from typing text directly into the field,
+active. ComboBox editable : Booleanfalse 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 : StringThe 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 : StringThe 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 : StringThe default text to place into an empty field (defaults to null).
+depending on the current field value. TextField emptyText : StringThe 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 : Booleantrue to enable the proxying of key events for the HTML input
-field (defaults to false) TextField fieldClass : StringThe default CSS class for the field (defaults to 'x-form-field') Field fieldLabel : StringThe label text to display next to this Component (defaults to '').
+field (defaults to false) TextField fieldClass : StringThe default CSS class for the field (defaults to 'x-form-field') Field fieldLabel : StringThe 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.
@@ -207,31 +213,37 @@ Example use:
new Ext.FormPanel({
xtype: 'textfield',
fieldLabel: 'Name'
}]
-});
Component focusClass : StringThe CSS class to use when the field receives focus (defaults to 'x-form-focus') Field forceSelection : Booleantrue to restrict the selected value to one of the values in the list,
+}); Component flex : NumberNote: 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 flex
property will be flexed either vertically (by a VBoxLayout)
+or horizontally (by an HBoxLayout) according to the item's relative flex
value
+compared to the sum of all Components with flex value specified. Any child items that have
+either a flex = 0
or flex = undefined
will not be 'flexed' (the initial size will not be changed).
BoxComponent focusClass : StringThe CSS class to use when the field receives focus (defaults to 'x-form-focus') Field forceSelection : Booleantrue 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 format : StringThe default time format string which can be overriden for localization support. The format must be
-valid according ...The default time format string which can be overriden for localization support. The format must be
-valid according to Date.parseDate (defaults to 'g:i A', e.g., '3:15 PM'). For 24-hour time
+false to allow the user to set arbitrary text into the field (defaults to false) ComboBox format : StringThe default time format string which can be overriden for localization support. The format must be
+valid according t...The default time format string which can be overriden for localization support. The format must be
+valid according to Date.parseDate (defaults to 'g:i A', e.g., '3:15 PM'). For 24-hour time
format try 'H:i' instead. TimeField handleHeight : NumberThe height in pixels of the dropdown list resize handle if
-resizable = true (defaults to 8) ComboBox height : NumberThe height of this component in pixels (defaults to auto).
+resizable = true (defaults to 8) ComboBox height : NumberThe 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 : BooleanRender this component hidden (default is false). If true, the
-hide method will be called internally. Component hiddenId : StringIf hiddenName is specified, hiddenId can also be provided
+hide method will be called internally. Component hiddenId : StringIf 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 : StringIf specified, a hidden form field with this name is dynamically generated to store the
+nodes should share the same id. ComboBox hiddenName : StringIf 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 : StringSets the initial value of the hidden field if hiddenName is
+hiddenName are the same, you should specify a unique hiddenId. ComboBox hiddenValue : StringSets 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 : Booleantrue to completely hide the label element
-(label and separator). Defaults to false.
+value. ComboBox hideLabel : Booleantrue 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
@@ -245,21 +257,21 @@ Example use:
new Ext.FormPanel({
xtype: 'textfield'
hideLabel: true
}]
-});
Component hideMode : StringHow this component should be hidden. Supported values are 'visibility'
+}); Component hideMode : StringHow 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 : BooleanTrue 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 : BooleanTrue 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 : Booleantrue to hide the trigger element and display only the base
-text field (defaults to false) TriggerField html : String/ObjectAn HTML fragment, or a DomHelper specification to use as the layout element
+text field (defaults to false) TriggerField html : String/ObjectAn 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 : StringThe 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 : StringThe 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).
@@ -269,12 +281,12 @@ 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
itemId
and ref
.
-Note: to access the container of an item see ownerCt
.
Component increment : NumberThe number of minutes between each time value in the list (defaults to 15). TimeField inputType : StringThe type attribute for input fields -- e.g. radio, text, password, file (defaults
+Note: to access the container of an item see ownerCt
.
Component increment : NumberThe number of minutes between each time value in the list (defaults to 15). TimeField inputType : StringThe 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 : StringThe CSS class to use when marking a field invalid (defaults to 'x-form-invalid') Field invalidText : StringThe error text to display when the time in the field is invalid (defaults to
-'{value} is not a valid time'). TimeField itemCls : StringNote: this config is only used when this Component is rendered by a Container which
+is not supported and should be avoided. Field invalidClass : StringThe CSS class to use when marking a field invalid (defaults to 'x-form-invalid') Field invalidText : StringThe error text to display when the time in the field is invalid (defaults to
+'{value} is not a valid time'). TimeField itemCls : StringNote: 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').
@@ -303,7 +315,7 @@ Example use:// Apply a style to the field's label:
xtype: 'textfield',
fieldLabel: 'Favorite Color'
}]
-});
Component itemId : StringAn itemId can be used as an alternative way to get a reference to a component
+}); Component itemId : StringAn 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 id
with
Ext.getCmp, use itemId
with
@@ -332,14 +344,14 @@ avoiding potential conflicts with getComponent('p1'); // not the same as Ext.getCmp()
p2 = p1.ownerCt.getComponent('p2'); // reference via a sibling
-Note: to access the container of an item see ownerCt.
Component itemSelector : StringA 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 : StringA 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 : StringThe separator to display after the text of each
-fieldLabel. This property may be configured at various levels.
+to dropdown list items ComboBox labelSeparator : StringThe 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:
@@ -367,7 +379,7 @@ Example use:
new Ext.FormPanel({
xtype: 'textfield',
fieldLabel: 'Field 2' // labelSeparator will be '='
}]
-});
Component labelStyle : StringA CSS style specification string to apply directly to this field's
+}); Component labelStyle : StringA 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 '').
@@ -383,16 +395,18 @@ Example use:new Ext.FormPanel({
labelStyle: 'font-weight:bold;'
}]
});
Component lazyInit : Booleantrue to not initialize the list for this combo until the field is focused
-(defaults to true) ComboBox lazyRender : Booleantrue to prevent the ComboBox from rendering until requested
+(defaults to true) ComboBox lazyRender : Booleantrue 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 : StringA 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 : StringThe CSS class to add to the predefined 'x-combo-list' class
+defaults to false). ComboBox listAlign : String/ArrayA 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.
+[ 'tl-bl?', [6,0] ]
(defaults to 'tl-bl?') ComboBox listClass : StringThe CSS class to add to the predefined 'x-combo-list' class
applied the dropdown list element (defaults to ''). ComboBox listEmptyText : StringThe empty text to display in the data view if no items are found.
-(defaults to '') ComboBox listWidth : NumberThe width (used as a parameter to Ext.Element.setWidth) of the dropdown
+(defaults to '') ComboBox listWidth : NumberThe 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 : ObjectA 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 : ObjectA 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.
@@ -447,9 +461,9 @@ Ext.DomObserver = Ext.extend(Object, {
typeAhead: true,
mode: 'local',
triggerAction: 'all'
-}); Observable loadingText : StringThe text to display in the dropdown list while data is loading. Only applies
+}); Observable loadingText : StringThe 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 : ObjectNote: this config is only used when this BoxComponent is rendered
+when mode = 'remote' (defaults to 'Loading...') ComboBox margins : ObjectNote: 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.
@@ -472,7 +486,7 @@ to the second, and the bottom is set to the third.
Defaults to:
{top:0, right:0, bottom:0, left:0}
BoxComponent maskRe : RegExpAn input mask regular expression that will be used to filter keystrokes that do
not match (defaults to null) TextField maxHeight : NumberThe maximum height in pixels of the dropdown list before scrollbars are shown
-(defaults to 300) ComboBox maxLength : NumberMaximum input field length allowed by validation (defaults to Number.MAX_VALUE).
+(defaults to 300) ComboBox maxLength : NumberMaximum 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
@@ -483,28 +497,28 @@ any attributes you want to a field, for example:var myField =
fieldLabel: 'Mobile',
maxLength: 16, // for validation
autoCreate: {tag: 'input', type: 'text', size: '20', autocomplete: 'off', maxlength: '10'}
-});
TextField maxLengthText : StringError text to display if the maximum length
+}); TextField maxLengthText : StringError 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 maxText : StringThe error text to display when the time is after maxValue (defaults to
-'The time in this field must be equal to or b...The error text to display when the time is after maxValue (defaults to
-'The time in this field must be equal to or before {0}'). TimeField maxValue : Date/StringThe maximum allowed time. Can be either a Javascript date object with a valid time value or a string
-time in a vali...The maximum allowed time. Can be either a Javascript date object with a valid time value or a string
-time in a valid format -- see format and altFormats (defaults to undefined). TimeField minChars : NumberThe minimum number of characters the user must type before autocomplete and
+validation fails (defaults to 'The maximum length for this field is {maxLength}') TextField maxText : StringThe error text to display when the time is after maxValue (defaults to
+'The time in this field must be equal to or be...The error text to display when the time is after maxValue (defaults to
+'The time in this field must be equal to or before {0}'). TimeField maxValue : Date/StringThe maximum allowed time. Can be either a Javascript date object with a valid time value or a string
+time in a valid ...The maximum allowed time. Can be either a Javascript date object with a valid time value or a string
+time in a valid format -- see format and altFormats (defaults to undefined). TimeField minChars : NumberThe minimum number of characters the user must type before autocomplete and
typeAhead activate (defaults to 4 if mode... ComboBox minHeight : NumberThe minimum height in pixels of the dropdown list when the list is constrained by its
+editable = false). ComboBox minHeight : NumberThe 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 : NumberMinimum input field length required (defaults to 0) TextField minLengthText : StringError text to display if the minimum length
+distance to the viewport edges (defaults to 90) ComboBox minLength : NumberMinimum input field length required (defaults to 0) TextField minLengthText : StringError 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 : NumberThe minimum width of the dropdown list in pixels (defaults to 70, will
-be ignored if listWidth has a higher value) ComboBox minText : StringThe error text to display when the date in the cell is before minValue (defaults to
-'The time in this field must be ...The error text to display when the date in the cell is before minValue (defaults to
-'The time in this field must be equal to or after {0}'). TimeField minValue : Date/StringThe minimum allowed time. Can be either a Javascript date object with a valid time value or a string
-time in a vali...The minimum allowed time. Can be either a Javascript date object with a valid time value or a string
-time in a valid format -- see format and altFormats (defaults to undefined). TimeField mode : StringAcceptable values are:
-<div class="mdetail-params">
-'remote' : Default
+be ignored if listWidth has a higher value) ComboBox minText : StringThe error text to display when the date in the cell is before minValue (defaults to
+'The time in this field must be e...The error text to display when the date in the cell is before minValue (defaults to
+'The time in this field must be equal to or after {0}'). TimeField minValue : Date/StringThe minimum allowed time. Can be either a Javascript date object with a valid time value or a string
+time in a valid ...The minimum allowed time. Can be either a Javascript date object with a valid time value or a string
+time in a valid format -- see format and altFormats (defaults to undefined). TimeField mode : StringAcceptable values are:
+<div class="mdetail-params">
+'remote' : Default
<p class="sub-desc">Automatically loads the st...Acceptable values are:
- 'remote' : Default
@@ -530,9 +544,9 @@ clicked, set to 'local' and manually load the store. To force a requer
triggerAction: 'all'
});
ComboBox msgFx : StringExperimental The effect used when displaying a validation message under the field
-(defaults to 'normal'). Field msgTarget<p>The : Stringlocation 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 : StringThe location where the message text set through markInvalid should display.
+Must be one of the following values:
+<div...The location where the message text set through markInvalid should display.
Must be one of the following values:
qtip
Display a quick tip containing the message when the user hovers over the field. This is the default.
@@ -541,23 +555,23 @@ Must be one of the following values:
under
Add a block div beneath the field containing the error message.
side
Add an error icon to the right of the field, displaying the message in a popup on hover.
[element id]
Add the error message directly to the innerHTML of the specified element.
-
Field name : StringThe field's HTML name attribute (defaults to '').
+ Field name : StringThe 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 : StringAn optional extra CSS class that will be added to this component's Element when the mouse moves
+form submit(). Field overCls : StringAn 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 : NumberIf 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 : NumberIf 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 : NumberThe page level x coordinate for this component if contained within a positioning container. BoxComponent pageY : NumberThe page level y coordinate for this component if contained within a positioning container. BoxComponent plugins : Object/ArrayAn object or array of objects that will provide custom functionality for this component. The only
+(defaults to 0). ComboBox pageX : NumberThe page level x coordinate for this component if contained within a positioning container. BoxComponent pageY : NumberThe page level y coordinate for this component if contained within a positioning container. BoxComponent plugins : Object/ArrayAn 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 : Booleantrue to disable marking the field invalid.
-Defaults to false. Field ptype : StringThe registered ptype to create. This config option is not used when passing
+Defaults to false. Field ptype : StringThe 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
@@ -566,14 +580,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 : NumberThe length of time in milliseconds to delay between the start of typing and
+take advantage of lazy instantiation and rendering. Component queryDelay : NumberThe length of time in milliseconds to delay between the start of typing and
sending the query to filter the dropdown ... ComboBox queryParam : StringName of the query (baseParam name for the store)
-as it will be passed on the querystring (defaults to 'query') ComboBox readOnly : Booleantrue to prevent the user from changing the field, and
+as it will be passed on the querystring (defaults to 'query') ComboBox readOnly : Booleantrue 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 : StringA path specification, relative to the Component's ownerCt
+(defaults to false) TriggerField ref : StringA path specification, relative to the Component's ownerCt
specifying into which ancestor Container to place a named r...A path specification, relative to the Component's ownerCt
specifying into which ancestor Container to place a named reference to this Component.
The ancestor axis can be traversed by using '/' characters in the path.
@@ -597,16 +611,16 @@ For example, to put a reference to a Toolbar Button into the Panel which owns
In the code above, if the ref
had been 'saveButton'
the reference would have been placed into the Toolbar. Each '/' in the ref
moves up one level from the Component's ownerCt
.
- Component regex : RegExp Component regex : RegExpA 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 : StringThe error text to display if regex is used and the
-test fails during validation (defaults to '') TextField region : StringNote: this config is only used when this BoxComponent is rendered
+test fails during validation (defaults to '') TextField region : StringNote: 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 : MixedSpecify 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 : MixedSpecify 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.
- Notes :
@@ -617,28 +631,28 @@ to render and manage its child items.
When using this config, a call to render() is not required.
-See render also.
Component resizable : Booleantrue 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 : Booleantrue 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 : Booleantrue to select any existing text in the field immediately on focus.
-Only applies when editable = true (defaults to
+Defaults to false. ComboBox selectOnFocus : Booleantrue 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 : StringCSS class to apply to the selected item in the dropdown list
(defaults to 'x-combo-selected') ComboBox shadow : Boolean/Stringtrue or "sides" for the default effect, "frame" for
-4-way shadow, and "drop" for bottom-right ComboBox stateEvents : ArrayAn array of events that, when fired, should trigger this component to
+4-way shadow, and "drop" for bottom-right ComboBox stateEvents : ArrayAn 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). stateEvents
may be any type
of event supported by this component, including browser or custom events
(e.g., ['click', 'customerchange']).
See stateful
for an explanation of saving and
-restoring Component state.
Component stateId : StringThe unique id for this component to use for state management purposes
+restoring Component state. Component stateId : StringThe 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 stateful
for an explanation of saving and
-restoring Component state.
Component stateful : BooleanA flag which causes the Component to attempt to restore the state of
+restoring Component state. Component stateful : BooleanA 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 stateId
or id
assigned
@@ -674,8 +688,8 @@ properties into the object, but a developer may override this to support
more behaviour.
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/ArrayThe 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/ArrayThe 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:
@@ -691,7 +705,7 @@ For a multi-dimensional array, the value in index 0 of each item will be assumed
valueField, while the value at index 1 is assumed to be the combo displayField.
See also mode.
ComboBox stripCharsRe : RegExpA JavaScript RegExp object used to strip unwanted content from the value
-before validation (defaults to null). TextField style : StringA custom style specification to be applied to this component's Element. Should be a valid argument to
+before validation (defaults to null). TextField style : StringA 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.
new Ext.Panel({
@@ -714,18 +728,18 @@ Ext.Element.ap...
A custom style specification to be appl
}
})
]
-}); Component submitValue : BooleanFalse to clear the name attribute on the field so that it is not submitted during a form post.
+}); Component submitValue : BooleanFalse 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 : NumberThe tabIndex for this field. Note this only applies to fields that are rendered,
+Defaults to undefined. ComboBox tabIndex : NumberThe 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 : StringNote: 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 : StringNote: 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 : StringIf 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 : StringIf 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.XTemplateThe template string, or Ext.XTemplate instance to
+the dropdown list (defaults to undefined, with no header element) ComboBox tpl : String/Ext.XTemplateThe 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.
@@ -737,16 +751,16 @@ names from the Combo's itemSelector for additional details. ComboBox tplWriteMode : StringThe 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 : StringThe 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 : MixedThe id, DOM node or element of an existing HTML SELECT to convert to a ComboBox.
+(see Ext.XTemplate.overwrite
). Component transform : MixedThe 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 : StringThe 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 : StringThe 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.
- 'query' : Default
@@ -754,25 +768,25 @@ Note that if you specify this and the combo is going to be in an run the query specified by the allQuery config option
-See also queryParam
.
ComboBox triggerClass : StringAn additional CSS class used to style the trigger button. The trigger will always
+See also queryParam
.
ComboBox triggerClass : StringAn 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 : MixedA 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 : MixedA 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:
-{tag: "img", src: Ext.BLANK_IMAGE_URL, cls: "x-form-trigger " + this.triggerClass}
TriggerField typeAhead : Booleantrue to populate and autoselect the remainder of the text being
+{tag: "img", src: Ext.BLANK_IMAGE_URL, cls: "x-form-trigger " + this.triggerClass}
TriggerField typeAhead : Booleantrue 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 : NumberThe length of time in milliseconds to wait until the typeahead text is displayed
+to false) ComboBox typeAheadDelay : NumberThe 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 : BooleanWhether the field should validate when it loses focus (defaults to true). Field validationDelay : NumberThe length of time in milliseconds after user input begins until validation
-is initiated (defaults to 250) Field validationEvent : String/BooleanThe event that should initiate field validation. Set to false to disable
+is initiated (defaults to 250) Field validationEvent : String/BooleanThe 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 : FunctionA custom validation function to be called during field validation (validateValue)
+ automatic validation (defaults to 'keyup'). Field validator : FunctionA 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.
@@ -787,23 +801,23 @@ developer to override the default validation process.
true
if the value is valid
msg
: String
An error message if the value is invalid
- TextField value : MixedA value to initialize this field with (defaults to undefined). Field valueField : StringThe underlying data value name to bind to this
-ComboBox (defaults to undefined if mode = 'remote' or 'field2' if
+ TextField value : MixedA value to initialize this field with (defaults to undefined). Field valueField : StringThe 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 : StringWhen using a name/value combo, if the value passed to setValue is not found in
+mapped. See also hiddenName, hiddenValue, and displayField. ComboBox valueNotFoundText : StringWhen 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 : StringA validation type name as defined in Ext.form.VTypes (defaults to null) TextField vtypeText : StringA 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 : StringA validation type name as defined in Ext.form.VTypes (defaults to null) TextField vtypeText : StringA custom error message to display in place of the default message provided
for the vtype currently set for this field... TextField width : NumberThe width of this component in pixels (defaults to auto).
+only applies if vtype
is set, else ignored. TextField width : NumberThe 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 : StringThe class added to the to the wrap of the trigger element. Defaults to
-x-trigger-wrap-focus. TriggerField x : NumberThe local x (left) coordinate for this component if contained within a positioning container. BoxComponent xtype : StringThe registered xtype to create. This config option is not used when passing
+x-trigger-wrap-focus. TriggerField x : NumberThe local x (left) coordinate for this component if contained within a positioning container. BoxComponent xtype : StringThe 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
@@ -814,7 +828,7 @@ The predefined xtypes are listed Ext.ComponentMgr.registerType in order to be able to
-take advantage of lazy instantiation and rendering. Component y : NumberThe local y (top) coordinate for this component if contained within a positioning container. BoxComponent
Public Properties
Property Defined By disabled : BooleanTrue if this component is disabled. Read-only. Component el : Ext.ElementThe Ext.Element which encapsulates this Component. Read-only.
+take advantage of lazy instantiation and rendering. Component y : NumberThe local y (top) coordinate for this component if contained within a positioning container. BoxComponent
Public Properties
Property Defined By disabled : BooleanTrue if this component is disabled. Read-only. Component el : Ext.ElementThe 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 autoEl
config.
@@ -831,10 +845,23 @@ config for a suggestion, or use a render listener directly:new
single: true // Remove the listener after first invocation
}
});
-See also getEl
Component hidden : BooleanTrue if this component is hidden. Read-only. Component initialConfig : ObjectThis Component's initial configuration specification. Read-only. Component label : Ext.ElementThe label Element associated with this Field. Only available after this Field has been rendered by a
+See also getEl
Component hidden : BooleanTrue if this component is hidden. Read-only. Component initialConfig : ObjectThis Component's initial configuration specification. Read-only. Component keyNav : Ext.KeyNav
+<p>A {@link Ext.KeyNav KeyNav} object which handles navigation keys for this ComboBox. This performs actions
+based on keystrokes typed when the input field is focused.</p>
+<p><b>After the ComboBox has been rendered</b>, you may override existing navigation key functionality,
+or add your own based upon key names as specified in the {@link Ext.KeyNav KeyNav} class.</p>
+<p>The function is executed in the scope (<code>this</code> reference of the ComboBox. Example:</p><pre><code>
+myCombo.keyNav.esc = function(e) { // Override ESC handling function
+ this.collapse(); // Standard behaviour of Ext's ComboBox.
+ this.setValue(this.startValue); // We reset to starting value on ESC
+};
+myCombo.keyNav.tab = function() { // Override TAB handling function
+ this.onViewClick(false); // Select the currently highlighted row
+};
+</code></pre> ComboBox label : Ext.ElementThe 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 : StringThe 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 : StringThe 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:
var combo = new Ext.form.ComboBox({
@@ -856,26 +883,26 @@ configure the combo with lastQuery=''. Example use:
mode: 'local',
triggerAction: 'all',
lastQuery: ''
-});
ComboBox originalValue : mixedThe original value of the field as configured in the value configuration, or
+}); ComboBox originalValue : mixedThe 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.ContainerThis Component's owner Container (defaults to undefined, and is set automatically when
+setting is true
. Field ownerCt : Ext.ContainerThis Component's owner Container (defaults to undefined, and is set automatically when
this Component is added to a C... Component refOwner : Ext.ContainerThe ancestor Container into which the ref reference was inserted if this Component
+Note: to access items within the Container see itemId.
Component refOwner : Ext.ContainerThe 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 : BooleanTrue if this component has been rendered. Read-only. Component startValue : mixedThe 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 : BooleanTrue if this component has been rendered. Read-only. Component startValue : mixedThe 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.DataViewThe DataView used to display the ComboBox's options. ComboBox
Public Methods
Method Defined By TimeField( Object config
)
- Create a new TimeFieldCreate a new TimeFieldParameters:config
: Object
Returns:- void
TimeField 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:cls
: stringThe CSS class name to add
Returns:Ext.Component
this
Component addEvents( Object|String o
, string Optional.
)
- :
+This will be undefined until the Field has been visited. Compare originalValue.
Field view : Ext.DataViewThe DataView used to display the ComboBox's options. ComboBox
Public Methods
Method Defined By TimeField( Object config
)
+ Create a new TimeFieldCreate a new TimeFieldParameters:config
: Object
Returns:- void
TimeField 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:cls
: stringThe CSS class name to add
Returns:Ext.Component
this
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:o
: Object|StringEither an object with event names as properties with a value of true
or the first event name string if multiple event names are being passed as separate parameters.Optional.
: stringEvent name if multiple event names are being passed as separate parameters.
-Usage:this.addEvents('storeloaded', 'storecleared');
Returns:- void
Observable addListener( String eventName
, Function handler
, [Object scope
], [Object options
] )
- :
+Usage:this.addEvents('storeloaded', 'storecleared');
Returns:- void
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:eventName
: StringThe name of the event to listen for.handler
: FunctionThe method the event invokes.scope
: Object(optional) The scope (this
reference) in which the handler function is executed.
If omitted, defaults to the object which fired the event.options
: Object(optional) An object containing handler configuration.
properties. This may contain any of the following properties:
@@ -925,91 +952,91 @@ Or a shorthand syntax:
'mouseover' : this.onMouseOver,
'mouseout' : this.onMouseOut,
scope: this
-});
Returns:- void
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:el
: String/HTMLElement
Returns:- void
Component clearInvalid()
- :
- voidClear any invalid styles/messages for this fieldClear any invalid styles/messages for this fieldParameters:- None.
Returns:- void
Field clearValue()
- :
- voidClears any text/value currently set in the fieldClears any text/value currently set in the fieldParameters:- None.
Returns:- void
ComboBox cloneConfig( Object overrides
)
- :
+});Returns:- void
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:el
: String/HTMLElement
Returns:- void
Component clearInvalid()
+ :
+ voidClear any invalid styles/messages for this fieldClear any invalid styles/messages for this fieldParameters:- None.
Returns:- void
Field clearValue()
+ :
+ voidClears any text/value currently set in the fieldClears any text/value currently set in the fieldParameters:- None.
Returns:- void
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:overrides
: ObjectA new config containing any properties to override in the cloned version.
-An id property can be passed on this object, otherwise one will be generated to avoid duplicates.
Returns:Ext.Component
clone The cloned copy of this component
Component collapse()
- :
- voidHides 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:- None.
Returns:- void
ComboBox destroy()
- :
- voidDestroys 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:Ext.Component
clone The cloned copy of this component
Component collapse()
+ :
+ voidHides 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:- None.
Returns:- void
ComboBox destroy()
+ :
+ voidDestroys 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:- None.
Returns:- void
Component disable()
- :
- Ext.ComponentDisable this component and fire the 'disable' event.Disable this component and fire the 'disable' event.Parameters:- None.
Returns:Ext.Component
this
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:- None.
Returns:- void
Component disable()
+ :
+ Ext.ComponentDisable this component and fire the 'disable' event.Disable this component and fire the 'disable' event.Parameters:- None.
Returns:Ext.Component
this
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:query
: StringThe SQL query to executeforceAll
: Booleantrue to force the query to execute even if there are currently fewer
characters in the field than the minimum specified by the minChars config option. It
-also clears any filter previously saved in the current store (defaults to false)
Returns:- void
ComboBox enable()
- :
- Ext.ComponentEnable this component and fire the 'enable' event.Enable this component and fire the 'enable' event.Parameters:- None.
Returns:Ext.Component
this
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.getBubbleTarget()
if present. There is no implementation in the Observable base class.
-This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
-implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
-access the required target more quickly.
-Example:
Ext.override(Ext.form.Field, {
- // Add functionality to Field's initComponent to enable the change event to bubble
- initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
- this.enableBubble('change');
- }),
-
- // We know that we want Field's events to bubble directly to the FormPanel.
- getBubbleTarget : function() {
- if (!this.formPanel) {
- this.formPanel = this.findParentByType('form');
- }
- return this.formPanel;
- }
-});
-
-var myForm = new Ext.formPanel({
- title: 'User Details',
- items: [{
- ...
- }],
- listeners: {
- change: function() {
- // Title goes red if form has been modified.
- myForm.header.setStyle('color', 'red');
- }
- }
-});
Parameters:events
: String/ArrayThe event name to bubble, or an Array of event names.
Returns:- void
Observable expand()
- :
- voidExpands 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:- None.
Returns:- void
ComboBox findParentBy( Function fn
)
- :
- Ext.ContainerFind a container above this component at any level by a custom function. If the passed function returns
+also clears any filter previously saved in the current store (defaults to false)Returns:- void
ComboBox enable()
+ :
+ Ext.ComponentEnable this component and fire the 'enable' event.Enable this component and fire the 'enable' event.Parameters:- None.
Returns:Ext.Component
this
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.getBubbleTarget()
if present. There is no implementation in the Observable base class.
+This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
+implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
+access the required target more quickly.
+Example:
Ext.override(Ext.form.Field, {
+ // Add functionality to Field's initComponent to enable the change event to bubble
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
+ this.enableBubble('change');
+ }),
+
+ // We know that we want Field's events to bubble directly to the FormPanel.
+ getBubbleTarget : function() {
+ if (!this.formPanel) {
+ this.formPanel = this.findParentByType('form');
+ }
+ return this.formPanel;
+ }
+});
+
+var myForm = new Ext.formPanel({
+ title: 'User Details',
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: function() {
+ // Title goes red if form has been modified.
+ myForm.header.setStyle('color', 'red');
+ }
+ }
+});
Parameters:events
: String/ArrayThe event name to bubble, or an Array of event names.
Returns:- void
Observable expand()
+ :
+ voidExpands 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:- None.
Returns:- void
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:fn
: FunctionThe custom function to call with the arguments (container, this component).
Returns:Ext.Container
The first Container for which the custom function returns true
Component findParentByType( String/Class xtype
)
- :
- Ext.ContainerFind a container above this component at any level by xtype or classFind a container above this component at any level by xtype or classParameters:xtype
: String/ClassThe xtype string for a component, or the class of the component directly
Returns:Ext.Container
The first Container which matches the given xtype or class
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:fn
: FunctionThe custom function to call with the arguments (container, this component).
Returns:Ext.Container
The first Container for which the custom function returns true
Component findParentByType( String/Class xtype
)
+ :
+ Ext.ContainerFind a container above this component at any level by xtype or classFind a container above this component at any level by xtype or classParameters:xtype
: String/ClassThe xtype string for a component, or the class of the component directly
Returns:Ext.Container
The first Container which matches the given xtype or class
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:eventName
: StringThe name of the event to fire.args
: Object...Variable number of parameters are passed to handlers.
Returns:Boolean
returns false if any of the handlers return false otherwise it returns true.
Observable focus( [Boolean selectText
], [Boolean/Number delay
] )
- :
- Ext.ComponentTry to focus this component.Try to focus this component.Parameters:selectText
: Boolean(optional) If applicable, true to also select the text in this componentdelay
: Boolean/Number(optional) Delay the focus this number of milliseconds (true for 10 milliseconds)
Returns:Ext.Component
this
Component getActiveError()
- :
- StringGets the active error message for this field.Gets the active error message for this field.Parameters:- None.
Returns:String
Returns the active error message on the field, if there is no error, an empty string is returned.
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:local
: Boolean(optional) If true the element's left and top are returned instead of page XY (defaults to false)
Returns:Object
box An object in the format {x, y, width, height}
BoxComponent getBubbleTarget()
- :
- Ext.ContainerProvides 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:- None.
Returns:Ext.Container
the Container which owns this Component.
Component getEl()
- :
- Ext.ElementReturns the Ext.Element which encapsulates this Component.
+by calling enableBubble.Parameters:eventName
: StringThe name of the event to fire.args
: Object...Variable number of parameters are passed to handlers.
Returns:Boolean
returns false if any of the handlers return false otherwise it returns true.
Observable focus( [Boolean selectText
], [Boolean/Number delay
] )
+ :
+ Ext.ComponentTry to focus this component.Try to focus this component.Parameters:selectText
: Boolean(optional) If applicable, true to also select the text in this componentdelay
: Boolean/Number(optional) Delay the focus this number of milliseconds (true for 10 milliseconds)
Returns:Ext.Component
this
Component getActiveError()
+ :
+ StringGets the active error message for this field.Gets the active error message for this field.Parameters:- None.
Returns:String
Returns the active error message on the field, if there is no error, an empty string is returned.
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:local
: Boolean(optional) If true the element's left and top are returned instead of page XY (defaults to false)
Returns:Object
box An object in the format {x, y, width, height}
BoxComponent getBubbleTarget()
+ :
+ Ext.ContainerProvides 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:- None.
Returns:Ext.Container
the Container which owns this Component.
Component getEl()
+ :
+ Ext.ElementReturns 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.
@@ -1025,21 +1052,77 @@ or use a render listener directly:new Ext.Panel({
},
single: true // Remove the listener after first invocation
}
-});
Parameters:- None.
Returns:Ext.Element
The Element which encapsulates this Component.
Component getHeight()
- :
- NumberGets the current height of the component's underlying element.Gets the current height of the component's underlying element.Parameters:- None.
Returns:Number
BoxComponent getId()
- :
- StringReturns the id of this component or automatically generates and
+});Parameters:- None.
Returns:Ext.Element
The Element which encapsulates this Component.
Component getErrors( Mixed value
)
+ :
+ ArrayValidates a value according to the field's validation rules and returns an array of errors
+for any failing validation...Validates a value according to the field's validation rules and returns an array of errors
+for any failing validations. Validation rules are processed in the following order:
+
+- 1. Field specific validator
+
+
A validator offers a way to customize and reuse a validation specification.
+If a field is configured with a validator
+function, it will be passed the current field value. The validator
+function is expected to return either:
+
+- Boolean true if the value is valid (validation continues).
+- a String to represent the invalid message if invalid (validation halts).
+
+
+- 2. Basic Validation
+
+
If the validator
has not halted validation,
+basic validation proceeds as follows:
+
+allowBlank
: (Invalid message =
+emptyText
)
+Depending on the configuration of allowBlank
, a
+blank field will cause validation to halt at this step and return
+Boolean true or false accordingly.
+
+minLength
: (Invalid message =
+minLengthText
)
+If the passed value does not satisfy the minLength
+specified, validation halts.
+
+maxLength
: (Invalid message =
+maxLengthText
)
+If the passed value does not satisfy the maxLength
+specified, validation halts.
+
+
+
+- 3. Preconfigured Validation Types (VTypes)
+
+
If none of the prior validation steps halts validation, a field
+configured with a vtype
will utilize the
+corresponding VTypes validation function.
+If invalid, either the field's vtypeText
or
+the VTypes vtype Text property will be used for the invalid message.
+Keystrokes on the field will be filtered according to the VTypes
+vtype Mask property.
+
+- 4. Field specific regex test
+
Parameters:value
: MixedThe value to validate. The processed raw value will be used if nothing is passed
Returns:Array
Array of any validation errors
TextField getHeight()
+ :
+ NumberGets the current height of the component's underlying element.Gets the current height of the component's underlying element.Parameters:- None.
Returns:Number
BoxComponent getId()
+ :
+ StringReturns 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:'ext-comp-' + (++Ext.Component.AUTO_ID)
Parameters:- None.
Returns:String
id
Component getItemId()
- :
- StringReturns the itemId of this component. If an
-itemId was not assigned through configuration the
+returns an id
if an id
is not defined yet:'ext-comp-' + (++Ext.Component.AUTO_ID)
Parameters:- None.
Returns:String
id
Component getItemId()
+ :
+ String Component getListParent()
- :
- voidReturns the element used to house this ComboBox's pop-up list. Defaults to the document body.
+id
is returned using getId
.Parameters:- None.
Returns:String
Component getListParent()
+ :
+ voidReturns 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
@@ -1073,19 +1156,19 @@ the list does not hide the Menu:var store = new Ext.dat
items: [
combo // A Field in a Menu
]
-});
Parameters:- None.
Returns:- void
ComboBox getName()
- :
- StringReturns the name or hiddenName
+});Parameters:- None.
Returns:- void
ComboBox getName()
+ :
+ StringReturns the name or hiddenName
attribute of the field if available.Returns the name or hiddenName
-attribute of the field if available.Parameters:- None.
Returns:String
name The field {@link Ext.form.Field#name name} or {@link Ext.form.ComboBox#hiddenName hiddenName}
Field getOuterSize()
- :
- ObjectGets 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:- None.
Returns:Object
An object containing the element's size {width: (element width + left/right margins), height: (element height + top/bottom margins)}
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:local
: Boolean(optional) If true the element's left and top are returned instead of page XY (defaults to false)
Returns:Array
The XY position of the element (e.g., [100, 200])
BoxComponent getRawValue()
- :
- MixedReturns 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:- None.
Returns:Mixed
value The field value
Field getResizeEl()
- :
- Ext.ElementReturns the outermost Element of this Component which defines the Components overall size.
+attribute of the field if available.Parameters:- None.
Returns:String
name The field {@link Ext.form.Field#name name} or {@link Ext.form.ComboBox#hiddenName hiddenName}
Field getOuterSize()
+ :
+ ObjectGets 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:- None.
Returns:Object
An object containing the element's size {width: (element width + left/right margins), height: (element height + top/bottom margins)}
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:local
: Boolean(optional) If true the element's left and top are returned instead of page XY (defaults to false)
Returns:Array
The XY position of the element (e.g., [100, 200])
BoxComponent getRawValue()
+ :
+ MixedReturns 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:- None.
Returns:Mixed
value The field value
Field getResizeEl()
+ :
+ Ext.ElementReturns 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 getEl
,
but in some cases, a Component may have some more wrapping Elements around its main
@@ -1093,59 +1176,59 @@ active Element.
An example is a ComboBox. It is encased in a wrapping Element which
contains both the <input>
Element (which is what would be returned
by its getEl
method, and the trigger button Element.
-This Element is returned as the resizeEl
.
Parameters:- None.
Returns:Ext.Element
The Element which is to be resized by size managing layouts.
BoxComponent getSize()
- :
- ObjectGets the current size of the component's underlying element.Gets the current size of the component's underlying element.Parameters:- None.
Returns:Object
An object containing the element's size {width: (element width), height: (element height)}
BoxComponent getStore()
- :
- Ext.data.StoreReturns the store associated with this combo.Returns the store associated with this combo.Parameters:- None.
Returns:Ext.data.Store
The store
ComboBox getValue()
- :
- StringReturns 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:- None.
Returns:String
value The selected value
ComboBox getWidth()
- :
- NumberGets the current width of the component's underlying element.Gets the current width of the component's underlying element.Parameters:- None.
Returns:Number
BoxComponent getXType()
- :
- StringGets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
+This Element is returned as the resizeEl
.Parameters:- None.
Returns:Ext.Element
The Element which is to be resized by size managing layouts.
BoxComponent getSize()
+ :
+ ObjectGets the current size of the component's underlying element.Gets the current size of the component's underlying element.Parameters:- None.
Returns:Object
An object containing the element's size {width: (element width), height: (element height)}
BoxComponent getStore()
+ :
+ Ext.data.StoreReturns the store associated with this combo.Returns the store associated with this combo.Parameters:- None.
Returns:Ext.data.Store
The store
ComboBox getValue()
+ :
+ StringReturns 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:- None.
Returns:String
value The selected value
ComboBox getWidth()
+ :
+ NumberGets the current width of the component's underlying element.Gets the current width of the component's underlying element.Parameters:- None.
Returns:Number
BoxComponent getXType()
+ :
+ StringGets 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:
var t = new Ext.form.TextField();
-alert(t.getXType()); // alerts 'textfield'
Parameters:- None.
Returns:String
The xtype
Component getXTypes()
- :
- StringReturns this Component's xtype hierarchy as a slash-delimited string. For a list of all
+alert(t.getXType()); // alerts 'textfield'Parameters:- None.
Returns:String
The xtype
Component getXTypes()
+ :
+ StringReturns 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:
var t = new Ext.form.TextField();
-alert(t.getXTypes()); // alerts 'component/box/field/textfield'
Parameters:- None.
Returns:String
The xtype hierarchy string
Component hasListener( String eventName
)
- :
- BooleanChecks to see if this object has any listeners for a specified eventChecks to see if this object has any listeners for a specified eventParameters:eventName
: StringThe name of the event to check for
Returns:Boolean
True if the event is being listened for, else false
Observable hide()
- :
- Ext.ComponentHide this component. Listen to the 'beforehide' event and return
+alert(t.getXTypes()); // alerts 'component/box/field/textfield'Parameters:- None.
Returns:String
The xtype hierarchy string
Component hasListener( String eventName
)
+ :
+ BooleanChecks to see if this object has any listeners for a specified eventChecks to see if this object has any listeners for a specified eventParameters:eventName
: StringThe name of the event to check for
Returns:Boolean
True if the event is being listened for, else false
Observable hide()
+ :
+ Ext.ComponentHide 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:- None.
Returns:Ext.Component
this
Component isDirty()
- :
- BooleanReturns true if the value of this Field has been changed from its original value.
+the component is configured to be hidden
.Parameters:- None.
Returns:Ext.Component
this
Component isDirty()
+ :
+ BooleanReturns 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:- None.
Returns:Boolean
True if this field has been changed from its original value (and
-is not disabled), false otherwise.
Field isExpanded()
- :
- voidReturns true if the dropdown list is expanded, else false.Returns true if the dropdown list is expanded, else false.Parameters:- None.
Returns:- void
ComboBox isValid( Boolean preventMark
)
- :
- BooleanReturns whether or not the field value is currently valid by
-validating the processed value
+Ext.form.BasicForm.setValues.Parameters:- None.
Returns:Boolean
True if this field has been changed from its original value (and
+is not disabled), false otherwise.
Field isExpanded()
+ :
+ voidReturns true if the dropdown list is expanded, else false.Returns true if the dropdown list is expanded, else false.Parameters:- None.
Returns:- void
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:preventMark
: BooleanTrue to disable marking the field invalid
Returns:Boolean
True if the value is valid, else false
Field isVisible()
- :
- BooleanReturns true if this component is visible.Returns true if this component is visible.Parameters:- None.
Returns:Boolean
True if this component is visible, false otherwise.
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:preventMark
: BooleanTrue to disable marking the field invalid
Returns:Boolean
True if the value is valid, else false
Field isVisible()
+ :
+ BooleanReturns true if this component is visible.Returns true if this component is visible.Parameters:- None.
Returns:Boolean
True if this component is visible, false otherwise.
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
@@ -1156,17 +1239,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:xtype
: StringThe xtype to check for this Componentshallow
: Boolean(optional) False to check whether this Component is descended from the xtype (this is
-the default), or true to check whether this Component is directly of the specified xtype.
Returns:Boolean
True if this component descends from the specified xtype, false otherwise.
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:Boolean
True if this component descends from the specified xtype, false otherwise.
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 false
if the value does pass validation. So simply marking a Field as invalid will not prevent
submission of forms submitted with the Ext.form.Action.Submit.clientValidation option set.
-invalid.Parameters:msg
: String(optional) The validation message (defaults to invalidText)
Returns:- void
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:msg
: String(optional) The validation message (defaults to invalidText)
Returns:- void
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:
myGridPanel.mon(myGridPanel.getSelectionModel(), 'selectionchange', handleSelectionChange, null, {buffer: 50});
@@ -1179,39 +1262,39 @@ myGridPanel.mon(myGridPanel.getSelectionModel(), {
Parameters:item
: Observable|ElementThe item to which to add a listener/listeners.ename
: Object|StringThe event name, or an object containing event name properties.fn
: FunctionOptional. If the ename
parameter was an event name, this
is the handler function.scope
: ObjectOptional. If the ename
parameter was an event name, this
is the scope (this
reference) in which the handler function is executed.opt
: ObjectOptional. If the ename
parameter was an event name, this
-is the addListener options.
Returns:- void
Component mun( Observable|Element item
, Object|String ename
, Function fn
, Object scope
)
- :
+is the addListener options.Returns:- void
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:item
: Observable|ElementThe item from which to remove a listener/listeners.ename
: Object|StringThe event name, or an object containing event name properties.fn
: FunctionOptional. If the ename
parameter was an event name, this
is the handler function.scope
: ObjectOptional. If the ename
parameter was an event name, this
-is the scope (this
reference) in which the handler function is executed.
Returns:- void
Component nextSibling()
- :
- Ext.ComponentReturns the next component in the owning containerReturns the next component in the owning containerParameters:- None.
Returns:Ext.Component
Component on( String eventName
, Function handler
, [Object scope
], [Object options
] )
- :
+is the scope (this
reference) in which the handler function is executed.Returns:- void
Component nextSibling()
+ :
+ Ext.ComponentReturns the next component in the owning containerReturns the next component in the owning containerParameters:- None.
Returns:Ext.Component
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:eventName
: StringThe type of event to listen forhandler
: FunctionThe method the event invokesscope
: Object(optional) The scope (this
reference) in which the handler function is executed.
-If omitted, defaults to the object which fired the event.options
: Object(optional) An object containing handler configuration.
Returns:- void
Observable onTriggerClick( EventObject e
)
- :
- voidThe function that should handle the trigger's click event. This method does nothing by default
+If omitted, defaults to the object which fired the event.options
: Object(optional) An object containing handler configuration. Returns:- void
Observable onTriggerClick( EventObject e
)
+ :
+ voidThe function that should handle the trigger's click event. This method does nothing by default
until overridden by a...The function that should handle the trigger's click event. This method does nothing by default
until overridden by an implementing function. See Ext.form.ComboBox and Ext.form.DateField for
-sample implementations.Parameters:e
: EventObject
Returns:- void
TriggerField previousSibling()
- :
- Ext.ComponentReturns the previous component in the owning containerReturns the previous component in the owning containerParameters:- None.
Returns:Ext.Component
Component processValue( Mixed value
)
- :
- voidThis method should only be overridden if necessary to prepare raw values
+sample implementations.Parameters:e
: EventObject
Returns:- void
TriggerField previousSibling()
+ :
+ Ext.ComponentReturns the previous component in the owning containerReturns the previous component in the owning containerParameters:- None.
Returns:Ext.Component
Component processValue( Mixed value
)
+ :
+ voidThis method should only be overridden if necessary to prepare raw values
for validation (see validate and isValid). ... Field purgeListeners()
- :
- voidRemoves all listeners for this objectRemoves all listeners for this objectParameters:- None.
Returns:- void
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:o
: ObjectThe Observable whose events this object is to relay.events
: ArrayArray of event names to relay.
Returns:- void
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:cls
: stringThe CSS class name to remove
Returns:Ext.Component
this
Component removeListener( String eventName
, Function handler
, [Object scope
] )
- :
- voidRemoves an event handler.Removes an event handler.Parameters:eventName
: StringThe type of event the handler was associated with.handler
: FunctionThe handler to remove. This must be a reference to the function passed into the addListener call.scope
: Object(optional) The scope originally specified for the handler.
Returns:- void
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:value
: Mixed
Returns:- void
Field purgeListeners()
+ :
+ voidRemoves all listeners for this objectRemoves all listeners for this objectParameters:- None.
Returns:- void
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:o
: ObjectThe Observable whose events this object is to relay.events
: ArrayArray of event names to relay.
Returns:- void
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:cls
: stringThe CSS class name to remove
Returns:Ext.Component
this
Component removeListener( String eventName
, Function handler
, [Object scope
] )
+ :
+ voidRemoves an event handler.Removes an event handler.Parameters:eventName
: StringThe type of event the handler was associated with.handler
: FunctionThe handler to remove. This must be a reference to the function passed into the addListener call.scope
: Object(optional) The scope originally specified for the handler.
Returns:- void
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.
@@ -1233,67 +1316,72 @@ 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:container
: Element/HTMLElement/String(optional) The element this Component should be
rendered into. If it is being created from existing markup, this should be omitted.position
: String/Number(optional) The element ID or DOM node index within the container before
-which this component will be inserted (defaults to appending to the end of the container)
Returns:- void
Component reset()
- :
- voidResets 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:- void
Component reset()
+ :
+ voidResets 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:- None.
Returns:- void
TextField resumeEvents()
- :
- voidResume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
+original value was blank.Parameters:- None.
Returns:- void
TextField resumeEvents()
+ :
+ voidResume 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:- None.
Returns:- void
Observable select( Number index
, Boolean scrollIntoView
)
- :
+events fired during event suspension will be sent to any listeners now.Parameters:- None.
Returns:- void
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:index
: NumberThe zero-based index of the list item to selectscrollIntoView
: BooleanFalse to prevent the dropdown list from autoscrolling to display the
-selected item if it is not currently in view (defaults to true)
Returns:- void
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:- void
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:value
: StringThe data value of the item to selectscrollIntoView
: BooleanFalse to prevent the dropdown list from autoscrolling to display the
-selected item if it is not currently in view (defaults to true)
Returns:Boolean
True if the value matched an item in the list, else false
ComboBox selectText( [Number start
], [Number end
] )
- :
- voidSelects text in this fieldSelects text in this fieldParameters:start
: Number(optional) The index where the selection should start (defaults to 0)end
: Number(optional) The index where the selection should end (defaults to the text length)
Returns:- void
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:scroll
: BooleanTrue to allow the Component to auto scroll.
Returns:Ext.BoxComponent
this
BoxComponent setDisabled( Boolean disabled
)
- :
- Ext.ComponentConvenience function for setting disabled/enabled by boolean.Convenience function for setting disabled/enabled by boolean.Parameters:disabled
: Boolean
Returns:Ext.Component
this
Component setEditable( Boolean value
)
- :
+selected item if it is not currently in view (defaults to true)Returns:Boolean
True if the value matched an item in the list, else false
ComboBox selectText( [Number start
], [Number end
] )
+ :
+ voidSelects text in this fieldSelects text in this fieldParameters:start
: Number(optional) The index where the selection should start (defaults to 0)end
: Number(optional) The index where the selection should end (defaults to the text length)
Returns:- void
TextField setActiveError( String msg
, Boolean suppressEvent
)
+ :
+ voidSets the current activeError to the given string. Fires the 'invalid' event.
+This does not set up the error icon, onl...Sets the current activeError to the given string. Fires the 'invalid' event.
+This does not set up the error icon, only sets the message and fires the event. To show the error icon,
+use markInvalid instead, which calls this method internallyParameters:msg
: StringThe error messagesuppressEvent
: BooleanTrue to suppress the 'invalid' event from being fired
Returns:- void
Field setAutoScroll( Boolean scroll
)
+ :
+ Ext.BoxComponentSets the overflow on the content element of the component.Sets the overflow on the content element of the component.Parameters:scroll
: BooleanTrue to allow the Component to auto scroll.
Returns:Ext.BoxComponent
this
BoxComponent setDisabled( Boolean disabled
)
+ :
+ Ext.ComponentConvenience function for setting disabled/enabled by boolean.Convenience function for setting disabled/enabled by boolean.Parameters:disabled
: Boolean
Returns:Ext.Component
this
Component setEditable( Boolean value
)
+ :
voidParameters:value
: BooleanTrue to allow the user to directly edit the field text
Allow or prevent the user from directly editing the field text. If false is passed,
the user will only be able to modify the field using the trigger. Will also add
a click event to the text field which will call the trigger. This method
-is the runtime equivalent of setting the 'editable' config option at config time.
Returns:- void
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:height
: NumberThe new height to set. This may be one of:
-- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
+is the runtime equivalent of setting the 'editable' config option at config time.
Returns:- void
TriggerField setHeight( Mixed height
)
+ :
+ Ext.BoxComponentSets the height of the component. This method fires the resize event.Sets the height of the component. This method fires the resize event.Parameters:height
: MixedThe new height to set. This may be one of:
+- A Number specifying the new height in the Element's defaultUnits (by default, pixels).
- A String used to set the CSS height style.
- undefined to leave the height unchanged.
-
Returns:Ext.BoxComponent
this
BoxComponent setMaxValue( Date/String value
)
- :
- voidReplaces any existing maxValue with the new time and refreshes the store.Replaces any existing maxValue with the new time and refreshes the store.Parameters:value
: Date/StringThe maximum time that can be selected
Returns:- void
TimeField setMinValue( Date/String value
)
- :
- voidReplaces any existing minValue with the new time and refreshes the store.Replaces any existing minValue with the new time and refreshes the store.Parameters:value
: Date/StringThe minimum time that can be selected
Returns:- void
TimeField setPagePosition( Number x
, Number y
)
- :
- Ext.BoxComponentSets the page XY position of the component. To set the left and top instead, use setPosition.
+Returns:Ext.BoxComponent
this
BoxComponent setMaxValue( Date/String value
)
+ :
+ voidReplaces any existing maxValue with the new time and refreshes the store.Replaces any existing maxValue with the new time and refreshes the store.Parameters:value
: Date/StringThe maximum time that can be selected
Returns:- void
TimeField setMinValue( Date/String value
)
+ :
+ voidReplaces any existing minValue with the new time and refreshes the store.Replaces any existing minValue with the new time and refreshes the store.Parameters:value
: Date/StringThe minimum time that can be selected
Returns:- void
TimeField 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:x
: NumberThe new x positiony
: NumberThe new y position
Returns:Ext.BoxComponent
this
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:x
: NumberThe new x positiony
: NumberThe new y position
Returns:Ext.BoxComponent
this
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:left
: NumberThe new lefttop
: NumberThe new top
Returns:Ext.BoxComponent
this
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:value
: MixedThe value to set
Returns:Mixed
value The field value that is set
Field setReadOnly( Boolean value
)
- :
+This method fires the move event.Parameters:left
: NumberThe new lefttop
: NumberThe new top
Returns:Ext.BoxComponent
this
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:value
: MixedThe value to set
Returns:Mixed
value The field value that is set
Field setReadOnly( Boolean value
)
+ :
voidParameters:value
: BooleanTrue to prevent the user changing the field and explicitly
hide the trigger.
Setting this to true will superceed settings editable and hideTrigger.
Setting this to false will defer back to editable and hideTrigger. This method
-is the runtime equivalent of setting the 'readOnly' config option at config time.
Returns:- void
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:- void
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:width
: MixedThe new width to set. This may be one of:
- A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
@@ -1305,193 +1393,147 @@ This may be one of:
- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
- A String used to set the CSS height style. Animation may not be used.
undefined
to leave the height unchanged.
-
Returns:Ext.BoxComponent
this
BoxComponent setValue( String value
)
- :
- Ext.form.FieldSets the specified value into the field. If the value finds a match, the corresponding record text
+Returns:Ext.BoxComponent
this
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:value
: StringThe value to match
Returns:Ext.form.Field
this
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:visible
: BooleanTrue to show, false to hide
Returns:Ext.Component
this
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:width
: NumberThe new width to setThis may be one of:
-- A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
+Otherwise the field will be blank (although the value will still be set).Parameters:value
: StringThe value to match
Returns:Ext.form.Field
this
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:visible
: BooleanTrue to show, false to hide
Returns:Ext.Component
this
Component setWidth( Mixed width
)
+ :
+ Ext.BoxComponentSets the width of the component. This method fires the resize event.Sets the width of the component. This method fires the resize event.Parameters:width
: MixedThe new width to set. This may be one of:
+- A Number specifying the new width in the Element's defaultUnits (by default, pixels).
- A String used to set the CSS width style.
-
Returns:Ext.BoxComponent
this
BoxComponent show()
- :
- Ext.ComponentShow this component. Listen to the 'beforeshow' event and return
+Returns:Ext.BoxComponent
this
BoxComponent show()
+ :
+ Ext.ComponentShow 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:- None.
Returns:Ext.Component
this
Component suspendEvents( Boolean queueSuspended
)
- :
+event after showing the component.Parameters:- None.
Returns:Ext.Component
this
Component suspendEvents( Boolean queueSuspended
)
+ :
voidSuspend the firing of all events. (see resumeEvents)Suspend the firing of all events. (see resumeEvents)Parameters:queueSuspended
: BooleanPass as true to queue up suspended events to be fired
-after the resumeEvents call instead of discarding all suspended events;
Returns:- void
Observable syncSize()
- :
- Ext.BoxComponentForce 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:- None.
Returns:Ext.BoxComponent
this
BoxComponent un( String eventName
, Function handler
, [Object scope
] )
- :
- voidRemoves an event handler (shorthand for removeListener.)Removes an event handler (shorthand for removeListener.)Parameters:eventName
: StringThe type of event the handler was associated with.handler
: FunctionThe handler to remove. This must be a reference to the function passed into the addListener call.scope
: Object(optional) The scope originally specified for the handler.
Returns:- void
Observable update( Mixed htmlOrData
, [Boolean loadScripts
], [Function callback
] )
- :
+after the resumeEvents call instead of discarding all suspended events;Returns:- void
Observable syncSize()
+ :
+ Ext.BoxComponentForce 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:- None.
Returns:Ext.BoxComponent
this
BoxComponent un( String eventName
, Function handler
, [Object scope
] )
+ :
+ voidRemoves an event handler (shorthand for removeListener.)Removes an event handler (shorthand for removeListener.)Parameters:eventName
: StringThe type of event the handler was associated with.handler
: FunctionThe handler to remove. This must be a reference to the function passed into the addListener call.scope
: Object(optional) The scope originally specified for the handler.
Returns:- void
Observable unsetActiveError( Boolean suppressEvent
)
+ :
+ voidClears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not
+usually n...Clears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not
+usually need to be called manuallyParameters:suppressEvent
: BooleanTrue to suppress the 'invalid' event from being fired
Returns:- void
Field update( Mixed htmlOrData
, [Boolean loadScripts
], [Function callback
] )
+ :
voidUpdate the content area of a component.Update the content area of a component.Parameters:htmlOrData
: MixedIf this component has been configured with a template via the tpl config
then it will use this argument as data to populate the template.
If this component was not configured with a template, the components
-content area will be updated via Ext.Element updateloadScripts
: Boolean(optional) Only legitimate when using the html configuration. Defaults to falsecallback
: Function(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading
Returns:- void
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:box
: ObjectAn object in the format {x, y, width, height}
Returns:Ext.BoxComponent
this
BoxComponent validate()
- :
- BooleanValidates the field valueValidates the field valueParameters:- None.
Returns:Boolean
True if the value is valid, else false
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:
-
-- 1. Field specific validator
-
-
A validator offers a way to customize and reuse a validation specification.
-If a field is configured with a validator
-function, it will be passed the current field value. The validator
-function is expected to return either:
-
-- Boolean true if the value is valid (validation continues).
-- a String to represent the invalid message if invalid (validation halts).
-
-
-- 2. Basic Validation
-
-
If the validator
has not halted validation,
-basic validation proceeds as follows:
-
-allowBlank
: (Invalid message =
-emptyText
)
-Depending on the configuration of allowBlank
, a
-blank field will cause validation to halt at this step and return
-Boolean true or false accordingly.
-
-minLength
: (Invalid message =
-minLengthText
)
-If the passed value does not satisfy the minLength
-specified, validation halts.
-
-maxLength
: (Invalid message =
-maxLengthText
)
-If the passed value does not satisfy the maxLength
-specified, validation halts.
-
-
-
-- 3. Preconfigured Validation Types (VTypes)
-
-
If none of the prior validation steps halts validation, a field
-configured with a vtype
will utilize the
-corresponding VTypes validation function.
-If invalid, either the field's vtypeText
or
-the VTypes vtype Text property will be used for the invalid message.
-Keystrokes on the field will be filtered according to the VTypes
-vtype Mask property.
-
-- 4. Field specific regex test
-
Parameters:value
: MixedThe value to validate
Returns:Boolean
True if the value is valid, else false
TextField
Public Events
Event Defined By added :
- ( Ext.Component this
, Ext.Container ownerCt
, number index
)
- Fires when a component is added to an Ext.ContainerFires when a component is added to an Ext.ContainerListeners will be called with the following arguments:this
: Ext.ComponentownerCt
: Ext.ContainerContainer which holds the componentindex
: numberPosition at which the component was added
Component afterrender :
- ( Ext.Component this
)
- Fires after the component rendering is finished.
+content area will be updated via Ext.Element updateloadScripts
: Boolean(optional) Only legitimate when using the html configuration. Defaults to falsecallback
: Function(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading Returns:- void
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:box
: ObjectAn object in the format {x, y, width, height}
Returns:Ext.BoxComponent
this
BoxComponent validate()
+ :
+ BooleanValidates the field valueValidates the field valueParameters:- None.
Returns:Boolean
True if the value is valid, else false
Field validateValue( Mixed The
)
+ :
+ BooleanUses getErrors to build an array of validation errors. If any errors are found, markInvalid is called
+with the first ...Uses getErrors to build an array of validation errors. If any errors are found, markInvalid is called
+with the first and false is returned, otherwise true is returned. Previously, subclasses were invited
+to provide an implementation of this to process validations - from 3.2 onwards getErrors should be
+overridden instead.Parameters:The
: Mixedcurrent value of the field
Returns:Boolean
True if all validations passed, false if one or more failed
Field
Public Events
Event Defined By added :
+ ( Ext.Component this
, Ext.Container ownerCt
, number index
)
+ Fires when a component is added to an Ext.ContainerFires when a component is added to an Ext.ContainerListeners will be called with the following arguments:this
: Ext.ComponentownerCt
: Ext.ContainerContainer which holds the componentindex
: numberPosition at which the component was added
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:this
: Ext.Component
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:this
: Ext.Component
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:this
: Ext.form.FieldThis text fieldwidth
: NumberThe new field width
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:this
: Ext.form.FieldThis text fieldwidth
: NumberThe new field width
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:this
: Ext.Component
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:this
: Ext.Component
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:queryEvent
: ObjectAn object that has these properties:
combo
: Ext.form.ComboBox This combo box
query
: String The query
forceAll
: Boolean True to force "all" query
cancel
: Boolean Set to true to cancel the query
-
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:combo
: Ext.form.ComboBoxThis combo boxrecord
: Ext.data.RecordThe data record returned from the underlying storeindex
: NumberThe index of the selected item in the dropdown list
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:this
: Ext.Component
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:combo
: Ext.form.ComboBoxThis combo boxrecord
: Ext.data.RecordThe data record returned from the underlying storeindex
: NumberThe index of the selected item in the dropdown list
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:this
: Ext.Component
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:this
: Ext.Component
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:this
: Ext.Componentstate
: ObjectThe hash of state values returned from the StateProvider. If this
event is not vetoed, then the state object is passed to applyState. By default,
that simply copies property values into this Component. The method maybe overriden to
-provide custom state restoration.
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:this
: Ext.Componentstate
: ObjectThe hash of state values. This is determined by calling
getState() on the Component. This method must be provided by the
developer to return whetever representation of state is required, by default, Ext.Component
-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:this
: Ext.form.Field
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:this
: Ext.form.FieldnewValue
: MixedThe new valueoldValue
: MixedThe original value
Field collapse :
- ( Ext.form.ComboBox combo
)
- Fires when the dropdown list is collapsedFires when the dropdown list is collapsedListeners will be called with the following arguments:combo
: Ext.form.ComboBoxThis combo box
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:this
: Ext.Component
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:this
: Ext.Component
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:this
: Ext.Component
Component expand :
- ( Ext.form.ComboBox combo
)
- Fires when the dropdown list is expandedFires when the dropdown list is expandedListeners will be called with the following arguments:combo
: Ext.form.ComboBoxThis combo box
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:this
: Ext.form.Field
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:this
: Ext.form.Field
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:this
: Ext.form.FieldnewValue
: MixedThe new valueoldValue
: MixedThe original value
Field collapse :
+ ( Ext.form.ComboBox combo
)
+ Fires when the dropdown list is collapsedFires when the dropdown list is collapsedListeners will be called with the following arguments:combo
: Ext.form.ComboBoxThis combo box
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:this
: Ext.Component
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:this
: Ext.Component
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:this
: Ext.Component
Component expand :
+ ( Ext.form.ComboBox combo
)
+ Fires when the dropdown list is expandedFires when the dropdown list is expandedListeners will be called with the following arguments:combo
: Ext.form.ComboBoxThis combo box
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:this
: Ext.form.Field
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:this
: Ext.Component
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:this
: Ext.form.Fieldmsg
: StringThe validation message
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:this
: Ext.Component
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:this
: Ext.form.Fieldmsg
: StringThe validation message
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:this
: Ext.form.TextFieldThis text fielde
: Ext.EventObject
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:this
: Ext.form.TextFieldThis text fielde
: Ext.EventObject
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:this
: Ext.form.TextFieldThis text fielde
: Ext.EventObject
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:this
: Ext.form.TextFieldThis text fielde
: Ext.EventObject
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:this
: Ext.form.TextFieldThis text fielde
: Ext.EventObject
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:this
: Ext.Componentx
: NumberThe new x positiony
: NumberThe new y position
BoxComponent removed :
- ( Ext.Component this
, Ext.Container ownerCt
)
- Fires when a component is removed from an Ext.ContainerFires when a component is removed from an Ext.ContainerListeners will be called with the following arguments:this
: Ext.ComponentownerCt
: Ext.ContainerContainer which holds the component
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:this
: Ext.Component
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:this
: Ext.ComponentadjWidth
: NumberThe box-adjusted width that was setadjHeight
: NumberThe box-adjusted height that was setrawWidth
: NumberThe width that was originally specifiedrawHeight
: NumberThe height that was originally specified
BoxComponent select :
- ( Ext.form.ComboBox combo
, Ext.data.Record record
, Number index
)
- Fires when a list item is selectedFires when a list item is selectedListeners will be called with the following arguments:combo
: Ext.form.ComboBoxThis combo boxrecord
: Ext.data.RecordThe data record returned from the underlying storeindex
: NumberThe index of the selected item in the dropdown list
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:this
: Ext.Component
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:this
: Ext.form.TextFieldThis text fielde
: Ext.EventObject
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:this
: Ext.Componentx
: NumberThe new x positiony
: NumberThe new y position
BoxComponent removed :
+ ( Ext.Component this
, Ext.Container ownerCt
)
+ Fires when a component is removed from an Ext.ContainerFires when a component is removed from an Ext.ContainerListeners will be called with the following arguments:this
: Ext.ComponentownerCt
: Ext.ContainerContainer which holds the component
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:this
: Ext.Component
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:this
: Ext.ComponentadjWidth
: NumberThe box-adjusted width that was setadjHeight
: NumberThe box-adjusted height that was setrawWidth
: NumberThe width that was originally specifiedrawHeight
: NumberThe height that was originally specified
BoxComponent select :
+ ( Ext.form.ComboBox combo
, Ext.data.Record record
, Number index
)
+ Fires when a list item is selectedFires when a list item is selectedListeners will be called with the following arguments:combo
: Ext.form.ComboBoxThis combo boxrecord
: Ext.data.RecordThe data record returned from the underlying storeindex
: NumberThe index of the selected item in the dropdown list
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:this
: Ext.Component
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.
@@ -1517,15 +1559,15 @@ For example: var form = new Ext.form.FormPanel({
}
],
...
-});
Listeners will be called with the following arguments:this
: Ext.form.Fielde
: Ext.EventObjectThe event object
Field staterestore :
- ( Ext.Component this
, Object state
)
+});Listeners will be called with the following arguments:this
: Ext.form.Fielde
: Ext.EventObjectThe event object
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:this
: Ext.Componentstate
: ObjectThe hash of state values returned from the StateProvider. This is passed
to applyState. By default, that simply copies property values into this
-Component. The method maybe overriden to provide custom state restoration.
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:this
: Ext.Componentstate
: ObjectThe hash of state values. This is determined by calling
getState() on the Component. This method must be provided by the
developer to return whetever representation of state is required, by default, Ext.Component
-has a null implementation.
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:this
: Ext.form.Field
Field
\ No newline at end of file