X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..2e847cf21b8ab9d15fa167b315ca5b2fa92638fc:/docs/output/Ext.form.TimeField.html diff --git a/docs/output/Ext.form.TimeField.html b/docs/output/Ext.form.TimeField.html index 8a8c16f1..d4f5e565 100644 --- a/docs/output/Ext.form.TimeField.html +++ b/docs/output/Ext.form.TimeField.html @@ -1,4 +1,4 @@ -
Properties Methods Events Config Options Direct Link 
Observable
  Component
    BoxComponent
      Field
        TextField
          TriggerField
            ComboBox
              TimeField

Class Ext.form.TimeField

Package:Ext.form
Defined In:TimeField.js
Class:TimeField
Extends:ComboBox
xtype:timefield
Provides a time input field with a time dropdown and automatic time validation. Example usage: +
Observable
  Component
    BoxComponent
      Field
        TextField
          TriggerField
            ComboBox
              TimeField

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',
@@ -7,14 +7,14 @@
 with no filtering (defaults to '')
ComboBox allowBlank : Boolean
Specify false to validate that the value's length is > 0 (defaults to true)
TextField allowDomMove : Boolean
Whether the component can move the Dom node when rendering (defaults to true).
Component altFormats : String
Multiple 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 : String
Note: this config is only used when this Component is rendered +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 : String
Note: this config is only used when this Component is rendered by a Container which has been configured to use an Anc...

Note: this config is only used when this Component is rendered -by a Container which has been configured to use an AnchorLayout +by a Container which has been configured to use an AnchorLayout (or subclass thereof). based layout manager, for example:

-

See Ext.layout.AnchorLayout.anchor also.

Component applyTo : Mixed
Specify the id of the element, a DOM element or an existing Element corresponding to a DIV +

See Ext.layout.AnchorLayout.anchor also.

BoxComponent applyTo : Mixed
Specify the id of the element, a DOM element or an existing Element corresponding to a DIV that is already present in...

Specify the id of the element, a DOM element or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component.

    @@ -32,10 +32,114 @@ element's parent node will automatically be used as the component's container.

    A DomHelper element spec, or true for a default element spec. Used to create the Element which will encapsulate this Component. See autoEl for details. Defaults to:

    -
    {tag: "input", type: "text", size: "24", autocomplete: "off"}
ComboBox autoShow : Boolean
True 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 : Mixed
A tag name or DomHelper spec used to create the Element which will +encapsulate this Component. +You do not normally ne...

A tag name or DomHelper spec used to create the Element which will +encapsulate this Component.

+

You do not normally need to specify this. For the base classes Ext.Component, Ext.BoxComponent, +and Ext.Container, this defaults to 'div'. The more complex Ext classes use a more complex +DOM structure created by their own onRender methods.

+

This is intended to allow the developer to create application-specific utility Components encapsulated by +different DOM elements. Example usage:

{
+    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 : Boolean
True to use height:'auto', false to use fixed height (or allow it to be managed by its parent +Container's layout mana...

True to use height:'auto', false to use fixed height (or allow it to be managed by its parent +Container's layout manager. Defaults to false.

+

Note: Although many components inherit this config option, not all will +function as expected with a height of 'auto'. Setting autoHeight:true means that the +browser will manage height based on the element's contents, and that Ext will not manage it at all.

+

If the browser is managing the height, be aware that resizes performed by the browser in response +to changes within the structure of the Component cannot be detected. Therefore changes to the height might +result in elements needing to be synchronized with the new height. Example:

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 : Boolean
true to use overflow:'auto' on the components layout element and show scroll bars automatically when +necessary, false...
true to use overflow:'auto' on the components layout element and show scroll bars automatically when +necessary, false to clip any overflowing content (defaults to false).
BoxComponent autoSelect : Boolean
true to select the first result gathered by the data store (defaults +to true). A false value would require a manual ...
true to select the first result gathered by the data store (defaults +to true). A false value would require a manual selection from the dropdown list to set the components value +unless the value of (typeAheadDelay) were true.
ComboBox autoShow : Boolean
True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render...
True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove -them on render (defaults to false).
Component blankText : String
The error text to display if the allowBlank validation -fails (defaults to 'This field is required')
TextField clearCls : String
The CSS class used to to apply to the special clearing div rendered +them on render (defaults to false).
Component autoWidth : Boolean
True to use width:'auto', false to use fixed width (or allow it to be managed by its parent +Container's layout manage...

True to use width:'auto', false to use fixed width (or allow it to be managed by its parent +Container's layout manager. Defaults to false.

+

Note: Although many components inherit this config option, not all will +function as expected with a width of 'auto'. Setting autoWidth:true means that the +browser will manage width based on the element's contents, and that Ext will not manage it at all.

+

If the browser is managing the width, be aware that resizes performed by the browser in response +to changes within the structure of the Component cannot be detected. Therefore changes to the width might +result in elements needing to be synchronized with the new width. For example, where the target element is:

<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 : String
The error text to display if the allowBlank validation +fails (defaults to 'This field is required')
TextField boxMaxHeight : Number
The maximum value in pixels which this BoxComponent will set its height to. +Warning: This will override any size mana...

The maximum value in pixels which this BoxComponent will set its height to.

+

Warning: This will override any size management applied by layout managers.

BoxComponent boxMaxWidth : Number
The maximum value in pixels which this BoxComponent will set its width to. +Warning: This will override any size manag...

The maximum value in pixels which this BoxComponent will set its width to.

+

Warning: This will override any size management applied by layout managers.

BoxComponent boxMinHeight : Number
The minimum value in pixels which this BoxComponent will set its height to. +Warning: This will override any size mana...

The minimum value in pixels which this BoxComponent will set its height to.

+

Warning: This will override any size management applied by layout managers.

BoxComponent boxMinWidth : Number
The minimum value in pixels which this BoxComponent will set its width to. +Warning: This will override any size manag...

The minimum value in pixels which this BoxComponent will set its width to.

+

Warning: This will override any size management applied by layout managers.

BoxComponent clearCls : String
The CSS class used to to apply to the special clearing div rendered 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 +147,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 : String
A custom CSS class to apply to the field's underlying element (defaults to "").
Field ctCls : String
An 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 : Boolean
true to clear any filters on the store (when in local mode) when reset is called +(defaults to true)
ComboBox cls : String
A custom CSS class to apply to the field's underlying element (defaults to '').
Field contentEl : String
Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content +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 : String
An optional extra CSS class that will be added to this component's container. This can be useful for adding customize...

An optional extra CSS class that will be added to this component's container. This can be useful for adding customized styles to the container or any of its children using standard CSS rules. See Ext.layout.ContainerLayout.extraCls also.

@@ -54,28 +173,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 : Boolean
Specify true to disable input keystroke filtering (defaults +

Component data : Mixed
The initial set of data to apply to the tpl to +update the content area of the Component.
Component disableKeyFilter : Boolean
Specify true to disable input keystroke filtering (defaults to false)
TextField disabled : Boolean
True to disable the field (defaults to false). Be aware that conformant with the <a href="http://www.w3.org/TR/html40...
True to disable the field (defaults to false).

Be aware that conformant with the HTML specification, disabled Fields will not be submitted.

Field disabledClass : String
CSS class added to the component when it is disabled (defaults to 'x-item-disabled').
Component displayField : String
The underlying data field name to bind to this -ComboBox (defaults to undefined if mode = 'remote' or '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 : Boolean
false to prevent the user from typing text directly into the field, the field will only respond to a click on the tri...
false to prevent the user from typing text directly into the field, -the field will only respond to a click on the trigger to set the value. (defaults to true)
TriggerField emptyClass : String
The CSS class to apply to an empty field to style the emptyText +the field will only respond to a click on the trigger to set the value. (defaults to true).
TriggerField emptyClass : String
The CSS class to apply to an empty field to style the emptyText (defaults to 'x-form-empty-field'). This class is au...
The CSS class to apply to an empty field to style the emptyText (defaults to 'x-form-empty-field'). This class is automatically added and removed as needed depending on the current field value.
TextField emptyText : String
The default text to place into an empty field (defaults to null). Note: that this value will be submitted to the serv...
The default text to place into an empty field (defaults to null). Note: that this value will be submitted to the server if this field is enabled and configured with a name.
TextField enableKeyEvents : Boolean
true to enable the proxying of key events for the HTML input -field (defaults to false)
TextField fieldClass : String
The default CSS class for the field (defaults to "x-form-field")
Field fieldLabel : String
The label text to display next to this Component (defaults to ''). +field (defaults to false)
TextField fieldClass : String
The default CSS class for the field (defaults to 'x-form-field')
Field fieldLabel : String
The label text to display next to this Component (defaults to ''). Note: this config is only used when this Component...

The label text to display next to this Component (defaults to '').


Note: this config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager (e.g. @@ -89,7 +210,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 forceSelection : Boolean
true to restrict the selected value to one of the values in the list, +});
Component flex : Number
Note: this config is only used when this Component is rendered +by a Container which has been configured to use a BoxL...

Note: this config is only used when this Component is rendered +by a Container which has been configured to use a BoxLayout. +Each child Component with a 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 forceSelection : Boolean
true to restrict the selected value to one of the values in the list, false to allow the user to set arbitrary text i...
true to restrict the selected value to one of the values in the list, false to allow the user to set arbitrary text into the field (defaults to false)
ComboBox format : String
The 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 @@ -137,7 +264,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 : String
The unique id of this component (defaults to an auto-assigned id). +text field (defaults to false)
TriggerField html : String/Object
An HTML fragment, or a DomHelper specification to use as the layout element +content (defaults to ''). The HTML conten...
An HTML fragment, or a DomHelper specification to use as the layout element +content (defaults to ''). The HTML content is added after the component is rendered, +so the document will not contain this HTML at the time the render event is fired. +This content is inserted into the body before any configured contentEl is appended.
Component id : String
The unique id of this component (defaults to an auto-assigned id). 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 +279,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 : Number
The number of minutes between each time value in the list (defaults to 15).
TimeField inputType : String
The type attribute for input fields -- e.g. radio, text, password, file (defaults -to "text"). The types "file" and "p...
The type attribute for input fields -- e.g. radio, text, password, file (defaults -to "text"). The types "file" and "password" must be used to render those field types currently -- there are +to 'text'). The types 'file' and 'p...
The type attribute for input fields -- e.g. radio, text, password, file (defaults +to 'text'). The types 'file' and 'password' must be used to render those field types currently -- there are no separate Ext components for those. Note that if you use inputType:'file', emptyText -is not supported and should be avoided.
Field invalidClass : String
The CSS class to use when marking a field invalid (defaults to "x-form-invalid")
Field invalidText : String
The error text to display when the time in the field is invalid (defaults to -'{value} is not a valid time').
TimeField itemCls : String
An 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 : String
The CSS class to use when marking a field invalid (defaults to 'x-form-invalid')
Field invalidText : String
The error text to display when the time in the field is invalid (defaults to +'{value} is not a valid time').
TimeField itemCls : String
Note: this config is only used when this Component is rendered by a Container which +has been configured to use the Fo...

Note: this config is only used when this Component is rendered by a Container which +has been configured to use the FormLayout layout manager (e.g. +Ext.form.FormPanel or specifying layout:'form').


+

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 +296,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 : String
An itemId can be used as an alternative way to get a reference to a component when no object reference is available. ...

An itemId can be used as an alternative way to get a reference to a component when no object reference is available. Instead of using an id with @@ -261,9 +395,11 @@ Example use:

new Ext.FormPanel({
 (defaults to true)
ComboBox lazyRender : Boolean
true to prevent the ComboBox from rendering until requested (should always be used when rendering into an Ext.Editor ...
true to prevent the ComboBox from rendering until requested (should always be used when rendering into an Ext.Editor (e.g. Grids), -defaults to false).
ComboBox listAlign : String
A valid anchor position value. See Ext.Element.alignTo for details -on supported anchor positions (defaults to 'tl-bl?...
A valid anchor position value. See Ext.Element.alignTo for details -on supported anchor positions (defaults to 'tl-bl?')
ComboBox listClass : String
The CSS class to add to the predefined 'x-combo-list' class +defaults to false).
ComboBox listAlign : String/Array
A valid anchor position value. See Ext.Element.alignTo for details +on supported anchor positions and offsets. To spec...
A valid anchor position value. See Ext.Element.alignTo for details +on supported anchor positions and offsets. To specify x/y offsets as well, this value +may be specified as an Array of Ext.Element.alignTo method arguments.

+
[ 'tl-bl?', [6,0] ]
(defaults to 'tl-bl?')
ComboBox listClass : String
The CSS class to add to the predefined 'x-combo-list' class applied the dropdown list element (defaults to '').
ComboBox listEmptyText : String
The empty text to display in the data view if no items are found. (defaults to '')
ComboBox listWidth : Number
The width (used as a parameter to Ext.Element.setWidth) of the dropdown list (defaults to the width of the ComboBox f...
The width (used as a parameter to Ext.Element.setWidth) of the dropdown @@ -364,7 +500,7 @@ validation fails (defaults to 'The maximum length for this field is {maxLeng '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/String
The 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 : Number
The minimum number of characters the user must type before autocomplete and +time in a valid format -- see format and altFormats (defaults to undefined).
TimeField minChars : Number
The 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 @@ -377,7 +513,7 @@ be ignored if 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/String
The 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 : String
Acceptable values are: +time in a valid format -- see format and altFormats (defaults to undefined).
TimeField mode : String
Acceptable values are: <div class="mdetail-params"> 'remote' : Default <p class="sub-desc">Automatically loads the st...
Acceptable values are: @@ -405,21 +541,19 @@ clicked, set to 'local' and manually load the store. To force a requer triggerAction: 'all' });
ComboBox msgFx : String
Experimental The effect used when displaying a validation message under the field -(defaults to 'normal').
Field msgTarget : String
The 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 : String
The field's HTML name attribute (defaults to ""). -Note: this property must be set if this field is to be automaticall...
The field's HTML name attribute (defaults to ""). +(defaults to 'normal').
Field msgTarget<p>The : String
location where the message text set through markInvalid should display. +Must be one of the following values: +<div cla...
location where the message text set through markInvalid should display. +Must be one of the following values:

+
    +
  • 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 : String
The field's HTML name attribute (defaults to ''). +Note: this property must be set if this field is to be automaticall...
The field's HTML name attribute (defaults to ''). Note: this property must be set if this field is to be automatically included with form submit().
Field overCls : String
An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and...
An optional extra CSS class that will be added to this component's Element when the mouse moves @@ -433,7 +567,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 : String
The registered ptype to create. This config option is not used when passing +component as needed to provide its functionality.
Component preventMark : Boolean
true to disable marking the field invalid. +Defaults to false.
Field ptype : String
The registered ptype to create. This config option is not used when passing 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 +581,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 : String
Name of the query (baseParam name for the store) -as it will be passed on the querystring (defaults to 'query')
ComboBox readOnly : Boolean
true to 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 : String
A path specification, relative to the Component's ownerCt specifying into which -ancestor Container to place a named r...

A path specification, relative to the Component's 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 : Boolean
true to prevent the user from changing the field, and +hides the trigger. Superceeds the editable and hideTrigger opt...
true to prevent the user from changing the field, and +hides the trigger. Superceeds the editable and hideTrigger options if the value is true. +(defaults to false)
TriggerField ref : String
A path specification, relative to the Component's ownerCt +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 +605,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 : RegExp
A 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 : RegExp
A JavaScript RegExp object to be tested against the field value during validation (defaults to null). If the test fai...
A JavaScript RegExp object to be tested against the field value during validation (defaults to null). If the test fails, the field will be marked invalid using regexText.
TextField regexText : String
The error text to display if regex is used and the @@ -560,14 +691,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 the combo -value and text)
      • +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 : RegExp
A JavaScript RegExp object used to strip unwanted content from the value before validation (defaults to null).
TextField style : String
A custom style specification to be applied to this component's Element. Should be a valid argument to @@ -593,9 +725,16 @@ Ext.Element.ap...
A custom style specification to be appl } }) ] -});
Component tabIndex : Number
The 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. +If a hiddenName is spe...
False to clear the name attribute on the field so that it is not submitted during a form post. +If a hiddenName is specified, setting this to true will cause both the hidden field and the element to be submitted. +Defaults to undefined.
ComboBox tabIndex : Number
The tabIndex for this field. Note this only applies to fields that are rendered, 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 : String
If 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 : String
Note: this config is only used when this BoxComponent is a child item of a TabPanel. +A string to be used as innerHTML...

Note: this config is only used when this BoxComponent is a child item of a TabPanel.

+A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over +the associated tab selector element. Ext.QuickTips.init() +must be called in order for the tips to render.
BoxComponent title : String
If supplied, a header element is created containing this text and added into the top of the dropdown list (defaults t...
If supplied, a header element is created containing this text and added into the top of the dropdown list (defaults to undefined, with no header element)
ComboBox tpl : String/Ext.XTemplate
The template string, or Ext.XTemplate instance to use to display each item in the dropdown list. The dropdown list is...

The template string, or Ext.XTemplate instance to @@ -609,7 +748,11 @@ names from the Combo's itemSelector for additional details.

ComboBox transform : Mixed
The id, DOM node or element of an existing HTML SELECT to convert to a ComboBox. +

Also see itemSelector for additional details.

ComboBox tplWriteMode : String
The Ext.(X)Template method to use when +updating the content area of the Component. Defaults to 'overwrite' +(see Ext.X...
The Ext.(X)Template method to use when +updating the content area of the Component. Defaults to 'overwrite' +(see Ext.XTemplate.overwrite).
Component transform : Mixed
The id, DOM node or element of an existing HTML SELECT to convert to a ComboBox. Note that if you specify this and th...
The id, DOM node or element of an existing HTML SELECT to convert to a ComboBox. Note that if you specify this and the combo is going to be in an Ext.form.BasicForm or Ext.form.FormPanel, you must also set lazyRender = true.
ComboBox triggerAction : String
The action to execute when the trigger is clicked. @@ -639,17 +782,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 : Boolean
Whether the field should validate when it loses focus (defaults to true).
Field validationDelay : Number
The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)
Field validationEvent : String/Boolean
The event that should initiate field validation. Set to false to disable - automatic validation (defaults to "key...
The event that should initiate field validation. Set to false to disable - automatic validation (defaults to "keyup").
Field validator : Function
A custom validation function to be called during field validation -(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 : Function
A custom validation function to be called during field validation (validateValue) +(defaults to null). If specified, t...

A custom validation function to be called during field validation (validateValue) (defaults to null). If specified, this function will be called first, allowing the -developer to override the default validation process. 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 valueField : String
The 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 : Mixed
A value to initialize this field with (defaults to undefined).
Field valueField : String
The underlying data value name to bind to this +ComboBox (defaults to undefined if mode = 'remote' or 'field2' if +tran...
The underlying data value name to bind to this +ComboBox (defaults to undefined if mode = 'remote' or 'field2' if +transforming a select or if the field name is autogenerated based on +the store configuration).

Note: use of a valueField requires the user to make a selection in order for a value to be mapped. See also hiddenName, hiddenValue, and displayField.

ComboBox valueNotFoundText : String
When using a name/value combo, if the value passed to setValue is not found in the store, valueNotFoundText will be d...
When using a name/value combo, if the value passed to setValue is not found in @@ -688,7 +842,9 @@ 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 lastQuery : String
The value of the match string used to filter the store. Delete this property to force a requery. +

See also getEl

Component hidden : Boolean
True if this component is hidden. Read-only.
Component initialConfig : Object
This Component's initial configuration specification. Read-only.
Component label : Ext.Element
The label Element associated with this Field. Only available after this Field has been rendered by a +Ext.layout.FormL...

The label Element associated with this Field. Only available after this Field has been rendered by a +Ext.layout.FormLayout layout manager.

Field lastQuery : String
The value of the match string used to filter the store. Delete this property to force a requery. Example use: var com...
The value of the match string used to filter the store. Delete this property to force a requery. Example use: @@ -714,15 +870,22 @@ configure the combo with lastQuery=''. Example use: });
ComboBox originalValue : mixed
The original value of the field as configured in the value configuration, or as loaded by the last form load operatio...
The original value of the field as configured in the value configuration, or as loaded by the last form load operation if the form's trackResetOnLoad -setting is true.
Field ownerCt : Ext.Container
The 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 view : Ext.DataView
The DataView used to display the ComboBox's options.
ComboBox

Public Methods

MethodDefined By
 rendered : Boolean
True if this component has been rendered. Read-only.
Component
 view : Ext.DataView
The DataView used to display the ComboBox's options.
ComboBox

Public Methods

MethodDefined By

Public Events

EventDefined By

Public Events

EventDefined By