X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/2e847cf21b8ab9d15fa167b315ca5b2fa92638fc..c8256059947f3aa8f5b0a9a2acf55e2142bb4742:/docs/output/Ext.form.ComboBox.html diff --git a/docs/output/Ext.form.ComboBox.html b/docs/output/Ext.form.ComboBox.html index 835a033c..c44f8beb 100644 --- a/docs/output/Ext.form.ComboBox.html +++ b/docs/output/Ext.form.ComboBox.html @@ -1,4 +1,4 @@ -
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 @@ -192,7 +192,10 @@ Warning: This will override any size manag...

The maxi 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 +

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

BoxComponent bubbleEvents : Array
An 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 : 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').

@@ -584,9 +587,9 @@ 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<p>The : String
location where the message text set through markInvalid should display. +(defaults to 'normal').
Field msgTarget : String
The 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. +<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. @@ -595,7 +598,7 @@ Must be one of the following values:

  • 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 ''). +
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 @@ -885,7 +888,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: @@ -1008,38 +1024,38 @@ also clears any filter previously saved in the current store (defaults to fa : Ext.Component
Enable 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 ) : - void
Enables 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');
-        }
-    }
+                                        void
Enables 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/Array
    The event name to bubble, or an Array of event names.
Returns:
  • void
Observable expand()
     :
                                         void
Expands 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 )
@@ -1079,7 +1095,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 ) + : + Array
Validates 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 +
    +

    If none of the prior validation steps halts validation, a field's +configured regex test will be processed. +The invalid message for this test is configured with +regexText.

    +
    • Parameters:
    • value : Mixed
      The value to validate. The processed raw value will be used if nothing is passed
    Returns:
    • Array
      Array of any validation errors
TextField getHeight() : Number
Gets 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() : @@ -1304,7 +1376,12 @@ 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 : String
    The data value of the item to select
  • scrollIntoView : Boolean
    False 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] ) : - void
Selects text in this field
Selects text in this field
Parameters:
  • 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 setAutoScroll( Boolean scroll ) + void
Selects text in this field
Selects text in this field
Parameters:
  • 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 ) + : + void
Sets the current activeError to the given string. Fires the 'invalid' event. +This does not set up the error icon, onl...
Sets the current activeError to the given string. Fires the 'invalid' event. +This does not set up the error icon, only sets the message and fires the event. To show the error icon, +use markInvalid instead, which calls this method internally
Parameters:
  • msg : String
    The error message
  • suppressEvent : Boolean
    True to suppress the 'invalid' event from being fired
Returns:
  • void
Field setAutoScroll( Boolean scroll ) : Ext.BoxComponent
Sets the overflow on the content element of the component.
Sets the overflow on the content element of the component.
Parameters:
  • scroll : Boolean
    True to allow the Component to auto scroll.
Returns:
  • Ext.BoxComponent
    this
BoxComponent setDisabled( Boolean disabled ) : @@ -1314,10 +1391,10 @@ selected item if it is not currently in view (defaults to true)< 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( Number height ) +is the runtime equivalent of setting the 'editable' config option at config time.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 : Number
    The 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.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 ) @@ -1358,10 +1435,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 : String
        The value to match
      Returns:
      • Ext.form.Field
        this
    ComboBox setVisible( Boolean visible ) : - Ext.Component
    Convenience function to hide or show this component by boolean.
    Convenience function to hide or show this component by boolean.
    Parameters:
    • visible : Boolean
      True to show, false to hide
    Returns:
    • Ext.Component
      this
    Component setWidth( Number width ) + Ext.Component
    Convenience function to hide or show this component by boolean.
    Convenience function to hide or show this component by boolean.
    Parameters:
    • visible : Boolean
      True to show, false to hide
    Returns:
    • Ext.Component
      this
    Component setWidth( Mixed width ) : - Ext.BoxComponent
    Sets 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 : Number
      The new width to setThis may be one of:
      BoxComponent un( String eventName, Function handler, [Object scope] ) : - void
      Removes an event handler (shorthand for removeListener.)
      Removes an event handler (shorthand for removeListener.)
      Parameters:
      • eventName : String
        The type of event the handler was associated with.
      • handler : Function
        The 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 update( Mixed htmlOrData, [Boolean loadScripts], [Function callback] ) + void
      Removes an event handler (shorthand for removeListener.)
      Removes an event handler (shorthand for removeListener.)
      Parameters:
      • eventName : String
        The type of event the handler was associated with.
      • handler : Function
        The 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 ) + : + void
      Clears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not +usually n...
      Clears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not +usually need to be called manually
      Parameters:
      • suppressEvent : Boolean
        True to suppress the 'invalid' event from being fired
      Returns:
      • void
      Field update( Mixed htmlOrData, [Boolean loadScripts], [Function callback] ) : void
      Update the content area of a component.
      Update the content area of a component.
      Parameters:
      • htmlOrData : Mixed
        If this component has been configured with a template via the tpl config then it will use this argument as data to populate the template. @@ -1384,63 +1465,13 @@ content area will be updated via Ext.Element update
      • loadScri : Ext.BoxComponent
        Sets the current box measurements of the component's underlying element.
        Sets the current box measurements of the component's underlying element.
        Parameters:
        • box : Object
          An object in the format {x, y, width, height}
        Returns:
        • Ext.BoxComponent
          this
        BoxComponent validate() : - Boolean
        Validates the field value
        Validates the field value
        Parameters:
        • None.
        Returns:
        • Boolean
          True if the value is valid, else false
        Field validateValue( Mixed value ) + Boolean
        Validates the field value
        Validates the field value
        Parameters:
        • None.
        Returns:
        • Boolean
          True if the value is valid, else false
        Field validateValue( Mixed The ) : - Boolean
        Validates a value according to the field's validation rules and marks the field as invalid -if the validation fails. V...

        Validates a value according to the field's validation rules and marks the field as invalid -if the validation fails. Validation rules are processed in the following order:

        -
          -
        • 1. Field specific validator -
          -

          A validator offers a way to customize and reuse a validation specification. -If a field is configured with a validator -function, it will be passed the current field value. The validator -function is expected to return either: -

            -
          • Boolean true if the value is valid (validation continues).
            • -
          • a String to represent the invalid message if invalid (validation halts).
            • -
          -
          • -
        • 2. Basic Validation -
          -

          If the validator has not halted validation, -basic validation proceeds as follows:

          -
            -
          • allowBlank : (Invalid message = -emptyText)
            -Depending on the configuration of allowBlank, a -blank field will cause validation to halt at this step and return -Boolean true or false accordingly. -
            • -
          • minLength : (Invalid message = -minLengthText)
            -If the passed value does not satisfy the minLength -specified, validation halts. -
            • -
          • maxLength : (Invalid message = -maxLengthText)
            -If the passed value does not satisfy the maxLength -specified, validation halts. -
            • -
          -
          • -
        • 3. Preconfigured Validation Types (VTypes) -
          -

          If none of the prior validation steps halts validation, a field -configured with a vtype will utilize the -corresponding VTypes validation function. -If invalid, either the field's vtypeText or -the VTypes vtype Text property will be used for the invalid message. -Keystrokes on the field will be filtered according to the VTypes -vtype Mask property.

          -
          • -
        • 4. Field specific regex test -
          -

          If none of the prior validation steps halts validation, a field's -configured regex test will be processed. -The invalid message for this test is configured with -regexText.

          -
          • Parameters:
          • value : Mixed
            The value to validate
          Returns:
          • Boolean
            True if the value is valid, else false
        TextField

        Public Events

        EventDefined By

        Public Events

        EventDefined By