Upgrade to ExtJS 3.0.3 - Released 10/11/2009
[extjs.git] / docs / source / Error.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="method-Ext.Element-handleError"></div>/**
15  * Framework-wide error-handler.  Developers can override this method to provide
16  * custom exception-handling.  Framework errors will often extend from the base
17  * Ext.Error class.
18  * @param {Object/Error} e The thrown exception object.
19  */
20 Ext.handleError = function(e) {
21     throw e;
22 };
23
24 <div id="cls-Ext.Error"></div>/**
25  * @class Ext.Error
26  * @extends Error
27  * <p>A base error class. Future implementations are intended to provide more
28  * robust error handling throughout the framework (<b>in the debug build only</b>)
29  * to check for common errors and problems. The messages issued by this class
30  * will aid error checking. Error checks will be automatically removed in the
31  * production build so that performance is not negatively impacted.</p>
32  * <p>Some sample messages currently implemented:</p><pre>
33 "DataProxy attempted to execute an API-action but found an undefined
34 url / function. Please review your Proxy url/api-configuration."
35  * </pre><pre>
36 "Could not locate your "root" property in your server response.
37 Please review your JsonReader config to ensure the config-property
38 "root" matches the property your server-response.  See the JsonReader
39 docs for additional assistance."
40  * </pre>
41  * <p>An example of the code used for generating error messages:</p><pre><code>
42 try {
43     generateError({
44         foo: 'bar'
45     });
46 }
47 catch (e) {
48     console.error(e);
49 }
50 function generateError(data) {
51     throw new Ext.Error('foo-error', data);
52 }
53  * </code></pre>
54  * @param {String} message
55  */
56 Ext.Error = function(message) {
57     // Try to read the message from Ext.Error.lang
58     this.message = (this.lang[message]) ? this.lang[message] : message;
59 }
60 Ext.Error.prototype = new Error();
61 Ext.apply(Ext.Error.prototype, {
62     // protected.  Extensions place their error-strings here.
63     lang: {},
64
65     name: 'Ext.Error',
66     <div id="method-Ext.Error-getName"></div>/**
67      * getName
68      * @return {String}
69      */
70     getName : function() {
71         return this.name;
72     },
73     <div id="method-Ext.Error-getMessage"></div>/**
74      * getMessage
75      * @return {String}
76      */
77     getMessage : function() {
78         return this.message;
79     },
80     <div id="method-Ext.Error-toJson"></div>/**
81      * toJson
82      * @return {String}
83      */
84     toJson : function() {
85         return Ext.encode(this);
86     }
87 });
88
89 </pre>
90 </body>
91 </html>