Player.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  5. <title>The source code</title>
  6. <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
  7. <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
  8. <style type="text/css">
  9. .highlight { display: block; background-color: #ddd; }
  10. </style>
  11. <script type="text/javascript">
  12. function highlight() {
  13. document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
  14. }
  15. </script>
  16. </head>
  17. <body onload="prettyPrint(); highlight();">
  18. <pre class="prettyprint lang-js"><span id='Ext-ux-event-Player'>/**
  19. </span> * This class manages the playback of an array of &quot;event descriptors&quot;. For details on the
  20. * contents of an &quot;event descriptor&quot;, see {@link Ext.ux.event.Recorder}. The events recorded by the
  21. * {@link Ext.ux.event.Recorder} class are designed to serve as input for this class.
  22. *
  23. * The simplest use of this class is to instantiate it with an {@link #eventQueue} and call
  24. * {@link #method-start}. Like so:
  25. *
  26. * var player = Ext.create('Ext.ux.event.Player', {
  27. * eventQueue: [ ... ],
  28. * speed: 2, // play at 2x speed
  29. * listeners: {
  30. * stop: function () {
  31. * player = null; // all done
  32. * }
  33. * }
  34. * });
  35. *
  36. * player.start();
  37. *
  38. * A more complex use would be to incorporate keyframe generation after playing certain
  39. * events.
  40. *
  41. * var player = Ext.create('Ext.ux.event.Player', {
  42. * eventQueue: [ ... ],
  43. * keyFrameEvents: {
  44. * click: true
  45. * },
  46. * listeners: {
  47. * stop: function () {
  48. * // play has completed... probably time for another keyframe...
  49. * player = null;
  50. * },
  51. * keyframe: onKeyFrame
  52. * }
  53. * });
  54. *
  55. * player.start();
  56. *
  57. * If a keyframe can be handled immediately (synchronously), the listener would be:
  58. *
  59. * function onKeyFrame () {
  60. * handleKeyFrame();
  61. * }
  62. *
  63. * If the keyframe event is always handled asynchronously, then the event listener is only
  64. * a bit more:
  65. *
  66. * function onKeyFrame (p, eventDescriptor) {
  67. * eventDescriptor.defer(); // pause event playback...
  68. *
  69. * handleKeyFrame(function () {
  70. * eventDescriptor.finish(); // ...resume event playback
  71. * });
  72. * }
  73. *
  74. * Finally, if the keyframe could be either handled synchronously or asynchronously (perhaps
  75. * differently by browser), a slightly more complex listener is required.
  76. *
  77. * function onKeyFrame (p, eventDescriptor) {
  78. * var async;
  79. *
  80. * handleKeyFrame(function () {
  81. * // either this callback is being called immediately by handleKeyFrame (in
  82. * // which case async is undefined) or it is being called later (in which case
  83. * // async will be true).
  84. *
  85. * if (async) {
  86. * eventDescriptor.finish();
  87. * } else {
  88. * async = false;
  89. * }
  90. * });
  91. *
  92. * // either the callback was called (and async is now false) or it was not
  93. * // called (and async remains undefined).
  94. *
  95. * if (async !== false) {
  96. * eventDescriptor.defer();
  97. * async = true; // let the callback know that we have gone async
  98. * }
  99. * }
  100. */
  101. Ext.define('Ext.ux.event.Player', {
  102. extend: 'Ext.ux.event.Driver',
  103. <span id='Ext-ux-event-Player-cfg-eventQueue'> /**
  104. </span> * @cfg {Array} eventQueue The event queue to playback. This must be provided before
  105. * the {@link #method-start} method is called.
  106. */
  107. <span id='Ext-ux-event-Player-cfg-keyFrameEvents'> /**
  108. </span> * @cfg {Object} keyFrameEvents An object that describes the events that should generate
  109. * keyframe events. For example, `{ click: true }` would generate keyframe events after
  110. * each `click` event.
  111. */
  112. keyFrameEvents: {
  113. click: true
  114. },
  115. <span id='Ext-ux-event-Player-cfg-pauseForAnimations'> /**
  116. </span> * @cfg {Boolean} pauseForAnimations True to pause event playback during animations, false
  117. * to ignore animations. Default is true.
  118. */
  119. pauseForAnimations: true,
  120. <span id='Ext-ux-event-Player-cfg-speed'> /**
  121. </span> * @cfg {Number} speed The playback speed multiplier. Default is 1.0 (to playback at the
  122. * recorded speed). A value of 2 would playback at 2x speed.
  123. */
  124. speed: 1.0,
  125. stallTime: 0,
  126. tagPathRegEx: /(\w+)(?:\[(\d+)\])?/,
  127. constructor: function (config) {
  128. var me = this;
  129. me.callParent(arguments);
  130. me.addEvents(
  131. <span id='Ext-ux-event-Player-event-beforeplay'> /**
  132. </span> * @event beforeplay
  133. * Fires before an event is played.
  134. * @param {Ext.ux.event.Player} this
  135. * @param {Object} eventDescriptor The event descriptor about to be played.
  136. */
  137. 'beforeplay',
  138. <span id='Ext-ux-event-Player-event-keyframe'> /**
  139. </span> * @event keyframe
  140. * Fires when this player reaches a keyframe. Typically, this is after events
  141. * like `click` are injected and any resulting animations have been completed.
  142. * @param {Ext.ux.event.Player} this
  143. * @param {Object} eventDescriptor The keyframe event descriptor.
  144. */
  145. 'keyframe'
  146. );
  147. me.eventObject = new Ext.EventObjectImpl();
  148. me.timerFn = function () {
  149. me.onTick();
  150. };
  151. me.attachTo = me.attachTo || window;
  152. },
  153. <span id='Ext-ux-event-Player-method-getElementFromXPath'> /**
  154. </span> * Returns the element given is XPath-like description.
  155. * @param {String} xpath The XPath-like description of the element.
  156. * @return {HTMLElement}
  157. */
  158. getElementFromXPath: function (xpath) {
  159. var me = this,
  160. parts = xpath.split('/'),
  161. regex = me.tagPathRegEx,
  162. i, n, m, count, tag, child,
  163. el = me.attachTo.document;
  164. el = (parts[0] == '~') ? el.body
  165. : el.getElementById(parts[0].substring(1)); // remove '#'
  166. for (i = 1, n = parts.length; el &amp;&amp; i &lt; n; ++i) {
  167. m = regex.exec(parts[i]);
  168. count = m[2] ? parseInt(m[2], 10) : 1;
  169. tag = m[1].toUpperCase();
  170. for (child = el.firstChild; child; child = child.nextSibling) {
  171. if (child.tagName == tag) {
  172. if (count == 1) {
  173. break;
  174. }
  175. --count;
  176. }
  177. }
  178. el = child;
  179. }
  180. return el;
  181. },
  182. getTimeIndex: function () {
  183. var t = this.getTimestamp() - this.stallTime;
  184. return t * this.speed;
  185. },
  186. makeToken: function (eventDescriptor, signal) {
  187. var me = this,
  188. t0;
  189. eventDescriptor[signal] = true;
  190. eventDescriptor.defer = function () {
  191. eventDescriptor[signal] = false;
  192. t0 = me.getTime();
  193. };
  194. eventDescriptor.finish = function () {
  195. eventDescriptor[signal] = true;
  196. me.stallTime += me.getTime() - t0;
  197. me.schedule();
  198. };
  199. },
  200. <span id='Ext-ux-event-Player-method-nextEvent'> /**
  201. </span> * This method is called after an event has been played to prepare for the next event.
  202. * @param {Object} eventDescriptor The descriptor of the event just played.
  203. */
  204. nextEvent: function (eventDescriptor) {
  205. var me = this,
  206. index = ++me.queueIndex;
  207. // keyframe events are inserted after a keyFrameEvent is played.
  208. if (me.keyFrameEvents[eventDescriptor.type]) {
  209. Ext.Array.insert(me.eventQueue, index, [
  210. { keyframe: true, ts: eventDescriptor.ts }
  211. ]);
  212. }
  213. },
  214. <span id='Ext-ux-event-Player-method-peekEvent'> /**
  215. </span> * This method returns the event descriptor at the front of the queue. This does not
  216. * dequeue the event. Repeated calls return the same object (until {@link #nextEvent}
  217. * is called).
  218. */
  219. peekEvent: function () {
  220. var me = this,
  221. queue = me.eventQueue,
  222. index = me.queueIndex,
  223. eventDescriptor = queue[index],
  224. type = eventDescriptor &amp;&amp; eventDescriptor.type,
  225. tmp;
  226. if (type == 'mduclick') {
  227. tmp = [
  228. Ext.applyIf({ type: 'mousedown' }, eventDescriptor),
  229. Ext.applyIf({ type: 'mouseup' }, eventDescriptor),
  230. Ext.applyIf({ type: 'click' }, eventDescriptor)
  231. ];
  232. me.replaceEvent(index, tmp);
  233. }
  234. return queue[index] || null;
  235. },
  236. replaceEvent: function (index, events) {
  237. for (var t, i = 0, n = events.length; i &lt; n; ++i) {
  238. if (i) {
  239. t = events[i-1];
  240. delete t.afterplay;
  241. delete t.screenshot;
  242. delete events[i].beforeplay;
  243. }
  244. }
  245. Ext.Array.replace(this.eventQueue, index, 1, events);
  246. },
  247. <span id='Ext-ux-event-Player-method-processEvents'> /**
  248. </span> * This method dequeues and injects events until it has arrived at the time index. If
  249. * no events are ready (based on the time index), this method does nothing.
  250. * @return {Boolean} True if there is more to do; false if not (at least for now).
  251. */
  252. processEvents: function () {
  253. var me = this,
  254. animations = me.pauseForAnimations &amp;&amp; me.attachTo.Ext.fx.Manager.items,
  255. eventDescriptor;
  256. while ((eventDescriptor = me.peekEvent()) !== null) {
  257. if (animations &amp;&amp; animations.getCount()) {
  258. return true;
  259. }
  260. if (eventDescriptor.keyframe) {
  261. if (!me.processKeyFrame(eventDescriptor)) {
  262. return false;
  263. }
  264. me.nextEvent(eventDescriptor);
  265. } else if (eventDescriptor.ts &lt;= me.getTimeIndex() &amp;&amp;
  266. me.fireEvent('beforeplay', me, eventDescriptor) !== false &amp;&amp;
  267. me.playEvent(eventDescriptor)) {
  268. if(window.__x &amp;&amp; eventDescriptor.screenshot) {
  269. __x.poll.sendSyncRequest({cmd: 'screenshot'});
  270. }
  271. me.nextEvent(eventDescriptor);
  272. } else {
  273. return true;
  274. }
  275. }
  276. me.stop();
  277. return false;
  278. },
  279. <span id='Ext-ux-event-Player-method-processKeyFrame'> /**
  280. </span> * This method is called when a keyframe is reached. This will fire the keyframe event.
  281. * If the keyframe has been handled, true is returned. Otherwise, false is returned.
  282. * @param {Object} The event descriptor of the keyframe.
  283. * @return {Boolean} True if the keyframe was handled, false if not.
  284. */
  285. processKeyFrame: function (eventDescriptor) {
  286. var me = this;
  287. // only fire keyframe event (and setup the eventDescriptor) once...
  288. if (!eventDescriptor.defer) {
  289. me.makeToken(eventDescriptor, 'done');
  290. me.fireEvent('keyframe', me, eventDescriptor);
  291. }
  292. return eventDescriptor.done;
  293. },
  294. <span id='Ext-ux-event-Player-method-injectEvent'> /**
  295. </span> * Called to inject the given event on the specified target.
  296. * @param {HTMLElement} target The target of the event.
  297. * @param {Ext.EventObject} The event to inject.
  298. */
  299. injectEvent: function (target, event) {
  300. event.injectEvent(target);
  301. },
  302. playEvent: function (eventDescriptor) {
  303. var me = this,
  304. target = me.getElementFromXPath(eventDescriptor.target),
  305. event;
  306. if (!target) {
  307. // not present (yet)... wait for element present...
  308. // TODO - need a timeout here
  309. return false;
  310. }
  311. if (!me.playEventHook(eventDescriptor, 'beforeplay')) {
  312. return false;
  313. }
  314. if (!eventDescriptor.injected) {
  315. eventDescriptor.injected = true;
  316. event = me.translateEvent(eventDescriptor, target);
  317. me.injectEvent(target, event);
  318. }
  319. return me.playEventHook(eventDescriptor, 'afterplay');
  320. },
  321. playEventHook: function (eventDescriptor, hookName) {
  322. var me = this,
  323. doneName = hookName + '.done',
  324. firedName = hookName + '.fired',
  325. hook = eventDescriptor[hookName];
  326. if (hook &amp;&amp; !eventDescriptor[doneName]) {
  327. if (!eventDescriptor[firedName]) {
  328. eventDescriptor[firedName] = true;
  329. me.makeToken(eventDescriptor, doneName);
  330. me.eventScope[hook](eventDescriptor);
  331. }
  332. return false;
  333. }
  334. return true;
  335. },
  336. schedule: function () {
  337. var me = this;
  338. if (!me.timer) {
  339. me.timer = setTimeout(me.timerFn, 10);
  340. }
  341. },
  342. translateEvent: function (eventDescriptor, target) {
  343. var me = this,
  344. event = me.eventObject,
  345. modKeys = eventDescriptor.modKeys || '',
  346. xy;
  347. if ('x' in eventDescriptor) {
  348. event.xy = xy = Ext.fly(target).getXY();
  349. xy[0] += eventDescriptor.x;
  350. xy[1] += eventDescriptor.y;
  351. }
  352. if ('wheel' in eventDescriptor) {
  353. // see getWheelDelta
  354. }
  355. event.type = eventDescriptor.type;
  356. event.button = eventDescriptor.button;
  357. event.altKey = modKeys.indexOf('A') &gt; 0;
  358. event.ctrlKey = modKeys.indexOf('C') &gt; 0;
  359. event.metaKey = modKeys.indexOf('M') &gt; 0;
  360. event.shiftKey = modKeys.indexOf('S') &gt; 0;
  361. return event;
  362. },
  363. //---------------------------------
  364. // Driver overrides
  365. onStart: function () {
  366. var me = this;
  367. me.queueIndex = 0;
  368. me.schedule();
  369. },
  370. onStop: function () {
  371. var me = this;
  372. if (me.timer) {
  373. clearTimeout(me.timer);
  374. me.timer = null;
  375. }
  376. if (window.__x) {
  377. __x.poll.sendSyncRequest({cmd: 'finish'});
  378. }
  379. },
  380. //---------------------------------
  381. onTick: function () {
  382. var me = this;
  383. me.timer = null;
  384. if (me.processEvents()) {
  385. me.schedule();
  386. }
  387. }
  388. });
  389. </pre>
  390. </body>
  391. </html>