EventManager.html 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: EventManager</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Class: EventManager</h1>
  17. <section>
  18. <header>
  19. <h2><span class="attribs"><span class="type-signature"></span></span>EventManager<span class="signature">()</span><span class="type-signature"></span></h2>
  20. </header>
  21. <article>
  22. <div class="container-overview">
  23. <h4 class="name" id="EventManager"><span class="type-signature"></span>new EventManager<span class="signature">()</span><span class="type-signature"></span></h4>
  24. <div class="description">
  25. EventManager is used to manager DOM events creationg and destruction in a single function call. It is used by objects to make it easier to add and remove events from global DOM objects.
  26. </div>
  27. <dl class="details">
  28. <dt class="tag-source">Source:</dt>
  29. <dd class="tag-source"><ul class="dummy"><li>
  30. <a href="EventManager.js.html">EventManager.js</a>, <a href="EventManager.js.html#line10">line 10</a>
  31. </li></ul></dd>
  32. </dl>
  33. </div>
  34. <h3 class="subsection-title">Members</h3>
  35. <h4 class="name" id="events"><span class="type-signature"></span>events<span class="type-signature"> :Array</span></h4>
  36. <div class="description">
  37. Stores all events in the manager, their target and callback. Format [target, event, callback, active]
  38. </div>
  39. <h5>Type:</h5>
  40. <ul>
  41. <li>
  42. <span class="param-type">Array</span>
  43. </li>
  44. </ul>
  45. <dl class="details">
  46. <dt class="tag-source">Source:</dt>
  47. <dd class="tag-source"><ul class="dummy"><li>
  48. <a href="EventManager.js.html">EventManager.js</a>, <a href="EventManager.js.html#line19">line 19</a>
  49. </li></ul></dd>
  50. </dl>
  51. <h3 class="subsection-title">Methods</h3>
  52. <h4 class="name" id="add"><span class="type-signature"></span>add<span class="signature">(target, event, callback)</span><span class="type-signature"></span></h4>
  53. <div class="description">
  54. Add new event to the manager.
  55. </div>
  56. <h5>Parameters:</h5>
  57. <table class="params">
  58. <thead>
  59. <tr>
  60. <th>Name</th>
  61. <th>Type</th>
  62. <th class="last">Description</th>
  63. </tr>
  64. </thead>
  65. <tbody>
  66. <tr>
  67. <td class="name"><code>target</code></td>
  68. <td class="type">
  69. <span class="param-type"><a href="DOM.html">DOM</a></span>
  70. </td>
  71. <td class="description last">Event target element.</td>
  72. </tr>
  73. <tr>
  74. <td class="name"><code>event</code></td>
  75. <td class="type">
  76. <span class="param-type">String</span>
  77. </td>
  78. <td class="description last">Event name.</td>
  79. </tr>
  80. <tr>
  81. <td class="name"><code>callback</code></td>
  82. <td class="type">
  83. <span class="param-type">function</span>
  84. </td>
  85. <td class="description last">Callback function.</td>
  86. </tr>
  87. </tbody>
  88. </table>
  89. <dl class="details">
  90. <dt class="tag-source">Source:</dt>
  91. <dd class="tag-source"><ul class="dummy"><li>
  92. <a href="EventManager.js.html">EventManager.js</a>, <a href="EventManager.js.html#line29">line 29</a>
  93. </li></ul></dd>
  94. </dl>
  95. <h4 class="name" id="clear"><span class="type-signature"></span>clear<span class="signature">()</span><span class="type-signature"></span></h4>
  96. <div class="description">
  97. Destroys this manager and remove all events.
  98. </div>
  99. <dl class="details">
  100. <dt class="tag-source">Source:</dt>
  101. <dd class="tag-source"><ul class="dummy"><li>
  102. <a href="EventManager.js.html">EventManager.js</a>, <a href="EventManager.js.html#line37">line 37</a>
  103. </li></ul></dd>
  104. </dl>
  105. <h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">()</span><span class="type-signature"></span></h4>
  106. <div class="description">
  107. Creates all events in this manager.
  108. </div>
  109. <dl class="details">
  110. <dt class="tag-source">Source:</dt>
  111. <dd class="tag-source"><ul class="dummy"><li>
  112. <a href="EventManager.js.html">EventManager.js</a>, <a href="EventManager.js.html#line46">line 46</a>
  113. </li></ul></dd>
  114. </dl>
  115. <h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span><span class="type-signature"></span></h4>
  116. <div class="description">
  117. Removes all events in this manager.
  118. </div>
  119. <dl class="details">
  120. <dt class="tag-source">Source:</dt>
  121. <dd class="tag-source"><ul class="dummy"><li>
  122. <a href="EventManager.js.html">EventManager.js</a>, <a href="EventManager.js.html#line59">line 59</a>
  123. </li></ul></dd>
  124. </dl>
  125. </article>
  126. </section>
  127. </div>
  128. <nav>
  129. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BezierCurve.html">BezierCurve</a></li><li><a href="Box.html">Box</a></li><li><a href="Box2.html">Box2</a></li><li><a href="BoxMask.html">BoxMask</a></li><li><a href="Circle.html">Circle</a></li><li><a href="DOM.html">DOM</a></li><li><a href="EventManager.html">EventManager</a></li><li><a href="Graph.html">Graph</a></li><li><a href="Helpers.html">Helpers</a></li><li><a href="Image.html">Image</a></li><li><a href="Key.html">Key</a></li><li><a href="Line.html">Line</a></li><li><a href="Mask.html">Mask</a></li><li><a href="Matrix.html">Matrix</a></li><li><a href="Object2D.html">Object2D</a></li><li><a href="Pattern.html">Pattern</a></li><li><a href="Pointer.html">Pointer</a></li><li><a href="Renderer.html">Renderer</a></li><li><a href="Text.html">Text</a></li><li><a href="UUID.html">UUID</a></li><li><a href="Vector2.html">Vector2</a></li><li><a href="Viewport.html">Viewport</a></li><li><a href="ViewportControls.html">ViewportControls</a></li></ul>
  130. </nav>
  131. <br class="clear">
  132. <footer>
  133. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Thu Jun 13 2019 09:46:06 GMT+0100 (Western European Summer Time)
  134. </footer>
  135. <script> prettyPrint(); </script>
  136. <script src="scripts/linenumber.js"> </script>
  137. </body>
  138. </html>