Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / docs / source / DisplayField.html
1 <html>\r
2 <head>\r
3   <title>The source code</title>\r
4     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
5     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
6 </head>\r
7 <body  onload="prettyPrint();">\r
8     <pre class="prettyprint lang-js"><div id="cls-Ext.form.DisplayField"></div>/**\r
9  * @class Ext.form.DisplayField\r
10  * @extends Ext.form.Field\r
11  * A display-only text field which is not validated and not submitted.\r
12  * @constructor\r
13  * Creates a new DisplayField.\r
14  * @param {Object} config Configuration options\r
15  * @xtype displayfield\r
16  */\r
17 Ext.form.DisplayField = Ext.extend(Ext.form.Field,  {\r
18     validationEvent : false,\r
19     validateOnBlur : false,\r
20     defaultAutoCreate : {tag: "div"},\r
21     <div id="cfg-Ext.form.DisplayField-fieldClass"></div>/**\r
22      * @cfg {String} fieldClass The default CSS class for the field (defaults to <tt>"x-form-display-field"</tt>)\r
23      */\r
24     fieldClass : "x-form-display-field",\r
25     <div id="cfg-Ext.form.DisplayField-htmlEncode"></div>/**\r
26      * @cfg {Boolean} htmlEncode <tt>false</tt> to skip HTML-encoding the text when rendering it (defaults to\r
27      * <tt>false</tt>). This might be useful if you want to include tags in the field's innerHTML rather than\r
28      * rendering them as string literals per the default logic.\r
29      */\r
30     htmlEncode: false,\r
31 \r
32     // private\r
33     initEvents : Ext.emptyFn,\r
34 \r
35     isValid : function(){\r
36         return true;\r
37     },\r
38 \r
39     validate : function(){\r
40         return true;\r
41     },\r
42 \r
43     getRawValue : function(){\r
44         var v = this.rendered ? this.el.dom.innerHTML : Ext.value(this.value, '');\r
45         if(v === this.emptyText){\r
46             v = '';\r
47         }\r
48         if(this.htmlEncode){\r
49             v = Ext.util.Format.htmlDecode(v);\r
50         }\r
51         return v;\r
52     },\r
53 \r
54     getValue : function(){\r
55         return this.getRawValue();\r
56     },\r
57     \r
58     getName: function() {\r
59         return this.name;\r
60     },\r
61 \r
62     setRawValue : function(v){\r
63         if(this.htmlEncode){\r
64             v = Ext.util.Format.htmlEncode(v);\r
65         }\r
66         return this.rendered ? (this.el.dom.innerHTML = (Ext.isEmpty(v) ? '' : v)) : (this.value = v);\r
67     },\r
68 \r
69     setValue : function(v){\r
70         this.setRawValue(v);\r
71         return this;\r
72     }\r
73     <div id="cfg-Ext.form.DisplayField-inputType"></div>/** \r
74      * @cfg {String} inputType \r
75      * @hide\r
76      */\r
77     <div id="cfg-Ext.form.DisplayField-disabled"></div>/** \r
78      * @cfg {Boolean} disabled \r
79      * @hide\r
80      */\r
81     <div id="cfg-Ext.form.DisplayField-readOnly"></div>/** \r
82      * @cfg {Boolean} readOnly \r
83      * @hide\r
84      */\r
85     <div id="cfg-Ext.form.DisplayField-validateOnBlur"></div>/** \r
86      * @cfg {Boolean} validateOnBlur \r
87      * @hide\r
88      */\r
89     <div id="cfg-Ext.form.DisplayField-validationDelay"></div>/** \r
90      * @cfg {Number} validationDelay \r
91      * @hide\r
92      */\r
93     <div id="cfg-Ext.form.DisplayField-validationEvent"></div>/** \r
94      * @cfg {String/Boolean} validationEvent \r
95      * @hide\r
96      */\r
97 });\r
98 \r
99 Ext.reg('displayfield', Ext.form.DisplayField);\r
100 </pre>    \r
101 </body>\r
102 </html>