src/cm/media/js/lib/yui/yui3-3.15.0/build/widget-parent/widget-parent.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('widget-parent', 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
 * Extension enabling a Widget to be a parent of another Widget.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     5
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     6
 * @module widget-parent
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     7
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     8
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     9
var Lang = Y.Lang,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    10
    RENDERED = "rendered",
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    11
    BOUNDING_BOX = "boundingBox";
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    12
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    13
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    14
 * Widget extension providing functionality enabling a Widget to be a
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    15
 * parent of another Widget.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    16
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    17
 * <p>In addition to the set of attributes supported by WidgetParent, the constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    18
 * configuration object can also contain a <code>children</code> which can be used
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    19
 * to add child widgets to the parent during construction. The <code>children</code>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    20
 * property is an array of either child widget instances or child widget configuration
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    21
 * objects, and is sugar for the <a href="#method_add">add</a> method. See the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    22
 * <a href="#method_add">add</a> for details on the structure of the child widget
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    23
 * configuration object.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    24
 * @class WidgetParent
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    25
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    26
 * @uses ArrayList
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    27
 * @param {Object} config User configuration object.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    28
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    29
function Parent(config) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    30
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    31
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    32
    * Fires when a Widget is add as a child.  The event object will have a
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    33
    * 'child' property that returns a reference to the child Widget, as well
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    34
    * as an 'index' property that returns a reference to the index specified
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    35
    * when the add() method was called.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    36
    * <p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    37
    * Subscribers to the "on" moment of this event, will be notified
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    38
    * before a child is added.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    39
    * </p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    40
    * <p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    41
    * Subscribers to the "after" moment of this event, will be notified
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    42
    * after a child is added.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    43
    * </p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    44
    *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    45
    * @event addChild
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    46
    * @preventable _defAddChildFn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    47
    * @param {EventFacade} e The Event Facade
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    48
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    49
    this.publish("addChild", {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    50
        defaultTargetOnly: true,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    51
        defaultFn: this._defAddChildFn
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
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    55
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    56
    * Fires when a child Widget is removed.  The event object will have a
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    57
    * 'child' property that returns a reference to the child Widget, as well
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    58
    * as an 'index' property that returns a reference child's ordinal position.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    59
    * <p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    60
    * Subscribers to the "on" moment of this event, will be notified
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    61
    * before a child is removed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    62
    * </p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    63
    * <p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    64
    * Subscribers to the "after" moment of this event, will be notified
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    65
    * after a child is removed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    66
    * </p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    67
    *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    68
    * @event removeChild
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    69
    * @preventable _defRemoveChildFn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    70
    * @param {EventFacade} e The Event Facade
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    71
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    72
    this.publish("removeChild", {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    73
        defaultTargetOnly: true,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    74
        defaultFn: this._defRemoveChildFn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    75
    });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    76
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    77
    this._items = [];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    78
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    79
    var children,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    80
        handle;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    81
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    82
    if (config && config.children) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    83
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    84
        children = config.children;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    85
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    86
        handle = this.after("initializedChange", function (e) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    87
            this._add(children);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    88
            handle.detach();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    89
        });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    90
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    91
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    92
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    93
    //  Widget method overlap
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    94
    Y.after(this._renderChildren, this, "renderUI");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    95
    Y.after(this._bindUIParent, this, "bindUI");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    96
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    97
    this.after("selectionChange", this._afterSelectionChange);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    98
    this.after("selectedChange", this._afterParentSelectedChange);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    99
    this.after("activeDescendantChange", this._afterActiveDescendantChange);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   100
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   101
    this._hDestroyChild = this.after("*:destroy", this._afterDestroyChild);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   102
    this.after("*:focusedChange", this._updateActiveDescendant);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   103
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   104
}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   105
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   106
Parent.ATTRS = {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   107
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   108
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   109
     * @attribute defaultChildType
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   110
     * @type {String|Object}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   111
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   112
     * @description String representing the default type of the children
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   113
     * managed by this Widget.  Can also supply default type as a constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   114
     * reference.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   115
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   116
    defaultChildType: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   117
        setter: function (val) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   118
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   119
            var returnVal = Y.Attribute.INVALID_VALUE,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   120
                FnConstructor = Lang.isString(val) ? Y[val] : val;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   121
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   122
            if (Lang.isFunction(FnConstructor)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   123
                returnVal = FnConstructor;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   124
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   125
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   126
            return returnVal;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   127
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   128
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   129
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   130
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   131
     * @attribute activeDescendant
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   132
     * @type Widget
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   133
     * @readOnly
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   134
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   135
     * @description Returns the Widget's currently focused descendant Widget.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   136
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   137
    activeDescendant: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   138
        readOnly: true
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   139
    },
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
     * @attribute multiple
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   143
     * @type Boolean
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   144
     * @default false
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   145
     * @writeOnce
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   146
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   147
     * @description Boolean indicating if multiple children can be selected at
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   148
     * once.  Whether or not multiple selection is enabled is always delegated
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   149
     * to the value of the <code>multiple</code> attribute of the root widget
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   150
     * in the object hierarchy.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   151
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   152
    multiple: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   153
        value: false,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   154
        validator: Lang.isBoolean,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   155
        writeOnce: true,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   156
        getter: function (value) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   157
            var root = this.get("root");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   158
            return (root && root != this) ? root.get("multiple") : value;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   159
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   160
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   161
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   162
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   163
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   164
     * @attribute selection
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   165
     * @type {ArrayList|Widget}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   166
     * @readOnly
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   167
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   168
     * @description Returns the currently selected child Widget.  If the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   169
     * <code>mulitple</code> attribte is set to <code>true</code> will
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   170
     * return an Y.ArrayList instance containing the currently selected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   171
     * children.  If no children are selected, will return null.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   172
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   173
    selection: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   174
        readOnly: true,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   175
        setter: "_setSelection",
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   176
        getter: function (value) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   177
            var selection = Lang.isArray(value) ?
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   178
                    (new Y.ArrayList(value)) : value;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   179
            return selection;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   180
        }
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
    selected: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   184
        setter: function (value) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   185
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   186
            //  Enforces selection behavior on for parent Widgets.  Parent's
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   187
            //  selected attribute can be set to the following:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   188
            //  0 - Not selected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   189
            //  1 - Fully selected (all children are selected).  In order for
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   190
            //  all children to be selected, multiple selection must be
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   191
            //  enabled.  Therefore, you cannot set the "selected" attribute
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   192
            //  on a parent Widget to 1 unless multiple selection is enabled.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   193
            //  2 - Partially selected, meaning one ore more (but not all)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   194
            //  children are selected.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   195
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   196
            var returnVal = value;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   197
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   198
            if (value === 1 && !this.get("multiple")) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   199
                returnVal = Y.Attribute.INVALID_VALUE;
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
            return returnVal;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   203
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   204
    }
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
Parent.prototype = {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   209
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   210
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   211
     * The destructor implementation for Parent widgets. Destroys all children.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   212
     * @method destructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   213
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   214
    destructor: function() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   215
        this._destroyChildren();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   216
    },
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
     * Destroy event listener for each child Widget, responsible for removing
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   220
     * the destroyed child Widget from the parent's internal array of children
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   221
     * (_items property).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   222
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   223
     * @method _afterDestroyChild
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   224
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   225
     * @param {EventFacade} event The event facade for the attribute change.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   226
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   227
    _afterDestroyChild: function (event) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   228
        var child = event.target;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   229
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   230
        if (child.get("parent") == this) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   231
            child.remove();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   232
        }
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
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   236
     * Attribute change listener for the <code>selection</code>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   237
     * attribute, responsible for setting the value of the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   238
     * parent's <code>selected</code> attribute.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   239
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   240
     * @method _afterSelectionChange
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   241
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   242
     * @param {EventFacade} event The event facade for the attribute change.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   243
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   244
    _afterSelectionChange: function (event) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   245
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   246
        if (event.target == this && event.src != this) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   247
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   248
            var selection = event.newVal,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   249
                selectedVal = 0;    //  Not selected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   250
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   251
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   252
            if (selection) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   253
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   254
                selectedVal = 2;    //  Assume partially selected, confirm otherwise
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   255
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   256
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   257
                if (Y.instanceOf(selection, Y.ArrayList) &&
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   258
                    (selection.size() === this.size())) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   259
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   260
                    selectedVal = 1;    //  Fully selected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   261
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   262
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   263
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   264
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   265
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   266
            this.set("selected", selectedVal, { src: this });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   267
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   268
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   269
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   270
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   271
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   272
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   273
     * Attribute change listener for the <code>activeDescendant</code>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   274
     * attribute, responsible for setting the value of the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   275
     * parent's <code>activeDescendant</code> attribute.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   276
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   277
     * @method _afterActiveDescendantChange
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   278
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   279
     * @param {EventFacade} event The event facade for the attribute change.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   280
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   281
    _afterActiveDescendantChange: function (event) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   282
        var parent = this.get("parent");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   283
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   284
        if (parent) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   285
            parent._set("activeDescendant", event.newVal);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   286
        }
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
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   290
     * Attribute change listener for the <code>selected</code>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   291
     * attribute, responsible for syncing the selected state of all children to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   292
     * match that of their parent Widget.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   293
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   294
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   295
     * @method _afterParentSelectedChange
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   296
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   297
     * @param {EventFacade} event The event facade for the attribute change.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   298
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   299
    _afterParentSelectedChange: function (event) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   300
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   301
        var value = event.newVal;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   302
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   303
        if (this == event.target && event.src != this &&
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   304
            (value === 0 || value === 1)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   305
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   306
            this.each(function (child) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   307
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   308
                //  Specify the source of this change as the parent so that
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   309
                //  value of the parent's "selection" attribute isn't
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   310
                //  recalculated
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   311
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   312
                child.set("selected", value, { src: this });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   313
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   314
            }, this);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   315
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   316
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   317
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   318
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   319
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   320
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   321
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   322
     * Default setter for <code>selection</code> attribute changes.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   323
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   324
     * @method _setSelection
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   325
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   326
     * @param child {Widget|Array} Widget or Array of Widget instances.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   327
     * @return {Widget|Array} Widget or Array of Widget instances.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   328
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   329
    _setSelection: function (child) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   330
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   331
        var selection = null,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   332
            selected;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   333
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   334
        if (this.get("multiple") && !this.isEmpty()) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   335
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   336
            selected = [];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   337
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   338
            this.each(function (v) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   339
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   340
               if (v.get("selected") > 0) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   341
                   selected.push(v);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   342
               }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   343
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   344
            });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   345
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   346
            if (selected.length > 0) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   347
                selection = selected;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   348
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   349
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   350
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   351
        else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   352
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   353
            if (child.get("selected") > 0) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   354
                selection = child;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   355
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   356
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   357
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   358
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   359
        return selection;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   360
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   361
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   362
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   363
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   364
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   365
     * Attribute change listener for the <code>selected</code>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   366
     * attribute of child Widgets, responsible for setting the value of the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   367
     * parent's <code>selection</code> attribute.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   368
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   369
     * @method _updateSelection
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   370
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   371
     * @param {EventFacade} event The event facade for the attribute change.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   372
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   373
    _updateSelection: function (event) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   374
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   375
        var child = event.target,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   376
            selection;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   377
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   378
        if (child.get("parent") == this) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   379
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   380
            if (event.src != "_updateSelection") {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   381
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   382
                selection = this.get("selection");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   383
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   384
                if (!this.get("multiple") && selection && event.newVal > 0) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   385
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   386
                    //  Deselect the previously selected child.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   387
                    //  Set src equal to the current context to prevent
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   388
                    //  unnecessary re-calculation of the selection.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   389
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   390
                    selection.set("selected", 0, { src: "_updateSelection" });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   391
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   392
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   393
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   394
                this._set("selection", child);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   395
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   396
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   397
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   398
            if (event.src == this) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   399
                this._set("selection", child, { src: this });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   400
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   401
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   402
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   403
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   404
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   405
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   406
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   407
     * Attribute change listener for the <code>focused</code>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   408
     * attribute of child Widgets, responsible for setting the value of the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   409
     * parent's <code>activeDescendant</code> attribute.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   410
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   411
     * @method _updateActiveDescendant
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   412
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   413
     * @param {EventFacade} event The event facade for the attribute change.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   414
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   415
    _updateActiveDescendant: function (event) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   416
        var activeDescendant = (event.newVal === true) ? event.target : null;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   417
        this._set("activeDescendant", activeDescendant);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   418
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   419
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   420
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   421
     * Creates an instance of a child Widget using the specified configuration.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   422
     * By default Widget instances will be created of the type specified
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   423
     * by the <code>defaultChildType</code> attribute.  Types can be explicitly
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   424
     * defined via the <code>childType</code> property of the configuration object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   425
     * literal. The use of the <code>type</code> property has been deprecated, but
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   426
     * will still be used as a fallback, if <code>childType</code> is not defined,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   427
     * for backwards compatibility.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   428
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   429
     * @method _createChild
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   430
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   431
     * @param config {Object} Object literal representing the configuration
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   432
     * used to create an instance of a Widget.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   433
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   434
    _createChild: function (config) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   435
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   436
        var defaultType = this.get("defaultChildType"),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   437
            altType = config.childType || config.type,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   438
            child,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   439
            Fn,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   440
            FnConstructor;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   441
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   442
        if (altType) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   443
            Fn = Lang.isString(altType) ? Y[altType] : altType;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   444
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   445
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   446
        if (Lang.isFunction(Fn)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   447
            FnConstructor = Fn;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   448
        } else if (defaultType) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   449
            // defaultType is normalized to a function in it's setter
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   450
            FnConstructor = defaultType;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   451
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   452
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   453
        if (FnConstructor) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   454
            child = new FnConstructor(config);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   455
        } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   456
            Y.error("Could not create a child instance because its constructor is either undefined or invalid.");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   457
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   458
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   459
        return child;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   460
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   461
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   462
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   463
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   464
     * Default addChild handler
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   465
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   466
     * @method _defAddChildFn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   467
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   468
     * @param event {EventFacade} The Event object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   469
     * @param child {Widget} The Widget instance, or configuration
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   470
     * object for the Widget to be added as a child.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   471
     * @param index {Number} Number representing the position at
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   472
     * which the child will be inserted.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   473
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   474
    _defAddChildFn: function (event) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   475
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   476
        var child = event.child,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   477
            index = event.index,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   478
            children = this._items;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   479
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   480
        if (child.get("parent")) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   481
            child.remove();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   482
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   483
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   484
        if (Lang.isNumber(index)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   485
            children.splice(index, 0, child);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   486
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   487
        else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   488
            children.push(child);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   489
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   490
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   491
        child._set("parent", this);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   492
        child.addTarget(this);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   493
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   494
        // Update index in case it got normalized after addition
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   495
        // (e.g. user passed in 10, and there are only 3 items, the actual index would be 3. We don't want to pass 10 around in the event facade).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   496
        event.index = child.get("index");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   497
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   498
        //  TO DO: Remove in favor of using event bubbling
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   499
        child.after("selectedChange", Y.bind(this._updateSelection, this));
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   500
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   501
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   502
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   503
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   504
     * Default removeChild handler
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   505
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   506
     * @method _defRemoveChildFn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   507
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   508
     * @param event {EventFacade} The Event object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   509
     * @param child {Widget} The Widget instance to be removed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   510
     * @param index {Number} Number representing the index of the Widget to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   511
     * be removed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   512
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   513
    _defRemoveChildFn: function (event) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   514
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   515
        var child = event.child,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   516
            index = event.index,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   517
            children = this._items;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   518
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   519
        if (child.get("focused")) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   520
            child.blur(); // focused is readOnly, so use the public i/f to unset it
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   521
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   522
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   523
        if (child.get("selected")) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   524
            child.set("selected", 0);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   525
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   526
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   527
        children.splice(index, 1);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   528
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   529
        child.removeTarget(this);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   530
        child._oldParent = child.get("parent");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   531
        child._set("parent", null);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   532
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   533
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   534
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   535
    * @method _add
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   536
    * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   537
    * @param child {Widget|Object} The Widget instance, or configuration
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   538
    * object for the Widget to be added as a child.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   539
    * @param child {Array} Array of Widget instances, or configuration
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   540
    * objects for the Widgets to be added as a children.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   541
    * @param index {Number} (Optional.)  Number representing the position at
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   542
    * which the child should be inserted.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   543
    * @description Adds a Widget as a child.  If the specified Widget already
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   544
    * has a parent it will be removed from its current parent before
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   545
    * being added as a child.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   546
    * @return {Widget|Array} Successfully added Widget or Array containing the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   547
    * successfully added Widget instance(s). If no children where added, will
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   548
    * will return undefined.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   549
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   550
    _add: function (child, index) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   551
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   552
        var children,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   553
            oChild,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   554
            returnVal;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   555
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   556
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   557
        if (Lang.isArray(child)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   558
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   559
            children = [];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   560
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   561
            Y.each(child, function (v, k) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   562
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   563
                oChild = this._add(v, (index + k));
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   564
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   565
                if (oChild) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   566
                    children.push(oChild);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   567
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   568
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   569
            }, this);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   570
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   571
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   572
            if (children.length > 0) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   573
                returnVal = children;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   574
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   575
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   576
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   577
        else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   578
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   579
            if (Y.instanceOf(child, Y.Widget)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   580
                oChild = child;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   581
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   582
            else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   583
                oChild = this._createChild(child);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   584
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   585
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   586
            if (oChild && this.fire("addChild", { child: oChild, index: index })) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   587
                returnVal = oChild;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   588
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   589
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   590
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   591
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   592
        return returnVal;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   593
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   594
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   595
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   596
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   597
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   598
    * @method add
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   599
    * @param child {Widget|Object} The Widget instance, or configuration
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   600
    * object for the Widget to be added as a child. The configuration object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   601
    * for the child can include a <code>childType</code> property, which is either
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   602
    * a constructor function or a string which names a constructor function on the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   603
    * Y instance (e.g. "Tab" would refer to Y.Tab) (<code>childType</code> used to be
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   604
    * named <code>type</code>, support for which has been deprecated, but is still
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   605
    * maintained for backward compatibility. <code>childType</code> takes precedence
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   606
    * over <code>type</code> if both are defined.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   607
    * @param child {Array} Array of Widget instances, or configuration
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   608
    * objects for the Widgets to be added as a children.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   609
    * @param index {Number} (Optional.)  Number representing the position at
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   610
    * which the child should be inserted.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   611
    * @description Adds a Widget as a child.  If the specified Widget already
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   612
    * has a parent it will be removed from its current parent before
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   613
    * being added as a child.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   614
    * @return {ArrayList} Y.ArrayList containing the successfully added
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   615
    * Widget instance(s).  If no children where added, will return an empty
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   616
    * Y.ArrayList instance.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   617
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   618
    add: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   619
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   620
        var added = this._add.apply(this, arguments),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   621
            children = added ? (Lang.isArray(added) ? added : [added]) : [];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   622
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   623
        return (new Y.ArrayList(children));
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   624
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   625
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   626
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   627
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   628
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   629
    * @method remove
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   630
    * @param index {Number} (Optional.)  Number representing the index of the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   631
    * child to be removed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   632
    * @description Removes the Widget from its parent.  Optionally, can remove
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   633
    * a child by specifying its index.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   634
    * @return {Widget} Widget instance that was successfully removed, otherwise
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   635
    * undefined.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   636
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   637
    remove: function (index) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   638
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   639
        var child = this._items[index],
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   640
            returnVal;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   641
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   642
        if (child && this.fire("removeChild", { child: child, index: index })) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   643
            returnVal = child;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   644
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   645
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   646
        return returnVal;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   647
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   648
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   649
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   650
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   651
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   652
    * @method removeAll
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   653
    * @description Removes all of the children from the Widget.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   654
    * @return {ArrayList} Y.ArrayList instance containing Widgets that were
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   655
    * successfully removed.  If no children where removed, will return an empty
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   656
    * Y.ArrayList instance.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   657
    */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   658
    removeAll: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   659
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   660
        var removed = [],
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   661
            child;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   662
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   663
        Y.each(this._items.concat(), function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   664
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   665
            child = this.remove(0);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   666
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   667
            if (child) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   668
                removed.push(child);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   669
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   670
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   671
        }, this);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   672
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   673
        return (new Y.ArrayList(removed));
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   674
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   675
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   676
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   677
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   678
     * Selects the child at the given index (zero-based).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   679
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   680
     * @method selectChild
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   681
     * @param {Number} i the index of the child to be selected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   682
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   683
    selectChild: function(i) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   684
        this.item(i).set('selected', 1);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   685
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   686
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   687
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   688
     * Selects all children.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   689
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   690
     * @method selectAll
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   691
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   692
    selectAll: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   693
        this.set("selected", 1);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   694
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   695
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   696
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   697
     * Deselects all children.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   698
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   699
     * @method deselectAll
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   700
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   701
    deselectAll: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   702
        this.set("selected", 0);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   703
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   704
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   705
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   706
     * Updates the UI in response to a child being added.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   707
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   708
     * @method _uiAddChild
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   709
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   710
     * @param child {Widget} The child Widget instance to render.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   711
     * @param parentNode {Object} The Node under which the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   712
     * child Widget is to be rendered.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   713
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   714
    _uiAddChild: function (child, parentNode) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   715
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   716
        child.render(parentNode);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   717
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   718
        // TODO: Ideally this should be in Child's render UI.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   719
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   720
        var childBB = child.get("boundingBox"),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   721
            siblingBB,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   722
            nextSibling = child.next(false),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   723
            prevSibling;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   724
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   725
        // Insert or Append to last child.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   726
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   727
        // Avoiding index, and using the current sibling
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   728
        // state (which should be accurate), means we don't have
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   729
        // to worry about decorator elements which may be added
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   730
        // to the _childContainer node.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   731
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   732
        if (nextSibling && nextSibling.get(RENDERED)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   733
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   734
            siblingBB = nextSibling.get(BOUNDING_BOX);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   735
            siblingBB.insert(childBB, "before");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   736
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   737
        } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   738
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   739
            prevSibling = child.previous(false);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   740
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   741
            if (prevSibling && prevSibling.get(RENDERED)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   742
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   743
                siblingBB = prevSibling.get(BOUNDING_BOX);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   744
                siblingBB.insert(childBB, "after");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   745
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   746
            } else if (!parentNode.contains(childBB)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   747
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   748
                // Based on pull request from andreas-karlsson
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   749
                // https://github.com/yui/yui3/pull/25#issuecomment-2103536
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   750
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   751
                // Account for case where a child was rendered independently of the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   752
                // parent-child framework, to a node outside of the parentNode,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   753
                // and there are no siblings.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   754
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   755
                parentNode.appendChild(childBB);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   756
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   757
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   758
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   759
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   760
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   761
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   762
     * Updates the UI in response to a child being removed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   763
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   764
     * @method _uiRemoveChild
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   765
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   766
     * @param child {Widget} The child Widget instance to render.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   767
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   768
    _uiRemoveChild: function (child) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   769
        child.get("boundingBox").remove();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   770
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   771
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   772
    _afterAddChild: function (event) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   773
        var child = event.child;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   774
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   775
        if (child.get("parent") == this) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   776
            this._uiAddChild(child, this._childrenContainer);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   777
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   778
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   779
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   780
    _afterRemoveChild: function (event) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   781
        var child = event.child;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   782
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   783
        if (child._oldParent == this) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   784
            this._uiRemoveChild(child);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   785
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   786
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   787
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   788
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   789
     * Sets up DOM and CustomEvent listeners for the parent widget.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   790
     * <p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   791
     * This method in invoked after bindUI is invoked for the Widget class
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   792
     * using YUI's aop infrastructure.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   793
     * </p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   794
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   795
     * @method _bindUIParent
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   796
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   797
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   798
    _bindUIParent: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   799
        this.after("addChild", this._afterAddChild);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   800
        this.after("removeChild", this._afterRemoveChild);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   801
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   802
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   803
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   804
     * Renders all child Widgets for the parent.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   805
     * <p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   806
     * This method in invoked after renderUI is invoked for the Widget class
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   807
     * using YUI's aop infrastructure.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   808
     * </p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   809
     * @method _renderChildren
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   810
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   811
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   812
    _renderChildren: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   813
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   814
        /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   815
         * <p>By default WidgetParent will render it's children to the parent's content box.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   816
         *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   817
         * <p>If the children need to be rendered somewhere else, the _childrenContainer property
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   818
         * can be set to the Node which the children should be rendered to. This property should be
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   819
         * set before the _renderChildren method is invoked, ideally in your renderUI method,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   820
         * as soon as you create the element to be rendered to.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   821
         *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   822
         * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   823
         * @property _childrenContainer
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   824
         * @value The content box
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   825
         * @type Node
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   826
         */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   827
        var renderTo = this._childrenContainer || this.get("contentBox");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   828
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   829
        this._childrenContainer = renderTo;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   830
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   831
        this.each(function (child) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   832
            child.render(renderTo);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   833
        });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   834
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   835
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   836
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   837
     * Destroys all child Widgets for the parent.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   838
     * <p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   839
     * This method is invoked before the destructor is invoked for the Widget
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   840
     * class using YUI's aop infrastructure.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   841
     * </p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   842
     * @method _destroyChildren
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   843
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   844
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   845
    _destroyChildren: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   846
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   847
        //  Detach the handler responsible for removing children in
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   848
        //  response to destroying them since:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   849
        //  1)  It is unnecessary/inefficient at this point since we are doing
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   850
        //      a batch destroy of all children.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   851
        //  2)  Removing each child will affect our ability to iterate the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   852
        //      children since the size of _items will be changing as we
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   853
        //      iterate.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   854
        this._hDestroyChild.detach();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   855
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   856
        //  Need to clone the _items array since
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   857
        this.each(function (child) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   858
            child.destroy();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   859
        });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   860
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   861
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   862
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   863
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   864
Y.augment(Parent, Y.ArrayList);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   865
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   866
Y.WidgetParent = Parent;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   867
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   868
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   869
}, '@VERSION@', {"requires": ["arraylist", "base-build", "widget"]});