src/cm/media/js/lib/yui/yui3-3.15.0/build/tree-selectable/tree-selectable.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('tree-selectable', function (Y, NAME) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     2
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     3
/*jshint expr:true, onevar:false */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     4
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     5
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     6
Extension for `Tree` that adds the concept of selection state for nodes.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     7
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     8
@module tree
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     9
@submodule tree-selectable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    10
@main tree-selectable
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 Do = Y.Do;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    14
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    15
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    16
Extension for `Tree` that adds the concept of selection state for nodes.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    17
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    18
@class Tree.Selectable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    19
@constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    20
@extensionfor Tree
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    21
**/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    22
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    23
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    24
Fired when a node is selected.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    25
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    26
@event select
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    27
@param {Tree.Node} node Node being selected.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    28
@preventable _defSelectFn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    29
**/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    30
var EVT_SELECT = 'select';
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    31
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    32
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    33
Fired when a node is unselected.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    34
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    35
@event unselect
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    36
@param {Tree.Node} node Node being unselected.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    37
@preventable _defUnselectFn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    38
**/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    39
var EVT_UNSELECT = 'unselect';
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    40
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    41
function Selectable() {}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    42
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    43
Selectable.prototype = {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    44
    // -- Protected Properties -------------------------------------------------
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    45
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    46
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    47
    Mapping of node ids to node instances for nodes in this tree that are
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    48
    currently selected.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    49
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    50
    @property {Object} _selectedMap
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    51
    @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    52
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    53
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    54
    // -- Lifecycle ------------------------------------------------------------
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    55
    initializer: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    56
        this.nodeExtensions = this.nodeExtensions.concat(Y.Tree.Node.Selectable);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    57
        this._selectedMap   = {};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    58
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    59
        Do.after(this._selectableAfterDefAddFn, this, '_defAddFn');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    60
        Do.after(this._selectableAfterDefClearFn, this, '_defClearFn');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    61
        Do.after(this._selectableAfterDefRemoveFn, this, '_defRemoveFn');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    62
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    63
        this._selectableEvents = [
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    64
            this.after('multiSelectChange', this._afterMultiSelectChange)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    65
        ];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    66
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    67
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    68
    destructor: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    69
        (new Y.EventHandle(this._selectableEvents)).detach();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    70
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    71
        this._selectableEvents = null;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    72
        this._selectedMap      = null;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    73
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    74
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    75
    // -- Public Methods -------------------------------------------------------
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    76
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    77
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    78
    Returns an array of nodes that are currently selected.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    79
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    80
    @method getSelectedNodes
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    81
    @return {Tree.Node.Selectable[]} Array of selected nodes.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    82
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    83
    getSelectedNodes: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    84
        return Y.Object.values(this._selectedMap);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    85
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    86
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    87
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    88
    Selects the specified node.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    89
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    90
    @method selectNode
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    91
    @param {Tree.Node.Selectable} node Node to select.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    92
    @param {Object} [options] Options.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    93
        @param {Boolean} [options.silent=false] If `true`, the `select` event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    94
            will be suppressed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    95
        @param {String} [options.src] Source of the change, to be passed along
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    96
            to the event facade of the resulting event. This can be used to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    97
            distinguish between changes triggered by a user and changes
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    98
            triggered programmatically, for example.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    99
    @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   100
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   101
    selectNode: function (node, options) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   102
        // Instead of calling node.isSelected(), we look for the node in this
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   103
        // tree's selectedMap, which ensures that the `select` event will fire
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   104
        // in cases such as a node being added to this tree with its selected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   105
        // state already set to true.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   106
        if (!this._selectedMap[node.id]) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   107
            this._fireTreeEvent(EVT_SELECT, {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   108
                node: node,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   109
                src : options && options.src
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   110
            }, {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   111
                defaultFn: this._defSelectFn,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   112
                silent   : options && options.silent
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   113
            });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   114
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   115
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   116
        return this;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   117
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   118
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   119
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   120
    Unselects all selected nodes.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   121
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   122
    @method unselect
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   123
    @param {Object} [options] Options.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   124
        @param {Boolean} [options.silent=false] If `true`, the `unselect` event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   125
            will be suppressed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   126
        @param {String} [options.src] Source of the change, to be passed along
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   127
            to the event facade of the resulting event. This can be used to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   128
            distinguish between changes triggered by a user and changes
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   129
            triggered programmatically, for example.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   130
    @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   131
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   132
    unselect: function (options) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   133
        for (var id in this._selectedMap) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   134
            if (this._selectedMap.hasOwnProperty(id)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   135
                this.unselectNode(this._selectedMap[id], options);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   136
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   137
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   138
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   139
        return this;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   140
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   141
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   142
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   143
    Unselects the specified node.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   144
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   145
    @method unselectNode
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   146
    @param {Tree.Node.Selectable} node Node to unselect.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   147
    @param {Object} [options] Options.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   148
        @param {Boolean} [options.silent=false] If `true`, the `unselect` event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   149
            will be suppressed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   150
        @param {String} [options.src] Source of the change, to be passed along
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   151
            to the event facade of the resulting event. This can be used to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   152
            distinguish between changes triggered by a user and changes
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   153
            triggered programmatically, for example.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   154
    @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   155
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   156
    unselectNode: function (node, options) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   157
        if (node.isSelected() || this._selectedMap[node.id]) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   158
            this._fireTreeEvent(EVT_UNSELECT, {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   159
                node: node,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   160
                src : options && options.src
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   161
            }, {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   162
                defaultFn: this._defUnselectFn,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   163
                silent   : options && options.silent
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   164
            });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   165
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   166
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   167
        return this;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   168
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   169
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   170
    // -- Protected Methods ----------------------------------------------------
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   171
    _selectableAfterDefAddFn: function (e) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   172
        // If the node is marked as selected, we need go through the select
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   173
        // flow.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   174
        if (e.node.isSelected()) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   175
            this.selectNode(e.node);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   176
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   177
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   178
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   179
    _selectableAfterDefClearFn: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   180
        this._selectedMap = {};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   181
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   182
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   183
    _selectableAfterDefRemoveFn: function (e) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   184
        delete e.node.state.selected;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   185
        delete this._selectedMap[e.node.id];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   186
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   187
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   188
    // -- Protected Event Handlers ---------------------------------------------
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   189
    _afterMultiSelectChange: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   190
        this.unselect();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   191
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   192
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   193
    _defSelectFn: function (e) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   194
        if (!this.get('multiSelect')) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   195
            this.unselect();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   196
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   197
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   198
        e.node.state.selected = true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   199
        this._selectedMap[e.node.id] = e.node;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   200
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   201
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   202
    _defUnselectFn: function (e) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   203
        delete e.node.state.selected;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   204
        delete this._selectedMap[e.node.id];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   205
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   206
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   207
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   208
Selectable.ATTRS = {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   209
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   210
    Whether or not to allow multiple nodes to be selected at once.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   211
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   212
    @attribute {Boolean} multiSelect
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   213
    @default false
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   214
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   215
    multiSelect: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   216
        value: false
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   217
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   218
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   219
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   220
Y.Tree.Selectable = Selectable;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   221
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   222
@module tree
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   223
@submodule tree-selectable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   224
**/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   225
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   226
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   227
`Tree.Node` extension that adds methods useful for nodes in trees that use the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   228
`Tree.Selectable` extension.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   229
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   230
@class Tree.Node.Selectable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   231
@constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   232
@extensionfor Tree.Node
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   233
**/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   234
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   235
function NodeSelectable() {}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   236
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   237
NodeSelectable.prototype = {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   238
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   239
    Returns `true` if this node is currently selected.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   240
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   241
    @method isSelected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   242
    @return {Boolean} `true` if this node is currently selected, `false`
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   243
        otherwise.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   244
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   245
    isSelected: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   246
        return !!this.state.selected;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   247
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   248
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   249
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   250
    Selects this node.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   251
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   252
    @method select
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   253
    @param {Object} [options] Options.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   254
        @param {Boolean} [options.silent=false] If `true`, the `select` event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   255
            will be suppressed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   256
        @param {String} [options.src] Source of the change, to be passed along
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   257
            to the event facade of the resulting event. This can be used to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   258
            distinguish between changes triggered by a user and changes
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   259
            triggered programmatically, for example.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   260
    @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   261
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   262
    select: function (options) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   263
        this.tree.selectNode(this, options);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   264
        return this;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   265
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   266
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   267
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   268
    Unselects this node.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   269
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   270
    @method unselect
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   271
    @param {Object} [options] Options.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   272
        @param {Boolean} [options.silent=false] If `true`, the `unselect` event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   273
            will be suppressed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   274
        @param {String} [options.src] Source of the change, to be passed along
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   275
            to the event facade of the resulting event. This can be used to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   276
            distinguish between changes triggered by a user and changes
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   277
            triggered programmatically, for example.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   278
    @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   279
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   280
    unselect: function (options) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   281
        this.tree.unselectNode(this, options);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   282
        return this;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   283
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   284
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   285
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   286
Y.Tree.Node.Selectable = NodeSelectable;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   287
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   288
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   289
}, '@VERSION@', {"requires": ["tree"]});