SelectFilter2.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  1. /*global SelectBox, gettext, interpolate, quickElement, SelectFilter*/
  2. /*
  3. SelectFilter2 - Turns a multiple-select box into a filter interface.
  4. Requires jQuery, core.js, and SelectBox.js.
  5. */
  6. (function($) {
  7. 'use strict';
  8. function findForm(node) {
  9. // returns the node of the form containing the given node
  10. if (node.tagName.toLowerCase() !== 'form') {
  11. return findForm(node.parentNode);
  12. }
  13. return node;
  14. }
  15. window.SelectFilter = {
  16. init: function(field_id, field_name, is_stacked) {
  17. if (field_id.match(/__prefix__/)) {
  18. // Don't initialize on empty forms.
  19. return;
  20. }
  21. var from_box = document.getElementById(field_id);
  22. from_box.id += '_from'; // change its ID
  23. from_box.className = 'filtered';
  24. var ps = from_box.parentNode.getElementsByTagName('p');
  25. for (var i = 0; i < ps.length; i++) {
  26. if (ps[i].className.indexOf("info") !== -1) {
  27. // Remove <p class="info">, because it just gets in the way.
  28. from_box.parentNode.removeChild(ps[i]);
  29. } else if (ps[i].className.indexOf("help") !== -1) {
  30. // Move help text up to the top so it isn't below the select
  31. // boxes or wrapped off on the side to the right of the add
  32. // button:
  33. from_box.parentNode.insertBefore(ps[i], from_box.parentNode.firstChild);
  34. }
  35. }
  36. // <div class="selector"> or <div class="selector stacked">
  37. var selector_div = quickElement('div', from_box.parentNode);
  38. selector_div.className = is_stacked ? 'selector stacked' : 'selector';
  39. // <div class="selector-available">
  40. var selector_available = quickElement('div', selector_div);
  41. selector_available.className = 'selector-available';
  42. var title_available = quickElement('h2', selector_available, interpolate(gettext('Available %s') + ' ', [field_name]));
  43. quickElement(
  44. 'span', title_available, '',
  45. 'class', 'help help-tooltip help-icon',
  46. 'title', interpolate(
  47. gettext(
  48. 'This is the list of available %s. You may choose some by ' +
  49. 'selecting them in the box below and then clicking the ' +
  50. '"Choose" arrow between the two boxes.'
  51. ),
  52. [field_name]
  53. )
  54. );
  55. var filter_p = quickElement('p', selector_available, '', 'id', field_id + '_filter');
  56. filter_p.className = 'selector-filter';
  57. var search_filter_label = quickElement('label', filter_p, '', 'for', field_id + '_input');
  58. quickElement(
  59. 'span', search_filter_label, '',
  60. 'class', 'help-tooltip search-label-icon',
  61. 'title', interpolate(gettext("Type into this box to filter down the list of available %s."), [field_name])
  62. );
  63. filter_p.appendChild(document.createTextNode(' '));
  64. var filter_input = quickElement('input', filter_p, '', 'type', 'text', 'placeholder', gettext("Filter"));
  65. filter_input.id = field_id + '_input';
  66. selector_available.appendChild(from_box);
  67. var choose_all = quickElement('a', selector_available, gettext('Choose all'), 'title', interpolate(gettext('Click to choose all %s at once.'), [field_name]), 'href', '#', 'id', field_id + '_add_all_link');
  68. choose_all.className = 'selector-chooseall';
  69. // <ul class="selector-chooser">
  70. var selector_chooser = quickElement('ul', selector_div);
  71. selector_chooser.className = 'selector-chooser';
  72. var add_link = quickElement('a', quickElement('li', selector_chooser), gettext('Choose'), 'title', gettext('Choose'), 'href', '#', 'id', field_id + '_add_link');
  73. add_link.className = 'selector-add';
  74. var remove_link = quickElement('a', quickElement('li', selector_chooser), gettext('Remove'), 'title', gettext('Remove'), 'href', '#', 'id', field_id + '_remove_link');
  75. remove_link.className = 'selector-remove';
  76. // <div class="selector-chosen">
  77. var selector_chosen = quickElement('div', selector_div);
  78. selector_chosen.className = 'selector-chosen';
  79. var title_chosen = quickElement('h2', selector_chosen, interpolate(gettext('Chosen %s') + ' ', [field_name]));
  80. quickElement(
  81. 'span', title_chosen, '',
  82. 'class', 'help help-tooltip help-icon',
  83. 'title', interpolate(
  84. gettext(
  85. 'This is the list of chosen %s. You may remove some by ' +
  86. 'selecting them in the box below and then clicking the ' +
  87. '"Remove" arrow between the two boxes.'
  88. ),
  89. [field_name]
  90. )
  91. );
  92. var to_box = quickElement('select', selector_chosen, '', 'id', field_id + '_to', 'multiple', 'multiple', 'size', from_box.size, 'name', from_box.getAttribute('name'));
  93. to_box.className = 'filtered';
  94. var clear_all = quickElement('a', selector_chosen, gettext('Remove all'), 'title', interpolate(gettext('Click to remove all chosen %s at once.'), [field_name]), 'href', '#', 'id', field_id + '_remove_all_link');
  95. clear_all.className = 'selector-clearall';
  96. from_box.setAttribute('name', from_box.getAttribute('name') + '_old');
  97. // Set up the JavaScript event handlers for the select box filter interface
  98. var move_selection = function(e, elem, move_func, from, to) {
  99. if (elem.className.indexOf('active') !== -1) {
  100. move_func(from, to);
  101. SelectFilter.refresh_icons(field_id);
  102. }
  103. e.preventDefault();
  104. };
  105. choose_all.addEventListener('click', function(e) {
  106. move_selection(e, this, SelectBox.move_all, field_id + '_from', field_id + '_to');
  107. });
  108. add_link.addEventListener('click', function(e) {
  109. move_selection(e, this, SelectBox.move, field_id + '_from', field_id + '_to');
  110. });
  111. remove_link.addEventListener('click', function(e) {
  112. move_selection(e, this, SelectBox.move, field_id + '_to', field_id + '_from');
  113. });
  114. clear_all.addEventListener('click', function(e) {
  115. move_selection(e, this, SelectBox.move_all, field_id + '_to', field_id + '_from');
  116. });
  117. filter_input.addEventListener('keypress', function(e) {
  118. SelectFilter.filter_key_press(e, field_id);
  119. });
  120. filter_input.addEventListener('keyup', function(e) {
  121. SelectFilter.filter_key_up(e, field_id);
  122. });
  123. filter_input.addEventListener('keydown', function(e) {
  124. SelectFilter.filter_key_down(e, field_id);
  125. });
  126. selector_div.addEventListener('change', function(e) {
  127. if (e.target.tagName === 'SELECT') {
  128. SelectFilter.refresh_icons(field_id);
  129. }
  130. });
  131. selector_div.addEventListener('dblclick', function(e) {
  132. if (e.target.tagName === 'OPTION') {
  133. if (e.target.closest('select').id === field_id + '_to') {
  134. SelectBox.move(field_id + '_to', field_id + '_from');
  135. } else {
  136. SelectBox.move(field_id + '_from', field_id + '_to');
  137. }
  138. SelectFilter.refresh_icons(field_id);
  139. }
  140. });
  141. findForm(from_box).addEventListener('submit', function() {
  142. SelectBox.select_all(field_id + '_to');
  143. });
  144. SelectBox.init(field_id + '_from');
  145. SelectBox.init(field_id + '_to');
  146. // Move selected from_box options to to_box
  147. SelectBox.move(field_id + '_from', field_id + '_to');
  148. if (!is_stacked) {
  149. // In horizontal mode, give the same height to the two boxes.
  150. var j_from_box = $('#' + field_id + '_from');
  151. var j_to_box = $('#' + field_id + '_to');
  152. j_to_box.height($(filter_p).outerHeight() + j_from_box.outerHeight());
  153. }
  154. // Initial icon refresh
  155. SelectFilter.refresh_icons(field_id);
  156. },
  157. any_selected: function(field) {
  158. var any_selected = false;
  159. try {
  160. // Temporarily add the required attribute and check validity.
  161. // This is much faster in WebKit browsers than the fallback.
  162. field.attr('required', 'required');
  163. any_selected = field.is(':valid');
  164. } catch (e) {
  165. // Browsers that don't support :valid (IE < 10)
  166. any_selected = field.find('option:selected').length > 0;
  167. }
  168. field.removeAttr('required');
  169. return any_selected;
  170. },
  171. refresh_icons: function(field_id) {
  172. var from = $('#' + field_id + '_from');
  173. var to = $('#' + field_id + '_to');
  174. // Active if at least one item is selected
  175. $('#' + field_id + '_add_link').toggleClass('active', SelectFilter.any_selected(from));
  176. $('#' + field_id + '_remove_link').toggleClass('active', SelectFilter.any_selected(to));
  177. // Active if the corresponding box isn't empty
  178. $('#' + field_id + '_add_all_link').toggleClass('active', from.find('option').length > 0);
  179. $('#' + field_id + '_remove_all_link').toggleClass('active', to.find('option').length > 0);
  180. },
  181. filter_key_press: function(event, field_id) {
  182. var from = document.getElementById(field_id + '_from');
  183. // don't submit form if user pressed Enter
  184. if ((event.which && event.which === 13) || (event.keyCode && event.keyCode === 13)) {
  185. from.selectedIndex = 0;
  186. SelectBox.move(field_id + '_from', field_id + '_to');
  187. from.selectedIndex = 0;
  188. event.preventDefault();
  189. return false;
  190. }
  191. },
  192. filter_key_up: function(event, field_id) {
  193. var from = document.getElementById(field_id + '_from');
  194. var temp = from.selectedIndex;
  195. SelectBox.filter(field_id + '_from', document.getElementById(field_id + '_input').value);
  196. from.selectedIndex = temp;
  197. return true;
  198. },
  199. filter_key_down: function(event, field_id) {
  200. var from = document.getElementById(field_id + '_from');
  201. // right arrow -- move across
  202. if ((event.which && event.which === 39) || (event.keyCode && event.keyCode === 39)) {
  203. var old_index = from.selectedIndex;
  204. SelectBox.move(field_id + '_from', field_id + '_to');
  205. from.selectedIndex = (old_index === from.length) ? from.length - 1 : old_index;
  206. return false;
  207. }
  208. // down arrow -- wrap around
  209. if ((event.which && event.which === 40) || (event.keyCode && event.keyCode === 40)) {
  210. from.selectedIndex = (from.length === from.selectedIndex + 1) ? 0 : from.selectedIndex + 1;
  211. }
  212. // up arrow -- wrap around
  213. if ((event.which && event.which === 38) || (event.keyCode && event.keyCode === 38)) {
  214. from.selectedIndex = (from.selectedIndex === 0) ? from.length - 1 : from.selectedIndex - 1;
  215. }
  216. return true;
  217. }
  218. };
  219. window.addEventListener('load', function(e) {
  220. $('select.selectfilter, select.selectfilterstacked').each(function() {
  221. var $el = $(this),
  222. data = $el.data();
  223. SelectFilter.init($el.attr('id'), data.fieldName, parseInt(data.isStacked, 10));
  224. });
  225. });
  226. })(django.jQuery);