Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / Display.html
index d9d407f..4426cad 100644 (file)
@@ -1,43 +1,53 @@
-<!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.field.Display-method-constructor'><span id='Ext-form.field.Display'>/**
-</span></span> * @class Ext.form.field.Display
- * @extends Ext.form.field.Base
- * &lt;p&gt;A display-only text field which is not validated and not submitted. This is useful for when you want
- * to display a value from a form's {@link Ext.form.Basic#load loaded data} but do not want to allow the
- * user to edit or submit that value. The value can be optionally {@link #htmlEncode HTML encoded} if it contains
- * HTML markup that you do not want to be rendered.&lt;/p&gt;
- * &lt;p&gt;If you have more complex content, or need to include components within the displayed content, also
- * consider using a {@link Ext.form.FieldContainer} instead.&lt;/p&gt;
- * {@img Ext.form.Display/Ext.form.Display.png Ext.form.Display component}
- * &lt;p&gt;Example:&lt;/p&gt;
- * &lt;pre&gt;&lt;code&gt;
-    Ext.create('Ext.form.Panel', {
-        width: 175,
-        height: 120,
-        bodyPadding: 10,
-        title: 'Final Score',
-        items: [{
-            xtype: 'displayfield',
-            fieldLabel: 'Home',
-            name: 'home_score',
-            value: '10'
-        }, {
-            xtype: 'displayfield',
-            fieldLabel: 'Visitor',
-            name: 'visitor_score',
-            value: '11'
-        }],
-        buttons: [{
-            text: 'Update',
-        }],
-        renderTo: Ext.getBody()
-    });
-&lt;/code&gt;&lt;/pre&gt;
-
- * @constructor
- * Creates a new DisplayField.
- * @param {Object} config Configuration options
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>The source code</title>
+  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+  <style type="text/css">
+    .highlight { display: block; background-color: #ddd; }
+  </style>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-form-field-Display'>/**
+</span> * A display-only text field which is not validated and not submitted. This is useful for when you want to display a
+ * value from a form's {@link Ext.form.Basic#load loaded data} but do not want to allow the user to edit or submit that
+ * value. The value can be optionally {@link #htmlEncode HTML encoded} if it contains HTML markup that you do not want
+ * to be rendered.
+ *
+ * If you have more complex content, or need to include components within the displayed content, also consider using a
+ * {@link Ext.form.FieldContainer} instead.
+ *
+ * Example:
  *
- * @xtype displayfield
+ *     @example
+ *     Ext.create('Ext.form.Panel', {
+ *         renderTo: Ext.getBody(),
+ *         width: 175,
+ *         height: 120,
+ *         bodyPadding: 10,
+ *         title: 'Final Score',
+ *         items: [{
+ *             xtype: 'displayfield',
+ *             fieldLabel: 'Home',
+ *             name: 'home_score',
+ *             value: '10'
+ *         }, {
+ *             xtype: 'displayfield',
+ *             fieldLabel: 'Visitor',
+ *             name: 'visitor_score',
+ *             value: '11'
+ *         }],
+ *         buttons: [{
+ *             text: 'Update',
+ *         }]
+ *     });
  */
 Ext.define('Ext.form.field.Display', {
     extend:'Ext.form.field.Base',
@@ -52,15 +62,16 @@ Ext.define('Ext.form.field.Display', {
         }
     ],
 
-<span id='Ext-form.field.Display-cfg-fieldCls'>    /**
-</span>     * @cfg {String} fieldCls The default CSS class for the field (defaults to &lt;tt&gt;&quot;x-form-display-field&quot;&lt;/tt&gt;)
+<span id='Ext-form-field-Display-cfg-fieldCls'>    /**
+</span>     * @cfg {String} [fieldCls=&quot;x-form-display-field&quot;]
+     * The default CSS class for the field.
      */
     fieldCls: Ext.baseCSSPrefix + 'form-display-field',
 
-<span id='Ext-form.field.Display-cfg-htmlEncode'>    /**
-</span>     * @cfg {Boolean} htmlEncode &lt;tt&gt;false&lt;/tt&gt; to skip HTML-encoding the text when rendering it (defaults to
-     * &lt;tt&gt;false&lt;/tt&gt;). This might be useful if you want to include tags in the field's innerHTML rather than
-     * rendering them as string literals per the default logic.
+<span id='Ext-form-field-Display-cfg-htmlEncode'>    /**
+</span>     * @cfg {Boolean} htmlEncode
+     * false to skip HTML-encoding the text when rendering it. This might be useful if you want to
+     * include tags in the field's innerHTML rather than rendering them as string literals per the default logic.
      */
     htmlEncode: false,
 
@@ -97,29 +108,31 @@ Ext.define('Ext.form.field.Display', {
         return this.inputEl;
     }
 
-<span id='Ext-form.field.Display-cfg-inputType'>    /**
+<span id='Ext-form-field-Display-cfg-inputType'>    /**
 </span>     * @cfg {String} inputType
      * @hide
      */
-<span id='Ext-form.field.Display-cfg-disabled'>    /**
+<span id='Ext-form-field-Display-cfg-disabled'>    /**
 </span>     * @cfg {Boolean} disabled
      * @hide
      */
-<span id='Ext-form.field.Display-cfg-readOnly'>    /**
+<span id='Ext-form-field-Display-cfg-readOnly'>    /**
 </span>     * @cfg {Boolean} readOnly
      * @hide
      */
-<span id='Ext-form.field.Display-cfg-validateOnChange'>    /**
+<span id='Ext-form-field-Display-cfg-validateOnChange'>    /**
 </span>     * @cfg {Boolean} validateOnChange
      * @hide
      */
-<span id='Ext-form.field.Display-cfg-checkChangeEvents'>    /**
+<span id='Ext-form-field-Display-cfg-checkChangeEvents'>    /**
 </span>     * @cfg {Number} checkChangeEvents
      * @hide
      */
-<span id='Ext-form.field.Display-cfg-checkChangeBuffer'>    /**
+<span id='Ext-form-field-Display-cfg-checkChangeBuffer'>    /**
 </span>     * @cfg {Number} checkChangeBuffer
      * @hide
      */
 });
-</pre></pre></body></html>
\ No newline at end of file
+</pre>
+</body>
+</html>