Marionette JS Client

API Docs for: 1.7.1
Show:

File: lib/marionette/multi-actions.js

  1. (function(module, ns) {

  3.   /**
  4.    * For a multifinger gesture, we can use MultiActions.
  5.    * For example, one finger to hold down
  6.    * while the other finger moves from one element to another.
  7.    *
  8.    * @class Marionette.MultiActions
  9.    * @param {Marionette.Client} context of a client.
  10.    */
  11.   function MultiActions(client) {
  12.     this.client = client;
  13.     this.multiActions = [];
  14.     this.maxLength = 0;
  15.   }

  17.   MultiActions.prototype = {

  19.     /**
  20.      * Adds a action chain for execution.
  21.      *
  22.      * @method add
  23.      * @param {Object} action {{#crossLink "Marionette.Actions"}}{{/crossLink}}.
  24.      *
  25.      * @return {Object} self.
  26.      */
  27.     add: function add(action) {
  28.       this.multiActions.push(action.actionChain);
  29.       if (action.actionChain.length > this.maxLength) {
  30.         this.maxLength = action.actionChain.length;
  31.       }
  32.       return this;
  33.     },

  35.     /**
  36.      * Send multiple action chains that have been added
  37.      * to the server side for execution.
  38.      *
  39.      * @method perform
  40.      * @param {Function} callback callback when the perform completes.
  41.      */
  42.     perform: function perform(callback) {
  43.       var cmd = {
  44.         type: 'multiAction',
  45.         value: this.multiActions,
  46.         max_length: this.maxLength
  47.       };

  49.       this.client._sendCommand(cmd, 'ok', callback);
  50.       this.multiActions = [];
  51.       return this;
  52.     }
  53.   };

  55.   module.exports = MultiActions;

  57. }.apply(
  58.   this,
  59.   (this.Marionette) ?
  60.     [Marionette('multi-actions'), Marionette] :
  61.     [module, require('../../lib/marionette/marionette')]
  62. ));

  64.