| altFormats : StringMultiple date formats separated by "|" to try when parsing a user input value and it
+ Provides a date input field with a Ext.DatePicker dropdown and automatic date validation. Config Options|
| allowBlank : Boolean Specify false to validate that the value's length is > 0 (defaults to
+true) | TextField | | allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component | | altFormats : StringMultiple date formats separated by "|" to try when parsing a user input value and it
does not match the defined forma... Multiple date formats separated by "|" to try when parsing a user input value and it
does not match the defined format (defaults to
-'m/d/Y|n/j/Y|n/j/y|m/j/y|n/d/y|m/j/Y|n/d/Y|m-d-y|m-d-Y|m/d|m-d|md|mdy|mdY|d|Y-m-d'). | DateField | | anchor : StringNote: this config is only used when this Component is rendered
+'m/d/Y|n/j/Y|n/j/y|m/j/y|n/d/y|m/j/Y|n/d/Y|m-d-y|m-d-Y|m/d|m-d|md|mdy|mdY|d|Y-m-d|n-j|n/j'). | DateField | | 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:
- See Ext.layout.AnchorLayout.anchor also. | Component | | applyTo : Mixed | 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.
@@ -23,12 +29,25 @@ 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 specification object, or true for the default element
+ | Component | | autoCreate : String/ObjectA DomHelper element specification object, or true for the default element
specification object:autoCreate: {tag: "inp... | DateField | | autoShow : BooleanTrue if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
+specification object: autoCreate: {tag: "input", type: "text", size: "10", autocomplete: "off"}
| DateField | | 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
them on render... True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
them on render (defaults to false). | Component | | blankText : StringThe error text to display if the allowBlank validation
-fails (defaults to 'This field is required') | TextField | | clearCls : StringThe CSS class used to to apply to the special clearing div rendered
+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 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 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 manag... The minimum value in pixels which this BoxComponent will set its width to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent | | bubbleEvents : ArrayAn array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.... | 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').
@@ -36,7 +55,21 @@ directly after each form field wrapper to provide field clearing (defaults to
which has been configured to use the FormLayout layout
manager (e.g. Ext.form.FormPanel or specifying layout:'form') and either a
fieldLabel is specified or isFormField=true is specified.
- See Ext.layout.FormLayout.fieldTpl also. | Component | | cls : String A custom CSS class to apply to the field's underlying element (defaults to ''). | Field | | ctCls : String | Component | | cls : String A 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.
+
+- Description :
+
This config option is used to take an existing HTML element and place it in the layout element
+of a new component (it simply moves the specified DOM element after the Component is rendered to use as the content.
+- Notes :
+
The specified HTML element is appended to the layout element of the component after any configured
+HTML has been inserted, and so the document will not contain this element at the time the render event is fired.
+The specified HTML element used will not participate in any layout
+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
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.
@@ -47,11 +80,12 @@ which assigns a value by default:
To configure the above Class with an extra CSS class append to the default. For example,
for BoxLayout (Hbox and Vbox): ctCls: 'x-box-layout-ct custom-class'
- | Component | | disableKeyFilter : Boolean Specify true to disable input keystroke filtering (defaults
-to false) | TextField | | disabled : BooleanTrue to disable the field (defaults to false).
+ | Component | | data : MixedThe initial set of data to apply to the tpl to
+update the content area of the Component. | Component | | disableKeyFilter : Boolean Specify true to disable input keystroke filtering (defaults
+to false) | TextField | | disabled : 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 : String CSS class added to the component when it is disabled (defaults to 'x-item-disabled'). | Component | | disabledDates : ArrayAn array of "dates" to disable, as strings. These strings will be used to build a dynamic regular
+disabled Fields will not be submitted. | Field | | disabledClass : String CSS class added to the component when it is disabled (defaults to 'x-item-disabled'). | Component | | disabledDates : ArrayAn array of "dates" to disable, as strings. These strings will be used to build a dynamic regular
expression so they ... An array of "dates" to disable, as strings. These strings will be used to build a dynamic regular
expression so they are very powerful. Some examples: // disable these exact dates:
disabledDates: ["03/08/2003", "09/16/2003"]
@@ -65,20 +99,20 @@ disabledDates: ["03/../2006"]
disabledDates: ["^03"]
Note that the format of the dates included in the array should exactly match the format config.
In order to support regular expressions, if you are using a date format that has "." in
-it, you will have to escape the dot when restricting dates. For example: ["03\\.08\\.03"]. | DateField | | disabledDatesText : String The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled') | DateField | | disabledDays : ArrayAn array of days to disable, 0 based (defaults to null). Some examples:// disable Sunday and Saturday:
+it, you will have to escape the dot when restricting dates. For example: ["03\\.08\\.03"]. | DateField | | disabledDatesText : String The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled') | DateField | | disabledDays : ArrayAn array of days to disable, 0 based (defaults to null). Some examples:// disable Sunday and Saturday:
disabledDays: ... An array of days to disable, 0 based (defaults to null). Some examples: // disable Sunday and Saturday:
disabledDays: [0, 6]
// disable weekdays:
-disabledDays: [1,2,3,4,5]
| DateField | | disabledDaysText : String The tooltip to display when the date falls on a disabled day (defaults to 'Disabled') | DateField | | editable : Booleanfalse to prevent the user from typing text directly into the field,
-the field will only respond to a click on the tr... 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
+disabledDays: [1,2,3,4,5] | DateField | | disabledDaysText : String The tooltip to display when the date falls on a disabled day (defaults to 'Disabled') | DateField | | 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
(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 : Boolean true to enable the proxying of key events for the HTML input
-field (defaults to false) | TextField | | fieldClass : String The default CSS class for the field (defaults to 'x-form-field') | Field | | fieldLabel : StringThe label text to display next to this Component (defaults to '').
+field (defaults to false) | TextField | | fieldClass : String The default CSS class for the field (defaults to 'x-form-field') | Field | | fieldLabel : 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.
@@ -92,13 +126,19 @@ Example use: new Ext.FormPanel({
xtype: 'textfield',
fieldLabel: 'Name'
}]
-});
| Component | | focusClass : String The CSS class to use when the field receives focus (defaults to 'x-form-focus') | Field | | format : StringThe default date format string which can be overriden for localization support. The format must be
+}); | 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 : String The CSS class to use when the field receives focus (defaults to 'x-form-focus') | Field | | format : StringThe default date format string which can be overriden for localization support. The format must be
valid according t... The default date format string which can be overriden for localization support. The format must be
-valid according to Date.parseDate (defaults to 'm/d/Y'). | DateField | | height : NumberThe height of this component in pixels (defaults to auto).
+valid according to Date.parseDate (defaults to 'm/d/Y'). | DateField | | 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 | | hideLabel : Booleantrue to completely hide the label element
-(label and separator). Defaults to false.
+ hide method will be called internally. | Component | | 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
@@ -112,17 +152,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 : Boolean true to hide the trigger element and display only the base
-text field (defaults to false) | TriggerField | | id : StringThe unique id of this component (defaults to an auto-assigned id).
+button on a window by setting hide:true on the button when adding it to its parent container. | Component | | hideTrigger : Boolean true to hide the trigger element and display only the base
+text field (defaults to false) | TriggerField | | html : String/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).
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).
@@ -132,13 +176,13 @@ rules to style the specific instance of this component uniquely, and also to sel
sub-elements using this component's id as the parent.
Note: to avoid complications imposed by a unique id also see
itemId and ref .
- Note: to access the container of an item see ownerCt . | Component | | 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 | | 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 : String The CSS class to use when marking a field invalid (defaults to 'x-form-invalid') | Field | | invalidText : StringThe error text to display when the date in the field is invalid (defaults to
+is not supported and should be avoided. | Field | | invalidClass : String The CSS class to use when marking a field invalid (defaults to 'x-form-invalid') | Field | | invalidText : StringThe error text to display when the date in the field is invalid (defaults to
'{value} is not a valid date - it must b... The error text to display when the date in the field is invalid (defaults to
-'{value} is not a valid date - it must be in the format {format}'). | DateField | | itemCls : StringNote: this config is only used when this Component is rendered by a Container which
+'{value} is not a valid date - it must be in the format {format}'). | DateField | | 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').
@@ -167,7 +211,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
@@ -196,8 +240,8 @@ avoiding potential conflicts with getComponent('p1'); // not the same as Ext.getCmp()
p2 = p1.ownerCt.getComponent('p2'); // reference via a sibling
Also see id and ref .
- Note: to access the container of an item see ownerCt. | Component | | labelSeparator : StringThe separator to display after the text of each
-fieldLabel. This property may be configured at various levels.
+ Note: to access the container of an item see ownerCt. | Component | | 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:
@@ -225,7 +269,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 '').
@@ -240,7 +284,7 @@ Example use: new Ext.FormPanel({
fieldLabel: 'Name',
labelStyle: 'font-weight:bold;'
}]
-});
| Component | | listeners : ObjectA config object containing one or more event handlers to be added to this
+}); | Component | | 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.
@@ -295,7 +339,7 @@ Ext.DomObserver = Ext.extend(Object, {
typeAhead: true,
mode: 'local',
triggerAction: 'all'
-}); | Observable | | margins : ObjectNote: this config is only used when this BoxComponent is rendered
+}); | Observable | | 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.
@@ -317,7 +361,7 @@ to the second, and the bottom is set to the third.
If there are four values, they apply to the top, right, bottom, and left, respectively.
Defaults to: {top:0, right:0, bottom:0, left:0}
| BoxComponent | | maskRe : RegExp An input mask regular expression that will be used to filter keystrokes that do
-not match (defaults to null) | TextField | | maxLength : NumberMaximum input field length allowed by validation (defaults to Number.MAX_VALUE).
+not match (defaults to null) | TextField | | 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
@@ -328,45 +372,43 @@ 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 date in the cell is after maxValue (defaults to
+validation fails (defaults to 'The maximum length for this field is {maxLength}') | TextField | | maxText : StringThe error text to display when the date in the cell is after maxValue (defaults to
'The date in this field must be be... The error text to display when the date in the cell is after maxValue (defaults to
- 'The date in this field must be before {maxValue}'). | DateField | | maxValue : Date/StringThe maximum allowed date. Can be either a Javascript date object or a string date in a
+'The date in this field must be before {maxValue}'). | DateField | | maxValue : Date/StringThe maximum allowed date. Can be either a Javascript date object or a string date in a
valid format (defaults to null... The maximum allowed date. Can be either a Javascript date object or a string date in a
-valid format (defaults to null). | DateField | | minLength : Number Minimum input field length required (defaults to 0) | TextField | | minLengthText : StringError text to display if the minimum length
+valid format (defaults to null). | DateField | | minLength : Number Minimum 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 | | minText : StringThe error text to display when the date in the cell is before minValue (defaults to
+validation fails (defaults to 'The minimum length for this field is {minLength}') | TextField | | minText : StringThe error text to display when the date in the cell is before minValue (defaults to
'The date in this field must be a... The error text to display when the date in the cell is before minValue (defaults to
- 'The date in this field must be after {minValue}'). | DateField | | minValue : Date/StringThe minimum allowed date. Can be either a Javascript date object or a string date in a
+'The date in this field must be after {minValue}'). | DateField | | minValue : Date/StringThe minimum allowed date. Can be either a Javascript date object or a string date in a
valid format (defaults to null... The minimum allowed date. Can be either a Javascript date object or a string date in a
valid format (defaults to null). | DateField | | msgFx : String Experimental The effect used when displaying a validation message under the field
-(defaults to 'normal'). | Field | | msgTarget : StringThe location where error text should display. Should be one of the following values
-(defaults to 'qtip'):
-
-Value ... The location where error text should display. Should be one of the following values
-(defaults to 'qtip'):
-
-Value Description
------------ ----------------------------------------------------------------------
-qtip Display a quick tip when the user hovers over the field
-title Display a default browser title attribute popup
-under Add a block div beneath the field containing the error text
-side Add an error icon to the right of the field with a popup on hover
-[element id] Add the error text directly to the innerHTML of the specified element
- | Field | | name : StringThe field's HTML name attribute (defaults to '').
+(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.
+
+title Display the message in a default browser title attribute popup.
+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 '').
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 | | pageX : Number The page level x coordinate for this component if contained within a positioning container. | BoxComponent | | pageY : Number The page level y coordinate for this component if contained within a positioning container. | BoxComponent | | plugins : Object/ArrayAn object or array of objects that will provide custom functionality for this component. The only
+useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. | Component | | pageX : Number The page level x coordinate for this component if contained within a positioning container. | BoxComponent | | pageY : Number The page level y coordinate for this component if contained within a positioning container. | BoxComponent | | plugins : Object/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 : Boolean | 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
@@ -375,17 +417,12 @@ 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 | | readOnly : Booleantrue to mark the field as readOnly in HTML
-(defaults to false).
-Note: this only sets the element's readOnly DOM attri... true to mark the field as readOnly in HTML
-(defaults to false).
- Note: this only sets the element's readOnly DOM attribute.
-Setting readOnly=true , for example, will not disable triggering a
-ComboBox or DateField; it gives you the option of forcing the user to choose
-via the trigger without typing in the text box. To hide the trigger use
-hideTrigger . | Field | | 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.
+take advantage of lazy instantiation and rendering. | Component | | 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
+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.
For example, to put a reference to a Toolbar Button into the Panel which owns the Toolbar: var myGrid = new Ext.grid.EditorGridPanel({
title: 'My EditorGridPanel',
@@ -404,18 +441,19 @@ 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 : RegExpA JavaScript RegExp object to be tested against the field value during validation
+ 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 .
+ Also see the added and removed events. | 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 :
@@ -427,20 +465,20 @@ to render and manage its child items.
See render also. | Component | | selectOnFocus : Boolean true to automatically select any existing field text when the field
-receives input focus (defaults to false) | TextField | | showToday : Booleanfalse to hide the footer area of the DatePicker containing the Today button and disable
+receives input focus (defaults to false) | TextField | | showToday : Booleanfalse to hide the footer area of the DatePicker containing the Today button and disable
the keyboard handler for spac... false to hide the footer area of the DatePicker containing the Today button and disable
-the keyboard handler for spacebar that selects the current date (defaults to true). | DateField | | stateEvents : ArrayAn array of events that, when fired, should trigger this component to
+the keyboard handler for spacebar that selects the current date (defaults to true). | DateField | | startDay : Number Day index at which the week should begin, 0-based (defaults to 0, which is Sunday) | DateField | | 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
@@ -477,7 +515,7 @@ more behaviour.
You can perform extra processing on state save and restore by attaching
handlers to the beforestaterestore, staterestore,
beforestatesave and statesave events. | Component | | stripCharsRe : RegExp A 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({
@@ -500,26 +538,36 @@ Ext.Element.ap...
A custom style specification to be appl
}
})
]
-}); | Component | | tabIndex : NumberThe tabIndex for this field. Note this only applies to fields that are rendered,
+}); | Component | | submitValue : Boolean False to clear the name attribute on the field so that it is not submitted during a form post.
+Defaults to true. | Field | | 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 | | triggerClass : StringAn additional CSS class used to style the trigger button. The trigger will always get the
+must be called in order for the tips to render. | BoxComponent | | tpl : MixedAn Ext.Template, Ext.XTemplate
+or an array of strings to form an Ext.XTemplate.
+Used in conjunction with the data and... | Component | | 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 | | 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-date-trigger' which displays a calendar icon). | DateField | | triggerConfig : MixedA DomHelper config object specifying the structure of the
-trigger element for this Field. (Optional).
-Specify this ... 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:
+(defaults to 'x-form-date-trigger' which displays a calendar icon). | DateField | | 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 | | validateOnBlur : Boolean Whether the field should validate when it loses focus (defaults to true). | Field | | validationDelay : Number The length of time in milliseconds after user input begins until validation
-is initiated (defaults to 250) | Field | | validationEvent : String/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.
@@ -534,13 +582,13 @@ 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 : Mixed A value to initialize this field with (defaults to undefined). | Field | | vtype : String | TextField | | vtypeText : StringA custom error message to display in place of the default message provided
+ | TextField | | value : Mixed A value to initialize this field with (defaults to undefined). | Field | | vtype : String | TextField | | vtypeText : StringA custom error message to display in place of the default message provided
for the vtype currently set for this field... A custom error message to display in place of the default message provided
for the vtype currently set for this field (defaults to ''). Note:
-only applies if vtype is set, else ignored. | 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 : String The class added to the to the wrap of the trigger element. Defaults to
-x-trigger-wrap-focus. | TriggerField | | x : Number The local x (left) coordinate for this component if contained within a positioning container. | BoxComponent | | xtype : StringThe registered xtype to create. This config option is not used when passing
+ Note to express this dimension as a percentage or offset see Ext.Component.anchor. | BoxComponent | | wrapFocusClass : String The class added to the to the wrap of the trigger element. Defaults to
+x-trigger-wrap-focus. | TriggerField | | x : Number The local x (left) coordinate for this component if contained within a positioning container. | BoxComponent | | xtype : 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
@@ -551,7 +599,7 @@ The predefined xtypes are listed Ext.ComponentMgr.registerType in order to be able to
-take advantage of lazy instantiation and rendering. | Component | | y : Number The local y (top) coordinate for this component if contained within a positioning container. | BoxComponent |
Public Properties|
| disabled : Boolean True 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 : Number The local y (top) coordinate for this component if contained within a positioning container. | BoxComponent |
Public Properties|
| disabled : Boolean True 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.
@@ -568,21 +616,28 @@ config for a suggestion, or use a render listener directly: new
single: true // Remove the listener after first invocation
}
});
- See also getEl | Component | | hidden : Boolean True if this component is hidden. Read-only. | Component | | initialConfig : Object This Component's initial configuration specification. Read-only. | Component | | originalValue : mixedThe original value of the field as configured in the value configuration, or
+ See also getEl | Component | | hidden : Boolean True if this component is hidden. Read-only. | Component | | initialConfig : Object This Component's initial configuration specification. Read-only. | Component | | label : Ext.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 | | 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... This Component's owner Container (defaults to undefined, and is set automatically when
this Component is added to a Container). Read-only.
- Note: to access items within the Container see itemId. | Component | | rendered : Boolean True if this component has been rendered. Read-only. | Component |
Public Methods|
| DateField( Object config )
- | DateField | | addClass( string cls )
- :
- Ext.ComponentAdds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. | Component | | addEvents( Object|String o , string Optional. )
- :
+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 : Boolean True 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 |
Public Methods|
| DateField( Object config )
+ | DateField | | addClass( string cls )
+ :
+ Ext.ComponentAdds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. | 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. | Observable | | addListener( String eventName , Function handler , [Object scope ], [Object options ] )
- :
+Usage:this.addEvents('storeloaded', 'storecleared'); Returns: | 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:
@@ -632,77 +687,86 @@ Or a shorthand syntax:
'mouseover' : this.onMouseOver,
'mouseout' : this.onMouseOut,
scope: this
-}); Returns: | Observable | | applyToMarkup( String/HTMLElement el )
- :
- voidApply this component to existing markup that is valid. With this function, no call to render() is required. Apply this component to existing markup that is valid. With this function, no call to render() is required. | Component | | clearInvalid()
- :
- voidClear any invalid styles/messages for this field Clear any invalid styles/messages for this field | Field | | cloneConfig( Object overrides )
- :
+});Returns: | Observable | | applyToMarkup( String/HTMLElement el )
+ :
+ voidApply this component to existing markup that is valid. With this function, no call to render() is required. Apply this component to existing markup that is valid. With this function, no call to render() is required. | Component | | bubble( Function fn , [Object scope ], [Array args ] )
+ :
+ Ext.ComponentBubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of... Bubbles up the component/container heirarchy, calling the specified function with each component. The scope ( this) of
+function call will be the scope provided or the current component. The arguments to the function
+will be the args provided or the current component. If the function returns false at any point,
+the bubble is stopped. | Component | | clearInvalid()
+ :
+ voidClear any invalid styles/messages for this field Clear any invalid styles/messages for this field | Field | | 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. | Component | | 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: | Component | | 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. | Component | | disable()
- :
- Ext.ComponentDisable this component and fire the 'disable' event. Disable this component and fire the 'disable' event. | Component | | enable()
- :
- Ext.ComponentEnable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. | Component | | enableBubble( Object 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");
- }
- }
-});
| Observable | | findParentBy( Function fn )
- :
- Ext.ContainerFind a container above this component at any level by a custom function. If the passed function returns
+should usually not need to be called directly. | Component | | disable()
+ :
+ Ext.ComponentDisable this component and fire the 'disable' event. Disable this component and fire the 'disable' event. | Component | | enable()
+ :
+ Ext.ComponentEnable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. | 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');
+ }
+ }
+});
| Observable | | 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. | Component | | findParentByType( String/Class xtype )
- :
- Ext.ContainerFind a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class | Component | | fireEvent( String eventName , Object... args )
- :
- BooleanFires the specified event with the passed parameters (minus the event name).
+true, the container will be returned. | Component | | findParentByType( String/Ext.Component/Class xtype , [Boolean shallow ] )
+ :
+ Ext.ContainerFind a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class Parameters:xtype : String/Ext.Component/ClassThe xtype to check for this Component. Note that the the component can either be an instance
+or a component class: shallow : 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: | 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... | 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 component delay : Boolean/Number(optional) Delay the focus this number of milliseconds (true for 10 milliseconds) Returns: | Component | | 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. | 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. | Component | | getEl()
- :
- Ext.ElementReturns the Ext.Element which encapsulates this Component.
+by calling enableBubble. | 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 component delay : Boolean/Number(optional) Delay the focus this number of milliseconds (true for 10 milliseconds) Returns: | Component | | getActiveError()
+ :
+ StringGets the active error message for this field. Gets the active error message for this field. | 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. | 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. | 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.
@@ -718,31 +782,38 @@ or use a render listener directly: new Ext.Panel({
},
single: true // Remove the listener after first invocation
}
-});
| Component | | getHeight()
- :
- NumberGets the current height of the component's underlying element. Gets the current height of the component's underlying element. | BoxComponent | | getId()
- :
- StringReturns the id of this component or automatically generates and
+}); | Component | | getErrors( Mixed value )
+ :
+ ArrayRuns all of NumberFields validations and returns an array of any errors. Note that this first
+runs TextField's valida... Runs all of NumberFields validations and returns an array of any errors. Note that this first
+runs TextField's validations, so the returned array is an amalgamation of all field errors.
+The additional validation checks are testing that the date format is valid, that the chosen
+date is within the min and max date constraints set, that the date chosen is not in the disabledDates
+regex and that the day chosed is not one of the disabledDays. | DateField | | getHeight()
+ :
+ NumberGets the current height of the component's underlying element. Gets the current height of the component's underlying element. | 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)
| 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)
| Component | | getItemId()
+ :
+ StringReturns the itemId of this component. If an
+itemId was not assigned through configuration the
id is returned using g... Returns the itemId of this component. If an
itemId was not assigned through configuration the
- id is returned using getId . | Component | | getName()
- :
- StringReturns the name or hiddenName
+ id is returned using getId . | Component | | getName()
+ :
+ StringReturns the name or hiddenName
attribute of the field if available. | 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. | 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. | 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:Returns:Mixed value The field value
| Field | | getResizeEl()
- :
- voidReturns the outermost Element of this Component which defines the Components overall size.
+attribute of the field if available. | 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. | 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. | 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: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
@@ -750,55 +821,55 @@ 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 . | BoxComponent | | getSize()
- :
- ObjectGets the current size of the component's underlying element. Gets the current size of the component's underlying element. | BoxComponent | | getValue()
- :
- DateReturns the current date value of the date field. Returns the current date value of the date field. | DateField | | getWidth()
- :
- NumberGets the current width of the component's underlying element. Gets the current width of the component's underlying element. | 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 . | BoxComponent | | getSize()
+ :
+ ObjectGets the current size of the component's underlying element. Gets the current size of the component's underlying element. | BoxComponent | | getValue()
+ :
+ DateReturns the current date value of the date field. Returns the current date value of the date field. | DateField | | getWidth()
+ :
+ NumberGets the current width of the component's underlying element. Gets the current width of the component's underlying element. | 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'
| Component | | getXTypes()
- :
- StringReturns this Component's xtype hierarchy as a slash-delimited string. For a list of all
+alert(t.getXType()); // alerts 'textfield' | 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'
| Component | | hasListener( String eventName )
- :
- BooleanChecks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event | Observable | | hide()
- :
- Ext.ComponentHide this component. Listen to the 'beforehide' event and return
+alert(t.getXTypes()); // alerts 'component/box/field/textfield' | Component | | hasListener( String eventName )
+ :
+ BooleanChecks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event | 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 . | Component | | isDirty()
- :
- BooleanReturns true if the value of this Field has been changed from its original value.
+the component is configured to be hidden . | 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. | Field | | isValid( Boolean preventMark )
- :
- Boolean | Field | | isValid( Boolean preventMark )
+ :
+ BooleanReturns whether or not the field value is currently valid by
+validating the processed value
of the field. Note: disab... | Field | | isVisible()
- :
- BooleanReturns true if this component is visible. Returns true if this component is visible. | 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. | Field | | isVisible()
+ :
+ BooleanReturns true if this component is visible. Returns true if this component is visible. | Component | | isXType( String/Ext.Component/Class 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
@@ -808,37 +879,62 @@ to participate in determination of inherited xtypes.
var t = new Ext.form.TextField();
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 instance
Parameters:xtype : StringThe xtype to check for this Component shallow : 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: | Component | | markInvalid( [String msg ] )
- :
- voidMark this field as invalid, using msgTarget to determine how to
-display the error and applying invalidClass to the fi... Mark this field as invalid, using msgTarget to determine how to
-display the error and applying invalidClass to the field's element.
- Note: this method does not actually make the field
- invalid. Parameters:msg : String(optional) The validation message (defaults to invalidText) Returns: | Field | | nextSibling()
- :
- Ext.ComponentReturns the next component in the owning container Returns the next component in the owning container | Component | | on( String eventName , Function handler , [Object scope ], [Object options ] )
- :
+var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instance | 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: | 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});
+
+ or:
+myGridPanel.mon(myGridPanel.getSelectionModel(), {
+ selectionchange: handleSelectionChange,
+ buffer: 50
+});
+
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: | 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: | Component | | nextSibling()
+ :
+ Ext.ComponentReturns the next component in the owning container Returns the next component in the owning container | 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 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. Returns: | Observable | | previousSibling()
- :
- Ext.ComponentReturns the previous component in the owning container Returns the previous component in the owning container | Component | | processValue( Mixed value )
- :
- voidThis method should only be overridden if necessary to prepare raw values
+If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration. Returns: | Observable | | previousSibling()
+ :
+ Ext.ComponentReturns the previous component in the owning container Returns the previous component in the owning container | Component | | processValue( Mixed value )
+ :
+ voidThis method should only be overridden if necessary to prepare raw values
for validation (see validate and isValid). ... This method should only be overridden if necessary to prepare raw values
for validation (see validate and isValid). This method
is expected to return the processed value for the field which will
-be used for validation (see validateValue method). | Field | | purgeListeners()
- :
- voidRemoves all listeners for this object Removes all listeners for this object | 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. | 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. | Component | | removeListener( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler. Removes an event handler. | Observable | | render( [Element/HTMLElement/String container ], [String/Number position ] )
- :
- voidRender this Component into the passed HTML element.
+be used for validation (see validateValue method). | Field | | purgeListeners()
+ :
+ voidRemoves all listeners for this object Removes all listeners for this object | 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. | 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. | Component | | removeListener( String eventName , Function handler , [Object scope ] )
+ :
+ voidRemoves an event handler. Removes an event handler. | 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.
@@ -860,55 +956,71 @@ 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: | 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: | 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. | TextField | | resumeEvents()
- :
- voidResume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
+original value was blank. | 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. | Observable | | selectText( [Number start ], [Number end ] )
- :
- voidSelects text in this field Selects text in this field | TextField | | setDisabled( Boolean disabled )
- :
- Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. | Component | | setDisabledDates( Array disabledDates )
- :
+events fired during event suspension will be sent to any listeners now. | Observable | | selectText( [Number start ], [Number end ] )
+ :
+ voidSelects text in this field Selects text in this field | TextField | | setActiveError( String msg , Boolean suppressEvent )
+ :
+ voidSets the current activeError to the given string. Fires the 'invalid' event.
+This does not set up the error icon, onl... Sets the current activeError to the given string. Fires the 'invalid' event.
+This does not set up the error icon, only sets the message and fires the event. To show the error icon,
+use markInvalid instead, which calls this method internally | 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. | BoxComponent | | setDisabled( Boolean disabled )
+ :
+ Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. | Component | | setDisabledDates( Array disabledDates )
+ :
voidReplaces any existing disabled dates with new values and refreshes the DatePicker. Replaces any existing disabled dates with new values and refreshes the DatePicker. Parameters:disabledDates : ArrayAn array of date strings (see the disabledDates config
-for details on supported values) used to disable a pattern of dates. Returns: | DateField | | setDisabledDays( Array disabledDays )
- :
+for details on supported values) used to disable a pattern of dates.Returns: | DateField | | setDisabledDays( Array disabledDays )
+ :
voidReplaces any existing disabled days (by index, 0-6) with new values and refreshes the DatePicker. Replaces any existing disabled days (by index, 0-6) with new values and refreshes the DatePicker. Parameters:disabledDays : ArrayAn array of disabled day indexes. See the disabledDays
-config for details on supported values. Returns: | DateField | | setEditable( Boolean value )
- :
- voidAllow or prevent the user from directly editing the field text. If false is passed,
-the user will only be able to m... Allow or prevent the user from directly editing the field text. If false is passed,
-the user will only be able to modify the field using the trigger. This method
-is the runtime equivalent of setting the 'editable' config option at config time. | 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: Returns:
| DateField | | setEditable( Boolean value )
+ :
+ voidAllow or prevent the user from directly editing the field text. If false is passed,
+the user will only be able to mo... Allow or prevent the user from directly editing the field text. If false is passed,
+the user will only be able to modify the field using the trigger. 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. | 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: | BoxComponent | | setMaxValue( Date value )
- :
- voidReplaces any existing maxValue with the new value and refreshes the DatePicker. Replaces any existing maxValue with the new value and refreshes the DatePicker. | DateField | | setMinValue( Date value )
- :
- voidReplaces any existing minValue with the new value and refreshes the DatePicker. Replaces any existing minValue with the new value and refreshes the DatePicker. | DateField | | setPagePosition( Number x , Number y )
- :
- Ext.BoxComponentSets the page XY position of the component. To set the left and top instead, use setPosition.
+ Returns: | BoxComponent | | setHideTrigger( Boolean hideTrigger )
+ :
+ voidChanges the hidden status of the trigger. Changes the hidden status of the trigger. | TriggerField | | setMaxValue( Date value )
+ :
+ voidReplaces any existing maxValue with the new value and refreshes the DatePicker. Replaces any existing maxValue with the new value and refreshes the DatePicker. | DateField | | setMinValue( Date value )
+ :
+ voidReplaces any existing minValue with the new value and refreshes the DatePicker. Replaces any existing minValue with the new value and refreshes the DatePicker. | DateField | | 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 position y : NumberThe new y position Returns: | 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 position y : NumberThe new y position Returns: | 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 left top : NumberThe new top Returns: | 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: | Field | | setSize( Mixed width , Mixed height )
- :
- Ext.BoxComponentSets the width and height of this BoxComponent. This method fires the resize event. This method can accept
+This method fires the move event. Parameters:left : NumberThe new left top : NumberThe new top Returns: | 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: | Field | | setReadOnly( Boolean value )
+ :
+ voidSetting this to true will supersede settings editable and hideTrigger.
+Setting this to false will defer back to edita... Setting this to true will supersede 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. | 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).
@@ -920,9 +1032,9 @@ 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:
| BoxComponent | | setValue( String/Date date )
- :
- Ext.form.FieldSets the value of the date field. You can pass a date object or any string that can be
+ Returns: | BoxComponent | | setValue( String/Date date )
+ :
+ Ext.form.FieldSets the value of the date field. You can pass a date object or any string that can be
parsed into a valid date, usi... Sets the value of the date field. You can pass a date object or any string that can be
parsed into a valid date, using format as the date format, according
to the same rules as Date.parseDate (the default format used is "m/d/Y").
@@ -938,163 +1050,126 @@ dateField.setValue( '05/04/2006');
//Pass a date string (custom format):
dateField.format = 'Y-m-d';
-dateField.setValue( '2006-05-04'); | DateField | | setVisible( Boolean visible )
- :
- Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. | 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:
| DateField | | setVisible( Boolean visible )
+ :
+ Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. | 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: | BoxComponent | | show()
- :
- Ext.ComponentShow this component. Listen to the 'beforeshow' event and return
+ Returns: | 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. | Component | | suspendEvents( Boolean queueSuspended )
- :
+event after showing the component. | 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: | 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. | BoxComponent | | un( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler (shorthand for removeListener.) | Observable | | 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. | BoxComponent | | validate()
- :
- BooleanValidates the field value Validates the field value | 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
-
- If none of the prior validation steps halts validation, a field's
-configured regex test will be processed.
-The invalid message for this test is configured with
-regexText .
- Parameters:value : MixedThe value to validate Returns: | TextField |
Public Events|
| afterrender :
- ( Ext.Component this )
- Fires after the component rendering is finished.
+after the resumeEvents call instead of discarding all suspended events; Returns: | 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. | BoxComponent | | un( String eventName , Function handler , [Object scope ] )
+ :
+ voidRemoves an event handler (shorthand for removeListener.) | Observable | | unsetActiveError( Boolean suppressEvent )
+ :
+ voidClears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not
+usually n... Clears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not
+usually need to be called manually | 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 update loadScripts : Boolean(optional) Only legitimate when using the html configuration. Defaults to false callback : Function(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading Returns: | 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. | BoxComponent | | validate()
+ :
+ BooleanValidates the field value Validates the field value | 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. | Field |
Public Events|
| added :
+ ( Ext.Component this , Ext.Container ownerCt , number index )
+ Fires when a component is added to an Ext.Container Fires when a component is added to an Ext.Container Listeners will be called with the following arguments: | Component | | afterrender :
+ ( Ext.Component this )
+ Fires after the component rendering is finished.
The afterrender event is fired after this Component has been rendere... Fires after the component rendering is finished.
The afterrender event is fired after this Component has been rendered, been postprocesed
by any afterRender method defined for the Component, and, if stateful, after state
-has been restored. Listeners will be called with the following arguments: | Component | | autosize :
- ( Ext.form.Field this , Number width )
- Fires when the autoSize function is triggered. The field may or
+has been restored. Listeners will be called with the following arguments: | Component | | autosize :
+ ( Ext.form.Field this , Number width )
+ Fires when the autoSize function is triggered. The field may or
may not have actually changed size according to the d... Fires when the autoSize function is triggered. The field may or
may not have actually changed size according to the default logic, but this event provides
-a hook for the developer to apply additional logic at runtime to resize the field if needed. Listeners will be called with the following arguments:this : Ext.form.FieldThis text field width : NumberThe new field width
| TextField | | beforedestroy :
- ( Ext.Component this )
- Fires before the component is destroyed. Return false from an event handler to stop the destroy. Fires before the component is destroyed. Return false from an event handler to stop the destroy. Listeners will be called with the following arguments: | 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 field width : NumberThe new field width
| TextField | | beforedestroy :
+ ( Ext.Component this )
+ Fires before the component is destroyed. Return false from an event handler to stop the destroy. Fires before the component is destroyed. Return false from an event handler to stop the destroy. Listeners will be called with the following arguments: | Component | | beforehide :
+ ( Ext.Component this )
+ Fires before the component is hidden by calling the hide method.
Return false from an event handler to stop the hide. Fires before the component is hidden by calling the hide method.
-Return false from an event handler to stop the hide. Listeners will be called with the following arguments: | Component | | beforerender :
- ( Ext.Component this )
- Fires before the component is rendered. Return false from an
+Return false from an event handler to stop the hide. Listeners will be called with the following arguments: | Component | | beforerender :
+ ( Ext.Component this )
+ Fires before the component is rendered. Return false from an
event handler to stop the render. Fires before the component is rendered. Return false from an
-event handler to stop the render. Listeners will be called with the following arguments: | Component | | beforeshow :
- ( Ext.Component this )
- Fires before the component is shown by calling the show method.
+event handler to stop the render. Listeners will be called with the following arguments: | Component | | beforeshow :
+ ( Ext.Component this )
+ Fires before the component is shown by calling the show method.
Return false from an event handler to stop the show. Fires before the component is shown by calling the show method.
-Return false from an event handler to stop the show. Listeners will be called with the following arguments: | Component | | beforestaterestore :
- ( Ext.Component this , Object state )
+Return false from an event handler to stop the show.Listeners will be called with the following arguments: | Component | | beforestaterestore :
+ ( Ext.Component this , Object state )
Fires before the state of the component is restored. Return false from an event handler to stop the restore. Fires before the state of the component is restored. Return false from an event handler to stop the restore. Listeners will be called with the following arguments: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: | 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 value oldValue : MixedThe original value
| Field | | destroy :
- ( Ext.Component this )
- Fires after the component is destroyed. Fires after the component is destroyed. Listeners will be called with the following arguments: | Component | | disable :
- ( Ext.Component this )
- Fires after the component is disabled. Fires after the component is disabled. Listeners will be called with the following arguments: | Component | | enable :
- ( Ext.Component this )
- Fires after the component is enabled. Fires after the component is enabled. Listeners will be called with the following arguments: | Component | | focus :
- ( Ext.form.Field this )
- Fires when this field receives input focus. Fires when this field receives input focus. Listeners will be called with the following arguments: | Field | | hide :
- ( Ext.Component this )
- Fires after the component is hidden.
+has a null implementation. | Component | | blur :
+ ( Ext.form.Field this )
+ Fires when this field loses input focus. Fires when this field loses input focus. Listeners will be called with the following arguments: | Field | | change :
+ ( Ext.form.Field this , Mixed newValue , Mixed oldValue )
+ Fires just before the field blurs if the field value has changed. Fires just before the field blurs if the field value has changed. Listeners will be called with the following arguments:this : Ext.form.FieldnewValue : MixedThe new value oldValue : MixedThe original value
| Field | | destroy :
+ ( Ext.Component this )
+ Fires after the component is destroyed. Fires after the component is destroyed. Listeners will be called with the following arguments: | Component | | disable :
+ ( Ext.Component this )
+ Fires after the component is disabled. Fires after the component is disabled. Listeners will be called with the following arguments: | Component | | enable :
+ ( Ext.Component this )
+ Fires after the component is enabled. Fires after the component is enabled. Listeners will be called with the following arguments: | Component | | focus :
+ ( Ext.form.Field this )
+ Fires when this field receives input focus. Fires when this field receives input focus. Listeners will be called with the following arguments: | Field | | hide :
+ ( Ext.Component this )
+ Fires after the component is hidden.
Fires after the component is hidden when calling the hide method. Fires after the component is hidden.
-Fires after the component is hidden when calling the hide method. Listeners will be called with the following arguments: | Component | | invalid :
- ( Ext.form.Field this , String msg )
- Fires after the field has been marked as invalid. Fires after the field has been marked as invalid. Listeners will be called with the following arguments: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: | 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 field e : 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 field e : 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 field e : 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 field e : 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 field e : 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 position y : NumberThe new y position
| BoxComponent | | render :
- ( Ext.Component this )
- Fires after the component markup is rendered. Fires after the component markup is rendered. Listeners will be called with the following arguments: | Component | | resize :
- ( Ext.Component this , Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight )
- Fires after the component is resized. Fires after the component is resized. Listeners will be called with the following arguments:this : Ext.ComponentadjWidth : NumberThe box-adjusted width that was set adjHeight : NumberThe box-adjusted height that was set rawWidth : NumberThe width that was originally specified rawHeight : NumberThe height that was originally specified
| BoxComponent | | select :
- ( Ext.form.DateField this , Date date )
- Fires when a date is selected via the date picker. Fires when a date is selected via the date picker. Listeners will be called with the following arguments: | DateField | | show :
- ( Ext.Component this )
- Fires after the component is shown when calling the show method. Fires after the component is shown when calling the show method. Listeners will be called with the following arguments: | Component | | specialkey :
- ( Ext.form.Field this , Ext.EventObject e )
- Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.
+is set to true. Listeners will be called with the following arguments:this : Ext.form.TextFieldThis text field e : 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 position y : NumberThe new y position
| BoxComponent | | removed :
+ ( Ext.Component this , Ext.Container ownerCt )
+ Fires when a component is removed from an Ext.Container Fires when a component is removed from an Ext.Container Listeners will be called with the following arguments: | Component | | render :
+ ( Ext.Component this )
+ Fires after the component markup is rendered. Fires after the component markup is rendered. Listeners will be called with the following arguments: | Component | | resize :
+ ( Ext.Component this , Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight )
+ Fires after the component is resized. Fires after the component is resized. Listeners will be called with the following arguments:this : Ext.ComponentadjWidth : NumberThe box-adjusted width that was set adjHeight : NumberThe box-adjusted height that was set rawWidth : NumberThe width that was originally specified rawHeight : NumberThe height that was originally specified
| BoxComponent | | select :
+ ( Ext.form.DateField this , Date date )
+ Fires when a date is selected via the date picker. Fires when a date is selected via the date picker. Listeners will be called with the following arguments: | DateField | | show :
+ ( Ext.Component this )
+ Fires after the component is shown when calling the show method. Fires after the component is shown when calling the show method. Listeners will be called with the following arguments: | Component | | specialkey :
+ ( Ext.form.Field this , Ext.EventObject e )
+ Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.
To handle other keys see Ext.Pan... Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.
To handle other keys see Ext.Panel.keys or Ext.KeyMap.
You can check Ext.EventObject.getKey to determine which key was pressed.
@@ -1120,15 +1195,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: | 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: | Field |
\ No newline at end of file
|