addon-sdk/source/lib/sdk/deprecated/events/assembler.js

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/addon-sdk/source/lib/sdk/deprecated/events/assembler.js	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,52 @@
     1.4 +/* This Source Code Form is subject to the terms of the Mozilla Public
     1.5 + * License, v. 2.0. If a copy of the MPL was not distributed with this
     1.6 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
     1.7 +
     1.8 +"use strict";
     1.9 +
    1.10 +const { Trait } = require("../light-traits");
    1.11 +const { removeListener, on } = require("../../dom/events");
    1.12 +
    1.13 +/**
    1.14 + * Trait may be used for building objects / composing traits that wish to handle
    1.15 + * multiple dom events from multiple event targets in one place. Event targets
    1.16 + * can be added / removed by calling `observe / ignore` methods. Composer should
    1.17 + * provide array of event types it wishes to handle as property
    1.18 + * `supportedEventsTypes` and function for handling all those events as
    1.19 + * `handleEvent` property.
    1.20 + */
    1.21 +exports.DOMEventAssembler = Trait({
    1.22 +  /**
    1.23 +   * Function that is supposed to handle all the supported events (that are
    1.24 +   * present in the `supportedEventsTypes`) from all the observed
    1.25 +   * `eventTargets`.
    1.26 +   * @param {Event} event
    1.27 +   *    Event being dispatched.
    1.28 +   */
    1.29 +  handleEvent: Trait.required,
    1.30 +  /**
    1.31 +   * Array of supported event names.
    1.32 +   * @type {String[]}
    1.33 +   */
    1.34 +  supportedEventsTypes: Trait.required,
    1.35 +  /**
    1.36 +   * Adds `eventTarget` to the list of observed `eventTarget`s. Listeners for
    1.37 +   * supported events will be registered on the given `eventTarget`.
    1.38 +   * @param {EventTarget} eventTarget
    1.39 +   */
    1.40 +  observe: function observe(eventTarget) {
    1.41 +    this.supportedEventsTypes.forEach(function(eventType) {
    1.42 +      on(eventTarget, eventType, this);
    1.43 +    }, this);
    1.44 +  },
    1.45 +  /**
    1.46 +   * Removes `eventTarget` from the list of observed `eventTarget`s. Listeners
    1.47 +   * for all supported events will be unregistered from the given `eventTarget`.
    1.48 +   * @param {EventTarget} eventTarget
    1.49 +   */
    1.50 +  ignore: function ignore(eventTarget) {
    1.51 +    this.supportedEventsTypes.forEach(function(eventType) {
    1.52 +      removeListener(eventTarget, eventType, this);
    1.53 +    }, this);
    1.54 +  }
    1.55 +});

mercurial