Easy DHTML treeview

A relatively easy implementation of a treeview using DHTML (Client Side Javascript in conjunction with DOM). This implementation is straightforward and doesn't require the filling of java-arrays.

Sample Image - DHTML_Treeview.jpg

Introduction

Have you ever tried to insert an easy-to-use treeview into your homepage or even use a treeview in your web-application? If you have, you will probably know that most ready-made treeviews out there are built in a quite complex manner, making heavy use of client side javascript and difficult-to-handle structures like multi-dimensional arrays and such. There is, however, a more elegant way of implementing a treeview using only one small client-side javascript and making use of DOM (Document Object Model) and basic HTML-tags such as DIV.

The 'Easy DHTML Treeview' builds a treeview on top of the Document Object Model, which already is hierarchical by definition. The whole idea of the 'Easy DHTML Treeview' is using simple HTML tags such as DIV and A to create the real tree and then using one simple javascript function (triggered by clicking on a branch) to collapse and unfold all of the children (branches and leaves) by hiding or showing the DIV-item (if a DIV item is hidden, all the children of the DIV item are hidden as well).

Overview of design

So, when you click on the yellow 'branch name', the javascript function Toggle will be called with a pointer to the branch name itsself. The Toggle-function will then ask the document (using DOM) what the next item is (which in this case is the yellow DIV-section) and hide it. If the yellow DIV-section is hidden all items inside the yellow square (which is almost everything in the picture) will be hidden as well.

Serialising the treeview

The good thing about this simple implementation is that it is very easy to construct a treeview from data that can be stored in a database. Whereas other treeview functions and components force you to fill a javascript array (which is only 2 levels deep anyway and therefore not a real n-level tree), 'Easy DHTML Treeview' allows you to simply print the data as if it were a table. The whole functionality of collapsing and unfolding the branches in the tree is then added almost automatically by the single function that does it all!

The included demo-project shows you that it is really quite easy to create very dynamic, n-level truly recursive trees using 'Easy DHTML Treeview'. For storing the data in the tree, this data model is used:

E-R Diagram

Like a treeview, the data model itself is recursive, because topic and topic_1 are the very same table. This means topic has a relation to topic, with the subtopic table in between to implement an n-n relationship.

Tips & Tricks

I got a lot of questions about the treeview so I'd just answer some of them here for your convenience:

How can I change the initial state of the treeview from collapsed to expanded? The answer is quite simple. If you're using the static version (from the live demo-site, simply omit the style attribute from the DIV-tags. So what was < DIV style='display:none' > simply becomes < DIV >. And of course if you're into details, you should change the images in front of the items from plus.gif to minus.gif. If you're using the scripts that generate a tree from a database, you should hack it the other way around, because that sample is initially expanded. It's quite straightforward, but when I find the time I could post 2 versions of the samples, one collapsed and the other one expanded.

How can I liven up the treeview to make it look better? Well, I've been working on a pure-HTML extension of the treeview with a colleague of mine, which draws lines in the treeview, like MFC treeviews do. I will post this version shortly.

Cross-browser treeview?

I developed this treeview for Internet Explorer 5, which is not such a good idea if you want to develop a cross-browser treeview because Microsoft has the tendency to build all kind of fancy non-standard goodies into it's browser. Luckily some people on the CodeProject have tested it on other browsers and it only seemed to work on IE5 (not even IE4!). I'm now in the process of evaluating what I can do to improve this. Today (June 13th 2001) I checked all my script-entries against the actual standards and found out that all of it should work on browsers supporting CSS Level 1, HTML 4.0 and DOM Level 2. I made some modifications today as well and I'm curious on which browsers the script works correctly.

The treeview has been tested on the following browsers:

Microsoft Internet Explorer 4 (SP 2)	Doesn't Work!
Microsoft Internet Explorer 5.0 (for Macintosh)	Work partially (different look)
Microsoft Internet Explorer 5.00.3103.1000	Works!
Microsoft Internet Explorer 5.50.4522.1800C0	Works!
Microsoft Internet Explorer 6.00.2462.0000	Works!
Netscape 4.77	Doesn't work!
Netscape 6	Works!
Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; 0.8.1) Gecko/20010323	Works!
Opera 5.0 (Build 528 on Windows 2000)	Doesn't work!
Opera 6	Doesn't work!

(Thanks to Jorge Sabater Redondo, Alexandra Berg, Neal Costello, Zinggl Alois, Jens Kreiensiek, Arnt Witteveen, Jamie Nordmeyer, Bryan Pietrzak and Bruce for the testing!)

If you have another browser than listed above, please test the script at THIS live-demo site and mail me to tell me if it did or didn't work on your browser... Together we can build a better treeview, I know it! ;-)

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

About the Author

D.D. de Kerf

Web Developer

Netherlands

Member

I completed college Higher Informatics (HIO Breda, The Netherlands) in august 2000. I have been software engineer/documentalist/project manager with Bodégro Technical Automation since 1998 (started as part-time, full-time since august 2000).

Lots of experience with Delphi, Visual C++, PL/SQL, ASP and PHP. Started a succesfull knowledge-sharing initiative in late 1999 called 'Cohort Forum', which resulted in a web-site a lot like the codeproject.

Article Top

Poor

Excellent

Add a reason or comment to your vote: x
Votes of 3 or less require a comment

Comments and Discussions

You must Sign In to use this message board. (secure sign-in)

Search this forum
	Profile popups Noise Layout Per page

Re: A helpful article!

HTML&JavascriptLearner

18:09 23 Mar '05

HTML treeview

rachnadevraj@yahoo.co.in

18:36 24 Jan '05

Mozilla 1.6, Netscape 7.1 support

evaki

6:57 22 Jan '05

Expand/Collapse All

dsacker

6:26 19 Nov '04

Re: Expand/Collapse All

dsacker

6:48 19 Nov '04

Re: Expand/Collapse All

gewe

2:01 21 Jun '05

Re: Expand/Collapse All

dsacker

3:24 21 Jun '05

Here is a complete example with HTML, javascript and styles in one:

<html>
<head><title>Tree View Example</title></head>
<script language=javascript>
   var saveHeading;
   function Save_Heading() {
      var strHeading = heading.innerHTML;
      saveHeading = strHeading;
   }
   function Restore_Heading() {
      var strHeading = heading.innerHTML;
      var newHeading = saveHeading;
      heading.innerHTML = newHeading;
   }
   function Toggle_All() {
      var strDisplay = "none";
      var strSrc = heading.firstChild.src;
      var strText = heading.lastChild.data;
      var strStatus = window.defaultStatus;
      var strOperation = "Expanding ";
      if (strText == "Expand All") {
            strDisplay = "";
            strSrc = "minus.gif";
            strText = "Collapse All";
            strOperation = "Collapsing ";
   } else {
            strDisplay = "none";
            strSrc = "plus.gif";
            strText = "Expand All"; }
   //------------------------------------------------------//
   //   Now that we know what to toggle, set the header      //
   //------------------------------------------------------//
      heading.firstChild.src = strSrc;
      heading.lastChild.data = strText;
      var objTable = heading.parentNode;
      while (objTable.tagName != "TABLE") {
            var objTable = objTable.nextSibling; }
   //------------------------------------------------------//
   //   Go through every IMG and DIV, and set.                  //
   //------------------------------------------------------//
      var objA = objTable.getElementsByTagName('a');
//   for (i = 0; i < objA.length; i++) {
//   for (i = (objA.length - 1); i < 0; i--) {
      var i=objA.length;
      while (i-- > 0) {
            var objItem = objA(i);
            var objDIV = objItem.nextSibling;
            for (j = 0; j < objItem.childNodes.length; j++) {
                  if (objItem.childNodes[j].tagName == "IMG" ) {
                        var objIMG = objItem.childNodes[j];
                        break; }
            }
            var pos = objIMG.src.lastIndexOf("/") + 1;
            var oldSrc = objIMG.src.substring(pos, 99);
            if (oldSrc == "plus.gif" || oldSrc == "minus.gif") {
                  window.status = strOperation + objIMG.nextSibling.data;
                  objIMG.src = strSrc;
                  objDIV.style.display = strDisplay;
            }
      }
      window.status = strStatus;
   }
   function Toggle(node) {
      var strDisplay = "none";
      var strSrc = "plus.gif";

      if (node.nextSibling.style.display == "none") {
         strSrc = "minus.gif";
         strDisplay = ""; }

      if (node.childNodes.length > 0) {
         if (node.childNodes[0].tagName == "IMG")
               node.childNodes[0].src = strSrc;
         var objNode = node;
         node.nextSibling.style.display = strDisplay; }
   }
   function Update_Heading(message) {
      heading.innerHTML = message;
   }
</script>
<style>
                  p { font-family      :"Arial,Helvetica,Sans Serif,Tacoma";
                        font-size         : 12pt; }
   table,tr,td { font-family      :"Arial,Helvetica,Sans Serif,Tacoma";
                        font-size         : 9pt;
                        vertical-align : top;
                        white-space      : nowrap; }
            table { border-style   : none; }
               td { position         : relative;
                        left               : 15; }
            td.0 { position         : relative;
                        left               : 0; }
</style>
<body>
<p><b>Tree View Example      </b><small id=heading onclick=Toggle_All()><img src="minus.gif">Collapse All</small></p>
<script>Save_Heading()</script>
<script language="Javascript">Update_Heading("Opening database ...");</script>
<table><tr><td class=0><a onClick="Toggle(this)"><img src="minus.gif">Main Tree</a><div>
<script language="Javascript">Update_Heading("Loading Administrator ...");</script>
<table><tr><td><a onClick="Toggle(this)"><img src="minus.gif">United States</a><div>
   <table><tr><td><a onClick="Toggle(this)"><img src="minus.gif">Western Region</a><div>
   <table><tr><td><a onClick="Toggle(this)"><img src="minus.gif">States</a><div>
      <table><tr><td><a onClick="Toggle(this)"><img src="minus.gif">Arizona</a><div>
      <table><tr><td><a onClick="Toggle(this)"><img src="minus.gif">Cities</a><div>
         <table><tr><td><img src="leaf.gif">Flagstaff</td></tr></table>
         <table><tr><td><img src="leaf.gif">Grand Canyon Village</td></tr></table>
         <table><tr><td><img src="leaf.gif">Phoenix</td></tr></table>
         <table><tr><td><img src="leaf.gif">Sedona</td></tr></table>
         <table><tr><td><img src="leaf.gif">Winslow</td></tr></table>
      </div></td></tr></table>
      </div></td></tr></table>
      <table><tr><td><img src="leaf.gif">New Mexico</td></tr></table>
      <table><tr><td><a onClick="Toggle(this)"><img src="minus.gif">Colorado</a><div>
      <table><tr><td><a onClick="Toggle(this)"><img src="minus.gif">Cities</a><div>
         <table><tr><td><img src="leaf.gif">Boulder</td></tr></table>
         <table><tr><td><a onClick="Toggle(this)"><img src="minus.gif">Denver</a><div>
         <table><tr><td><a onClick="Toggle(this)"><img src="minus.gif">Restaurants</a><div>
            <table><tr><td><img src="leaf.gif">Joe's Place</td></tr></table>
         </div></td></tr></table>
         </div></td></tr></table>
         <table><tr><td><img src="leaf.gif">Durango</td></tr></table>
         <table><tr><td><img src="leaf.gif">Estes Park</td></tr></table>
         <table><tr><td><img src="leaf.gif">Grandby</td></tr></table>
      </div></td></tr></table>
      </div></td></tr></table>
   </div></td></tr></table>
   </div></td></tr></table>
</div></td></tr></table>
</div></td></tr></table>
<script>Restore_Heading()</script>
</body>
</html>