mkdocs-material/src/assets/javascripts/components/Material/Sidebar/Abstract.js

/*
 * Copyright (c) 2016 Martin Donath <martin.donath@squidfunk.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

/* ----------------------------------------------------------------------------
 * Definition
 * ------------------------------------------------------------------------- */

export default class Abstract {

  /**
   * Dispatch update on next repaint
   *
   * @constructor
   */
  constructor() {
    if (this === Abstract)
      throw new TypeError("Cannot construct abstract instance")

    /* Dispatch update on next repaint */
    this.handler_ = ev => {
      window.requestAnimationFrame(() => {
        this.update(ev)
      })
    }
  }

  /**
   * Update state
   *
   * @abstract
   */
  update() {
    throw new Error("update(): not implemented")
  }

  /**
   * Reset state
   *
   * @abstract
   */
  reset() {
    throw new Error("reset(): not implemented")
  }

  /**
   * Register listener for all relevant events
   */
  listen() {
    ["scroll", "resize", "orientationchange"].forEach(name => {
      window.addEventListener(name, this.handler_, false)
    })

    /* Initial update */
    this.update()
  }

  /**
   * Unregister listener for all relevant events
   */
  unlisten() {
    ["scroll", "resize", "orientationchange"].forEach(name => {
      window.removeEventListener(name, this.handler_, false)
    })

    /* Final reset */
    this.reset()
  }
}