YUI Library Examples: TreeView Control: Treeview Node Selection and Checkbox Example
TreeView Control: Treeview Node Selection and Checkbox Example
In this simple example you can see how to do node selection in the TreeView Control.
Tri-State Checkbox Example
Nodes of the TreeView Control can be highlighted in response to a user action or via code. That highlighting can affect a single node at a time or multiple nodes and it can propagate up or down the tree. In this example we show two trees built at random with different node highlighting settings.
We begin by defining the containers that will hold the trees.
The built-in stylesheet allows for two styles of highlighting,
the first one, selected via the className ygtv-checkbox, will add a tri-state checkbox
in between the toggle icon and the label, the second, selected via the className ygtv-highlight,
will change the background of highlighted nodes.
If neither of those classes are selected, the highlighting will still work,
but the user won't notice since there will be no visual clues.
We also add a button to show how highlighted (selected) nodes can be found.
| 1 | <h3>Tree with highlight propagation and 'checkbox' skin</h3> |
| 2 | <div id="treeDiv1" class="ygtv-checkbox"></div> |
| 3 | <button id="logHilit">Log selected</button> |
| 4 | <hr/> |
| 5 | <h3>Tree with single node highlighting and simple skin</h3> |
| 6 | <div id="treeDiv2" class="ygtv-highlight"></div> |
| view plain | print | ? |
We create the first TreeView and render it.
Function makeBranch recursively builds a random branch of TextNodes.
Highlighting is enabled by default, nodes can be highlighted via code,
but to respond to user events we need to attach the supplied listener onEventToggleHighlight
to the event we want to respond to.
We also want the highlighting to propagate both up and down.
| 1 | tree1 = new YAHOO.widget.TreeView("treeDiv1"); |
| 2 | makeBranch(tree1.getRoot()); |
| 3 | tree1.subscribe('clickEvent',tree1.onEventToggleHighlight); |
| 4 | tree1.setNodesProperty('propagateHighlightUp',true); |
| 5 | tree1.setNodesProperty('propagateHighlightDown',true); |
| 6 | tree1.render(); |
| view plain | print | ? |
The checkbox is tri-state because when the highlighting propagates up, the parent node into which it propagates might not have all its child nodes highlighted, so the checkbox has a partially checked state.
We can easily find out which nodes have been highlighted by searching the tree by property
highlighState which will be 0 for not-highlighted, 1 for highlighted
and 2 for a node that has some children highlighted.
| 1 | YAHOO.util.Event.on('logHilit','click',function() { |
| 2 | var hiLit = tree1.getNodesByProperty('highlightState',1); |
| 3 | if (YAHOO.lang.isNull(hiLit)) { |
| 4 | YAHOO.log("None selected"); |
| 5 | } else { |
| 6 | var labels = []; |
| 7 | for (var i = 0; i < hiLit.length; i++) { |
| 8 | labels.push(hiLit[i].label); |
| 9 | } |
| 10 | YAHOO.log("Highlighted nodes:\n" + labels.join("\n"), "info", "example"); |
| 11 | } |
| 12 | }); |
| view plain | print | ? |
For tree2 we have set property singleNodeHighlight to true
so that by selecting one node, the currently highlighted node, if any, will be un-highlighted.
The change in appearance is due to the highlighting 'skin' selected.
| 1 | tree2 = new YAHOO.widget.TreeView("treeDiv2"); |
| 2 | makeBranch(tree2.getRoot()); |
| 3 | tree2.singleNodeHighlight = true; |
| 4 | tree2.subscribe('clickEvent',tree2.onEventToggleHighlight); |
| 5 | tree2.render(); |
| view plain | print | ? |
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:
Logger Console
INFO 3376ms (+1) 1:39:38 PM:
TextNode (41): label-0-1
Generating html
INFO 3375ms (+0) 1:39:38 PM:
TextNode (38): label-0-0
Generating html
INFO 3375ms (+0) 1:39:38 PM:
TextNode (37): label-0
completeRender: 37, # of children: 2
INFO 3375ms (+0) 1:39:38 PM:
TextNode (37): label-0
rendering children for 37
INFO 3375ms (+0) 1:39:38 PM:
TextNode (37): label-0
Generating html
INFO 3375ms (+0) 1:39:38 PM:
RootNode
completeRender: 36, # of children: 1
INFO 3375ms (+0) 1:39:38 PM:
RootNode
rendering children for 36
INFO 3375ms (+0) 1:39:38 PM:
TreeView treeDiv2
tree init: treeDiv2
INFO 3375ms (+0) 1:39:38 PM:
TextNode (35): label-5-1-0
Generating html
INFO 3375ms (+0) 1:39:38 PM:
TextNode (34): label-5-1
completeRender: 34, # of children: 1
INFO 3375ms (+0) 1:39:38 PM:
TextNode (34): label-5-1
rendering children for 34
INFO 3375ms (+0) 1:39:38 PM:
TextNode (34): label-5-1
Generating html
INFO 3375ms (+0) 1:39:38 PM:
TextNode (33): label-5-0-0
Generating html
INFO 3375ms (+0) 1:39:38 PM:
TextNode (32): label-5-0
completeRender: 32, # of children: 1
INFO 3375ms (+1) 1:39:38 PM:
TextNode (32): label-5-0
rendering children for 32
INFO 3374ms (+0) 1:39:38 PM:
TextNode (32): label-5-0
Generating html
INFO 3374ms (+0) 1:39:38 PM:
TextNode (31): label-5
completeRender: 31, # of children: 2
INFO 3374ms (+0) 1:39:38 PM:
TextNode (31): label-5
rendering children for 31
INFO 3374ms (+0) 1:39:38 PM:
TextNode (31): label-5
Generating html
INFO 3374ms (+0) 1:39:38 PM:
TextNode (25): label-4
Generating html
INFO 3374ms (+0) 1:39:38 PM:
TextNode (15): label-3
Generating html
INFO 3374ms (+0) 1:39:38 PM:
TextNode (9): label-2
Generating html
INFO 3374ms (+0) 1:39:38 PM:
TextNode (8): label-1-0-1
Generating html
INFO 3374ms (+0) 1:39:38 PM:
TextNode (7): label-1-0-0
Generating html
INFO 3374ms (+0) 1:39:38 PM:
TextNode (6): label-1-0
completeRender: 6, # of children: 2
INFO 3374ms (+0) 1:39:38 PM:
TextNode (6): label-1-0
rendering children for 6
INFO 3374ms (+0) 1:39:38 PM:
TextNode (6): label-1-0
Generating html
INFO 3374ms (+0) 1:39:38 PM:
TextNode (5): label-1
completeRender: 5, # of children: 1
INFO 3374ms (+0) 1:39:38 PM:
TextNode (5): label-1
rendering children for 5
INFO 3374ms (+0) 1:39:38 PM:
TextNode (5): label-1
Generating html
INFO 3374ms (+0) 1:39:38 PM:
TextNode (1): label-0
Generating html
INFO 3374ms (+0) 1:39:38 PM:
RootNode
completeRender: 0, # of children: 6
INFO 3374ms (+2) 1:39:38 PM:
RootNode
rendering children for 0
INFO 3372ms (+31) 1:39:38 PM:
TreeView treeDiv1
tree init: treeDiv1
INFO 3341ms (+3340) 1:39:38 PM:
LogReader instance0
LogReader initialized
INFO 1ms (+0) 1:39:34 PM:
global
Logger initialized
TreeView Control Examples:
- Default TreeView
- Dynamically Loading Node Data
- Folder-Style TreeView Design
- Menu-Style TreeView Design
- Using TreeView with Custom Icons
- TreeView with Tooltips
- Three Ways to Define a TreeView: Markup (Progressive Enhancement), Existing TreeView Instance, and Object Literal
- Inline Editing of TreeView Node Labels
- Treeview Node Selection and Checkbox Example
- 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)
- Yahoo! UI Library
- Home (external)
- YUIBlog (external)
- YUI Discussion Forum (external)
- YUI on GitHub
- API Documentation
- Functional Examples
- YUI Theater (external)
- YUI License (external)
- YUI Functional Examples
- Animation
- AutoComplete
- Browser History Manager
- Button
- Calendar
- Carousel
- Charts
- Color Picker
- Cookie
- Connection Manager
- Container
- DataTable
- Dom
- Drag & Drop
- Event
- Get
- ImageCropper
- ImageLoader
- JSON
- Layout Manager
- Logger
- Menu
- Paginator
- Profiler
- ProfilerViewer
- ProgressBar
- Resize
- Rich Text Editor
- Selector
- Slider
- Storage
- SWF
- SWFStore
- Stylesheet
- TabView
- TreeView
- Uploader (experimental)
- YAHOO Global Object
- YUI Loader
- YUI Test
- Reset CSS
- Base CSS
- Fonts CSS
- Grids CSS
- YUI Articles on the YUI Website
- YUI FAQ (external)
- Graded Browser Support (external)
- Bug Reports/Feature Requests (external)
- Serving YUI Files from Yahoo! (external)
- Security Best Practices (external)
Copyright © 2009 Yahoo! Inc. All rights reserved.
Privacy Policy - Terms of Service - Copyright Policy - Job Openings