ole/build/service/storage.js

OpenLayers Editor

import Service from './service';
/**
 * OLE storage service.
 * Base class for storage services,
 * such as LocalStorage, PermalinkStorage, CookieStorage.
 * @alias ole.service.Storage
 */
export default class Storage extends Service {
    /**
     * Saves control properties.
     * @param {object} [options] Service options
     * @param {array.<ol.control.Control>} [controls] List of controls.
     *  If undefined, all controls of the editor are used.
     */
    constructor(optOptions) {
        const options = optOptions || {};
        super();
        /**
         * List of service controls
         * @type {array.<ol.control.Control>}
         * @private
         */
        this.controls = options.controls;
        /**
         * List of properties keys to ignore.
         * @type {array.<string>}
         */
        this.ignoreKeys = ['title', 'image', 'className'];
    }
    /**
     * @inheritdoc
     */
    activate() {
        super.activate();
        this.controls = this.controls || this.editor.getControls().getArray();
        this.restoreProperties();
        this.restoreActiveControls();
        this.controls.forEach((control) => {
            control.addEventListener('propertychange', (evt) => {
                this.storeProperties(evt.detail.control.getProperties().title, evt.detail.properties);
            });
            control.addEventListener('change:active', () => {
                this.storeActiveControls();
            });
        });
    }
    /**
     * @inheritdoc
     */
    deactivate() {
        super.deactivate();
        this.controls.forEach((control) => {
            control.removeEventListener('propertychange');
        });
    }
    /**
     * Store control properties.
     * @param {string} controlName Name of the control.
     * @param {object} properties Control properties.
     */
    storeProperties(controlName, properties) {
        const storageProps = {};
        const propKeys = Object.keys(properties);
        for (let i = 0; i < propKeys.length; i += 1) {
            const key = propKeys[i];
            if (this.ignoreKeys.indexOf(key) === -1 &&
                !(properties[key] instanceof Object)) {
                storageProps[key] = properties[key];
            }
        }
        return storageProps;
    }
    /**
     * Restore the control properties.
     */
    // eslint-disable-next-line class-methods-use-this
    restoreProperties() {
        // to be implemented by child class
    }
    /**
     * Store the active state of controls.
     */
    storeActiveControls() {
        const activeControls = this.editor.getActiveControls();
        return activeControls.getArray().map((c) => c.getProperties().title);
    }
    /**
     * Restore the active state of the controls.
     */
    // eslint-disable-next-line class-methods-use-this
    restoreActiveControls() {
        // to be implemented by child class
    }
}