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