PreloadJS v1.0.0 API Documentation : createjs/events/ErrorEvent.js

API Documentation for: 1.0.0
Show:

File:ErrorEvent.js

  1. /*
  2. * Event
  3. * Visit http://createjs.com/ for documentation, updates and examples.
  4. *
  5. * Copyright (c) 2010 gskinner.com, inc.
  6. *
  7. * Permission is hereby granted, free of charge, to any person
  8. * obtaining a copy of this software and associated documentation
  9. * files (the "Software"), to deal in the Software without
  10. * restriction, including without limitation the rights to use,
  11. * copy, modify, merge, publish, distribute, sublicense, and/or sell
  12. * copies of the Software, and to permit persons to whom the
  13. * Software is furnished to do so, subject to the following
  14. * conditions:
  15. *
  16. * The above copyright notice and this permission notice shall be
  17. * included in all copies or substantial portions of the Software.
  18. *
  19. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  20. * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  21. * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  22. * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  23. * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  24. * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  25. * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  26. * OTHER DEALINGS IN THE SOFTWARE.
  27. */
  28.  
  29. /**
  30. * @module CreateJS
  31. */
  32.  
  33. // namespace:
  34. this.createjs = this.createjs||{};
  35.  
  36. (function() {
  37. "use strict";
  38.  
  39. /**
  40. * A general error {{#crossLink "Event"}}{{/crossLink}}, that describes an error that occurred, as well as any details.
  41. * @class ErrorEvent
  42. * @param {String} [title] The error title
  43. * @param {String} [message] The error description
  44. * @param {Object} [data] Additional error data
  45. * @constructor
  46. */
  47. function ErrorEvent(title, message, data) {
  48. this.Event_constructor("error");
  49.  
  50. /**
  51. * The short error title, which indicates the type of error that occurred.
  52. * @property title
  53. * @type String
  54. */
  55. this.title = title;
  56.  
  57. /**
  58. * The verbose error message, containing details about the error.
  59. * @property message
  60. * @type String
  61. */
  62. this.message = message;
  63.  
  64. /**
  65. * Additional data attached to an error.
  66. * @property data
  67. * @type {Object}
  68. */
  69. this.data = data;
  70. }
  71.  
  72. var p = createjs.extend(ErrorEvent, createjs.Event);
  73.  
  74. p.clone = function() {
  75. return new createjs.ErrorEvent(this.title, this.message, this.data);
  76. };
  77.  
  78. createjs.ErrorEvent = createjs.promote(ErrorEvent, "Event");
  79.  
  80. }());