YUI Library Home

Site Search (YDN & YUIBlog):

# YUI Library Examples: TreeView Control: Inline Editing of TreeView Node Labels

# TreeView Control: Inline Editing of TreeView Node Labels

This example demonstrates label editing and keyboard navigation in the YUI TreeView Control. As you interact with the TreeView instance below, you'll find that some nodes allow you to edit them — double-click on node labels to open the inline editor. This example also demonstrates how you can use arrow keys, +/- keys (expand/collapse), and the enter key to navigate and control the TreeView instance.

View example in new window.

## Label editing and keyboard navigation.

This example for the TreeView Control demonstrates user interaction models for inline editing and keyboard navigation. The second node in the tree, the one labeled `Label 1`, has the focus initially. The arrow, home and end keys can be used to move the focus on other nodes, the plus and minus (+/-) keys to expand/collapse nodes and shift-plus and shift-minus to expand-all/collapse-all.

The Enter key will act as a click on the node with the focus. It will expand or collapse it or will navigate if the node has an `href` property.

The example has event listeners for click, double-click and enter key pressed which will signal the event at the bottom of the box. The click and double click events will not fire when the toggle icon is clicked since toggling has specific events associated with it.

Nodes defined by simple strings, instead of full object definitions, are plain non-editable TextNodes. They can be clicked, double-clicked and Enter pressed while the focus is on any of them.

A `DateNode` is included which is also editable via the YUI Calendar Control. The date is set in `dd.mm.yyyy` format and it has been declared so by the `calendarConfig` property which is the same used by Calendar (see: Creating International Calendars).

Here is the JavaScript we use to define the TreeView instance in this example:

// Create a tree with an assortment of nodes tree = new YAHOO.widget.TreeView("treeView", [ 'Label 0', {type:'Text', label:'Label 1', editable:true}, {type:'Text', label:'Branch 2', editable:true, expanded:true, children:[ {type:'Text', label:'Branch 2-0', editable:true, children: [ 'Label 2-0-0', 'Label 2-0-1' ]}, {type:'Text', label:'Branch 2-1', editable:true, children: [ 'Label 2-1-0', 'Label 2-1-1' ]}, ]}, {type:'Text',label:'YAHOO', href:'http://www.yahoo.com', target:'YAHOO\'s home page'}, {type:'DateNode',label:'31.3.2001',editable:true, calendarConfig: { DATE_FIELD_DELIMITER:".", MDY_DAY_POSITION:1, MDY_MONTH_POSITION:2, MDY_YEAR_POSITION:3 }}, {type:'Text',label:'Branch 3', editable:true, expanded:false, children:[ 'Label 3-0', 'Label 3-1' ]} ]); // render it tree.render(); // Make the editor pop-up on a double click tree.subscribe('dblClickEvent',tree.onEventEditNode); // Place the focus on the second node tree.root.children[1].focus(); // report events tree.subscribe('enterKeyPressed',function(node) { YAHOO.util.Dom.get('msg').innerHTML = 'Enter key pressed on node: ' + node.label; }); tree.subscribe('clickEvent',function(oArgs) { YAHOO.util.Dom.get('msg').innerHTML = 'Click on node: ' + oArgs.node.label; }); tree.subscribe('dblClickEvent',function(oArgs) { YAHOO.util.Dom.get('msg').innerHTML = 'Double click on node: ' + oArgs.node.label; });

## Configuration for This Example

You can load the necessary JavaScript and CSS for this example from Yahoo's servers. Click here to load the YUI Dependency Configurator with all of this example's dependencies preconfigured.

### YUI Logger Output:

### TreeView Control Examples:

- Default TreeView
- Dynamically Loading Node Data
- Folder-Style TreeView Design
- Menu-Style TreeView Design
- Using TreeView with Custom Icons
- Custom TreeView with Check Boxes
- TreeView with Tooltips
- Three Ways to Define a TreeView: Markup (Progressive Enhancement), Existing TreeView Instance, and Object Literal
- Inline Editing of TreeView Node Labels
- Adding A Context Menu To A TreeView (included with examples for Menu Family)

### More TreeView Control Resources:

- User's Guide (external)
- API Documentation
- Cheat Sheet PDF (external)

Copyright © 2009 Yahoo! Inc. All rights reserved.

Privacy Policy - Terms of Service - Copyright Policy - Job Openings