X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/2e847cf21b8ab9d15fa167b315ca5b2fa92638fc..0494b8d9b9bb03ab6c22b34dae81261e3cd7e3e6:/docs/output/Ext.form.TriggerField.html diff --git a/docs/output/Ext.form.TriggerField.html b/docs/output/Ext.form.TriggerField.html index c0b00b5f..a15ae9e3 100644 --- a/docs/output/Ext.form.TriggerField.html +++ b/docs/output/Ext.form.TriggerField.html @@ -1,4 +1,9 @@ -
Observable
  Component
    BoxComponent
      Field
        TextField
          TriggerField

Class Ext.form.TriggerField

Package:Ext.form
Defined In:TriggerField.js
Class:TriggerField
Subclasses:ComboBox, DateField, TwinTriggerField
Extends:TextField
Provides a convenient wrapper for TextFields that adds a clickable trigger button (looks like a combobox by default). +
Properties Methods Events Config Options Direct Link 
Observable
+  Component
+    BoxComponent
+      Field
+        TextField
+          TriggerField

Class Ext.form.TriggerField

Package:Ext.form
Defined In:TriggerField.js
Class:TriggerField
Subclasses:ComboBox, DateField, TwinTriggerField
Extends:TextField
Provides a convenient wrapper for TextFields that adds a clickable trigger button (looks like a combobox by default). The trigger has no default action, so you must assign a function to implement the trigger click handler by overriding onTriggerClick. You can create a TriggerField directly, as it renders exactly like a combobox for which you can provide a custom implementation. For example: @@ -136,7 +141,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').

@@ -446,9 +454,9 @@ validation fails (defaults to 'The maximum length for this field is {maxL...'The maximum length for this field is {maxLength}')
TextField minLength : Number
Minimum input field length required (defaults to 0)
TextField minLengthText : String
Error 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 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. @@ -457,7 +465,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 @@ -748,7 +756,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 cloneConfig( Object overrides ) : @@ -765,45 +778,47 @@ should usually not need to be called directly.
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 findParentBy( Function fn )
     :
                                         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).

@@ -834,7 +849,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:Returns:
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() : @@ -912,7 +983,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:Returns:
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 @@ -924,7 +995,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 @@ -1015,23 +1090,30 @@ event...
Resume firing events. (see Parameters:
  • None.
Returns:
  • void
Observable 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 ) : Ext.Component
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( Number height ) +is the runtime equivalent of setting the editable config option at config time.
Parameters:Returns:
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 ) +
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. @@ -1043,11 +1125,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 @@ -1065,10 +1147,10 @@ This may be one of:
    : Ext.form.Field
    Sets a data value into the field and validates it. To set the value directly without validation see setRawValue.
    Sets a data value into the field and validates it. To set the value directly without validation see setRawValue.
    Parameters:
    • value : Mixed
      The value to set
    Returns:
    • Ext.form.Field
      this
    Field 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. @@ -1091,63 +1177,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