summaryrefslogtreecommitdiff
path: root/horizon/static/framework/widgets/table/hz-select-all.directive.js
blob: cb1a1ca521a099f4ac54430d5b22368ea03a99cc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/*
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
(function() {
  'use strict';

  angular
    .module('horizon.framework.widgets.table')
    .directive('hzSelectAll', hzSelectAll);

  hzSelectAll.$inject = [
    'horizon.framework.widgets.table.events'
  ];

  /**
   * @ngdoc directive
   * @name horizon.framework.widgets.table.directive:hzSelectAll
   * @element input type='checkbox'
   * @description
   * The `hzSelectAll` directive updates the checkbox selection state of
   * every row in the table. Assign this as an attribute to a checkbox
   * input element, passing in the displayed row collection data.
   *
   * Required: Use `st-table` attribute to pass in the displayed
   * row collection and `st-safe-src` attribute to pass in the
   * safe row collection.
   *
   * Define a `ng-model` attribute on the individual row checkboxes
   * so that they will be updated when the select all checkbox is
   * clicked. The `hzTable` controller `tCtrl` provides a `selections` object
   * which stores the checked state of the row.
   *
   * @restrict A
   * @scope
   * @example
   *
   * ```
   * <thead>
   *   <th>
   *     <input type='checkbox' hz-select-all='displayedCollection'/>
   *   </th>
   * </thead>
   * <tbody>
   * <tr ng-repeat="row in displayedCollection">
   *   <td>
   *     <input type='checkbox' hz-select='row'
   *       ng-model='tCtrl.selections[row.id].checked'/>
   *   </td>
   * </tr>
   * </tbody>
   * ```
   *
   * To clear all of the selected checkboxes after an action, such as
   * delete, emit the event `hzTable:clearSelected` from your table
   * controller.
   *
   */
  function hzSelectAll(events) {
    var directive = {
      restrict: 'A',
      require: [ '^hzTable', '^stTable' ],
      scope: {
        rows: '=hzSelectAll'
      },
      link: link
    };
    return directive;

    ///////////////////

    function link(scope, element, attrs, ctrls) {
      var hzTableCtrl = ctrls[0];
      var stTableCtrl = ctrls[1];

      element.on('click', clickHandler);

      /*
       * watch the table state for changes
       * on sort, filter and pagination
       */
      var unWatchTableState = scope.$watch(function() {
        return stTableCtrl.tableState();
      },
        updateSelectAll,
        true
      );

      // watch the row length for add/removed rows
      var unWatchRowsLength = scope.$watch('rows.length', updateSelectAll);

      // watch for row selection
      var unWatchRowSelected = scope.$on(events.ROW_SELECTED, updateSelectAll);

      // deregister $watch, $on on destroy
      scope.$on('$destroy', function () {
        unWatchTableState();
        unWatchRowsLength();
        unWatchRowSelected();
      });

      // select or unselect all
      function clickHandler() {
        scope.$apply(function() {
          scope.$evalAsync(function() {
            var checkedState = element.prop('checked');
            angular.forEach(scope.rows, function(row) {
              var selected = hzTableCtrl.isSelected(row);
              if (selected !== checkedState) {
                hzTableCtrl.toggleSelect(row, checkedState);
              }
            });
          });
        });
      }

      /*
       * update the select all checkbox when table
       * state changes (sort, filter, paginate)
       */
      function updateSelectAll() {
        var visibleRows = scope.rows;
        var numVisibleRows = visibleRows.length;
        var checkedCnt = visibleRows.filter(hzTableCtrl.isSelected).length;
        element.prop('checked', numVisibleRows > 0 && numVisibleRows === checkedCnt);
      }
    }
  }
})();