X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/25ef3491bd9ae007ff1fc2b0d7943e6eaaccf775..HEAD:/docs/source/TextArea.html diff --git a/docs/source/TextArea.html b/docs/source/TextArea.html index f6b7d0dd..78536a55 100644 --- a/docs/source/TextArea.html +++ b/docs/source/TextArea.html @@ -1,127 +1,190 @@ + + The source code - - + + + + - -
/*!
- * Ext JS Library 3.0.3
- * Copyright(c) 2006-2009 Ext JS, LLC
- * licensing@extjs.com
- * http://www.extjs.com/license
- */
-
/** - * @class Ext.form.TextArea - * @extends Ext.form.TextField - * Multiline text field. Can be used as a direct replacement for traditional textarea fields, plus adds - * support for auto-sizing. - * @constructor - * Creates a new TextArea - * @param {Object} config Configuration options - * @xtype textarea + +
/**
+ * @docauthor Robert Dougan <rob@sencha.com>
+ *
+ * This class creates a multiline text field, which can be used as a direct replacement for traditional
+ * textarea fields. In addition, it supports automatically {@link #grow growing} the height of the textarea to
+ * fit its content.
+ *
+ * All of the configuration options from {@link Ext.form.field.Text} can be used on TextArea.
+ *
+ * Example usage:
+ *
+ *     @example
+ *     Ext.create('Ext.form.FormPanel', {
+ *         title      : 'Sample TextArea',
+ *         width      : 400,
+ *         bodyPadding: 10,
+ *         renderTo   : Ext.getBody(),
+ *         items: [{
+ *             xtype     : 'textareafield',
+ *             grow      : true,
+ *             name      : 'message',
+ *             fieldLabel: 'Message',
+ *             anchor    : '100%'
+ *         }]
+ *     });
+ *
+ * Some other useful configuration options when using {@link #grow} are {@link #growMin} and {@link #growMax}.
+ * These allow you to set the minimum and maximum grow heights for the textarea.
  */
-Ext.form.TextArea = Ext.extend(Ext.form.TextField,  {
-    
/** - * @cfg {Number} growMin The minimum height to allow when {@link Ext.form.TextField#grow grow}=true - * (defaults to 60) +Ext.define('Ext.form.field.TextArea', { + extend:'Ext.form.field.Text', + alias: ['widget.textareafield', 'widget.textarea'], + alternateClassName: 'Ext.form.TextArea', + requires: ['Ext.XTemplate', 'Ext.layout.component.field.TextArea'], + + fieldSubTpl: [ + '<textarea id="{id}" ', + '<tpl if="name">name="{name}" </tpl>', + '<tpl if="rows">rows="{rows}" </tpl>', + '<tpl if="cols">cols="{cols}" </tpl>', + '<tpl if="tabIdx">tabIndex="{tabIdx}" </tpl>', + 'class="{fieldCls} {typeCls}" ', + 'autocomplete="off">', + '</textarea>', + { + compiled: true, + disableFormats: true + } + ], + + /** + * @cfg {Number} growMin + * The minimum height to allow when {@link #grow}=true */ - growMin : 60, -
/** - * @cfg {Number} growMax The maximum height to allow when {@link Ext.form.TextField#grow grow}=true - * (defaults to 1000) + growMin: 60, + + /** + * @cfg {Number} growMax + * The maximum height to allow when {@link #grow}=true */ growMax: 1000, - growAppend : ' \n ', - growPad : Ext.isWebKit ? -6 : 0, - enterIsSpecial : false, + /** + * @cfg {String} growAppend + * A string that will be appended to the field's current value for the purposes of calculating the target field + * size. Only used when the {@link #grow} config is true. Defaults to a newline for TextArea to ensure there is + * always a space below the current line. + */ + growAppend: '\n-', -
/** - * @cfg {Boolean} preventScrollbars true to prevent scrollbars from appearing regardless of how much text is - * in the field. This option is only relevant when {@link #grow} is true. Equivalent to setting overflow: hidden, defaults to - * false. + /** + * @cfg {Number} cols + * An initial value for the 'cols' attribute on the textarea element. This is only used if the component has no + * configured {@link #width} and is not given a width by its container's layout. */ - preventScrollbars: false, -
/** - * @cfg {String/Object} autoCreate

A {@link Ext.DomHelper DomHelper} element spec, or true for a default - * element spec. Used to create the {@link Ext.Component#getEl Element} which will encapsulate this Component. - * See {@link Ext.Component#autoEl autoEl} for details. Defaults to:

- *
{tag: "textarea", style: "width:100px;height:60px;", autocomplete: "off"}
+ cols: 20, + + /** + * @cfg {Number} cols + * An initial value for the 'cols' attribute on the textarea element. This is only used if the component has no + * configured {@link #width} and is not given a width by its container's layout. */ + rows: 4, + + /** + * @cfg {Boolean} enterIsSpecial + * True if you want the enter key to be classed as a special key. Special keys are generally navigation keys + * (arrows, space, enter). Setting the config property to true would mean that you could not insert returns into the + * textarea. + */ + enterIsSpecial: false, + + /** + * @cfg {Boolean} preventScrollbars + * true to prevent scrollbars from appearing regardless of how much text is in the field. This option is only + * relevant when {@link #grow} is true. Equivalent to setting overflow: hidden. + */ + preventScrollbars: false, // private - onRender : function(ct, position){ - if(!this.el){ - this.defaultAutoCreate = { - tag: "textarea", - style:"width:100px;height:60px;", - autocomplete: "off" - }; - } - Ext.form.TextArea.superclass.onRender.call(this, ct, position); - if(this.grow){ - this.textSizeEl = Ext.DomHelper.append(document.body, { - tag: "pre", cls: "x-form-grow-sizer" - }); - if(this.preventScrollbars){ - this.el.setStyle("overflow", "hidden"); - } - this.el.setHeight(this.growMin); - } - }, + componentLayout: 'textareafield', - onDestroy : function(){ - Ext.destroy(this.textSizeEl); - Ext.form.TextArea.superclass.onDestroy.call(this); + // private + onRender: function(ct, position) { + var me = this; + Ext.applyIf(me.subTplData, { + cols: me.cols, + rows: me.rows + }); + + me.callParent(arguments); }, - fireKey : function(e){ - if(e.isSpecialKey() && (this.enterIsSpecial || (e.getKey() != e.ENTER || e.hasModifier()))){ - this.fireEvent("specialkey", this, e); + // private + afterRender: function(){ + var me = this; + + me.callParent(arguments); + + if (me.grow) { + if (me.preventScrollbars) { + me.inputEl.setStyle('overflow', 'hidden'); + } + me.inputEl.setHeight(me.growMin); } }, // private - onKeyUp : function(e){ - if(!e.isNavKeyPress() || e.getKey() == e.ENTER){ - this.autoSize(); + fireKey: function(e) { + if (e.isSpecialKey() && (this.enterIsSpecial || (e.getKey() !== e.ENTER || e.hasModifier()))) { + this.fireEvent('specialkey', this, e); } - Ext.form.TextArea.superclass.onKeyUp.call(this, e); }, -
/** - * Automatically grows the field to accomodate the height of the text up to the maximum field height allowed. - * This only takes effect if grow = true, and fires the {@link #autosize} event if the height changes. + /** + * Automatically grows the field to accomodate the height of the text up to the maximum field height allowed. This + * only takes effect if {@link #grow} = true, and fires the {@link #autosize} event if the height changes. */ - autoSize: function(){ - if(!this.grow || !this.textSizeEl){ - return; - } - var el = this.el; - var v = el.dom.value; - var ts = this.textSizeEl; - ts.innerHTML = ''; - ts.appendChild(document.createTextNode(v)); - v = ts.innerHTML; - Ext.fly(ts).setWidth(this.el.getWidth()); - if(v.length < 1){ - v = "  "; - }else{ - v += this.growAppend; - if(Ext.isIE){ - v = v.replace(/\n/g, '
'); + autoSize: function() { + var me = this, + height; + + if (me.grow && me.rendered) { + me.doComponentLayout(); + height = me.inputEl.getHeight(); + if (height !== me.lastInputHeight) { + me.fireEvent('autosize', height); + me.lastInputHeight = height; } } - ts.innerHTML = v; - var h = Math.min(this.growMax, Math.max(ts.offsetHeight, this.growMin) + this.growPad); - if(h != this.lastHeight){ - this.lastHeight = h; - this.el.setHeight(h); - this.fireEvent("autosize", this, h); - } + }, + + // private + initAria: function() { + this.callParent(arguments); + this.getActionEl().dom.setAttribute('aria-multiline', true); + }, + + /** + * To get the natural width of the textarea element, we do a simple calculation based on the 'cols' config. + * We use hard-coded numbers to approximate what browsers do natively, to avoid having to read any styles which + * would hurt performance. Overrides Labelable method. + * @protected + */ + getBodyNaturalWidth: function() { + return Math.round(this.cols * 6.5) + 20; } + }); -Ext.reg('textarea', Ext.form.TextArea);
+ +
- \ No newline at end of file +