2 +-----------------------------------------------------------------------+
3 | RoundCube List Widget |
5 | This file is part of the RoundCube Webmail client |
6 | Copyright (C) 2006-2009, RoundCube Dev, - Switzerland |
7 | Licensed under the GNU GPL |
9 +-----------------------------------------------------------------------+
10 | Authors: Thomas Bruederli <roundcube@gmail.com> |
11 | Charles McNulty <charles@charlesmcnulty.com> |
12 +-----------------------------------------------------------------------+
13 | Requires: common.js |
14 +-----------------------------------------------------------------------+
16 $Id: list.js 3055 2009-10-23 18:11:41Z alec $
21 * RoundCube List Widget class
24 function rcube_list_widget(list, p)
29 this.BACKSPACE_KEY = 8;
31 this.list = list ? list : null;
37 this.subject_col = -1;
38 this.shiftkey = false;
39 this.multiselect = false;
40 this.multi_selecting = false;
41 this.draggable = false;
42 this.keyboard = false;
43 this.toggleselect = false;
45 this.dont_select = false;
46 this.drag_active = false;
47 this.last_selected = 0;
49 this.in_selection_before = false;
51 this.drag_mouse_start = null;
52 this.dblclick_time = 600;
53 this.row_init = function(){};
55 // overwrite default paramaters
56 if (p && typeof(p)=='object')
62 rcube_list_widget.prototype = {
66 * get all message rows from HTML table and init each row
70 if (this.list && this.list.tBodies[0])
72 this.rows = new Array();
76 for(var r=0; r<this.list.tBodies[0].childNodes.length; r++)
78 row = this.list.tBodies[0].childNodes[r];
79 while (row && (row.nodeType != 1 || row.style.display == 'none'))
81 row = row.nextSibling;
89 this.frame = this.list.parentNode;
93 rcube_event.add_listener({element:document, event:bw.opera?'keypress':'keydown', object:this, method:'key_press'});
94 rcube_event.add_listener({element:document, event:'keydown', object:this, method:'key_down'});
101 * Init list row and set mouse events on it
103 init_row: function(row)
105 // make references in internal array and set event handlers
106 if (row && String(row.id).match(/rcmrow([a-z0-9\-_=\+\/]+)/i))
111 this.rows[uid] = {uid:uid, id:row.id, obj:row, classname:row.className};
113 // set eventhandlers to table row
114 row.onmousedown = function(e){ return p.drag_row(e, this.uid); };
115 row.onmouseup = function(e){ return p.click_row(e, this.uid); };
118 row.onselectstart = function() { return false; };
120 this.row_init(this.rows[uid]);
126 * Remove all list rows
130 var tbody = document.createElement('tbody');
131 this.list.insertBefore(tbody, this.list.tBodies[0]);
132 this.list.removeChild(this.list.tBodies[1]);
133 this.rows = new Array();
136 if (sel) this.clear_selection();
141 * 'remove' message row from list (just hide it)
143 remove_row: function(uid, sel_next)
145 if (this.rows[uid].obj)
146 this.rows[uid].obj.style.display = 'none';
151 this.rows[uid] = null;
157 * Add row to the list and initialize it
159 insert_row: function(row, attop)
162 var tbody = this.background;
164 var tbody = this.list.tBodies[0];
166 if (attop && tbody.rows.length)
167 tbody.insertBefore(row, tbody.firstChild);
169 tbody.appendChild(row);
178 * Set focus to the list
183 for (var n=0; n<this.selection.length; n++)
185 id = this.selection[n];
186 if (this.rows[id] && this.rows[id].obj) {
187 $(this.rows[id].obj).addClass('selected').removeClass('unfocused');
191 if (e || (e = window.event))
192 rcube_event.cancel(e);
197 * remove focus from the list
202 this.focused = false;
203 for (var n=0; n<this.selection.length; n++)
205 id = this.selection[n];
206 if (this.rows[id] && this.rows[id].obj) {
207 $(this.rows[id].obj).removeClass('selected').addClass('unfocused');
214 * onmousedown-handler of message list row
216 drag_row: function(e, id)
218 // don't do anything (another action processed before)
219 var evtarget = rcube_event.get_target(e);
220 var tagname = evtarget.tagName.toLowerCase();
221 if (this.dont_select || (evtarget && (tagname == 'input' || tagname == 'img')))
224 // accept right-clicks
225 if (rcube_event.get_button(e) == 2)
228 this.in_selection_before = this.in_selection(id) ? id : false;
230 // selects currently unselected row
231 if (!this.in_selection_before)
233 var mod_key = rcube_event.get_modifier(e);
234 this.select_row(id, mod_key, false);
237 if (this.draggable && this.selection.length)
239 this.drag_start = true;
240 this.drag_mouse_start = rcube_event.get_mouse_pos(e);
241 rcube_event.add_listener({element:document, event:'mousemove', object:this, method:'drag_mouse_move'});
242 rcube_event.add_listener({element:document, event:'mouseup', object:this, method:'drag_mouse_up'});
244 // add listener for iframes
245 var iframes = document.getElementsByTagName('iframe');
246 this.iframe_events = Object();
247 for (var n in iframes)
249 var iframedoc = null;
250 if (iframes[n].contentDocument)
251 iframedoc = iframes[n].contentDocument;
252 else if (iframes[n].contentWindow)
253 iframedoc = iframes[n].contentWindow.document;
254 else if (iframes[n].document)
255 iframedoc = iframes[n].document;
260 var pos = $('#'+iframes[n].id).offset();
261 this.iframe_events[n] = function(e) { e._offset = pos; return list.drag_mouse_move(e); }
263 if (iframedoc.addEventListener)
264 iframedoc.addEventListener('mousemove', this.iframe_events[n], false);
265 else if (iframes[n].attachEvent)
266 iframedoc.attachEvent('onmousemove', this.iframe_events[n]);
268 iframedoc['onmousemove'] = this.iframe_events[n];
270 rcube_event.add_listener({element:iframedoc, event:'mouseup', object:this, method:'drag_mouse_up'});
280 * onmouseup-handler of message list row
282 click_row: function(e, id)
284 var now = new Date().getTime();
285 var mod_key = rcube_event.get_modifier(e);
286 var evtarget = rcube_event.get_target(e);
287 var tagname = evtarget.tagName.toLowerCase();
289 if ((evtarget && (tagname == 'input' || tagname == 'img')))
292 // don't do anything (another action processed before)
293 if (this.dont_select)
295 this.dont_select = false;
299 var dblclicked = now - this.rows[id].clicked < this.dblclick_time;
301 // unselects currently selected row
302 if (!this.drag_active && this.in_selection_before == id && !dblclicked)
303 this.select_row(id, mod_key, false);
305 this.drag_start = false;
306 this.in_selection_before = false;
308 // row was double clicked
309 if (this.rows && dblclicked && this.in_selection(id))
310 this.triggerEvent('dblclick');
312 this.triggerEvent('click');
314 if (!this.drag_active)
315 rcube_event.cancel(e);
317 this.rows[id].clicked = now;
323 * get first/next/previous/last rows that are not hidden
325 get_next_row: function()
330 var last_selected_row = this.rows[this.last_selected];
331 var new_row = last_selected_row ? last_selected_row.obj.nextSibling : null;
332 while (new_row && (new_row.nodeType != 1 || new_row.style.display == 'none'))
333 new_row = new_row.nextSibling;
338 get_prev_row: function()
343 var last_selected_row = this.rows[this.last_selected];
344 var new_row = last_selected_row ? last_selected_row.obj.previousSibling : null;
345 while (new_row && (new_row.nodeType != 1 || new_row.style.display == 'none'))
346 new_row = new_row.previousSibling;
351 get_first_row: function()
355 var rows = this.list.tBodies[0].rows;
357 for(var i=0; i<rows.length-1; i++)
358 if(rows[i].id && String(rows[i].id).match(/rcmrow([a-z0-9\-_=\+\/]+)/i) && this.rows[RegExp.$1] != null)
365 get_last_row: function()
369 var rows = this.list.tBodies[0].rows;
371 for(var i=rows.length-1; i>=0; i--)
372 if(rows[i].id && String(rows[i].id).match(/rcmrow([a-z0-9\-_=\+\/]+)/i) && this.rows[RegExp.$1] != null)
381 * selects or unselects the proper row depending on the modifier key pressed
383 select_row: function(id, mod_key, with_mouse)
385 var select_before = this.selection.join(',');
386 if (!this.multiselect)
389 if (!this.shift_start)
390 this.shift_start = id
394 this.shift_start = id;
395 this.highlight_row(id, false);
396 this.multi_selecting = false;
403 this.shift_select(id, false);
408 this.highlight_row(id, true);
411 case CONTROL_SHIFT_KEY:
412 this.shift_select(id, true);
416 this.highlight_row(id, false);
419 this.multi_selecting = true;
422 // trigger event if selection changed
423 if (this.selection.join(',') != select_before)
424 this.triggerEvent('select');
426 if (this.last_selected != 0 && this.rows[this.last_selected])
427 $(this.rows[this.last_selected].obj).removeClass('focused');
429 // unselect if toggleselect is active and the same row was clicked again
430 if (this.toggleselect && this.last_selected == id)
432 this.clear_selection();
436 $(this.rows[id].obj).addClass('focused');
438 if (!this.selection.length)
439 this.shift_start = null;
441 this.last_selected = id;
446 * Alias method for select_row
450 this.select_row(id, false);
456 * Select row next to the last selected one.
457 * Either below or above.
459 select_next: function()
461 var next_row = this.get_next_row();
462 var prev_row = this.get_prev_row();
463 var new_row = (next_row) ? next_row : prev_row;
465 this.select_row(new_row.uid, false, false);
471 select_first: function()
473 var first_row = this.get_first_row();
475 this.select_row(first_row, false, false);
480 * Perform selection when shift key is pressed
482 shift_select: function(id, control)
484 if (!this.rows[this.shift_start] || !this.selection.length)
485 this.shift_start = id;
487 var from_rowIndex = this.rows[this.shift_start].obj.rowIndex;
488 var to_rowIndex = this.rows[id].obj.rowIndex;
490 var i = ((from_rowIndex < to_rowIndex)? from_rowIndex : to_rowIndex);
491 var j = ((from_rowIndex > to_rowIndex)? from_rowIndex : to_rowIndex);
493 // iterate through the entire message list
494 for (var n in this.rows)
496 if ((this.rows[n].obj.rowIndex >= i) && (this.rows[n].obj.rowIndex <= j))
498 if (!this.in_selection(n))
499 this.highlight_row(n, true);
503 if (this.in_selection(n) && !control)
504 this.highlight_row(n, true);
511 * Check if given id is part of the current selection
513 in_selection: function(id)
515 for(var n in this.selection)
516 if (this.selection[n]==id)
524 * Select each row in list
526 select_all: function(filter)
528 if (!this.rows || !this.rows.length)
531 // reset but remember selection first
532 var select_before = this.selection.join(',');
533 this.selection = new Array();
535 for (var n in this.rows)
537 if (!filter || (this.rows[n] && this.rows[n][filter] == true))
539 this.last_selected = n;
540 this.highlight_row(n, true);
542 else if (this.rows[n])
544 $(this.rows[n].obj).removeClass('selected').removeClass('unfocused');
548 // trigger event if selection changed
549 if (this.selection.join(',') != select_before)
550 this.triggerEvent('select');
561 invert_selection: function()
563 if (!this.rows || !this.rows.length)
566 // remember old selection
567 var select_before = this.selection.join(',');
569 for (var n in this.rows)
570 this.highlight_row(n, true);
572 // trigger event if selection changed
573 if (this.selection.join(',') != select_before)
574 this.triggerEvent('select');
583 * Unselect selected row(s)
585 clear_selection: function(id)
587 var num_select = this.selection.length;
592 for (var n=0; n<this.selection.length; n++)
593 if (this.selection[n] == id) {
594 this.selection.splice(n,1);
601 for (var n=0; n<this.selection.length; n++)
602 if (this.rows[this.selection[n]]) {
603 $(this.rows[this.selection[n]].obj).removeClass('selected').removeClass('unfocused');
606 this.selection = new Array();
609 if (num_select && !this.selection.length)
610 this.triggerEvent('select');
615 * Getter for the selection array
617 get_selection: function()
619 return this.selection;
624 * Return the ID if only one row is selected
626 get_single_selection: function()
628 if (this.selection.length == 1)
629 return this.selection[0];
636 * Highlight/unhighlight a row
638 highlight_row: function(id, multiple)
640 if (this.rows[id] && !multiple)
642 if (this.selection.length > 1 || !this.in_selection(id))
644 this.clear_selection();
645 this.selection[0] = id;
646 $(this.rows[id].obj).addClass('selected');
649 else if (this.rows[id])
651 if (!this.in_selection(id)) // select row
653 this.selection[this.selection.length] = id;
654 $(this.rows[id].obj).addClass('selected');
658 var p = find_in_array(id, this.selection);
659 var a_pre = this.selection.slice(0, p);
660 var a_post = this.selection.slice(p+1, this.selection.length);
661 this.selection = a_pre.concat(a_post);
662 $(this.rows[id].obj).removeClass('selected').removeClass('unfocused');
669 * Handler for keyboard events
671 key_press: function(e)
673 if (this.focused != true)
676 var keyCode = rcube_event.get_keycode(e);
677 var mod_key = rcube_event.get_modifier(e);
683 case 63233: // "down", in safari keypress
684 case 63232: // "up", in safari keypress
685 // Stop propagation so that the browser doesn't scroll
686 rcube_event.cancel(e);
687 return this.use_arrow_key(keyCode, mod_key);
689 this.shiftkey = e.shiftKey;
690 this.key_pressed = keyCode;
691 this.triggerEvent('keypress');
693 if (this.key_pressed == this.BACKSPACE_KEY)
694 return rcube_event.cancel(e);
701 * Handler for keydown events
703 key_down: function(e)
705 switch (rcube_event.get_keycode(e))
708 if (this.drag_active)
709 return this.drag_mouse_up(e);
715 if (!rcube_event.get_modifier(e) && this.focused)
716 return rcube_event.cancel(e);
726 * Special handling method for arrow keys
728 use_arrow_key: function(keyCode, mod_key)
731 // Safari uses the nonstandard keycodes 63232/63233 for up/down, if we're
732 // using the keypress event (but not the keydown or keyup event).
733 if (keyCode == 40 || keyCode == 63233) // down arrow key pressed
734 new_row = this.get_next_row();
735 else if (keyCode == 38 || keyCode == 63232) // up arrow key pressed
736 new_row = this.get_prev_row();
740 this.select_row(new_row.uid, mod_key, true);
741 this.scrollto(new_row.uid);
749 * Try to scroll the list to make the specified row visible
751 scrollto: function(id)
753 var row = this.rows[id].obj;
754 if (row && this.frame)
756 var scroll_to = Number(row.offsetTop);
758 if (scroll_to < Number(this.frame.scrollTop))
759 this.frame.scrollTop = scroll_to;
760 else if (scroll_to + Number(row.offsetHeight) > Number(this.frame.scrollTop) + Number(this.frame.offsetHeight))
761 this.frame.scrollTop = (scroll_to + Number(row.offsetHeight)) - Number(this.frame.offsetHeight);
767 * Handler for mouse move events
769 drag_mouse_move: function(e)
773 // check mouse movement, of less than 3 pixels, don't start dragging
774 var m = rcube_event.get_mouse_pos(e);
776 if (!this.drag_mouse_start || (Math.abs(m.x - this.drag_mouse_start.x) < 3 && Math.abs(m.y - this.drag_mouse_start.y) < 3))
780 this.draglayer = $('<div>').attr('id', 'rcmdraglayer').css({ position:'absolute', display:'none', 'z-index':2000 }).appendTo(document.body);
782 // get subjects of selectedd messages
784 var c, i, node, subject, obj;
785 for(var n=0; n<this.selection.length; n++)
787 if (n>12) // only show 12 lines
793 if (this.rows[this.selection[n]].obj)
795 obj = this.rows[this.selection[n]].obj;
798 for(c=0, i=0; i<obj.childNodes.length; i++)
800 if (obj.childNodes[i].nodeName == 'TD')
802 if (((node = obj.childNodes[i].firstChild) && (node.nodeType==3 || node.nodeName=='A')) &&
803 (this.subject_col < 0 || (this.subject_col >= 0 && this.subject_col == c)))
806 if (node.nodeType == 3)
807 this.drag_start_pos = $(obj.childNodes[i]).offset();
809 this.drag_start_pos = $(node).offset();
811 subject = node.nodeType==3 ? node.data : node.innerHTML;
812 // remove leading spaces
813 subject = subject.replace(/^\s+/i, '');
814 // truncate line to 50 characters
815 names += (subject.length > 50 ? subject.substring(0, 50)+'...' : subject) + '<br />';
824 this.draglayer.html(names);
825 this.draglayer.show();
827 this.drag_active = true;
828 this.triggerEvent('dragstart');
831 if (this.drag_active && this.draglayer)
833 var pos = rcube_event.get_mouse_pos(e);
834 this.draglayer.css({ left:(pos.x+20)+'px', top:(pos.y-5 + (bw.ie ? document.documentElement.scrollTop : 0))+'px' });
835 this.triggerEvent('dragmove', e?e:window.event);
838 this.drag_start = false;
845 * Handler for mouse up events
847 drag_mouse_up: function(e)
849 document.onmousemove = null;
851 if (this.draglayer && this.draglayer.is(':visible')) {
852 if (this.drag_start_pos)
853 this.draglayer.animate(this.drag_start_pos, 300, 'swing').hide(20);
855 this.draglayer.hide();
858 this.drag_active = false;
859 this.triggerEvent('dragend');
861 rcube_event.remove_listener({element:document, event:'mousemove', object:this, method:'drag_mouse_move'});
862 rcube_event.remove_listener({element:document, event:'mouseup', object:this, method:'drag_mouse_up'});
864 var iframes = document.getElementsByTagName('iframe');
865 for (var n in iframes) {
868 if (iframes[n].contentDocument)
869 iframedoc = iframes[n].contentDocument;
870 else if (iframes[n].contentWindow)
871 iframedoc = iframes[n].contentWindow.document;
872 else if (iframes[n].document)
873 iframedoc = iframes[n].document;
876 if (this.iframe_events[n]) {
877 if (iframedoc.removeEventListener)
878 iframedoc.removeEventListener('mousemove', this.iframe_events[n], false);
879 else if (iframedoc.detachEvent)
880 iframedoc.detachEvent('onmousemove', this.iframe_events[n]);
882 iframedoc['onmousemove'] = null;
884 rcube_event.remove_listener({element:iframedoc, event:'mouseup', object:this, method:'drag_mouse_up'});
888 return rcube_event.cancel(e);
893 * Creating the list in background
895 set_background_mode: function(flag)
898 this.background = document.createElement('tbody');
899 } else if (this.background) {
900 this.list.replaceChild(this.background, this.list.tBodies[0]);
901 this.background = null;
907 rcube_list_widget.prototype.addEventListener = rcube_event_engine.prototype.addEventListener;
908 rcube_list_widget.prototype.removeEventListener = rcube_event_engine.prototype.removeEventListener;
909 rcube_list_widget.prototype.triggerEvent = rcube_event_engine.prototype.triggerEvent;