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

Class Ext.form.TextField

Package:Ext.form
Defined In:TextField.js
Class:TextField
Subclasses:NumberField, TextArea, TriggerField
Extends:Field

Basic text field. Can be used as a direct replacement for traditional text inputs, +

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

Class Ext.form.TextField

Package:Ext.form
Defined In:TextField.js
Class:TextField
Subclasses:NumberField, TextArea, TriggerField
Extends:Field

Basic text field. Can be used as a direct replacement for traditional text inputs, or as the base class for more sophisticated input controls (like Ext.form.TextArea and Ext.form.ComboBox).

Validation

@@ -41,102 +45,11 @@ 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: '20', autocomplete: 'off'}
Field 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: '20', autocomplete: 'off'}
Field 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 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. @@ -758,7 +671,12 @@ Or a shorthand syntax:
: void
Automatically grows the field to accomodate the width of the text up to the maximum field width allowed. This only ta...
Automatically grows the field to accomodate the width of the text up to the maximum field width allowed. -This only takes effect if grow = true, and fires the autosize event.
Parameters:
  • None.
Returns:
  • void
TextField clearInvalid() +This only takes effect if grow = true, and fires the autosize event.
Parameters:
  • None.
Returns:
  • void
TextField 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 ) : @@ -811,9 +729,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).

@@ -978,7 +898,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 @@ -990,7 +910,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