/** * Roundcube Treelist Widget * * This file is part of the Roundcube Webmail client * * @licstart The following is the entire license notice for the * JavaScript code in this file. * * Copyright (c) 2013-2014, The Roundcube Dev Team * * The JavaScript code in this page is free software: you can * redistribute it and/or modify it under the terms of the GNU * General Public License (GNU GPL) as published by the Free Software * Foundation, either version 3 of the License, or (at your option) * any later version. The code is distributed WITHOUT ANY WARRANTY; * without even the implied warranty of MERCHANTABILITY or FITNESS * FOR A PARTICULAR PURPOSE. See the GNU GPL for more details. * * As additional permission under GNU GPL version 3 section 7, you * may distribute non-source (e.g., minimized or compacted) forms of * that code without the copy of the GNU GPL normally required by * section 4, provided you include this license notice and a URL * through which recipients can access the Corresponding Source. * * @licend The above is the entire license notice * for the JavaScript code in this file. * * @author Thomas Bruederli * @requires jquery.js, common.js */ /** * Roundcube Treelist widget class * @contructor */ function rcube_treelist_widget(node, p) { // apply some defaults to p p = $.extend({ id_prefix: '', autoexpand: 1000, selectable: false, scroll_delay: 500, scroll_step: 5, scroll_speed: 20, save_state: false, keyboard: true, check_droptarget: function(node) { return !node.virtual; } }, p || {}); var container = $(node), data = p.data || [], indexbyid = {}, selection = null, drag_active = false, search_active = false, last_search = '', has_focus = false, box_coords = {}, item_coords = [], autoexpand_timer, autoexpand_item, body_scroll_top = 0, list_scroll_top = 0, scroll_timer, searchfield, tree_state, ui_droppable, ui_draggable, draggable_opts, droppable_opts, list_id = (container.attr('id') || p.id_prefix || '0'), me = this; /////// export public members and methods this.container = container; this.expand = expand; this.collapse = collapse; this.select = select; this.render = render; this.reset = reset; this.drag_start = drag_start; this.drag_end = drag_end; this.intersects = intersects; this.droppable = droppable; this.draggable = draggable; this.update = update_node; this.insert = insert; this.remove = remove; this.get_item = get_item; this.get_node = get_node; this.get_selection = get_selection; this.is_search = is_search; this.reset_search = reset_search; /////// startup code (constructor) // abort if node not found if (!container.length) return; if (p.data) index_data({ children:data }); // load data from DOM else update_data(); // register click handlers on list container.on('click', 'div.treetoggle', function(e){ toggle(dom2id($(this).parent())); e.stopPropagation(); }); container.on('click', 'li', function(e) { // do not select record on checkbox/input click if ($(e.target).is('input')) return true; var node = p.selectable ? indexbyid[dom2id($(this))] : null; if (node && !node.virtual) { select(node.id); e.stopPropagation(); } }); // mute clicks on virtual folder links (they need tabindex="0" in order to be selectable by keyboard) container.on('mousedown', 'a', function(e) { var link = $(e.target), node = indexbyid[dom2id(link.closest('li'))]; if (node && node.virtual && !link.attr('href')) { e.preventDefault(); e.stopPropagation(); return false; } }); // activate search function if (p.searchbox) { searchfield = $(p.searchbox).on('keyup', function(e) { var key = rcube_event.get_keycode(e), mod = rcube_event.get_modifier(e); switch (key) { case 9: // tab break; case 13: // enter search(this.value, true); return rcube_event.cancel(e); case 27: // escape reset_search(); break; case 38: // arrow up case 37: // left case 39: // right case 40: // arrow down return; // ignore arrow keys default: search(this.value, false); break; } }).attr('autocomplete', 'off'); // find the reset button for this search field searchfield.parent().find('a.reset').click(function(e) { reset_search(); return false; }) } container.on('focusin', function(e){ // TODO: only accept focus on virtual nodes from keyboard events has_focus = true; }) .on('focusout', function(e){ has_focus = false; }); container.attr('role', 'tree'); $(document.body) .bind('keydown', keypress); /////// private methods /** * Collaps a the node with the given ID */ function collapse(id, recursive, set) { var node; if (node = indexbyid[id]) { node.collapsed = typeof set == 'undefined' || set; update_dom(node); if (recursive && node.children) { for (var i=0; i < node.children.length; i++) { collapse(node.children[i].id, recursive, set); } } me.triggerEvent(node.collapsed ? 'collapse' : 'expand', node); save_state(id, node.collapsed); } } /** * Expand a the node with the given ID */ function expand(id, recursive) { collapse(id, recursive, false); } /** * Toggle collapsed state of a list node */ function toggle(id, recursive) { var node; if (node = indexbyid[id]) { collapse(id, recursive, !node.collapsed); } } /** * Select a tree node by it's ID */ function select(id) { if (selection) { id2dom(selection, true).removeClass('selected').removeAttr('aria-selected'); if (search_active) id2dom(selection).removeClass('selected').removeAttr('aria-selected'); selection = null; } if (!id) return; var li = id2dom(id, true); if (li.length) { li.addClass('selected').attr('aria-selected', 'true'); selection = id; // TODO: expand all parent nodes if collapsed if (search_active) id2dom(id).addClass('selected').attr('aria-selected', 'true'); scroll_to_node(li); } me.triggerEvent('select', indexbyid[id]); } /** * Getter for the currently selected node ID */ function get_selection() { return selection; } /** * Return the DOM element of the list item with the given ID */ function get_node(id) { return indexbyid[id]; } /** * Return the DOM element of the list item with the given ID */ function get_item(id, real) { return id2dom(id, real).get(0); } /** * Insert the given node */ function insert(node, parent_id, sort) { var li, parent_li, parent_node = parent_id ? indexbyid[parent_id] : null search_ = search_active; // ignore, already exists if (indexbyid[node.id]) { return; } // apply saved state state = get_state(node.id, node.collapsed); if (state !== undefined) { node.collapsed = state; } // insert as child of an existing node if (parent_node) { node.level = parent_node.level + 1; if (!parent_node.children) parent_node.children = []; search_active = false; parent_node.children.push(node); parent_li = id2dom(parent_id); // re-render the entire subtree if (parent_node.children.length == 1) { render_node(parent_node, parent_li.parent(), parent_li); li = id2dom(node.id); } else { // append new node to parent's child list li = render_node(node, parent_li.children('ul').first()); } // list is in search mode if (search_) { search_active = search_; // add clone to current search results (top level) if (!li.is(':visible')) { $('
  • ') .attr('id', li.attr('id') + '--xsR') .attr('class', li.attr('class')) .addClass('searchresult__') .append(li.children().first().clone(true, true)) .appendTo(container); } } } // insert at top level else { node.level = 0; data.push(node); li = render_node(node, container); } indexbyid[node.id] = node; if (sort) { resort_node(li, typeof sort == 'string' ? '[class~="' + sort + '"]' : ''); } } /** * Update properties of an existing node */ function update_node(id, updates, sort) { var li, parent_ul, parent_node, old_parent, node = indexbyid[id]; if (node) { li = id2dom(id); parent_ul = li.parent(); if (updates.id || updates.html || updates.children || updates.classes || updates.parent) { if (updates.parent && (parent_node = indexbyid[updates.parent])) { // remove reference from old parent's child list if (parent_ul.closest('li').length && (old_parent = indexbyid[dom2id(parent_ul.closest('li'))])) { old_parent.children = $.grep(old_parent.children, function(elem, i){ return elem.id != node.id; }); } // append to new parent node parent_ul = id2dom(updates.parent).children('ul').first(); if (!parent_node.children) parent_node.children = []; parent_node.children.push(node); } else if (updates.parent !== undefined) { parent_ul = container; } $.extend(node, updates); li = render_node(node, parent_ul, li); } if (node.id != id) { delete indexbyid[id]; indexbyid[node.id] = node; } if (sort) { resort_node(li, typeof sort == 'string' ? '[class~="' + sort + '"]' : ''); } } } /** * Helper method to sort the list of the given item */ function resort_node(li, filter) { var first, sibling, myid = li.get(0).id, sortname = li.children().first().text().toUpperCase(); li.parent().children('li' + filter).each(function(i, elem) { if (i == 0) first = elem; if (elem.id == myid) { // skip } else if (elem.id != myid && sortname >= $(elem).children().first().text().toUpperCase()) { sibling = elem; } else { return false; } }); if (sibling) { li.insertAfter(sibling); } else if (first && first.id != myid) { li.insertBefore(first); } // reload data from dom update_data(); } /** * Remove the item with the given ID */ function remove(id) { var node, li; if (node = indexbyid[id]) { li = id2dom(id, true); li.remove(); node.deleted = true; delete indexbyid[id]; return true; } return false; } /** * (Re-)read tree data from DOM */ function update_data() { data = walk_list(container, 0); } /** * Apply the 'collapsed' status of the data node to the corresponding DOM element(s) */ function update_dom(node) { var li = id2dom(node.id); li.attr('aria-expanded', node.collapsed ? 'false' : 'true'); li.children('ul').first()[(node.collapsed ? 'hide' : 'show')](); li.children('div.treetoggle').removeClass('collapsed expanded').addClass(node.collapsed ? 'collapsed' : 'expanded'); me.triggerEvent('toggle', node); } /** * */ function reset(keep_content) { select(''); data = []; indexbyid = {}; drag_active = false; if (keep_content) { if (draggable_opts) { if (ui_draggable) draggable('destroy'); draggable(draggable_opts); } if (droppable_opts) { if (ui_droppable) droppable('destroy'); droppable(droppable_opts); } update_data(); } else { container.html(''); } reset_search(); } /** * */ function search(q, enter) { q = String(q).toLowerCase(); if (!q.length) return reset_search(); else if (q == last_search && !enter) return 0; var hits = []; var search_tree = function(items) { $.each(items, function(i, node) { var li, sli; if (!node.virtual && !node.deleted && String(node.text).toLowerCase().indexOf(q) >= 0 && hits.indexOf(node.id) < 0) { li = id2dom(node.id); // skip already filtered nodes if (li.data('filtered')) return; sli = $('
  • ') .attr('id', li.attr('id') + '--xsR') .attr('class', li.attr('class')) .addClass('searchresult__') // append all elements like links and inputs, but not sub-trees .append(li.children(':not(div.treetoggle,ul)').clone(true, true)) .appendTo(container); hits.push(node.id); } if (node.children && node.children.length) { search_tree(node.children); } }); }; // reset old search results if (search_active) { $(container).children('li.searchresult__').remove(); search_active = false; } // hide all list items $(container).children('li').hide().removeClass('selected'); // search recursively in tree (to keep sorting order) search_tree(data); search_active = true; last_search = q; me.triggerEvent('search', { query: q, last: last_search, count: hits.length, ids: hits, execute: enter||false }); return hits.count; } /** * */ function reset_search() { if (searchfield) searchfield.val(''); $(container).children('li.searchresult__').remove(); $(container).children('li').filter(function() { return !$(this).data('filtered'); }).show(); search_active = false; me.triggerEvent('search', { query: false, last: last_search }); last_search = ''; if (selection) select(selection); } /** * */ function is_search() { return search_active; } /** * Render the tree list from the internal data structure */ function render() { if (me.triggerEvent('renderBefore', data) === false) return; // remove all child nodes container.html(''); // render child nodes for (var i=0; i < data.length; i++) { data[i].level = 0; render_node(data[i], container); } me.triggerEvent('renderAfter', container); } /** * Render a specific node into the DOM list */ function render_node(node, parent, replace) { if (node.deleted) return; var li = $('
  • ') .attr('id', p.id_prefix + (p.id_encode ? p.id_encode(node.id) : node.id)) .attr('role', 'treeitem') .addClass((node.classes || []).join(' ')) .data('id', node.id); if (replace) { replace.replaceWith(li); if (parent) li.appendTo(parent); } else li.appendTo(parent); if (typeof node.html == 'string') li.html(node.html); else if (typeof node.html == 'object') li.append(node.html); if (!node.text) node.text = li.children().first().text(); if (node.virtual) li.addClass('virtual'); if (node.id == selection) li.addClass('selected'); // add child list and toggle icon if (node.children && node.children.length) { li.attr('aria-expanded', node.collapsed ? 'false' : 'true'); $('
     
    ').appendTo(li); var ul = $('