add extjs 6.0.1 sources

[extjs.git] / extjs / packages / charts / src / chart / MarkerHolder.js

/**\r
 * Mixin that provides the functionality to place markers.\r
 */\r
Ext.define('Ext.chart.MarkerHolder', {\r
    extend: 'Ext.Mixin',\r
\r
    mixinConfig: {\r
        id: 'markerHolder',\r
        after: {\r
            constructor: 'constructor',\r
            preRender: 'preRender'\r
        },\r
        before: {\r
            destroy: 'destroy'\r
        }\r
    },\r
\r
    isMarkerHolder: true,\r
\r
    // The combined transformation applied to the sprite by its parents.\r
    // Does not include the transformation matrix of the sprite itself.\r
    surfaceMatrix: null,\r
    // The inverse of the above transformation to go back to the original state.\r
    inverseSurfaceMatrix: null,\r
\r
    deprecated: {\r
        6: {\r
            methods: {\r
                /**\r
                 * Returns the markers bound to the given name.\r
                 * @param {String} name The name of the marker (e.g., "items", "labels", etc.).\r
                 * @return {Ext.chart.Markers[]}\r
                 * @method getBoundMarker\r
                 * @deprecated 6.0 Use {@link #getMarker} instead.\r
                 */\r
                getBoundMarker: {\r
                    message: "Please use the 'getMarker' method instead.",\r
                    fn: function (name) {\r
                        var marker = this.boundMarkers[name];\r
                        return marker ? [marker] : marker;\r
                    }\r
                }\r
            }\r
        }\r
    },\r
\r
    constructor: function () {\r
        this.boundMarkers = {};\r
        this.cleanRedraw = false;\r
    },\r
\r
    /**\r
     * Registers the given marker with the marker holder under the specified name.\r
     * @param {String} name The name of the marker (e.g., "items", "labels", etc.).\r
     * @param {Ext.chart.Markers} marker\r
     */\r
    bindMarker: function (name, marker) {\r
        var me = this,\r
            markers = me.boundMarkers;\r
\r
        if (marker && marker.isMarkers) {\r
            //<debug>\r
            if (markers[name] && markers[name] === marker) {\r
                Ext.log.warn(me.getId(), " (MarkerHolder): the Markers instance '", marker.getId(), "' is already bound under the name '", name, "'.");\r
            }\r
            //</debug>\r
            me.releaseMarker(name);\r
            markers[name] = marker;\r
            marker.on('destroy', me.onMarkerDestroy, me);\r
        }\r
    },\r
\r
    onMarkerDestroy: function (marker) {\r
        this.releaseMarker(marker);\r
    },\r
\r
    /**\r
     * Unregisters the given marker or a marker with the given name.\r
     * Providing a name of the marker is more efficient as it avoids lookup.\r
     * @param marker {String/Ext.chart.Markers}\r
     * @return {Ext.chart.Markers} Released marker or null.\r
     */\r
    releaseMarker: function (marker) {\r
        var markers = this.boundMarkers,\r
            name;\r
\r
        if (marker && marker.isMarkers) {\r
            for (name in markers) {\r
                if (markers[name] === marker) {\r
                    delete markers[name];\r
                    break;\r
                }\r
            }\r
        } else {\r
            name = marker;\r
            marker = markers[name];\r
            delete markers[name];\r
        }\r
\r
        return marker || null;\r
    },\r
\r
    /**\r
     * Returns the marker bound to the given name (or null). See {@link #bindMarker}.\r
     * @param {String} name The name of the marker (e.g., "items", "labels", etc.).\r
     * @return {Ext.chart.Markers}\r
     */\r
    getMarker: function (name) {\r
        return this.boundMarkers[name] || null;\r
    },\r
\r
    preRender: function () {\r
        var me = this,\r
            id = me.getId(),\r
            boundMarkers = me.boundMarkers,\r
            parent = me.getParent(),\r
            name, marker,\r
            matrix;\r
\r
        if (me.surfaceMatrix) {\r
            matrix = me.surfaceMatrix.set(1, 0, 0, 1, 0, 0);\r
        } else {\r
            matrix = me.surfaceMatrix = new Ext.draw.Matrix();\r
        }\r
\r
        me.cleanRedraw = !me.attr.dirty;\r
        if (!me.cleanRedraw) {\r
            for (name in boundMarkers) {\r
                marker = boundMarkers[name];\r
                if (marker) {\r
                    marker.clear(id);\r
                }\r
            }\r
        }\r
\r
        // Parent can be either a sprite (like a composite or instancing)\r
        // or a surface. First, climb up and apply transformations of the\r
        // parent sprites.\r
        while (parent && parent.attr && parent.attr.matrix) {\r
            matrix.prependMatrix(parent.attr.matrix);\r
            parent = parent.getParent();\r
        }\r
        // Finally, apply the transformation used by the surface.\r
        matrix.prependMatrix(parent.matrix);\r
        me.surfaceMatrix = matrix;\r
        me.inverseSurfaceMatrix = matrix.inverse(me.inverseSurfaceMatrix);\r
    },\r
\r
    putMarker: function (name, attr, index, bypassNormalization, keepRevision) {\r
        var marker = this.boundMarkers[name],\r
            id = this.getId();\r
\r
        if (marker) {\r
            marker.putMarkerFor(id, attr, index, bypassNormalization, keepRevision);\r
        }\r
    },\r
\r
    getMarkerBBox: function (name, index, isWithoutTransform) {\r
        var marker = this.boundMarkers[name],\r
            id = this.getId();\r
\r
        if (marker) {\r
            return marker.getMarkerBBoxFor(id, index, isWithoutTransform);\r
        }\r
    },\r
\r
    destroy: function () {\r
        var boundMarkers = this.boundMarkers,\r
            name, marker;\r
\r
        for (name in boundMarkers) {\r
            marker = boundMarkers[name];\r
            marker.destroy();\r
        }\r
    }\r
\r
});\r