add extjs 6.0.1 sources

[extjs.git] / extjs / classic / classic / src / util / Memento.js

/**\r
 * @class Ext.util.Memento\r
 * This class manages a set of captured properties from an object. These captured properties\r
 * can later be restored to an object.\r
 */\r
Ext.define('Ext.util.Memento', (function () {\r
\r
    function captureOne (src, target, prop, prefix) {\r
        src[prefix ? prefix + prop : prop] = target[prop];\r
    }\r
\r
    function removeOne (src, target, prop) {\r
        delete src[prop];\r
    }\r
\r
    function restoreOne (src, target, prop, prefix) {\r
        var name = prefix ? prefix + prop : prop,\r
            value = src[name];\r
\r
        if (value || src.hasOwnProperty(name)) {\r
            restoreValue(target, prop, value);\r
        }\r
    }\r
\r
    function restoreValue (target, prop, value) {\r
        if (Ext.isDefined(value)) {\r
            target[prop] = value;\r
        } else {\r
            delete target[prop];\r
        }\r
    }\r
\r
    function doMany (doOne, src, target, props, prefix) {\r
        if (src) {\r
            if (Ext.isArray(props)) {\r
                var p, pLen = props.length;\r
                for (p = 0; p < pLen; p++) {\r
                    doOne(src, target, props[p], prefix);\r
                }\r
            } else {\r
                doOne(src, target, props, prefix);\r
            }\r
        }\r
    }\r
\r
    return {\r
        /**\r
         * @property data\r
         * The collection of captured properties.\r
         * @private\r
         */\r
        data: null,\r
\r
        /**\r
         * @property target\r
         * The default target object for capture/restore (passed to the constructor).\r
         */\r
        target: null,\r
\r
        /**\r
         * Creates a new memento and optionally captures properties from the target object.\r
         * @param {Object} target The target from which to capture properties. If specified in the\r
         * constructor, this target becomes the default target for all other operations.\r
         * @param {String/String[]} props The property or array of properties to capture.\r
         */\r
        constructor: function (target, props) {\r
            this.data = {};\r
\r
            if (target) {\r
                this.target = target;\r
                if (props) {\r
                    this.capture(props);\r
                }\r
            }\r
        },\r
\r
        /**\r
         * Captures the specified properties from the target object in this memento.\r
         * @param {String/String[]} props The property or array of properties to capture.\r
         * @param {Object} target The object from which to capture properties.\r
         */\r
        capture: function (props, target, prefix) {\r
            var me = this;\r
            doMany(captureOne, me.data || (me.data = {}), target || me.target, props, prefix);\r
        },\r
\r
        /**\r
         * Removes the specified properties from this memento. These properties will not be\r
         * restored later without re-capturing their values.\r
         * @param {String/String[]} props The property or array of properties to remove.\r
         */\r
        remove: function (props) {\r
            doMany(removeOne, this.data, null, props);\r
        },\r
\r
        /**\r
         * Restores the specified properties from this memento to the target object.\r
         * @param {String/String[]} props The property or array of properties to restore.\r
         * @param {Boolean} clear True to remove the restored properties from this memento or\r
         * false to keep them (default is true).\r
         * @param {Object} target The object to which to restore properties.\r
         */\r
        restore: function (props, clear, target, prefix) {\r
            doMany(restoreOne, this.data, target || this.target, props, prefix);\r
            if (clear !== false) {\r
                this.remove(props);\r
            }\r
        },\r
\r
        /**\r
         * Restores all captured properties in this memento to the target object.\r
         * @param {Boolean} clear True to remove the restored properties from this memento or\r
         * false to keep them (default is true).\r
         * @param {Object} target The object to which to restore properties.\r
         */\r
        restoreAll: function (clear, target) {\r
            var me   = this,\r
                t    = target || this.target,\r
                data = me.data,\r
                prop;\r
\r
            clear = clear !== false;\r
\r
            for (prop in data) {\r
                if (data.hasOwnProperty(prop)) {\r
                    restoreValue(t, prop, data[prop]);\r
                    if (clear) {\r
                        delete data[prop];\r
                    }\r
                }\r
            }\r
\r
        }\r
    };\r
}()));\r