src/cm/media/js/lib/yui/yui3-3.15.0/build/view-node-map/view-node-map.js
author gibus
Mon, 10 Mar 2014 15:19:48 +0100
changeset 602 e16a97fb364a
permissions -rw-r--r--
Use YUI 3.15
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
602
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     1
YUI.add('view-node-map', function (Y, NAME) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     2
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     3
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     4
View extension that adds a static `getByNode()` method that returns the nearest
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     5
View instance associated with the given Node (similar to Widget's `getByNode()`
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     6
method).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     7
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     8
@module app
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     9
@submodule view-node-map
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    10
@since 3.5.0
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    11
**/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    12
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    13
var buildCfg  = Y.namespace('View._buildCfg'),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    14
    instances = {};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    15
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    16
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    17
View extension that adds a static `getByNode()` method that returns the nearest
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    18
View instance associated with the given Node (similar to Widget's `getByNode()`
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    19
method).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    20
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    21
Note that it's important to call `destroy()` on a View instance using this
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    22
extension when you plan to stop using it. This ensures that all internal
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    23
references to that View are cleared to prevent memory leaks.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    24
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    25
@class View.NodeMap
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    26
@extensionfor View
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    27
@since 3.5.0
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    28
**/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    29
function NodeMap() {}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    30
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    31
// Tells Base.create() to mix the static getByNode method into built classes.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    32
// We're cheating and modifying Y.View here, because right now there's no better
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    33
// way to do it.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    34
buildCfg.aggregates || (buildCfg.aggregates = []);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    35
buildCfg.aggregates.push('getByNode');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    36
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    37
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    38
Returns the nearest View instance associated with the given Node. The Node may
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    39
be a View container or any child of a View container.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    40
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    41
Note that only instances of Views that have the Y.View.NodeMap extension mixed
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    42
in will be returned. The base View class doesn't provide this functionality by
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    43
default due to the additional memory management overhead involved in maintaining
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    44
a mapping of Nodes to View instances.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    45
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    46
@method getByNode
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    47
@param {Node|HTMLElement|String} node Node instance, selector string, or
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    48
    HTMLElement.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    49
@return {View} Closest View instance associated with the given Node, or `null`
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    50
    if no associated View instance was found.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    51
@static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    52
@since 3.5.0
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    53
**/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    54
NodeMap.getByNode = function (node) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    55
    var view;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    56
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    57
    Y.one(node).ancestor(function (ancestor) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    58
        return (view = instances[Y.stamp(ancestor, true)]) || false;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    59
    }, true);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    60
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    61
    return view || null;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    62
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    63
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    64
// To make this testable.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    65
NodeMap._instances = instances;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    66
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    67
NodeMap.prototype = {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    68
    initializer: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    69
        instances[Y.stamp(this.get('container'))] = this;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    70
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    71
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    72
    destructor: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    73
        var stamp = Y.stamp(this.get('container'), true);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    74
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    75
        if (stamp in instances) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    76
            delete instances[stamp];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    77
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    78
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    79
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    80
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    81
Y.View.NodeMap = NodeMap;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    82
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    83
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    84
}, '@VERSION@', {"requires": ["view"]});