| allowBlank : BooleanSpecify false to validate that the value's length is > 0 (defaults to
+ 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'). | 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.
@@ -25,10 +25,114 @@ 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
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 | | autoEl : MixedA tag name or DomHelper spec used to create the Element which will
+encapsulate this Component.
+You do not normally ne... A tag name or DomHelper spec used to create the Element which will
+encapsulate this Component.
+ You do not normally need to specify this. For the base classes Ext.Component, Ext.BoxComponent,
+and Ext.Container, this defaults to 'div'. The more complex Ext classes use a more complex
+DOM structure created by their own onRender methods.
+ This is intended to allow the developer to create application-specific utility Components encapsulated by
+different DOM elements. Example usage: {
+ xtype: 'box',
+ autoEl: {
+ tag: 'img',
+ src: 'http://www.example.com/example.jpg'
+ }
+}, {
+ xtype: 'box',
+ autoEl: {
+ tag: 'blockquote',
+ html: 'autoEl is cool!'
+ }
+}, {
+ xtype: 'container',
+ autoEl: 'ul',
+ cls: 'ux-unordered-list',
+ items: {
+ xtype: 'box',
+ autoEl: 'li',
+ html: 'First list item'
+ }
+}
| Component | | autoHeight : BooleanTrue to use height:'auto', false to use fixed height (or allow it to be managed by its parent
+Container's layout mana... True to use height:'auto', false to use fixed height (or allow it to be managed by its parent
+Container's layout manager. Defaults to false.
+ Note: Although many components inherit this config option, not all will
+function as expected with a height of 'auto'. Setting autoHeight:true means that the
+browser will manage height based on the element's contents, and that Ext will not manage it at all.
+ If the browser is managing the height, be aware that resizes performed by the browser in response
+to changes within the structure of the Component cannot be detected. Therefore changes to the height might
+result in elements needing to be synchronized with the new height. Example: var w = new Ext.Window({
+ title: 'Window',
+ width: 600,
+ autoHeight: true,
+ items: {
+ title: 'Collapse Me',
+ height: 400,
+ collapsible: true,
+ border: false,
+ listeners: {
+ beforecollapse: function() {
+ w.el.shadow.hide();
+ },
+ beforeexpand: function() {
+ w.el.shadow.hide();
+ },
+ collapse: function() {
+ w.syncShadow();
+ },
+ expand: function() {
+ w.syncShadow();
+ }
+ }
+ }
+}).show();
| BoxComponent | | autoScroll : Booleantrue to use overflow:'auto' on the components layout element and show scroll bars automatically when
+necessary, false... true to use overflow:'auto' on the components layout element and show scroll bars automatically when
+necessary, false to clip any overflowing content (defaults to false ).
| BoxComponent | | autoShow : BooleanTrue if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
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
+them on render (defaults to false). | Component | | autoWidth : BooleanTrue to use width:'auto', false to use fixed width (or allow it to be managed by its parent
+Container's layout manage... True to use width:'auto', false to use fixed width (or allow it to be managed by its parent
+Container's layout manager. Defaults to false.
+ Note: Although many components inherit this config option, not all will
+function as expected with a width of 'auto'. Setting autoWidth:true means that the
+browser will manage width based on the element's contents, and that Ext will not manage it at all.
+ If the browser is managing the width, be aware that resizes performed by the browser in response
+to changes within the structure of the Component cannot be detected. Therefore changes to the width might
+result in elements needing to be synchronized with the new width. For example, where the target element is: <div id='grid-container' style='margin-left:25%;width:50%'></div>
+A Panel rendered into that target element must listen for browser window resize in order to relay its
+child items when the browser changes its width: var myPanel = new Ext.Panel({
+ renderTo: 'grid-container',
+ monitorResize: true, // relay on browser resize
+ title: 'Panel',
+ height: 400,
+ autoWidth: true,
+ layout: 'hbox',
+ layoutConfig: {
+ align: 'stretch'
+ },
+ defaults: {
+ flex: 1
+ },
+ items: [{
+ title: 'Box 1',
+ }, {
+ title: 'Box 2'
+ }, {
+ title: 'Box 3'
+ }],
+});
| BoxComponent | | blankText : StringThe error text to display if the allowBlank validation
+fails (defaults to 'This field is required') | TextField | | boxMaxHeight : NumberThe maximum value in pixels which this BoxComponent will set its height to.
+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 +140,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,7 +165,8 @@ 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
+ | 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,
@@ -71,14 +190,14 @@ 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 tri... false to prevent the user from typing text directly into the field,
-the field will only respond to a click on the trigger to set the value. (defaults to true) | TriggerField | | emptyClass : StringThe CSS class to apply to an empty field to style the emptyText
+the field will only respond to a click on the trigger to set the value. (defaults to true). | TriggerField | | emptyClass : StringThe CSS class to apply to an empty field to style the emptyText
(defaults to 'x-form-empty-field'). This class is au... The CSS class to apply to an empty field to style the emptyText
(defaults to 'x-form-empty-field'). This class is automatically added and removed as needed
depending on the current field value. | TextField | | emptyText : StringThe default text to place into an empty field (defaults to null).
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,7 +211,13 @@ 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).
Note to express this dimension as a percentage or offset s... The height of this component in pixels (defaults to auto).
@@ -122,7 +247,11 @@ is done while hidden). | True to hide and show the component's container when hide/show is called on the component, false to hide
and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide
button on a window by setting hide:true on the button when adding it to its parent container. | Component | | hideTrigger : Boolean true to hide the trigger element and display only the base
-text field (defaults to false) | TriggerField | | id : StringThe unique id of this component (defaults to an auto-assigned id).
+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).
@@ -133,13 +262,16 @@ 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
-to "text"). The types "file" and "p... The type attribute for input fields -- e.g. radio, text, password, file (defaults
-to "text"). The types "file" and "password" must be used to render those field types currently -- there are
+to 'text'). The types 'file' and 'p... The type attribute for input fields -- e.g. radio, text, password, file (defaults
+to 'text'). The types 'file' and 'password' must be used to render those field types currently -- there are
no separate Ext components for those. Note that if you use inputType:'file', emptyText
-is not supported and should be avoided. | Field | | invalidClass : String The CSS class to use when marking a field invalid (defaults to "x-form-invalid") | Field | | invalidText : 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 : StringAn additional CSS class to apply to the div wrapping the form item
-element of this field. If supplied, itemCls at th... An additional CSS class to apply to the div wrapping the form item
+'{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').
+ An additional CSS class to apply to the div wrapping the form item
element of this field. If supplied, itemCls at the field level will override
the default itemCls supplied at the container level. The value specified for
itemCls will be added to the default class ('x-form-item').
@@ -148,22 +280,22 @@ the default itemCls supplied at the container level. The value s
you to write standard CSS rules that can apply to the field, the label (if specified), or
any other element within the markup for the field.
Note: see the note for fieldLabel.
-Example use: // Apply a style to the field's label:
+Example use:// Apply a style to the field's label:
<style>
.required .x-form-item-label {font-weight:bold;color:red;}
</style>
new Ext.FormPanel({
- height: 100,
- renderTo: Ext.getBody(),
- items: [{
- xtype: 'textfield',
- fieldLabel: 'Name',
- itemCls: 'required' //this label will be styled
- },{
- xtype: 'textfield',
- fieldLabel: 'Favorite Color'
- }]
+ height: 100,
+ renderTo: Ext.getBody(),
+ items: [{
+ xtype: 'textfield',
+ fieldLabel: 'Name',
+ itemCls: 'required' //this label will be styled
+ },{
+ xtype: 'textfield',
+ fieldLabel: 'Favorite Color'
+ }]
});
| 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
@@ -338,21 +470,19 @@ validation fails (defaults to 'The minimum length for this field is {minLeng
'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 "").
-Note: this property must be set if this field is to be automaticall... The field's HTML name attribute (defaults to "").
+(defaults to 'normal'). | Field | | msgTarget : 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
over the Element, and... An optional extra CSS class that will be added to this component's Element when the mouse moves
@@ -362,7 +492,8 @@ requirement for a ... An object or array of objects that
requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.
When a component is created, if any plugins are available, the component will call the init method on each
plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the
-component as needed to provide its functionality. | Component | | ptype : StringThe registered ptype to create. This config option is not used when passing
+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
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
@@ -371,17 +502,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',
@@ -400,9 +526,10 @@ 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
@@ -496,9 +623,23 @@ 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 | | triggerClass : StringAn additional CSS class used to style the trigger button. The trigger will always get the
+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 | | 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
@@ -510,13 +651,23 @@ trigger element for this Field. (Optional).
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
- 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
-(defaults to null). If specified, this function wil... A custom validation function to be called during field validation
+ automatic validation (defaults to 'key... The event that should initiate field validation. Set to false to disable
+ automatic validation (defaults to 'keyup'). | Field | | validator : 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. This function will be passed the current
-field value and expected to return boolean true if the value is valid or a string
-error message if invalid. | TextField | | value : Mixed A value to initialize this field with (defaults to undefined). | Field | | vtype : String | TextField | | vtypeText : StringA custom error message to display in place of the default message provided
+developer to override the default validation process.
+ This function will be passed the following Parameters:
+
+value : Mixed
+The current field value
+
+ This function is to Return:
+ | 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).
@@ -550,18 +701,27 @@ 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.ContainerThe component's owner Ext.Container (defaults to undefined, and is set automatically when
-the component is added to a... The component's owner Ext.Container (defaults to undefined, and is set automatically when
-the component is added to a container). Read-only.
- Note: to access items within the container see itemId. | Component | | rendered : Boolean True if this component has been rendered. Read-only. | Component |
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 object )
- :
- voidUsed to define events on this Observable Used to define events on this Observable | Observable | | addListener( String eventName , Function handler , [Object scope ], [Object options ] )
+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 | | 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 ] )
:
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.
@@ -582,8 +742,8 @@ Using the options argument, it is possible to combine different types of listene
A delayed, one-time listener.
myDataView.on('click', this.onClick, this, {
- single: true,
- delay: 100
+single: true,
+delay: 100
});
Attaching multiple handlers in 1 call
@@ -591,27 +751,27 @@ The method also allows for a single argument to be passed which is a config obje
which specify multiple handlers.
myGridPanel.on({
- 'click' : {
- fn: this.onClick,
- scope: this,
- delay: 100
- },
- 'mouseover' : {
- fn: this.onMouseOver,
- scope: this
- },
- 'mouseout' : {
- fn: this.onMouseOut,
- scope: this
- }
+'click' : {
+ fn: this.onClick,
+ scope: this,
+ delay: 100
+},
+'mouseover' : {
+ fn: this.onMouseOver,
+ scope: this
+},
+'mouseout' : {
+ fn: this.onMouseOut,
+ scope: this
+}
});
Or a shorthand syntax:
myGridPanel.on({
- 'click' : this.onClick,
- 'mouseover' : this.onMouseOver,
- 'mouseout' : this.onMouseOut,
- scope: this
+'click' : this.onClick,
+'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()
@@ -629,9 +789,41 @@ should usually not need to be called directly.Disable 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 )
- :
- voidUsed to enable bubbling of events Used to enable bubbling of events | Observable | | findParentBy( Function fn )
+ 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
@@ -644,7 +836,9 @@ 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 ] )
+ 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()
:
@@ -666,7 +860,14 @@ or use a render listener directly:new Ext.Panel({
},
single: true // Remove the listener after first invocation
}
-});
| Component | | getHeight()
+}); | 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()
:
@@ -690,7 +891,7 @@ attribute of the field if available.Paramete
:
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.
+ Ext.Element Returns the outermost Element of this Component which defines the Components overall size.
Usually this will return t... Returns the outermost Element of this Component which defines the Components overall size.
Usually this will return the same Element as getEl ,
but in some cases, a Component may have some more wrapping Elements around its main
@@ -698,7 +899,7 @@ 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()
+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()
:
@@ -738,7 +939,11 @@ then the original value is updated when the values are loaded by
Ext.form.BasicForm.setValues. | Field | | isValid( Boolean preventMark )
:
- BooleanReturns whether or not the field value is currently valid Returns whether or not the field value is currently valid | Field | | isVisible()
+ 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 ] )
:
@@ -755,16 +960,45 @@ to participate in determination of inherited xtypes.
var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instanceParameters: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. Parameters:msg : String(optional) The validation message (defaults to invalidText) Returns: | Field | | nextSibling()
+ 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 | | purgeListeners()
+ 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 )
:
@@ -809,7 +1043,14 @@ event... | Observable | | selectText( [Number start ], [Number end ] )
:
- voidSelects text in this field Selects text in this field | TextField | | setDisabled( Boolean disabled )
+ 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 )
:
@@ -819,13 +1060,14 @@ for details on supported values) used to disable a pattern of dates.<
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 mo... Allow or prevent the user from directly editing the field text. If false is passed,
-the user will only be able to modify the field using the trigger. This method
-is the runtime equivalent of setting the 'editable' config option at config time. | TriggerField | | setHeight( Number height )
+ voidParameters:value : BooleanTrue to allow the user to directly edit the field text
+Allow or prevent the user from directly editing the field text. If false is passed,
+the user will only be able to modify the field using the trigger. Will also add
+a click event to the text field which will call the trigger. This method
+is the runtime equivalent of setting the 'editable' config option at config time. Returns: | 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 : NumberThe new height to set. This may be one of:
| BoxComponent | | setMaxValue( Date value )
@@ -842,7 +1084,13 @@ This method fires the Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
This method fires the move event.Parameters: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 )
+ 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 )
+ :
+ void | TriggerField | | setSize( Mixed width , Mixed height )
:
Ext.BoxComponentSets the width and height of this BoxComponent. This method fires the resize event. This method can accept
either wid... Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept
@@ -876,10 +1124,10 @@ dateField.setValue( '05/04/2006');
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.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 : NumberThe new width to setThis may be one of:
| BoxComponent | | show()
:
@@ -893,15 +1141,28 @@ after the Force the component's size to recalculate based on the underlying element's current height and width. Force the component's size to recalculate based on the underlying element's current height and width. | BoxComponent | | un( String eventName , Function handler , [Object scope ] )
:
- voidRemoves an event handler (shorthand for removeListener.) | Observable | | updateBox( Object box )
+ 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 value )
+ BooleanValidates the field value Validates the field value | Field | | validateValue( Mixed The )
:
- BooleanValidates a value according to the field's validation rules and marks the field as invalid
-if the validation fails Validates a value according to the field's validation rules and marks the field as invalid
-if the validation fails Parameters:value : MixedThe value to validate Returns: | TextField |
Public Events|
| afterrender :
+ 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.
@@ -968,7 +1229,9 @@ is set to true.
is set to true. Keyup input field event. This event only fires if enableKeyEvents
is set to true. Listeners will be called with the following arguments: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 :
+ 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 )
|
|