docs/source/Label.html

   1 <!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-form.Label-method-constructor'><span id='Ext-form.Label'>/**
   2 </span></span> * @class Ext.form.Label
   3  * @extends Ext.Component
   4
   5 Produces a standalone `&lt;label /&gt;` element which can be inserted into a form and be associated with a field
   6 in that form using the {@link #forId} property.
   7
   8 **NOTE:** in most cases it will be more appropriate to use the {@link Ext.form.Labelable#fieldLabel fieldLabel}
   9 and associated config properties ({@link Ext.form.Labelable#labelAlign}, {@link Ext.form.Labelable#labelWidth},
  10 etc.) in field components themselves, as that allows labels to be uniformly sized throughout the form.
  11 Ext.form.Label should only be used when your layout can not be achieved with the standard
  12 {@link Ext.form.Labelable field layout}.
  13
  14 You will likely be associating the label with a field component that extends {@link Ext.form.field.Base}, so
  15 you should make sure the {@link #forId} is set to the same value as the {@link Ext.form.field.Base#inputId inputId}
  16 of that field.
  17
  18 The label's text can be set using either the {@link #text} or {@link #html} configuration properties; the
  19 difference between the two is that the former will automatically escape HTML characters when rendering, while
  20 the latter will not.
  21 {@img Ext.form.Label/Ext.form.Label.png Ext.form.Label component}
  22 #Example usage:#
  23
  24 This example creates a Label after its associated Text field, an arrangement that cannot currently
  25 be achieved using the standard Field layout's labelAlign.
  26
  27     Ext.create('Ext.form.Panel', {
  28         title: 'Field with Label',
  29         width: 400,
  30         bodyPadding: 10,
  31         renderTo: Ext.getBody(),
  32         layout: {
  33             type: 'hbox',
  34             align: 'middle'
  35         },
  36         items: [{
  37             xtype: 'textfield',
  38             hideLabel: true,
  39             flex: 1
  40         }, {
  41             xtype: 'label',
  42             forId: 'myFieldId',
  43             text: 'My Awesome Field',
  44             margins: '0 0 0 10'
  45         }]
  46     });
  47
  48  * @constructor
  49  * Creates a new Label component.
  50  * @param {Ext.core.Element/String/Object} config The configuration options.
  51  *
  52  * @xtype label
  53  * @markdown
  54  * @docauthor Jason Johnston &lt;jason@sencha.com&gt;
  55  */
  56 Ext.define('Ext.form.Label', {
  57     extend:'Ext.Component',
  58     alias: 'widget.label',
  59     requires: ['Ext.util.Format'],
  60
  61 <span id='Ext-form.Label-cfg-text'>    /**
  62 </span>     * @cfg {String} text The plain text to display within the label (defaults to ''). If you need to include HTML
  63      * tags within the label's innerHTML, use the {@link #html} config instead.
  64      */
  65 <span id='Ext-form.Label-cfg-forId'>    /**
  66 </span>     * @cfg {String} forId The id of the input element to which this label will be bound via the standard HTML 'for'
  67      * attribute. If not specified, the attribute will not be added to the label. In most cases you will be
  68      * associating the label with a {@link Ext.form.field.Base} component, so you should make sure this matches
  69      * the {@link Ext.form.field.Base#inputId inputId} of that field.
  70      */
  71 <span id='Ext-form.Label-cfg-html'>    /**
  72 </span>     * @cfg {String} html An HTML fragment that will be used as the label's innerHTML (defaults to '').
  73      * Note that if {@link #text} is specified it will take precedence and this value will be ignored.
  74      */
  75
  76     maskOnDisable: false,
  77     getElConfig: function(){
  78         var me = this;
  79         return {
  80             tag: 'label',
  81             id: me.id,
  82             htmlFor: me.forId || '',
  83             html: me.text ? Ext.util.Format.htmlEncode(me.text) : (me.html || '')
  84         };
  85     },
  86
  87 <span id='Ext-form.Label-method-setText'>    /**
  88 </span>     * Updates the label's innerHTML with the specified string.
  89      * @param {String} text The new label text
  90      * @param {Boolean} encode (optional) False to skip HTML-encoding the text when rendering it
  91      * to the label (defaults to true which encodes the value). This might be useful if you want to include
  92      * tags in the label's innerHTML rather than rendering them as string literals per the default logic.
  93      * @return {Label} this
  94      */
  95     setText : function(text, encode){
  96         var me = this;
  97
  98         encode = encode !== false;
  99         if(encode) {
 100             me.text = text;
 101             delete me.html;
 102         } else {
 103             me.html = text;
 104             delete me.text;
 105         }
 106
 107         if(me.rendered){
 108             me.el.dom.innerHTML = encode !== false ? Ext.util.Format.htmlEncode(text) : text;
 109         }
 110         return this;
 111     }
 112 });
 113
 114 </pre></pre></body></html>