3 * Copyright(c) 2006-2009 Ext JS, LLC
5 * http://www.extjs.com/license
8 * @class Ext.tree.TreeNodeUI
\r
9 * This class provides the default UI implementation for Ext TreeNodes.
\r
10 * The TreeNode UI implementation is separate from the
\r
11 * tree implementation, and allows customizing of the appearance of
\r
14 * If you are customizing the Tree's user interface, you
\r
15 * may need to extend this class, but you should never need to instantiate this class.<br>
\r
17 * This class provides access to the user interface components of an Ext TreeNode, through
\r
18 * {@link Ext.tree.TreeNode#getUI}
\r
20 Ext.tree.TreeNodeUI = function(node){
\r
22 this.rendered = false;
\r
23 this.animating = false;
\r
24 this.wasLeaf = true;
\r
25 this.ecc = 'x-tree-ec-icon x-tree-elbow';
\r
26 this.emptyIcon = Ext.BLANK_IMAGE_URL;
\r
29 Ext.tree.TreeNodeUI.prototype = {
\r
31 removeChild : function(node){
\r
33 this.ctNode.removeChild(node.ui.getEl());
\r
38 beforeLoad : function(){
\r
39 this.addClass("x-tree-node-loading");
\r
43 afterLoad : function(){
\r
44 this.removeClass("x-tree-node-loading");
\r
48 onTextChange : function(node, text, oldText){
\r
50 this.textNode.innerHTML = text;
\r
55 onDisableChange : function(node, state){
\r
56 this.disabled = state;
\r
57 if (this.checkbox) {
\r
58 this.checkbox.disabled = state;
\r
61 this.addClass("x-tree-node-disabled");
\r
63 this.removeClass("x-tree-node-disabled");
\r
68 onSelectedChange : function(state){
\r
71 this.addClass("x-tree-selected");
\r
74 this.removeClass("x-tree-selected");
\r
79 onMove : function(tree, node, oldParent, newParent, index, refNode){
\r
80 this.childIndent = null;
\r
82 var targetNode = newParent.ui.getContainer();
\r
83 if(!targetNode){//target not rendered
\r
84 this.holder = document.createElement("div");
\r
85 this.holder.appendChild(this.wrap);
\r
88 var insertBefore = refNode ? refNode.ui.getEl() : null;
\r
90 targetNode.insertBefore(this.wrap, insertBefore);
\r
92 targetNode.appendChild(this.wrap);
\r
94 this.node.renderIndent(true, oldParent != newParent);
\r
99 * Adds one or more CSS classes to the node's UI element.
\r
100 * Duplicate classes are automatically filtered out.
\r
101 * @param {String/Array} className The CSS class to add, or an array of classes
\r
103 addClass : function(cls){
\r
105 Ext.fly(this.elNode).addClass(cls);
\r
110 * Removes one or more CSS classes from the node's UI element.
\r
111 * @param {String/Array} className The CSS class to remove, or an array of classes
\r
113 removeClass : function(cls){
\r
115 Ext.fly(this.elNode).removeClass(cls);
\r
120 remove : function(){
\r
122 this.holder = document.createElement("div");
\r
123 this.holder.appendChild(this.wrap);
\r
128 fireEvent : function(){
\r
129 return this.node.fireEvent.apply(this.node, arguments);
\r
133 initEvents : function(){
\r
134 this.node.on("move", this.onMove, this);
\r
136 if(this.node.disabled){
\r
137 this.onDisableChange(this.node, true);
\r
139 if(this.node.hidden){
\r
142 var ot = this.node.getOwnerTree();
\r
143 var dd = ot.enableDD || ot.enableDrag || ot.enableDrop;
\r
144 if(dd && (!this.node.isRoot || ot.rootVisible)){
\r
145 Ext.dd.Registry.register(this.elNode, {
\r
147 handles: this.getDDHandles(),
\r
154 getDDHandles : function(){
\r
155 return [this.iconNode, this.textNode, this.elNode];
\r
162 this.node.hidden = true;
\r
164 this.wrap.style.display = "none";
\r
172 this.node.hidden = false;
\r
174 this.wrap.style.display = "";
\r
179 onContextMenu : function(e){
\r
180 if (this.node.hasListener("contextmenu") || this.node.getOwnerTree().hasListener("contextmenu")) {
\r
181 e.preventDefault();
\r
183 this.fireEvent("contextmenu", this.node, e);
\r
188 onClick : function(e){
\r
193 if(this.fireEvent("beforeclick", this.node, e) !== false){
\r
194 var a = e.getTarget('a');
\r
195 if(!this.disabled && this.node.attributes.href && a){
\r
196 this.fireEvent("click", this.node, e);
\r
198 }else if(a && e.ctrlKey){
\r
201 e.preventDefault();
\r
206 if(this.node.attributes.singleClickExpand && !this.animating && this.node.isExpandable()){
\r
207 this.node.toggle();
\r
210 this.fireEvent("click", this.node, e);
\r
217 onDblClick : function(e){
\r
218 e.preventDefault();
\r
222 if(this.fireEvent("beforedblclick", this.node, e) !== false){
\r
224 this.toggleCheck();
\r
226 if(!this.animating && this.node.isExpandable()){
\r
227 this.node.toggle();
\r
229 this.fireEvent("dblclick", this.node, e);
\r
233 onOver : function(e){
\r
234 this.addClass('x-tree-node-over');
\r
237 onOut : function(e){
\r
238 this.removeClass('x-tree-node-over');
\r
242 onCheckChange : function(){
\r
243 var checked = this.checkbox.checked;
\r
245 this.checkbox.defaultChecked = checked;
\r
246 this.node.attributes.checked = checked;
\r
247 this.fireEvent('checkchange', this.node, checked);
\r
251 ecClick : function(e){
\r
252 if(!this.animating && this.node.isExpandable()){
\r
253 this.node.toggle();
\r
258 startDrop : function(){
\r
259 this.dropping = true;
\r
262 // delayed drop so the click event doesn't get fired on a drop
\r
263 endDrop : function(){
\r
264 setTimeout(function(){
\r
265 this.dropping = false;
\r
266 }.createDelegate(this), 50);
\r
270 expand : function(){
\r
271 this.updateExpandIcon();
\r
272 this.ctNode.style.display = "";
\r
276 focus : function(){
\r
277 if(!this.node.preventHScroll){
\r
278 try{this.anchor.focus();
\r
282 var noscroll = this.node.getOwnerTree().getTreeEl().dom;
\r
283 var l = noscroll.scrollLeft;
\r
284 this.anchor.focus();
\r
285 noscroll.scrollLeft = l;
\r
291 * Sets the checked status of the tree node to the passed value, or, if no value was passed,
\r
292 * toggles the checked status. If the node was rendered with no checkbox, this has no effect.
\r
293 * @param {Boolean} (optional) The new checked status.
\r
295 toggleCheck : function(value){
\r
296 var cb = this.checkbox;
\r
298 cb.checked = (value === undefined ? !cb.checked : value);
\r
299 this.onCheckChange();
\r
306 this.anchor.blur();
\r
311 animExpand : function(callback){
\r
312 var ct = Ext.get(this.ctNode);
\r
314 if(!this.node.isExpandable()){
\r
315 this.updateExpandIcon();
\r
316 this.ctNode.style.display = "";
\r
317 Ext.callback(callback);
\r
320 this.animating = true;
\r
321 this.updateExpandIcon();
\r
324 callback : function(){
\r
325 this.animating = false;
\r
326 Ext.callback(callback);
\r
329 duration: this.node.ownerTree.duration || .25
\r
334 highlight : function(){
\r
335 var tree = this.node.getOwnerTree();
\r
336 Ext.fly(this.wrap).highlight(
\r
337 tree.hlColor || "C3DAF9",
\r
338 {endColor: tree.hlBaseColor}
\r
343 collapse : function(){
\r
344 this.updateExpandIcon();
\r
345 this.ctNode.style.display = "none";
\r
349 animCollapse : function(callback){
\r
350 var ct = Ext.get(this.ctNode);
\r
351 ct.enableDisplayMode('block');
\r
354 this.animating = true;
\r
355 this.updateExpandIcon();
\r
358 callback : function(){
\r
359 this.animating = false;
\r
360 Ext.callback(callback);
\r
363 duration: this.node.ownerTree.duration || .25
\r
368 getContainer : function(){
\r
369 return this.ctNode;
\r
373 * Returns the element which encapsulates this node.
\r
374 * @return {HtmlElement} The DOM element. The default implementation uses a <code><li></code>.
\r
376 getEl : function(){
\r
381 appendDDGhost : function(ghostNode){
\r
382 ghostNode.appendChild(this.elNode.cloneNode(true));
\r
386 getDDRepairXY : function(){
\r
387 return Ext.lib.Dom.getXY(this.iconNode);
\r
391 onRender : function(){
\r
396 render : function(bulkRender){
\r
397 var n = this.node, a = n.attributes;
\r
398 var targetNode = n.parentNode ?
\r
399 n.parentNode.ui.getContainer() : n.ownerTree.innerCt.dom;
\r
401 if(!this.rendered){
\r
402 this.rendered = true;
\r
404 this.renderElements(n, a, targetNode, bulkRender);
\r
407 if(this.textNode.setAttributeNS){
\r
408 this.textNode.setAttributeNS("ext", "qtip", a.qtip);
\r
410 this.textNode.setAttributeNS("ext", "qtitle", a.qtipTitle);
\r
413 this.textNode.setAttribute("ext:qtip", a.qtip);
\r
415 this.textNode.setAttribute("ext:qtitle", a.qtipTitle);
\r
418 }else if(a.qtipCfg){
\r
419 a.qtipCfg.target = Ext.id(this.textNode);
\r
420 Ext.QuickTips.register(a.qtipCfg);
\r
423 if(!this.node.expanded){
\r
424 this.updateExpandIcon(true);
\r
427 if(bulkRender === true) {
\r
428 targetNode.appendChild(this.wrap);
\r
434 renderElements : function(n, a, targetNode, bulkRender){
\r
435 // add some indent caching, this helps performance when rendering a large tree
\r
436 this.indentMarkup = n.parentNode ? n.parentNode.ui.getChildIndent() : '';
\r
438 var cb = Ext.isBoolean(a.checked),
\r
440 href = a.href ? a.href : Ext.isGecko ? "" : "#",
\r
441 buf = ['<li class="x-tree-node"><div ext:tree-node-id="',n.id,'" class="x-tree-node-el x-tree-node-leaf x-unselectable ', a.cls,'" unselectable="on">',
\r
442 '<span class="x-tree-node-indent">',this.indentMarkup,"</span>",
\r
443 '<img src="', this.emptyIcon, '" class="x-tree-ec-icon x-tree-elbow" />',
\r
444 '<img src="', a.icon || this.emptyIcon, '" class="x-tree-node-icon',(a.icon ? " x-tree-node-inline-icon" : ""),(a.iconCls ? " "+a.iconCls : ""),'" unselectable="on" />',
\r
445 cb ? ('<input class="x-tree-node-cb" type="checkbox" ' + (a.checked ? 'checked="checked" />' : '/>')) : '',
\r
446 '<a hidefocus="on" class="x-tree-node-anchor" href="',href,'" tabIndex="1" ',
\r
447 a.hrefTarget ? ' target="'+a.hrefTarget+'"' : "", '><span unselectable="on">',n.text,"</span></a></div>",
\r
448 '<ul class="x-tree-node-ct" style="display:none;"></ul>',
\r
451 if(bulkRender !== true && n.nextSibling && (nel = n.nextSibling.ui.getEl())){
\r
452 this.wrap = Ext.DomHelper.insertHtml("beforeBegin", nel, buf);
\r
454 this.wrap = Ext.DomHelper.insertHtml("beforeEnd", targetNode, buf);
\r
457 this.elNode = this.wrap.childNodes[0];
\r
458 this.ctNode = this.wrap.childNodes[1];
\r
459 var cs = this.elNode.childNodes;
\r
460 this.indentNode = cs[0];
\r
461 this.ecNode = cs[1];
\r
462 this.iconNode = cs[2];
\r
465 this.checkbox = cs[3];
\r
467 this.checkbox.defaultChecked = this.checkbox.checked;
\r
470 this.anchor = cs[index];
\r
471 this.textNode = cs[index].firstChild;
\r
475 * Returns the <a> element that provides focus for the node's UI.
\r
476 * @return {HtmlElement} The DOM anchor element.
\r
478 getAnchor : function(){
\r
479 return this.anchor;
\r
483 * Returns the text node.
\r
484 * @return {HtmlNode} The DOM text node.
\r
486 getTextEl : function(){
\r
487 return this.textNode;
\r
491 * Returns the icon <img> element.
\r
492 * @return {HtmlElement} The DOM image element.
\r
494 getIconEl : function(){
\r
495 return this.iconNode;
\r
499 * Returns the checked status of the node. If the node was rendered with no
\r
500 * checkbox, it returns false.
\r
501 * @return {Boolean} The checked flag.
\r
503 isChecked : function(){
\r
504 return this.checkbox ? this.checkbox.checked : false;
\r
508 updateExpandIcon : function(){
\r
510 var n = this.node,
\r
513 cls = n.isLast() ? "x-tree-elbow-end" : "x-tree-elbow",
\r
514 hasChild = n.hasChildNodes();
\r
515 if(hasChild || n.attributes.expandable){
\r
518 c1 = "x-tree-node-collapsed";
\r
519 c2 = "x-tree-node-expanded";
\r
522 c1 = "x-tree-node-expanded";
\r
523 c2 = "x-tree-node-collapsed";
\r
526 this.removeClass("x-tree-node-leaf");
\r
527 this.wasLeaf = false;
\r
529 if(this.c1 != c1 || this.c2 != c2){
\r
530 Ext.fly(this.elNode).replaceClass(c1, c2);
\r
531 this.c1 = c1; this.c2 = c2;
\r
535 Ext.fly(this.elNode).replaceClass("x-tree-node-expanded", "x-tree-node-leaf");
\r
538 this.wasLeaf = true;
\r
541 var ecc = "x-tree-ec-icon "+cls;
\r
542 if(this.ecc != ecc){
\r
543 this.ecNode.className = ecc;
\r
550 onIdChange: function(id){
\r
552 this.elNode.setAttribute('ext:tree-node-id', id);
\r
557 getChildIndent : function(){
\r
558 if(!this.childIndent){
\r
562 if(!p.isRoot || (p.isRoot && p.ownerTree.rootVisible)){
\r
564 buf.unshift('<img src="'+this.emptyIcon+'" class="x-tree-elbow-line" />');
\r
566 buf.unshift('<img src="'+this.emptyIcon+'" class="x-tree-icon" />');
\r
571 this.childIndent = buf.join("");
\r
573 return this.childIndent;
\r
577 renderIndent : function(){
\r
580 p = this.node.parentNode;
\r
582 indent = p.ui.getChildIndent();
\r
584 if(this.indentMarkup != indent){ // don't rerender if not required
\r
585 this.indentNode.innerHTML = indent;
\r
586 this.indentMarkup = indent;
\r
588 this.updateExpandIcon();
\r
592 destroy : function(){
\r
594 Ext.dd.Registry.unregister(this.elNode.id);
\r
597 Ext.each(['textnode', 'anchor', 'checkbox', 'indentNode', 'ecNode', 'iconNode', 'elNode', 'ctNode', 'wrap', 'holder'], function(el){
\r
599 Ext.fly(this[el]).remove();
\r
608 * @class Ext.tree.RootTreeNodeUI
\r
609 * This class provides the default UI implementation for <b>root</b> Ext TreeNodes.
\r
610 * The RootTreeNode UI implementation allows customizing the appearance of the root tree node.<br>
\r
612 * If you are customizing the Tree's user interface, you
\r
613 * may need to extend this class, but you should never need to instantiate this class.<br>
\r
615 Ext.tree.RootTreeNodeUI = Ext.extend(Ext.tree.TreeNodeUI, {
\r
617 render : function(){
\r
618 if(!this.rendered){
\r
619 var targetNode = this.node.ownerTree.innerCt.dom;
\r
620 this.node.expanded = true;
\r
621 targetNode.innerHTML = '<div class="x-tree-root-node"></div>';
\r
622 this.wrap = this.ctNode = targetNode.firstChild;
\r
625 collapse : Ext.emptyFn,
\r
626 expand : Ext.emptyFn
\r