Upgrade to ExtJS 3.0.0 - Released 07/06/2009

[extjs.git] / docs / source / DisplayField.html
diff --git a/docs/source/DisplayField.html b/docs/source/DisplayField.html

new file mode 100644 (file)

index 0000000..25d67de
--- /dev/null
+++ b/docs/source/DisplayField.html
@@ -0,0 +1,102 @@
+<html>\r
+<head>\r
+  <title>The source code</title>\r
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
+</head>\r
+<body  onload="prettyPrint();">\r
+    <pre class="prettyprint lang-js"><div id="cls-Ext.form.DisplayField"></div>/**\r
+ * @class Ext.form.DisplayField\r
+ * @extends Ext.form.Field\r
+ * A display-only text field which is not validated and not submitted.\r
+ * @constructor\r
+ * Creates a new DisplayField.\r
+ * @param {Object} config Configuration options\r
+ * @xtype displayfield\r
+ */\r
+Ext.form.DisplayField = Ext.extend(Ext.form.Field,  {\r
+    validationEvent : false,\r
+    validateOnBlur : false,\r
+    defaultAutoCreate : {tag: "div"},\r
+    <div id="cfg-Ext.form.DisplayField-fieldClass"></div>/**\r
+     * @cfg {String} fieldClass The default CSS class for the field (defaults to <tt>"x-form-display-field"</tt>)\r
+     */\r
+    fieldClass : "x-form-display-field",\r
+    <div id="cfg-Ext.form.DisplayField-htmlEncode"></div>/**\r
+     * @cfg {Boolean} htmlEncode <tt>false</tt> to skip HTML-encoding the text when rendering it (defaults to\r
+     * <tt>false</tt>). This might be useful if you want to include tags in the field's innerHTML rather than\r
+     * rendering them as string literals per the default logic.\r
+     */\r
+    htmlEncode: false,\r
+\r
+    // private\r
+    initEvents : Ext.emptyFn,\r
+\r
+    isValid : function(){\r
+        return true;\r
+    },\r
+\r
+    validate : function(){\r
+        return true;\r
+    },\r
+\r
+    getRawValue : function(){\r
+        var v = this.rendered ? this.el.dom.innerHTML : Ext.value(this.value, '');\r
+        if(v === this.emptyText){\r
+            v = '';\r
+        }\r
+        if(this.htmlEncode){\r
+            v = Ext.util.Format.htmlDecode(v);\r
+        }\r
+        return v;\r
+    },\r
+\r
+    getValue : function(){\r
+        return this.getRawValue();\r
+    },\r
+    \r
+    getName: function() {\r
+        return this.name;\r
+    },\r
+\r
+    setRawValue : function(v){\r
+        if(this.htmlEncode){\r
+            v = Ext.util.Format.htmlEncode(v);\r
+        }\r
+        return this.rendered ? (this.el.dom.innerHTML = (Ext.isEmpty(v) ? '' : v)) : (this.value = v);\r
+    },\r
+\r
+    setValue : function(v){\r
+        this.setRawValue(v);\r
+        return this;\r
+    }\r
+    <div id="cfg-Ext.form.DisplayField-inputType"></div>/** \r
+     * @cfg {String} inputType \r
+     * @hide\r
+     */\r
+    <div id="cfg-Ext.form.DisplayField-disabled"></div>/** \r
+     * @cfg {Boolean} disabled \r
+     * @hide\r
+     */\r
+    <div id="cfg-Ext.form.DisplayField-readOnly"></div>/** \r
+     * @cfg {Boolean} readOnly \r
+     * @hide\r
+     */\r
+    <div id="cfg-Ext.form.DisplayField-validateOnBlur"></div>/** \r
+     * @cfg {Boolean} validateOnBlur \r
+     * @hide\r
+     */\r
+    <div id="cfg-Ext.form.DisplayField-validationDelay"></div>/** \r
+     * @cfg {Number} validationDelay \r
+     * @hide\r
+     */\r
+    <div id="cfg-Ext.form.DisplayField-validationEvent"></div>/** \r
+     * @cfg {String/Boolean} validationEvent \r
+     * @hide\r
+     */\r
+});\r
+\r
+Ext.reg('displayfield', Ext.form.DisplayField);\r
+</pre>    \r
+</body>\r
+</html>
+\ No newline at end of file