X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6a7e4474cba9d8be4b2ec445e10f1691f7277c50..6b044c28b5f26fb99c86c237ffad19741c0f7f3d:/docs/output/Ext.form.ComboBox.html?ds=sidebyside diff --git a/docs/output/Ext.form.ComboBox.html b/docs/output/Ext.form.ComboBox.html index e3324465..888f930f 100644 --- a/docs/output/Ext.form.ComboBox.html +++ b/docs/output/Ext.form.ComboBox.html @@ -1,4 +1,10 @@ -
Properties Methods Events Config Options Direct Link 
Observable
  Component
    BoxComponent
      Field
        TextField
          TriggerField
            ComboBox

Class Ext.form.ComboBox

Package:Ext.form
Defined In:Combo.js
Class:ComboBox
Subclasses:TimeField
Extends:TriggerField

A combobox control with support for autocomplete, remote-loading, paging and many other features.

+
Properties Methods Events Config Options Direct Link 
Observable
+  Component
+    BoxComponent
+      Field
+        TextField
+          TriggerField
+            ComboBox

Class Ext.form.ComboBox

Package:Ext.form
Defined In:Combo.js
Class:ComboBox
Subclasses:TimeField
Extends:TriggerField

A combobox control with support for autocomplete, remote-loading, paging and many other features.

A ComboBox works in a similar manner to a traditional HTML <select> field. The difference is that to submit the valueField, you must specify a hiddenName to create a hidden input field to hold the value of the valueField. The displayField is shown in the text field @@ -85,105 +91,14 @@ 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 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 +
{tag: "input", type: "text", size: "24", autocomplete: "off"}
ComboBox 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 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 +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 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. @@ -279,17 +194,12 @@ false to allow the user to set arbitrary text i...
tr Note to express this dimension as a percentage or offset s...
The height of this component in pixels (defaults to auto). Note to express this dimension as a percentage or offset see Ext.Component.anchor.
BoxComponent hidden : Boolean
Render this component hidden (default is false). If true, the hide method will be called internally.
Component hiddenId : String
If hiddenName is specified, hiddenId can also be provided -to give the hidden field a unique id (defaults to the hidde...
If hiddenName is specified, hiddenId can also be provided -to give the hidden field a unique id (defaults to the hiddenName). The hiddenId -and combo id should be different, since no two DOM -nodes should share the same id.
ComboBox hiddenName : String
If specified, a hidden form field with this name is dynamically generated to store the +to give the hidden field a unique id. The hiddenId and com...
If hiddenName is specified, hiddenId can also be provided +to give the hidden field a unique id. The hiddenId and combo id should be +different, since no two DOM nodes should share the same id.
ComboBox hiddenName : String
If specified, a hidden form field with this name is dynamically generated to store the field's data value (defaults t...
If specified, a hidden form field with this name is dynamically generated to store the field's data value (defaults to the underlying DOM element's name). Required for the combo's value to automatically -post during a form submission. See also valueField. -

Note: the hidden field's id will also default to this name if hiddenId is not specified. -The ComboBox id and the hiddenId should be different, since -no two DOM nodes should share the same id. So, if the ComboBox name and -hiddenName are the same, you should specify a unique hiddenId.

ComboBox hiddenValue : String
Sets the initial value of the hidden field if hiddenName is +post during a form submission. See also valueField.
ComboBox hiddenValue : String
Sets the initial value of the hidden field if hiddenName is specified to contain the selected valueField, from the St...
Sets the initial value of the hidden field if hiddenName is specified to contain the selected valueField, from the Store. Defaults to the configured value.
ComboBox hideLabel : Boolean
true to completely hide the label element @@ -888,7 +798,20 @@ 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 label : Ext.Element
The label Element associated with this Field. Only available after this Field has been rendered by a +

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 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.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: @@ -984,7 +907,12 @@ Or a shorthand syntax:
scope: this });
Returns:
  • void
Observable applyToMarkup( String/HTMLElement el ) : - void
Apply 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() + void
Apply 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 bubble( Function fn, [Object scope], [Array args] ) + : + Ext.Component
Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of...
Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of +function call will be the scope provided or the current component. The arguments to the function +will be the args provided or the current component. If the function returns false at any point, +the bubble is stopped.
Parameters:
  • fn : Function
    The function to call
  • scope : Object
    (optional) The scope of the function (defaults to current node)
  • args : Array
    (optional) The args to call the function with (default to passing the current component)
Returns:
  • Ext.Component
    this
Component clearInvalid() : void
Clear any invalid styles/messages for this field
Clear any invalid styles/messages for this field
Parameters:
  • None.
Returns:
  • void
Field clearValue() : @@ -1049,9 +977,11 @@ access the required target more quickly.

: Ext.Container
Find a container above this component at any level by a custom function. If the passed function returns true, the con...
Find a container above this component at any level by a custom function. If the passed function returns -true, the container will be returned.
Parameters:
  • fn : Function
    The custom function to call with the arguments (container, this component).
Returns:
  • Ext.Container
    The first Container for which the custom function returns true
Component findParentByType( String/Class xtype ) +true, the container will be returned.
Parameters:
  • fn : Function
    The custom function to call with the arguments (container, this component).
Returns:
  • Ext.Container
    The first Container for which the custom function returns true
Component findParentByType( String/Ext.Component/Class xtype, [Boolean shallow] ) : - Ext.Container
Find a container above this component at any level by xtype or class
Find a container above this component at any level by xtype or class
Parameters:
  • xtype : String/Class
    The xtype string for a component, or the class of the component directly
Returns:
  • Ext.Container
    The first Container which matches the given xtype or class
Component fireEvent( String eventName, Object... args ) + Ext.Container
Find a container above this component at any level by xtype or class
Find a container above this component at any level by xtype or class
Parameters:
  • xtype : String/Ext.Component/Class
    The xtype to check for this Component. Note that the the component can either be an instance +or a component class:
  • shallow : Boolean
    (optional) False to check whether this Component is descended from the xtype (this is +the default), or true to check whether this Component is directly of the specified xtype.
Returns:
  • Ext.Container
    The first Container which matches the given xtype or class
Component fireEvent( String eventName, Object... args ) : Boolean
Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Obse...

Fires the specified event with the passed parameters (minus the event name).

@@ -1256,7 +1186,7 @@ of the field. Note: disab...
Returns whether or not the f validating the processed value of the field. Note: disabled fields are ignored.
Parameters:
  • preventMark : Boolean
    True to disable marking the field invalid
Returns:
  • Boolean
    True if the value is valid, else false
Field isVisible() : - Boolean
Returns 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] ) + Boolean
Returns 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/Ext.Component/Class xtype, [Boolean shallow] ) : Boolean
Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended from th...

Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended @@ -1268,7 +1198,11 @@ to participate in determination of inherited xtypes.

var t = new Ext.form.TextField();
 var isText = t.isXType('textfield');        // true
 var isBoxSubclass = t.isXType('box');       // true, descended from BoxComponent
-var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instance
Parameters:
  • xtype : String
    The xtype to check for this Component
  • shallow : Boolean
    (optional) False to check whether this Component is descended from the xtype (this is +var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instance
    Parameters:
    • xtype : String/Ext.Component/Class
      The xtype to check for this Component. Note that the the component can either be an instance +or a component class: +
      var c = new Ext.Component();
+console.log(c.isXType(c));
+console.log(c.isXType(Ext.Component));
    • shallow : Boolean
      (optional) False to check whether this Component is descended from the xtype (this is the default), or true to check whether this Component is directly of the specified xtype.
    Returns:
    • Boolean
      True if this component descends from the specified xtype, false otherwise.
Component markInvalid( [String msg] ) : void
Display an error message associated with this field, using msgTarget to determine how to @@ -1374,17 +1308,19 @@ use markInvalid instead, which calls this method internally
Convenience 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 ) : - void
Parameters:
  • value : Boolean
    True 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, + void
    Allow or prevent the user from directly editing the field text. If false is passed, +the user will only be able to mo...
    Allow or prevent the user from directly editing the field text. If false is passed, the user will only be able to modify the field using the trigger. Will also add a click event to the text field which will call the trigger. This method -is the runtime equivalent of setting the 'editable' config option at config time.
Returns:
  • void
TriggerField setHeight( Mixed height ) +is the runtime equivalent of setting the editable config option at config time.
Parameters:
  • value : Boolean
    True to allow the user to directly edit the field text.
Returns:
  • void
TriggerField setHeight( Mixed height ) : Ext.BoxComponent
Sets 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 : Mixed
    The 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 setHideTrigger( Boolean hideTrigger ) + : + void
Changes the hidden status of the trigger.
Changes the hidden status of the trigger.
Parameters:
  • hideTrigger : Boolean
    True to hide the trigger, false to show it.
Returns:
  • void
TriggerField setPagePosition( Number x, Number y ) : Ext.BoxComponent
Sets 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. @@ -1396,11 +1332,11 @@ This method fires the
Sets 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 : Mixed
    The value to set
Returns:
  • Mixed
    value The field value that is set
Field setReadOnly( Boolean value ) : - void
Parameters:
  • value : Boolean
    True 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 ) + void
Setting this to true will supersede settings editable and hideTrigger. +Setting this to false will defer back to edita...
Setting this to true will supersede settings editable and hideTrigger. +Setting this to false will defer back to editable and hideTrigger. This method +is the runtime equivalent of setting the readOnly config option at config time.
Parameters:
  • value : Boolean
    True to prevent the user changing the field and explicitly +hide the trigger.
Returns:
  • void
TriggerField setSize( Mixed width, Mixed height ) : Ext.BoxComponent
Sets 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