add extjs 6.0.1 sources

[extjs.git] / extjs / classic / classic / src / layout / SizeModel.js

/**\r
 * This class describes a size determination strategy or algorithm used by the layout\r
 * system. There are special instances of this class stored as static properties to\r
 * avoid needless object instantiation. These instances should be treated as readonly.\r
 * \r
 *  * `calculated`\r
 *  * `configured`\r
 *  * `constrainedMax`\r
 *  * `constrainedMin`\r
 *  * `natural`\r
 *  * `shrinkWrap`\r
 *  * `calculatedFromConfigured`\r
 *  * `calculatedFromNatural`\r
 *  * `calculatedFromShrinkWrap`\r
 *\r
 * Using one of these instances is simply:\r
 *\r
 *       var calculated = Ext.layout.SizeModel.calculated;\r
 *\r
 * @private\r
 */\r
Ext.define('Ext.layout.SizeModel', {\r
    constructor: function (config) {\r
        var me = this,\r
            SizeModel = me.self,\r
            sizeModelsArray = SizeModel.sizeModelsArray,\r
            name;\r
\r
        Ext.apply(me, config);\r
\r
        me[name = me.name] = true; // set the one special flag that matches our name\r
\r
        me.fixed = !(me.auto = me.natural || me.shrinkWrap);\r
\r
        /**\r
         * @property {Number} ordinal\r
         * The 0-based ordinal for this `SizeModel` instance.\r
         * @readonly\r
         */\r
        sizeModelsArray[me.ordinal = sizeModelsArray.length] =\r
            SizeModel[name] =\r
            SizeModel.sizeModels[name] = me;\r
    },\r
\r
    statics: {\r
        /**\r
         * An array of all SizeModel instances.\r
         * @private\r
         */\r
        sizeModelsArray: [],\r
\r
        /**\r
         * An object containing all SizeModel instances keyed by `name`.\r
         * @private\r
         */\r
        sizeModels: {}\r
    },\r
\r
    /**\r
     * @property {String} name\r
     * The name of this size model (e.g., "calculated").\r
     * @readonly\r
     */\r
\r
    /**\r
     * @property {Boolean} auto\r
     * True if the size is either `natural` or `shrinkWrap`, otherwise false.\r
     * @readonly\r
     */\r
\r
    /**\r
     * @property {Boolean} calculated\r
     * True if the size is calculated by the `ownerLayout`.\r
     * @readonly\r
     */\r
    calculated: false,\r
\r
    /**\r
     * @property {Boolean} configured\r
     * True if the size is configured (e.g., by a `width` or `minWidth`). The names of\r
     * configuration properties can be found in the {@link #names} property.\r
     * @readonly\r
     */\r
    configured: false,\r
\r
    /**\r
     * @property {Boolean} constrainedMax\r
     * True if the size is constrained by a `maxWidth` or `maxHeight` configuration. This\r
     * is a flavor of `configured` (since `maxWidth` and `maxHeight` are config options).\r
     * If true, the {@link #names} property will be defined as well.\r
     * @readonly\r
     */\r
    constrainedMax: false,\r
\r
    /**\r
     * @property {Boolean} constrainedMin\r
     * True if the size is constrained by a `minWidth` or `minHeight` configuration. This\r
     * is a flavor of `configured` (since `minWidth` and `minHeight` are config options).\r
     * If true, the {@link #names} property will be defined as well.\r
     * @readonly\r
     */\r
    constrainedMin: false,\r
\r
    /**\r
     * @property {Boolean} fixed\r
     * True if the size is either `calculated` or `configured`, otherwise false.\r
     * @readonly\r
     */\r
\r
    /**\r
     * @property {Boolean} natural\r
     * True if the size is determined by CSS and not by content. Such sizes are assumed to\r
     * be dependent on the container box and measurement occurs on the outer-most element.\r
     * @readonly\r
     */\r
    natural: false,\r
\r
    /**\r
     * @property {Boolean} shrinkWrap\r
     * True if the size is determined by content irrespective of the container box.\r
     * @readonly\r
     */\r
    shrinkWrap: false,\r
\r
    /**\r
     * @property {Boolean} calculatedFromConfigured\r
     * True if the size is calculated by the `ownerLayout` based on a configured size.\r
     * @readonly\r
     */\r
    calculatedFromConfigured: false,\r
\r
    /**\r
     * @property {Boolean} calculatedFromNatural\r
     * True if the size is calculated by the `ownerLayout` based on `natural` size model\r
     * results.\r
     * @readonly\r
     */\r
    calculatedFromNatural: false,\r
\r
    /**\r
     * @property {Boolean} calculatedFromShrinkWrap\r
     * True if the size is calculated by the `ownerLayout` based on `shrinkWrap` size model\r
     * results.\r
     * @readonly\r
     */\r
    calculatedFromShrinkWrap: false,\r
\r
    /**\r
     * @property {Object} names An object with the config property names that determine the\r
     * size.\r
     * @property {String} names.width The width property name (e.g., 'width').\r
     * @property {String} names.height The height property name (e.g., 'minHeight').\r
     * @readonly\r
     */\r
    names: null\r
},\r
function () {\r
    var SizeModel = this,\r
        sizeModelsArray = SizeModel.sizeModelsArray,\r
        i, j, n, pairs, sizeModel;\r
\r
    //-------------------------------------------------------------------------------\r
    // These are the 4 fundamental size models.\r
\r
    new SizeModel({ // jshint ignore:line\r
        name: 'calculated'\r
    });\r
\r
    new SizeModel({ // jshint ignore:line\r
        name: 'configured',\r
        names: { width: 'width', height: 'height' }\r
    });\r
\r
    new SizeModel({ // jshint ignore:line\r
        name: 'natural'\r
    });\r
\r
    new SizeModel({ // jshint ignore:line\r
        name: 'shrinkWrap'\r
    });\r
\r
    //-------------------------------------------------------------------------------\r
    // These are the size models are flavors of the above but with some extra detail\r
    // about their dynamic use.\r
\r
    new SizeModel({ // jshint ignore:line\r
        name: 'calculatedFromConfigured',\r
        configured: true,\r
        calculatedFrom: true,\r
        names: { width: 'width', height: 'height' }\r
    });\r
\r
    new SizeModel({ // jshint ignore:line\r
        name: 'calculatedFromNatural',\r
        natural: true,\r
        calculatedFrom: true\r
    });\r
\r
    new SizeModel({ // jshint ignore:line\r
        name: 'calculatedFromShrinkWrap',\r
        shrinkWrap: true,\r
        calculatedFrom: true\r
    });\r
\r
    new SizeModel({ // jshint ignore:line\r
        name: 'constrainedMax',\r
        configured: true,\r
        constrained: true,\r
        names: { width: 'maxWidth', height: 'maxHeight' }\r
    });\r
\r
    new SizeModel({ // jshint ignore:line\r
        name: 'constrainedMin',\r
        configured: true,\r
        constrained: true,\r
        names: { width: 'minWidth', height: 'minHeight' }\r
    });\r
\r
    new SizeModel({ // jshint ignore:line\r
        name: 'constrainedDock',\r
        configured: true,\r
        constrained: true,\r
        constrainedByMin: true,\r
        names: { width: 'dockConstrainedWidth', height: 'dockConstrainedHeight' }\r
    });\r
\r
    for (i = 0, n = sizeModelsArray.length; i < n; ++i) {\r
        sizeModel = sizeModelsArray[i];\r
\r
        /**\r
         * An array of objects indexed by the {@link #ordinal} of a height `SizeModel` on\r
         * a width `SizeModel` to yield an object describing both height and width size\r
         * models.\r
         * \r
         * Used like this:\r
         *\r
         *      widthModel.pairsByHeightOrdinal[heightModel.ordinal]\r
         *\r
         * This provides a reusable object equivalent to the following:\r
         * \r
         *      {\r
         *          width: widthModel,\r
         *          height: heightModel\r
         *      }\r
         *\r
         * @property {Object[]} pairsByHeightOrdinal\r
         * @property {Ext.layout.SizeModel} pairsByHeightOrdinal.width The `SizeModel` for\r
         * the width.\r
         * @property {Ext.layout.SizeModel} pairsByHeightOrdinal.height The `SizeModel` for\r
         * the height.\r
         */\r
        sizeModel.pairsByHeightOrdinal = pairs = [];\r
\r
        for (j = 0; j < n; ++j) {\r
            pairs.push({\r
                width: sizeModel,\r
                height: sizeModelsArray[j]\r
            });\r
        }\r
    }\r
});\r