X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..c8256059947f3aa8f5b0a9a2acf55e2142bb4742:/docs/output/Ext.form.TimeField.html diff --git a/docs/output/Ext.form.TimeField.html b/docs/output/Ext.form.TimeField.html index 8a8c16f1..6577eca8 100644 --- a/docs/output/Ext.form.TimeField.html +++ b/docs/output/Ext.form.TimeField.html @@ -1,20 +1,20 @@ -
Package: | Ext.form |
Defined In: | TimeField.js |
Class: | TimeField |
Extends: | ComboBox |
xtype: | timefield |
new Ext.form.TimeField({
- minValue: '9:00 AM',
- maxValue: '6:00 PM',
- increment: 30
+Class Ext.form.TimeField
Package: Ext.form Defined In: TimeField.js Class: TimeField Extends: ComboBox
Provides a time input field with a time dropdown and automatic time validation. Example usage:
+new Ext.form.TimeField({
+ minValue: '9:00 AM',
+ maxValue: '6:00 PM',
+ increment: 30
});
Config Options
Config Options Defined By allQuery : StringThe text query to send to the server to return all records for the list
with no filtering (defaults to '') ComboBox allowBlank : BooleanSpecify false to validate that the value's length is > 0 (defaults to
-true) TextField allowDomMove : BooleanWhether the component can move the Dom node when rendering (defaults to true). Component altFormats : StringMultiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined
-forma...Multiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined
-format (defaults to 'g:ia|g:iA|g:i a|g:i A|h:i|g:i|H:i|ga|ha|gA|h a|g a|g A|gi|hi|gia|hia|g|H'). TimeField anchor : StringNote: this config is only used when this Component is rendered
+true) TextField allowDomMove : BooleanWhether the component can move the Dom node when rendering (defaults to true). Component altFormats : StringMultiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined
+format...Multiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined
+format (defaults to 'g:ia|g:iA|g:i a|g:i A|h:i|g:i|H:i|ga|ha|gA|h a|g a|g A|gi|hi|gia|hia|g|H|gi a|hi a|giA|hiA|gi A|hi A'). TimeField anchor : StringNote: this config is only used when this Component is rendered
by a Container which has been configured to use an Anc...Note: this config is only used when this Component is rendered
-by a Container which has been configured to use an AnchorLayout
+by a Container which has been configured to use an AnchorLayout (or subclass thereof).
based layout manager, for example:
- Ext.form.FormPanel
- specifying
layout: 'anchor' // or 'form', or 'absolute'
-See Ext.layout.AnchorLayout.anchor also.
Component applyTo : MixedSpecify the id of the element, a DOM element or an existing Element corresponding to a DIV
+See Ext.layout.AnchorLayout.anchor also.
BoxComponent applyTo : MixedSpecify the id of the element, a DOM element or an existing Element corresponding to a DIV
that is already present in...Specify the id of the element, a DOM element or an existing Element corresponding to a DIV
that is already present in the document that specifies some structural markup for this
component.
@@ -32,10 +32,117 @@ element's parent node will automatically be used as the component's container.
element spec. Used to create the Element which will encapsulate this ...
ComboBox autoShow : BooleanTrue if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
+{tag: "input", type: "text", size: "24", autocomplete: "off"}
ComboBox autoEl : MixedA tag name or DomHelper spec used to create the Element which will
+encapsulate this Component.
+You do not normally ne...A tag name or DomHelper spec used to create the Element which will
+encapsulate this Component.
+You do not normally need to specify this. For the base classes Ext.Component, Ext.BoxComponent,
+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 autoSelect : Booleantrue to select the first result gathered by the data store (defaults
+to true). A false value would require a manual ...true to select the first result gathered by the data store (defaults
+to true). A false value would require a manual selection from the dropdown list to set the components value
+unless the value of (typeAheadDelay) were true. ComboBox autoShow : BooleanTrue if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
them on render...True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
-them on render (defaults to false). Component 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....An array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.
+Defaults to [].
Component clearCls : StringThe CSS class used to to apply to the special clearing div rendered
directly after each form field wrapper to provide...The CSS class used to to apply to the special clearing div rendered
directly after each form field wrapper to provide field clearing (defaults to
'x-form-clear-left').
@@ -43,7 +150,22 @@ directly after each form field wrapper to provide field clearing (defaults to
which has been configured to use the FormLayout layout
manager (e.g. Ext.form.FormPanel or specifying layout:'form') and either a
fieldLabel is specified or isFormField=true is specified.
-See Ext.layout.FormLayout.fieldTpl also.
Component cls : StringA custom CSS class to apply to the field's underlying element (defaults to ""). Field ctCls : StringAn optional extra CSS class that will be added to this component's container. This can be useful for
+See Ext.layout.FormLayout.fieldTpl also.
Component clearFilterOnReset : Booleantrue to clear any filters on the store (when in local mode) when reset is called
+(defaults to true) ComboBox cls : StringA custom CSS class to apply to the field's underlying element (defaults to ''). Field contentEl : StringOptional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
+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.
@@ -54,28 +176,30 @@ 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 : BooleanSpecify 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 : BooleanSpecify 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 : StringCSS class added to the component when it is disabled (defaults to 'x-item-disabled'). Component displayField : StringThe underlying data field name to bind to this
-ComboBox (defaults to undefined if mode = 'remote' or 'text' if
-transf...The underlying data field name to bind to this
-ComboBox (defaults to undefined if mode = 'remote' or 'text' if
-transforming a select a select).
+ComboBox (defaults to undefined if mode = 'remote' or 'field1' if
+tran...The underlying data field name to bind to this
+ComboBox (defaults to undefined if mode = 'remote' or 'field1' if
+transforming a select or if the field name is autogenerated based on
+the store configuration).
See also valueField.
Note: if using a ComboBox in an Editor Grid a
renderer will be needed to show the displayField when the editor is not
active.
ComboBox editable : 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 : Booleantrue to enable the proxying of key events for the HTML input
-field (defaults to false) TextField fieldClass : StringThe default CSS class for the field (defaults to "x-form-field") Field fieldLabel : StringThe label text to display next to this Component (defaults to '').
+field (defaults to false) TextField fieldClass : StringThe default CSS class for the field (defaults to 'x-form-field') Field fieldLabel : StringThe label text to display next to this Component (defaults to '').
Note: this config is only used when this Component...The label text to display next to this Component (defaults to '').
Note: this config is only used when this Component is rendered by a Container which
has been configured to use the FormLayout layout manager (e.g.
@@ -89,11 +213,17 @@ Example use:
new Ext.FormPanel({
xtype: 'textfield',
fieldLabel: 'Name'
}]
-});
Component focusClass : StringThe CSS class to use when the field receives focus (defaults to "x-form-focus") Field forceSelection : Booleantrue to restrict the selected value to one of the values in the list,
+}); Component flex : NumberNote: this config is only used when this Component is rendered
+by a Container which has been configured to use a BoxL...Note: this config is only used when this Component is rendered
+by a Container which has been configured to use a BoxLayout.
+Each child Component with a flex
property will be flexed either vertically (by a VBoxLayout)
+or horizontally (by an HBoxLayout) according to the item's relative flex
value
+compared to the sum of all Components with flex value specified. Any child items that have
+either a flex = 0
or flex = undefined
will not be 'flexed' (the initial size will not be changed).
BoxComponent focusClass : StringThe CSS class to use when the field receives focus (defaults to 'x-form-focus') Field forceSelection : Booleantrue to restrict the selected value to one of the values in the list,
false to allow the user to set arbitrary text i...true to restrict the selected value to one of the values in the list,
-false to allow the user to set arbitrary text into the field (defaults to false) ComboBox format : StringThe default time format string which can be overriden for localization support. The format must be
-valid according ...The default time format string which can be overriden for localization support. The format must be
-valid according to Date.parseDate (defaults to 'g:i A', e.g., '3:15 PM'). For 24-hour time
+false to allow the user to set arbitrary text into the field (defaults to false) ComboBox format : StringThe default time format string which can be overriden for localization support. The format must be
+valid according t...The default time format string which can be overriden for localization support. The format must be
+valid according to Date.parseDate (defaults to 'g:i A', e.g., '3:15 PM'). For 24-hour time
format try 'H:i' instead. TimeField handleHeight : NumberThe height in pixels of the dropdown list resize handle if
resizable = true (defaults to 8) ComboBox height : NumberThe height of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset s...The height of this component in pixels (defaults to auto).
@@ -137,7 +267,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 : Booleantrue 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).
@@ -148,12 +282,15 @@ sub-elements using this component's id as the parent.
Note: to avoid complications imposed by a unique id also see
itemId
and ref
.
Note: to access the container of an item see ownerCt
.
Component increment : NumberThe number of minutes between each time value in the list (defaults to 15). TimeField inputType : StringThe type attribute for input fields -- e.g. radio, text, password, file (defaults
-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 : StringThe CSS class to use when marking a field invalid (defaults to "x-form-invalid") Field invalidText : StringThe error text to display when the time in the field is invalid (defaults to
-'{value} is not a valid time'). TimeField itemCls : 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
+is not supported and should be avoided.
Field invalidClass : StringThe CSS class to use when marking a field invalid (defaults to 'x-form-invalid') Field invalidText : StringThe error text to display when the time in the field is invalid (defaults to
+'{value} is not a valid time'). TimeField itemCls : StringNote: this config is only used when this Component is rendered by a Container which
+has been configured to use the Fo...Note: this config is only used when this Component is rendered by a Container which
+has been configured to use the FormLayout layout manager (e.g.
+Ext.form.FormPanel or specifying layout:'form').
+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').
@@ -162,22 +299,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
@@ -261,9 +398,11 @@ Example use:
new Ext.FormPanel({
(defaults to true)
ComboBox lazyRender : Booleantrue to prevent the ComboBox from rendering until requested
(should always be used when rendering into an Ext.Editor ...true to prevent the ComboBox from rendering until requested
(should always be used when rendering into an Ext.Editor (e.g. Grids),
-defaults to false). ComboBox listAlign : StringA valid anchor position value. See Ext.Element.alignTo for details
-on supported anchor positions (defaults to 'tl-bl?...A valid anchor position value. See Ext.Element.alignTo for details
-on supported anchor positions (defaults to 'tl-bl?') ComboBox listClass : StringThe CSS class to add to the predefined 'x-combo-list' class
+defaults to false). ComboBox listAlign : String/ArrayA valid anchor position value. See Ext.Element.alignTo for details
+on supported anchor positions and offsets. To spec...A valid anchor position value. See Ext.Element.alignTo for details
+on supported anchor positions and offsets. To specify x/y offsets as well, this value
+may be specified as an Array of Ext.Element.alignTo method arguments.
+[ 'tl-bl?', [6,0] ]
(defaults to 'tl-bl?') ComboBox listClass : StringThe CSS class to add to the predefined 'x-combo-list' class
applied the dropdown list element (defaults to ''). ComboBox listEmptyText : StringThe empty text to display in the data view if no items are found.
(defaults to '') ComboBox listWidth : NumberThe width (used as a parameter to Ext.Element.setWidth) of the dropdown
list (defaults to the width of the ComboBox f...The width (used as a parameter to Ext.Element.setWidth) of the dropdown
@@ -360,11 +499,11 @@ any attributes you want to a field, for example:var myField =
autoCreate: {tag: 'input', type: 'text', size: '20', autocomplete: 'off', maxlength: '10'}
});
TextField maxLengthText : StringError text to display if the maximum length
validation fails (defaults to 'The maximum length for this field is {maxL...Error text to display if the maximum length
-validation fails (defaults to 'The maximum length for this field is {maxLength}') TextField maxText : StringThe error text to display when the time is after maxValue (defaults to
-'The time in this field must be equal to or b...The error text to display when the time is after maxValue (defaults to
-'The time in this field must be equal to or before {0}'). TimeField maxValue : Date/StringThe maximum allowed time. Can be either a Javascript date object with a valid time value or a string
-time in a vali...The maximum allowed time. Can be either a Javascript date object with a valid time value or a string
-time in a valid format -- see format and altFormats (defaults to null). TimeField minChars : NumberThe minimum number of characters the user must type before autocomplete and
+validation fails (defaults to 'The maximum length for this field is {maxLength}') TextField maxText : StringThe error text to display when the time is after maxValue (defaults to
+'The time in this field must be equal to or be...The error text to display when the time is after maxValue (defaults to
+'The time in this field must be equal to or before {0}'). TimeField maxValue : Date/StringThe maximum allowed time. Can be either a Javascript date object with a valid time value or a string
+time in a valid ...The maximum allowed time. Can be either a Javascript date object with a valid time value or a string
+time in a valid format -- see format and altFormats (defaults to undefined). TimeField minChars : NumberThe minimum number of characters the user must type before autocomplete and
typeAhead activate (defaults to 4 if mode...The minimum number of characters the user must type before autocomplete and
typeAhead activate (defaults to 4 if mode = 'remote' or 0 if
mode = 'local', does not apply if
@@ -373,11 +512,11 @@ distance to the viewport edges ...The minimum height in
distance to the viewport edges (defaults to 90) ComboBox minLength : NumberMinimum input field length required (defaults to 0) TextField minLengthText : StringError text to display if the minimum length
validation fails (defaults to 'The minimum length for this field is {minL...Error text to display if the minimum length
validation fails (defaults to 'The minimum length for this field is {minLength}') TextField minListWidth : NumberThe minimum width of the dropdown list in pixels (defaults to 70, will
-be ignored if listWidth has a higher value) ComboBox minText : StringThe error text to display when the date in the cell is before minValue (defaults to
-'The time in this field must be ...The error text to display when the date in the cell is before minValue (defaults to
-'The time in this field must be equal to or after {0}'). TimeField minValue : Date/StringThe minimum allowed time. Can be either a Javascript date object with a valid time value or a string
-time in a vali...The minimum allowed time. Can be either a Javascript date object with a valid time value or a string
-time in a valid format -- see format and altFormats (defaults to null). TimeField mode : StringAcceptable values are:
+be ignored if listWidth has a higher value) ComboBox minText : StringThe error text to display when the date in the cell is before minValue (defaults to
+'The time in this field must be e...The error text to display when the date in the cell is before minValue (defaults to
+'The time in this field must be equal to or after {0}'). TimeField minValue : Date/StringThe minimum allowed time. Can be either a Javascript date object with a valid time value or a string
+time in a valid ...The minimum allowed time. Can be either a Javascript date object with a valid time value or a string
+time in a valid format -- see format and altFormats (defaults to undefined). TimeField mode : StringAcceptable values are:
<div class="mdetail-params">
'remote' : Default
<p class="sub-desc">Automatically loads the st...Acceptable values are:
@@ -405,21 +544,19 @@ clicked, set to 'local' and manually load the store. To force a requer
triggerAction: 'all'
});
ComboBox msgFx : StringExperimental The effect used when displaying a validation message under the field
-(defaults to 'normal'). Field msgTarget : 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.
+Ext.QuickTips.init must have been called for this setting to work.
+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
@@ -433,7 +570,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 : Booleantrue to disable marking the field invalid.
+Defaults to false. Field ptype : StringThe registered ptype to create. This config option is not used when passing
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
@@ -446,17 +584,12 @@ take advantage of lazy instantiation and rendering. The length of time in milliseconds to delay between the start of typing and
sending the query to filter the dropdown list (defaults to 500 if mode = 'remote'
or 10 if mode = 'local') ComboBox queryParam : StringName of the query (baseParam name for the store)
-as it will be passed on the querystring (defaults to 'query') ComboBox 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.
+as it will be passed on the querystring (defaults to 'query') ComboBox readOnly : Booleantrue to prevent the user from changing the field, and
+hides the trigger. Superceeds the editable and hideTrigger opt...true to prevent the user from changing the field, and
+hides the trigger. Superceeds the editable and hideTrigger options if the value is true.
+(defaults to false) TriggerField ref : StringA path specification, relative to the Component's ownerCt
+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',
@@ -475,9 +608,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
.
+ 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
@@ -560,14 +694,15 @@ Acceptable values for this property are:
Acceptable values for this property are:
- any Store subclass
-- an Array : Arrays will be converted to a Ext.data.ArrayStore internally.
+
- an Array : Arrays will be converted to a Ext.data.ArrayStore internally,
+automatically generating field names to work with all data components.
- 1-dimensional array : (e.g., ['Foo','Bar'])
+A 1-dimensional array will automatically be expanded (each array item will be used for both the combo
+valueField and displayField)
- 2-dimensional array : (e.g., [['f','Foo'],['b','Bar']])
For a multi-dimensional array, the value in index 0 of each item will be assumed to be the combo
-value, while the value at index 1 is assumed to be the combo text.
+valueField, while the value at index 1 is assumed to be the combo displayField.
See also mode.
ComboBox stripCharsRe : RegExpA JavaScript RegExp object used to strip unwanted content from the value
before validation (defaults to null). TextField style : StringA custom style specification to be applied to this component's Element. Should be a valid argument to
@@ -593,9 +728,16 @@ 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 : BooleanFalse to clear the name attribute on the field so that it is not submitted during a form post.
+If a hiddenName is spe...False to clear the name attribute on the field so that it is not submitted during a form post.
+If a hiddenName is specified, setting this to true will cause both the hidden field and the element to be submitted.
+Defaults to undefined. ComboBox tabIndex : NumberThe tabIndex for this field. Note this only applies to fields that are rendered,
not those which are built via applyT...The tabIndex for this field. Note this only applies to fields that are rendered,
-not those which are built via applyTo (defaults to undefined). Field title : StringIf supplied, a header element is created containing this text and added into the top of
+not those which are built via applyTo (defaults to undefined). Field tabTip : StringNote: this config is only used when this BoxComponent is a child item of a TabPanel.
+A string to be used as innerHTML...Note: this config is only used when this BoxComponent is a child item of a TabPanel.
+A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over
+the associated tab selector element. Ext.QuickTips.init()
+must be called in order for the tips to render. BoxComponent title : StringIf supplied, a header element is created containing this text and added into the top of
the dropdown list (defaults t...If supplied, a header element is created containing this text and added into the top of
the dropdown list (defaults to undefined, with no header element) ComboBox tpl : String/Ext.XTemplateThe template string, or Ext.XTemplate instance to
use to display each item in the dropdown list. The dropdown list is...The template string, or Ext.XTemplate instance to
@@ -609,7 +751,11 @@ names from the Combo's itemSelector for additional details.
ComboBox transform : MixedThe id, DOM node or element of an existing HTML SELECT to convert to a ComboBox.
+Also see itemSelector for additional details.
ComboBox tplWriteMode : StringThe Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.X...The Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.XTemplate.overwrite
). Component transform : MixedThe id, DOM node or element of an existing HTML SELECT to convert to a ComboBox.
Note that if you specify this and th...The id, DOM node or element of an existing HTML SELECT to convert to a ComboBox.
Note that if you specify this and the combo is going to be in an Ext.form.BasicForm or
Ext.form.FormPanel, you must also set lazyRender = true. ComboBox triggerAction : StringThe action to execute when the trigger is clicked.
@@ -639,17 +785,28 @@ to false) The length of time in milliseconds to wait until the typeahead text is displayed
if typeAhead = true (defaults to 250) ComboBox validateOnBlur : BooleanWhether the field should validate when it loses focus (defaults to true). Field validationDelay : NumberThe length of time in milliseconds after user input begins until validation
is initiated (defaults to 250) Field validationEvent : String/BooleanThe event that should initiate field validation. Set to false to disable
- 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 : MixedA value to initialize this field with (defaults to undefined). Field valueField : StringThe underlying data value name to bind to this
-ComboBox (defaults to undefined if mode = 'remote' or 'value' if
-trans...The underlying data value name to bind to this
-ComboBox (defaults to undefined if mode = 'remote' or 'value' if
-transforming a select).
+developer to override the default validation process.
+
This function will be passed the following Parameters:
+
+value
: Mixed
+The current field value
+
+
This function is to Return:
+
+true
: Boolean
+true
if the value is valid
+msg
: String
+An error message if the value is invalid
+
TextField value : MixedA value to initialize this field with (defaults to undefined). Field valueField : StringThe underlying data value name to bind to this
+ComboBox (defaults to undefined if mode = 'remote' or 'field2' if
+tran...The underlying data value name to bind to this
+ComboBox (defaults to undefined if mode = 'remote' or 'field2' if
+transforming a select or if the field name is autogenerated based on
+the store configuration).
Note: use of a valueField requires the user to make a selection in order for a value to be
mapped. See also hiddenName, hiddenValue, and displayField.
ComboBox valueNotFoundText : StringWhen using a name/value combo, if the value passed to setValue is not found in
the store, valueNotFoundText will be d...When using a name/value combo, if the value passed to setValue is not found in
@@ -688,7 +845,22 @@ config for a suggestion, or use a render listener directly:new
single: true // Remove the listener after first invocation
}
});
-See also getEl
Component hidden : BooleanTrue if this component is hidden. Read-only. Component initialConfig : ObjectThis Component's initial configuration specification. Read-only. Component lastQuery : StringThe value of the match string used to filter the store. Delete this property to force a requery.
+See also getEl
Component hidden : BooleanTrue if this component is hidden. Read-only. Component initialConfig : ObjectThis Component's initial configuration specification. Read-only. Component keyNav : Ext.KeyNav
+<p>A {@link Ext.KeyNav KeyNav} object which handles navigation keys for this ComboBox. This performs actions
+based on keystrokes typed when the input field is focused.</p>
+<p><b>After the ComboBox has been rendered</b>, you may override existing navigation key functionality,
+or add your own based upon key names as specified in the {@link Ext.KeyNav KeyNav} class.</p>
+<p>The function is executed in the scope (<code>this</code> reference of the ComboBox. Example:</p><pre><code>
+myCombo.keyNav.esc = function(e) { // Override ESC handling function
+ this.collapse(); // Standard behaviour of Ext's ComboBox.
+ this.setValue(this.startValue); // We reset to starting value on ESC
+};
+myCombo.keyNav.tab = function() { // Override TAB handling function
+ this.onViewClick(false); // Select the currently highlighted row
+};
+</code></pre> ComboBox label : Ext.ElementThe label Element associated with this Field. Only available after this Field has been rendered by a
+Ext.layout.FormL...The label Element associated with this Field. Only available after this Field has been rendered by a
+Ext.layout.FormLayout layout manager.
Field lastQuery : StringThe value of the match string used to filter the store. Delete this property to force a requery.
Example use:
var com...The value of the match string used to filter the store. Delete this property to force a requery.
Example use:
@@ -714,15 +886,22 @@ configure the combo with lastQuery=''. Example use:
}); ComboBox originalValue : mixedThe original value of the field as configured in the value configuration, or
as loaded by the last form load operatio...The original value of the field as configured in the value configuration, or
as loaded by the last form load operation if the form's trackResetOnLoad
-setting is true
. Field ownerCt : Ext.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 : BooleanTrue if this component has been rendered. Read-only. Component view : Ext.DataViewThe DataView used to display the ComboBox's options. ComboBox
Public Methods
Method Defined By TimeField( Object config
)
- Create a new TimeFieldCreate a new TimeFieldParameters:config
: Object
Returns:- void
xtype: timefield
TimeField addClass( string cls
)
- :
- Ext.ComponentAdds a CSS class to the component's underlying element.Adds a CSS class to the component's underlying element.Parameters:cls
: stringThe CSS class name to add
Returns:Ext.Component
this
Component addEvents( Object object
)
- :
- voidUsed to define events on this ObservableUsed to define events on this ObservableParameters:object
: ObjectThe object with the events defined
Returns:- void
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... Component refOwner : Ext.ContainerThe ancestor Container into which the ref reference was inserted if this Component
+is a child of a Container, and has...The ancestor Container into which the ref reference was inserted if this Component
+is a child of a Container, and has been configured with a ref
. Component rendered : BooleanTrue if this component has been rendered. Read-only. Component startValue : mixedThe value that the Field had at the time it was last focused. This is the value that is passed
+to the change event wh...The value that the Field had at the time it was last focused. This is the value that is passed
+to the change event which is fired if the value has been changed when the Field is blurred.
+This will be undefined until the Field has been visited. Compare originalValue.
Field view : Ext.DataViewThe DataView used to display the ComboBox's options. ComboBox
Public Methods
Method Defined By TimeField( Object config
)
+ Create a new TimeFieldCreate a new TimeFieldParameters:config
: Object
Returns:- void
TimeField addClass( string cls
)
+ :
+ Ext.ComponentAdds a CSS class to the component's underlying element.Adds a CSS class to the component's underlying element.Parameters:cls
: stringThe CSS class name to add
Returns:Ext.Component
this
Component addEvents( Object|String o
, string Optional.
)
+ :
+ voidAdds the specified events to the list of events which this Observable may fire.Adds the specified events to the list of events which this Observable may fire.Parameters:o
: Object|StringEither an object with event names as properties with a value of true
+or the first event name string if multiple event names are being passed as separate parameters.Optional.
: stringEvent name if multiple event names are being passed as separate parameters.
+Usage:this.addEvents('storeloaded', 'storecleared');
Returns:- void
Observable addListener( String eventName
, Function handler
, [Object scope
], [Object options
] )
:
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.
@@ -743,8 +922,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
@@ -752,27 +931,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:- void
Observable applyToMarkup( String/HTMLElement el
)
:
voidApply this component to existing markup that is valid. With this function, no call to render() is required.Apply this component to existing markup that is valid. With this function, no call to render() is required.Parameters:el
: String/HTMLElement
Returns:- void
Component clearInvalid()
@@ -800,9 +979,41 @@ query allowing the query action to be canceled if needed.minChars config option. It
also clears any filter previously saved in the current store (defaults to false)Returns:- void
ComboBox enable()
:
- Ext.ComponentEnable this component and fire the 'enable' event.Enable this component and fire the 'enable' event.Parameters:- None.
Returns:Ext.Component
this
Component enableBubble( Object events
)
- :
- voidUsed to enable bubbling of eventsUsed to enable bubbling of eventsParameters:events
: Object
Returns:- void
Observable expand()
+ Ext.ComponentEnable this component and fire the 'enable' event.Enable this component and fire the 'enable' event.Parameters:- None.
Returns:Ext.Component
this
Component enableBubble( String/Array events
)
+ :
+ voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present....Enables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget()
if present. There is no implementation in the Observable base class.
+This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
+implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
+access the required target more quickly.
+Example:
Ext.override(Ext.form.Field, {
+ // Add functionality to Field's initComponent to enable the change event to bubble
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
+ this.enableBubble('change');
+ }),
+
+ // We know that we want Field's events to bubble directly to the FormPanel.
+ getBubbleTarget : function() {
+ if (!this.formPanel) {
+ this.formPanel = this.findParentByType('form');
+ }
+ return this.formPanel;
+ }
+});
+
+var myForm = new Ext.formPanel({
+ title: 'User Details',
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: function() {
+ // Title goes red if form has been modified.
+ myForm.header.setStyle('color', 'red');
+ }
+ }
+});
Parameters:events
: String/ArrayThe event name to bubble, or an Array of event names.
Returns:- void
Observable expand()
:
voidExpands the dropdown list if it is currently hidden. Fires the expand event on completion.Expands the dropdown list if it is currently hidden. Fires the expand event on completion.Parameters:- None.
Returns:- void
ComboBox findParentBy( Function fn
)
:
@@ -817,7 +1028,9 @@ An event may be set to bubble up an Obse...Fires the
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)
by calling enableBubble.
Parameters:eventName
: StringThe name of the event to fire.args
: Object...Variable number of parameters are passed to handlers.
Returns:Boolean
returns false if any of the handlers return false otherwise it returns true.
Observable focus( [Boolean selectText
], [Boolean/Number delay
] )
:
- Ext.ComponentTry to focus this component.Try to focus this component.Parameters:selectText
: Boolean(optional) If applicable, true to also select the text in this componentdelay
: Boolean/Number(optional) Delay the focus this number of milliseconds (true for 10 milliseconds)
Returns:Ext.Component
this
Component 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 componentdelay
: Boolean/Number(optional) Delay the focus this number of milliseconds (true for 10 milliseconds)
Returns:Ext.Component
this
Component getActiveError()
+ :
+ StringGets the active error message for this field.Gets the active error message for this field.Parameters:- None.
Returns:String
Returns the active error message on the field, if there is no error, an empty string is returned.
Field getBox( [Boolean local
] )
:
ObjectGets the current box measurements of the component's underlying element.Gets the current box measurements of the component's underlying element.Parameters:local
: Boolean(optional) If true the element's left and top are returned instead of page XY (defaults to false)
Returns:Object
box An object in the format {x, y, width, height}
BoxComponent getBubbleTarget()
:
@@ -839,7 +1052,63 @@ or use a render listener directly:new Ext.Panel({
},
single: true // Remove the listener after first invocation
}
-});
Parameters:- None.
Returns:Ext.Element
The Element which encapsulates this Component.
Component getHeight()
+});Parameters:- None.
Returns:Ext.Element
The Element which encapsulates this Component.
Component getErrors( Mixed value
)
+ :
+ ArrayValidates a value according to the field's validation rules and returns an array of errors
+for any failing validation...Validates a value according to the field's validation rules and returns an array of errors
+for any failing validations. Validation rules are processed in the following order:
+
+- 1. Field specific validator
+
+
A validator offers a way to customize and reuse a validation specification.
+If a field is configured with a validator
+function, it will be passed the current field value. The validator
+function is expected to return either:
+
+- Boolean true if the value is valid (validation continues).
+- a String to represent the invalid message if invalid (validation halts).
+
+
+- 2. Basic Validation
+
+
If the validator
has not halted validation,
+basic validation proceeds as follows:
+
+allowBlank
: (Invalid message =
+emptyText
)
+Depending on the configuration of allowBlank
, a
+blank field will cause validation to halt at this step and return
+Boolean true or false accordingly.
+
+minLength
: (Invalid message =
+minLengthText
)
+If the passed value does not satisfy the minLength
+specified, validation halts.
+
+maxLength
: (Invalid message =
+maxLengthText
)
+If the passed value does not satisfy the maxLength
+specified, validation halts.
+
+
+
+- 3. Preconfigured Validation Types (VTypes)
+
+
If none of the prior validation steps halts validation, a field
+configured with a vtype
will utilize the
+corresponding VTypes validation function.
+If invalid, either the field's vtypeText
or
+the VTypes vtype Text property will be used for the invalid message.
+Keystrokes on the field will be filtered according to the VTypes
+vtype Mask property.
+
+- 4. Field specific regex test
+
Parameters:value
: MixedThe value to validate. The processed raw value will be used if nothing is passed
Returns:Array
Array of any validation errors
TextField getHeight()
:
NumberGets the current height of the component's underlying element.Gets the current height of the component's underlying element.Parameters:- None.
Returns:Number
BoxComponent getId()
:
@@ -899,7 +1168,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:- None.
Returns:Mixed
value The field value
Field getResizeEl()
:
- voidReturns the outermost Element of this Component which defines the Components overall size.
+ 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
@@ -907,7 +1176,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
.
Parameters:- None.
Returns:- void
BoxComponent getSize()
+This Element is returned as the resizeEl
.Parameters:- None.
Returns:Ext.Element
The Element which is to be resized by size managing layouts.
BoxComponent getSize()
:
ObjectGets the current size of the component's underlying element.Gets the current size of the component's underlying element.Parameters:- None.
Returns:Object
An object containing the element's size {width: (element width), height: (element height)}
BoxComponent getStore()
:
@@ -951,7 +1220,11 @@ is not disabled), false otherwise. Returns true if the dropdown list is expanded, else false.Returns true if the dropdown list is expanded, else false.Parameters:- None.
Returns:- void
ComboBox isValid( Boolean preventMark
)
:
- BooleanReturns whether or not the field value is currently validReturns whether or not the field value is currently validParameters:preventMark
: BooleanTrue to disable marking the field invalid
Returns:Boolean
True if the value is valid, else false
Field isVisible()
+ BooleanReturns whether or not the field value is currently valid by
+validating the processed value
+of the field. Note: disab...Returns whether or not the field value is currently valid by
+validating the processed value
+of the field. Note: disabled fields are ignored.Parameters:preventMark
: BooleanTrue to disable marking the field invalid
Returns:Boolean
True if the value is valid, else false
Field isVisible()
:
BooleanReturns true if this component is visible.Returns true if this component is visible.Parameters:- None.
Returns:Boolean
True if this component is visible, false otherwise.
Component isXType( String xtype
, [Boolean shallow
] )
:
@@ -968,16 +1241,50 @@ 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 Componentshallow
: Boolean(optional) False to check whether this Component is descended from the xtype (this is
the default), or true to check whether this Component is directly of the specified xtype.
Returns:Boolean
True if this component descends from the specified xtype, false otherwise.
Component markInvalid( [String msg
] )
:
- 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:- void
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:- void
Field mon( Observable|Element item
, Object|String ename
, Function fn
, Object scope
, Object opt
)
+ :
+ voidAdds listeners to any Observable object (or Elements) which are automatically removed when this Component
+is destroye...Adds listeners to any Observable object (or Elements) which are automatically removed when this Component
+is destroyed. Usage:
+myGridPanel.mon(myGridPanel.getSelectionModel(), 'selectionchange', handleSelectionChange, null, {buffer: 50});
+
+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:- void
Component mun( Observable|Element item
, Object|String ename
, Function fn
, Object scope
)
+ :
+ voidRemoves listeners that were added by the mon method.Removes listeners that were added by the mon method.Parameters:item
: Observable|ElementThe item from which to remove a listener/listeners.ename
: Object|StringThe event name, or an object containing event name properties.fn
: FunctionOptional. If the ename
parameter was an event name, this
+is the handler function.scope
: ObjectOptional. If the ename
parameter was an event name, this
+is the scope (this
reference) in which the handler function is executed.
Returns:- void
Component nextSibling()
:
Ext.ComponentReturns the next component in the owning containerReturns the next component in the owning containerParameters:- None.
Returns:Ext.Component
Component on( String eventName
, Function handler
, [Object scope
], [Object options
] )
:
voidAppends an event handler to this object (shorthand for addListener.)Appends an event handler to this object (shorthand for addListener.)Parameters:eventName
: StringThe type of event to listen forhandler
: FunctionThe method the event invokesscope
: Object(optional) The scope (this
reference) in which the handler function is executed.
-If omitted, defaults to the object which fired the event.options
: Object(optional) An object containing handler configuration.
Returns:- void
Observable previousSibling()
+If omitted, defaults to the object which fired the event.options
: Object(optional) An object containing handler configuration. Returns:- void
Observable onTriggerClick( EventObject e
)
+ :
+ voidThe function that should handle the trigger's click event. This method does nothing by default
+until overridden by a...The function that should handle the trigger's click event. This method does nothing by default
+until overridden by an implementing function. See Ext.form.ComboBox and Ext.form.DateField for
+sample implementations.Parameters:e
: EventObject
Returns:- void
TriggerField previousSibling()
:
- Ext.ComponentReturns the previous component in the owning containerReturns the previous component in the owning containerParameters:- None.
Returns:Ext.Component
Component purgeListeners()
+ Ext.ComponentReturns the previous component in the owning containerReturns the previous component in the owning containerParameters:- None.
Returns:Ext.Component
Component processValue( Mixed value
)
+ :
+ voidThis method should only be overridden if necessary to prepare raw values
+for validation (see validate and isValid). ... Field purgeListeners()
:
voidRemoves all listeners for this objectRemoves all listeners for this objectParameters:- None.
Returns:- void
Observable relayEvents( Object o
, Array events
)
:
@@ -1031,20 +1338,32 @@ The sto...Select an item in the dropdown list by its dat
The store must be loaded and the list expanded for this function to work, otherwise use setValue.Parameters:value
: StringThe data value of the item to selectscrollIntoView
: BooleanFalse to prevent the dropdown list from autoscrolling to display the
selected item if it is not currently in view (defaults to true)
Returns:Boolean
True if the value matched an item in the list, else false
ComboBox selectText( [Number start
], [Number end
] )
:
- voidSelects text in this fieldSelects text in this fieldParameters:start
: Number(optional) The index where the selection should start (defaults to 0)end
: Number(optional) The index where the selection should end (defaults to the text length)
Returns:- void
TextField setDisabled( Boolean disabled
)
+ voidSelects text in this fieldSelects text in this fieldParameters:start
: Number(optional) The index where the selection should start (defaults to 0)end
: Number(optional) The index where the selection should end (defaults to the text length)
Returns:- void
TextField setActiveError( String msg
, Boolean suppressEvent
)
+ :
+ voidSets the current activeError to the given string. Fires the 'invalid' event.
+This does not set up the error icon, onl...Sets the current activeError to the given string. Fires the 'invalid' event.
+This does not set up the error icon, only sets the message and fires the event. To show the error icon,
+use markInvalid instead, which calls this method internallyParameters:msg
: StringThe error messagesuppressEvent
: BooleanTrue to suppress the 'invalid' event from being fired
Returns:- void
Field setAutoScroll( Boolean scroll
)
+ :
+ Ext.BoxComponentSets the overflow on the content element of the component.Sets the overflow on the content element of the component.Parameters:scroll
: BooleanTrue to allow the Component to auto scroll.
Returns:Ext.BoxComponent
this
BoxComponent setDisabled( Boolean disabled
)
:
Ext.ComponentConvenience function for setting disabled/enabled by boolean.Convenience function for setting disabled/enabled by boolean.Parameters:disabled
: Boolean
Returns:Ext.Component
this
Component setEditable( Boolean value
)
:
- voidAllow or prevent the user from directly editing the field text. If false is passed,
-the user will only be able to mo...Allow or prevent the user from directly editing the field text. If false is passed,
-the user will only be able to modify the field using the trigger. This method
-is the runtime equivalent of setting the 'editable' config option at config time.Parameters:value
: BooleanTrue to allow the user to directly edit the field text
Returns:- void
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:- void
TriggerField setHeight( Mixed height
)
:
- Ext.BoxComponentSets the height of the component. This method fires the resize event.Sets the height of the component. This method fires the resize event.Parameters:height
: NumberThe new height to set. This may be one of:
-- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
+ Ext.BoxComponentSets the height of the component. This method fires the resize event.Sets the height of the component. This method fires the resize event.Parameters:height
: MixedThe new height to set. This may be one of:
+- A Number specifying the new height in the Element's defaultUnits (by default, pixels).
- A String used to set the CSS height style.
- undefined to leave the height unchanged.
-
Returns:Ext.BoxComponent
this
BoxComponent setPagePosition( Number x
, Number y
)
+Returns:Ext.BoxComponent
this
BoxComponent setMaxValue( Date/String value
)
+ :
+ voidReplaces any existing maxValue with the new time and refreshes the store.Replaces any existing maxValue with the new time and refreshes the store.Parameters:value
: Date/StringThe maximum time that can be selected
Returns:- void
TimeField setMinValue( Date/String value
)
+ :
+ voidReplaces any existing minValue with the new time and refreshes the store.Replaces any existing minValue with the new time and refreshes the store.Parameters:value
: Date/StringThe minimum time that can be selected
Returns:- void
TimeField setPagePosition( Number x
, Number y
)
:
Ext.BoxComponentSets the page XY position of the component. To set the left and top instead, use setPosition.
This method fires the ...Sets the page XY position of the component. To set the left and top instead, use setPosition.
@@ -1054,7 +1373,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 lefttop
: NumberThe new top
Returns:Ext.BoxComponent
this
BoxComponent setRawValue( Mixed value
)
:
- MixedSets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue.Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue.Parameters:value
: MixedThe value to set
Returns:Mixed
value The field value that is set
Field 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:Mixed
value The field value that is set
Field setReadOnly( Boolean value
)
+ :
+ voidParameters:value
: BooleanTrue to prevent the user changing the field and explicitly
+hide the trigger.
+Setting this to true will superceed settings editable and hideTrigger.
+Setting this to false will defer back to editable and hideTrigger. This method
+is the runtime equivalent of setting the 'readOnly' config option at config time.
Returns:- void
TriggerField setSize( Mixed width
, Mixed height
)
:
Ext.BoxComponentSets the width and height of this BoxComponent. This method fires the resize event. This method can accept
either wid...Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept
@@ -1076,10 +1401,10 @@ will be displayed in the field. If the value does not match the data value of a
and the valueNotFoundText config option is defined, it will be displayed as the default field text.
Otherwise the field will be blank (although the value will still be set).Parameters:value
: StringThe value to match
Returns:Ext.form.Field
this
ComboBox setVisible( Boolean visible
)
:
- Ext.ComponentConvenience function to hide or show this component by boolean.Convenience function to hide or show this component by boolean.Parameters:visible
: BooleanTrue to show, false to hide
Returns:Ext.Component
this
Component setWidth( Number width
)
+ Ext.ComponentConvenience function to hide or show this component by boolean.Convenience function to hide or show this component by boolean.Parameters:visible
: BooleanTrue to show, false to hide
Returns:Ext.Component
this
Component setWidth( Mixed width
)
:
- Ext.BoxComponentSets the width of the component. This method fires the resize event.Sets the width of the component. This method fires the resize event.Parameters:width
: NumberThe new width to setThis may be one of:
-- A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
+ Ext.BoxComponentSets the width of the component. This method fires the resize event.Sets the width of the component. This method fires the resize event.Parameters:width
: MixedThe new width to set. This may be one of:
+- A Number specifying the new width in the Element's defaultUnits (by default, pixels).
- A String used to set the CSS width style.
Returns:Ext.BoxComponent
this
BoxComponent show()
:
@@ -1093,15 +1418,28 @@ after the Force the component's size to recalculate based on the underlying element's current height and width.Force the component's size to recalculate based on the underlying element's current height and width.Parameters:- None.
Returns:Ext.BoxComponent
this
BoxComponent un( String eventName
, Function handler
, [Object scope
] )
:
- voidRemoves an event handler (shorthand for removeListener.)Removes an event handler (shorthand for removeListener.)Parameters:eventName
: StringThe type of event the handler was associated with.handler
: FunctionThe handler to remove. This must be a reference to the function passed into the addListener call.scope
: Object(optional) The scope originally specified for the handler.
Returns:- void
Observable updateBox( Object box
)
+ voidRemoves an event handler (shorthand for removeListener.)Removes an event handler (shorthand for removeListener.)Parameters:eventName
: StringThe type of event the handler was associated with.handler
: FunctionThe handler to remove. This must be a reference to the function passed into the addListener call.scope
: Object(optional) The scope originally specified for the handler.
Returns:- void
Observable unsetActiveError( Boolean suppressEvent
)
+ :
+ voidClears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not
+usually n...Clears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not
+usually need to be called manuallyParameters:suppressEvent
: BooleanTrue to suppress the 'invalid' event from being fired
Returns:- void
Field update( Mixed htmlOrData
, [Boolean loadScripts
], [Function callback
] )
+ :
+ voidUpdate the content area of a component.Update the content area of a component.Parameters:htmlOrData
: MixedIf this component has been configured with a template via the tpl config
+then it will use this argument as data to populate the template.
+If this component was not configured with a template, the components
+content area will be updated via Ext.Element updateloadScripts
: Boolean(optional) Only legitimate when using the html configuration. Defaults to falsecallback
: Function(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading
Returns:- void
Component updateBox( Object box
)
:
Ext.BoxComponentSets the current box measurements of the component's underlying element.Sets the current box measurements of the component's underlying element.Parameters:box
: ObjectAn object in the format {x, y, width, height}
Returns:Ext.BoxComponent
this
BoxComponent validate()
:
- BooleanValidates the field valueValidates the field valueParameters:- None.
Returns:Boolean
True if the value is valid, else false
Field validateValue( Mixed value
)
+ BooleanValidates the field valueValidates the field valueParameters:- None.
Returns:Boolean
True if the value is valid, else false
Field validateValue( Mixed The
)
:
- BooleanValidates a value according to the field's validation rules and marks the field as invalid
-if the validation failsValidates a value according to the field's validation rules and marks the field as invalid
-if the validation failsParameters:value
: MixedThe value to validate
Returns:Boolean
True if the value is valid, else false
TextField
Public Events
Event Defined By 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.Parameters:The
: Mixedcurrent value of the field
Returns:Boolean
True if all validations passed, false if one or more failed
Field
Public Events
Event Defined By added :
+ ( Ext.Component this
, Ext.Container ownerCt
, number index
)
+ Fires when a component is added to an Ext.ContainerFires when a component is added to an Ext.ContainerListeners will be called with the following arguments:this
: Ext.ComponentownerCt
: Ext.ContainerContainer which holds the componentindex
: numberPosition at which the component was added
Component afterrender :
( Ext.Component this
)
Fires after the component rendering is finished.
The afterrender event is fired after this Component has been rendere...Fires after the component rendering is finished.
@@ -1183,7 +1521,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 fielde
: Ext.EventObject
TextField move :
( Ext.Component this
, Number x
, Number y
)
- Fires after the component is moved.Fires after the component is moved.Listeners will be called with the following arguments:this
: Ext.Componentx
: NumberThe new x positiony
: NumberThe new y position
BoxComponent 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 positiony
: NumberThe new y position
BoxComponent removed :
+ ( Ext.Component this
, Ext.Container ownerCt
)
+ Fires when a component is removed from an Ext.ContainerFires when a component is removed from an Ext.ContainerListeners will be called with the following arguments:this
: Ext.ComponentownerCt
: Ext.ContainerContainer which holds the component
Component render :
( Ext.Component this
)
Fires after the component markup is rendered.Fires after the component markup is rendered.Listeners will be called with the following arguments:this
: Ext.Component
Component resize :
( Ext.Component this
, Number adjWidth
, Number adjHeight
, Number rawWidth
, Number rawHeight
)