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 2761 2009-07-17 08:46:59Z 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 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_last_row: function()
355 var rows = this.list.tBodies[0].rows;
357 for(var i=rows.length-1; i>=0; i--)
358 if(rows[i].id && String(rows[i].id).match(/rcmrow([a-z0-9\-_=\+\/]+)/i) && this.rows[RegExp.$1] != null)
367 * selects or unselects the proper row depending on the modifier key pressed
369 select_row: function(id, mod_key, with_mouse)
371 var select_before = this.selection.join(',');
372 if (!this.multiselect)
375 if (!this.shift_start)
376 this.shift_start = id
380 this.shift_start = id;
381 this.highlight_row(id, false);
382 this.multi_selecting = false;
389 this.shift_select(id, false);
394 this.highlight_row(id, true);
397 case CONTROL_SHIFT_KEY:
398 this.shift_select(id, true);
402 this.highlight_row(id, false);
405 this.multi_selecting = true;
408 // trigger event if selection changed
409 if (this.selection.join(',') != select_before)
410 this.triggerEvent('select');
412 if (this.last_selected != 0 && this.rows[this.last_selected])
413 $(this.rows[this.last_selected].obj).removeClass('focused');
415 // unselect if toggleselect is active and the same row was clicked again
416 if (this.toggleselect && this.last_selected == id)
418 this.clear_selection();
422 $(this.rows[id].obj).addClass('focused');
424 if (!this.selection.length)
425 this.shift_start = null;
427 this.last_selected = id;
432 * Alias method for select_row
436 this.select_row(id, false);
442 * Select row next to the last selected one.
443 * Either below or above.
445 select_next: function()
447 var next_row = this.get_next_row();
448 var prev_row = this.get_prev_row();
449 var new_row = (next_row) ? next_row : prev_row;
451 this.select_row(new_row.uid, false, false);
456 * Perform selection when shift key is pressed
458 shift_select: function(id, control)
460 if (!this.rows[this.shift_start] || !this.selection.length)
461 this.shift_start = id;
463 var from_rowIndex = this.rows[this.shift_start].obj.rowIndex;
464 var to_rowIndex = this.rows[id].obj.rowIndex;
466 var i = ((from_rowIndex < to_rowIndex)? from_rowIndex : to_rowIndex);
467 var j = ((from_rowIndex > to_rowIndex)? from_rowIndex : to_rowIndex);
469 // iterate through the entire message list
470 for (var n in this.rows)
472 if ((this.rows[n].obj.rowIndex >= i) && (this.rows[n].obj.rowIndex <= j))
474 if (!this.in_selection(n))
475 this.highlight_row(n, true);
479 if (this.in_selection(n) && !control)
480 this.highlight_row(n, true);
487 * Check if given id is part of the current selection
489 in_selection: function(id)
491 for(var n in this.selection)
492 if (this.selection[n]==id)
500 * Select each row in list
502 select_all: function(filter)
504 if (!this.rows || !this.rows.length)
507 // reset but remember selection first
508 var select_before = this.selection.join(',');
509 this.selection = new Array();
511 for (var n in this.rows)
513 if (!filter || (this.rows[n] && this.rows[n][filter] == true))
515 this.last_selected = n;
516 this.highlight_row(n, true);
518 else if (this.rows[n])
520 $(this.rows[n].obj).removeClass('selected').removeClass('unfocused');
524 // trigger event if selection changed
525 if (this.selection.join(',') != select_before)
526 this.triggerEvent('select');
537 invert_selection: function()
539 if (!this.rows || !this.rows.length)
542 // remember old selection
543 var select_before = this.selection.join(',');
545 for (var n in this.rows)
546 this.highlight_row(n, true);
548 // trigger event if selection changed
549 if (this.selection.join(',') != select_before)
550 this.triggerEvent('select');
559 * Unselect selected row(s)
561 clear_selection: function(id)
563 var num_select = this.selection.length;
568 for (var n=0; n<this.selection.length; n++)
569 if (this.selection[n] == id) {
570 this.selection.splice(n,1);
577 for (var n=0; n<this.selection.length; n++)
578 if (this.rows[this.selection[n]]) {
579 $(this.rows[this.selection[n]].obj).removeClass('selected').removeClass('unfocused');
582 this.selection = new Array();
585 if (num_select && !this.selection.length)
586 this.triggerEvent('select');
591 * Getter for the selection array
593 get_selection: function()
595 return this.selection;
600 * Return the ID if only one row is selected
602 get_single_selection: function()
604 if (this.selection.length == 1)
605 return this.selection[0];
612 * Highlight/unhighlight a row
614 highlight_row: function(id, multiple)
616 if (this.rows[id] && !multiple)
618 if (this.selection.length > 1 || !this.in_selection(id))
620 this.clear_selection();
621 this.selection[0] = id;
622 $(this.rows[id].obj).addClass('selected');
625 else if (this.rows[id])
627 if (!this.in_selection(id)) // select row
629 this.selection[this.selection.length] = id;
630 $(this.rows[id].obj).addClass('selected');
634 var p = find_in_array(id, this.selection);
635 var a_pre = this.selection.slice(0, p);
636 var a_post = this.selection.slice(p+1, this.selection.length);
637 this.selection = a_pre.concat(a_post);
638 $(this.rows[id].obj).removeClass('selected').removeClass('unfocused');
645 * Handler for keyboard events
647 key_press: function(e)
649 if (this.focused != true)
652 var keyCode = rcube_event.get_keycode(e);
653 var mod_key = rcube_event.get_modifier(e);
659 case 63233: // "down", in safari keypress
660 case 63232: // "up", in safari keypress
661 // Stop propagation so that the browser doesn't scroll
662 rcube_event.cancel(e);
663 return this.use_arrow_key(keyCode, mod_key);
665 this.shiftkey = e.shiftKey;
666 this.key_pressed = keyCode;
667 this.triggerEvent('keypress');
669 if (this.key_pressed == this.BACKSPACE_KEY)
670 return rcube_event.cancel(e);
677 * Handler for keydown events
679 key_down: function(e)
681 switch (rcube_event.get_keycode(e))
684 if (this.drag_active)
685 return this.drag_mouse_up(e);
691 if (!rcube_event.get_modifier(e) && this.focused)
692 return rcube_event.cancel(e);
702 * Special handling method for arrow keys
704 use_arrow_key: function(keyCode, mod_key)
707 // Safari uses the nonstandard keycodes 63232/63233 for up/down, if we're
708 // using the keypress event (but not the keydown or keyup event).
709 if (keyCode == 40 || keyCode == 63233) // down arrow key pressed
710 new_row = this.get_next_row();
711 else if (keyCode == 38 || keyCode == 63232) // up arrow key pressed
712 new_row = this.get_prev_row();
716 this.select_row(new_row.uid, mod_key, true);
717 this.scrollto(new_row.uid);
725 * Try to scroll the list to make the specified row visible
727 scrollto: function(id)
729 var row = this.rows[id].obj;
730 if (row && this.frame)
732 var scroll_to = Number(row.offsetTop);
734 if (scroll_to < Number(this.frame.scrollTop))
735 this.frame.scrollTop = scroll_to;
736 else if (scroll_to + Number(row.offsetHeight) > Number(this.frame.scrollTop) + Number(this.frame.offsetHeight))
737 this.frame.scrollTop = (scroll_to + Number(row.offsetHeight)) - Number(this.frame.offsetHeight);
743 * Handler for mouse move events
745 drag_mouse_move: function(e)
749 // check mouse movement, of less than 3 pixels, don't start dragging
750 var m = rcube_event.get_mouse_pos(e);
752 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))
756 this.draglayer = $('<div>').attr('id', 'rcmdraglayer').css({ position:'absolute', display:'none', 'z-index':2000 }).appendTo(document.body);
758 // get subjects of selectedd messages
760 var c, i, node, subject, obj;
761 for(var n=0; n<this.selection.length; n++)
763 if (n>12) // only show 12 lines
769 if (this.rows[this.selection[n]].obj)
771 obj = this.rows[this.selection[n]].obj;
774 for(c=0, i=0; i<obj.childNodes.length; i++)
776 if (obj.childNodes[i].nodeName == 'TD')
778 if (((node = obj.childNodes[i].firstChild) && (node.nodeType==3 || node.nodeName=='A')) &&
779 (this.subject_col < 0 || (this.subject_col >= 0 && this.subject_col == c)))
782 if (node.nodeType == 3)
783 this.drag_start_pos = $(obj.childNodes[i]).offset();
785 this.drag_start_pos = $(node).offset();
787 subject = node.nodeType==3 ? node.data : node.innerHTML;
788 // remove leading spaces
789 subject = subject.replace(/^\s+/i, '');
790 // truncate line to 50 characters
791 names += (subject.length > 50 ? subject.substring(0, 50)+'...' : subject) + '<br />';
800 this.draglayer.html(names);
801 this.draglayer.show();
803 this.drag_active = true;
804 this.triggerEvent('dragstart');
807 if (this.drag_active && this.draglayer)
809 var pos = rcube_event.get_mouse_pos(e);
810 this.draglayer.css({ left:(pos.x+20)+'px', top:(pos.y-5 + (bw.ie ? document.documentElement.scrollTop : 0))+'px' });
811 this.triggerEvent('dragmove', e?e:window.event);
814 this.drag_start = false;
821 * Handler for mouse up events
823 drag_mouse_up: function(e)
825 document.onmousemove = null;
827 if (this.draglayer && this.draglayer.is(':visible')) {
828 if (this.drag_start_pos)
829 this.draglayer.animate(this.drag_start_pos, 300, 'swing').hide(20);
831 this.draglayer.hide();
834 this.drag_active = false;
835 this.triggerEvent('dragend');
837 rcube_event.remove_listener({element:document, event:'mousemove', object:this, method:'drag_mouse_move'});
838 rcube_event.remove_listener({element:document, event:'mouseup', object:this, method:'drag_mouse_up'});
840 var iframes = document.getElementsByTagName('iframe');
841 for (var n in iframes) {
844 if (iframes[n].contentDocument)
845 iframedoc = iframes[n].contentDocument;
846 else if (iframes[n].contentWindow)
847 iframedoc = iframes[n].contentWindow.document;
848 else if (iframes[n].document)
849 iframedoc = iframes[n].document;
852 if (this.iframe_events[n]) {
853 if (iframedoc.removeEventListener)
854 iframedoc.removeEventListener('mousemove', this.iframe_events[n], false);
855 else if (iframedoc.detachEvent)
856 iframedoc.detachEvent('onmousemove', this.iframe_events[n]);
858 iframedoc['onmousemove'] = null;
860 rcube_event.remove_listener({element:iframedoc, event:'mouseup', object:this, method:'drag_mouse_up'});
864 return rcube_event.cancel(e);
869 * Creating the list in background
871 set_background_mode: function(flag)
874 this.background = document.createElement('tbody');
875 } else if (this.background) {
876 this.list.replaceChild(this.background, this.list.tBodies[0]);
877 this.background = null;
883 rcube_list_widget.prototype.addEventListener = rcube_event_engine.prototype.addEventListener;
884 rcube_list_widget.prototype.removeEventListener = rcube_event_engine.prototype.removeEventListener;
885 rcube_list_widget.prototype.triggerEvent = rcube_event_engine.prototype.triggerEvent;