Click here to Skip to main content
Click here to Skip to main content

JScript Tree List Control v3.0

By , 6 Dec 2002
Rate this:
Please Sign up or sign in to vote.

Sample Image - treelistcontrol.v3.gif

Introduction

This is my third attempt at making a TreeListControl for Internet Explorer-based web applications. The first was very slow and required ASP to generate a tree. The second has lots of features, and even resizable columns, but, while it did not suffer from the freeze-up delays that occurred in the first one, was generally sluggish in operation if there were more than a few nodes on the screen. This latest version has tighter code and is generally more versatile all round. It doesn't have resizable columns, but it shouldn't be too hard to put them in. If I do that, I'll upload the updated version here. The only other major limitation of this control is that it is fixed-width. That is, you have to specify the exact width of each column, and this determines the control width.

Features that version 3.0 has are:

  • Enable/disable column headings
  • Enable/disable root node
  • The ability to choose which column the tree appears in
  • Dynamic loading of branches via XML files
  • Completely dynamic updating of the tree structure after it has been generated, including:
    • remove nodes
    • add new nodes
    • remove nodes and re-add them somewhere else
    • insert before or after a specified node
    • expand/collapse branches
  • optional row onclick action
  • row highlights while being pointed at
  • prevent specified columns from firing the row onclick event (e.g. for a column of checkboxes)

To use the control, simply include treelistcontrol.js and treelistcontrol.css in your html file, then, inside the element (body tag, div tag, or where ever) you want to render the tree inside, place a script tag and build the tree according to the API. A demo of how to do this is inside the included zip file.

Usage

See the API below for explanations of the tree's objects, and the file demo.htm for an example of how to use the tree.

  1. Create a tree control
  2. Create and add the columns to the tree
  3. Add all the initial nodes to the tree
  4. document.write the tree object to the page

Tree List Control v3.0 API

TreeListControl

TreeListControl(strRootNodeLabel, strRootNodeIconSrc, boolHideColumnHeadings, boolHideRootNode)

  • strRootNodeLabel: the label to use for the root node
  • strRootNodeIconSrc: the path to the node's icon
  • boolHideColumnHeadings: don't show the column headings
  • boolHideRootNode: don't show the root node

Properties

  • showColumnHeadings: hide/show the column headings. The visibility of the column headings will automatically change depending on the state of this property.
  • showRootNode: hide/show the root node. The visibility of the root node will automatically change depending on the state of this property.
  • all: this is a collection (array) contain references to all the nodes that were assigned a non-null refKey when added to the tree. usage: mytree.all['mynoderefKey']
  • allNodes: this is a collection containing references to every node in the tree, indexed by the node's automatically assigned ID property.
  • rootNode: a reference to the tree's root node. This is of type TreeListControlNode.
  • iconPath: the path to the location where the tree's images are stored. The default is 'tlcimages/'.

Methods

  • addColumn( oColumnObject ): adds a column to the tree. Do not use this once the tree has been rendered to the page. Pass in a reference to a TreeListControlColumn object that defines the column's parameters.
  • add( oNodeObject ): appends a node to the children of the root node. Pass in a reference to a previously created node.

TreeListControlColumn

TreeListControlColumn (intWidth, strTitle, boolPreventRowClickEvents)

  • intWidth: the width, in pixels, of the column.
  • strTitle: the heading/title of the column. Use a zero-length string if no title is desired.
  • boolPreventRowClickEvents: when a row is clicked, it fires the onclick event for that row. Setting this parameter to true will prevent clicks in this row from firing that event.

TreeListControlNode

TreeListControlNode (boolShowChildren, strIconSrc, strXMLSrc, strReferenceKey)

  • boolShowChildren: this specifies the initial expand/collapse state for the node.
  • strIconSrc: the path to the icon image to use.
  • strXMLSrc: if the children of this node are to be loaded at run-time when the node is expanded, this parameter should contain the URL of the XML file. Set to null or '' if not used.
  • strReferenceKey: if you want to use your own identifiers for each node, instead of the automatically-assigned ID that each node has, specify the identifier here. It can be an integer or a string, and, once the node has been added to the tree, you can access the node via the all property of the TreeListControl object.

Properties

  • onclick: the javascript to execute when the onclick event fires for that node. Only set this before the node has been added to the tree.

Methods

  • expand: shows the node's children.
  • collapse: hides the node's children.
  • setText( strColumn1, strColumn2, ..., strColumnN ): sets the node's text in each column.
  • setColumnText( intColumn, strText ): sets the text for the node in the specified column.
  • add( oNodeObject ): appends a node object to this node's children. DO NOT use this method if this node has not yet been added to the tree.
  • insertBefore( oNodeObject ): inserts the supplied node immediately before this node.
  • insertAfter( oNodeObject ): inserts the supplied node directly after this node.
  • remove(): removes this node from the tree completely and returns a reference to the node so that it can be reinserted elsewhere if desired.

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

Nathan Ridley
Web Developer
Australia Australia
Web application developer, graphic designer, aspiring entrepreneur, snowboarder and electronic music afficianado.
 

Comments and Discussions

 
Generalit's so good PinsussAnonymous3-Aug-03 17:13 
GeneralFreeze up Pinmemberpobrob23-Jul-03 11:32 
GeneralRe: Freeze up Pinmembertigertoy18-Dec-03 9:25 
GeneralRe: Freeze up Pinmemberpobrob19-Dec-03 6:44 
GeneralRe: Freeze up PinsussOliver Haskell28-Jan-04 2:25 
GeneralTreeListControlHandler.allTrees.6.showRootNode is Null or no Object PinsussM.E.-P._Germany16-Jul-03 22:28 
GeneralRe: TreeListControlHandler.allTrees.6.showRootNode is Null or no Object Pinmemberpobrob17-Jul-03 3:49 
GeneralRe: TreeListControlHandler.allTrees.6.showRootNode is Null or no Object PinmemberM.E.-P._Germany17-Jul-03 10:00 
Thanks for answering,
but doesn't the code has to be evaluated in the new Window to display the tree there (in the new window)?
You think I should evaluate the code in the existing window, right? But if I evaluate the code in the existing window, it builds the tree into the existing window which I already have working in another function also mentionend in my question before.
 
So how do I define the tree or "TreeListControlHandler.allTrees.6.showRootNode" in my new window? Any ideas?
Or am I wrong at that point that I have to do that? Or do I just don't see the wood for the trees?
 
Appreciate any help on that.
 
Mathias
 


GeneralRe: TreeListControlHandler.allTrees.6.showRootNode is Null or no Object PinmemberNathan Ridley17-Jul-03 14:01 
GeneralRe: TreeListControlHandler.allTrees.6.showRootNode is Null or no Object PinsussM.EP_Germany17-Jul-03 21:26 
GeneralRe: TreeListControlHandler.allTrees.6.showRootNode is Null or no Object PinmemberNathan Ridley29-Apr-04 19:15 
GeneralHad to change Status to 200 Pinmemberpobrob16-Jul-03 5:42 
GeneralRe: Had to change Status to 200 PinmemberNathan Ridley16-Jul-03 12:30 
GeneralRe: Had to change Status to 200 Pinmemberrcolonia19-Jul-03 11:05 
GeneralVery Good Pinmembereugenesun15-Jul-03 0:04 
Generalwired tree behavior Pinmemberiwavelet10-Jul-03 11:01 
GeneralRe: wired tree behavior PinmemberNathan Ridley10-Jul-03 12:29 
GeneralRe: wired tree behavior Pinmemberiwavelet14-Jul-03 5:42 
GeneralClipped checkboxes + SOAP + XML PinsussOla Strandberg26-Jun-03 1:01 
GeneralWhich Versions of IE Pinmemberpobrob25-Jun-03 9:06 
GeneralRe: Which Versions of IE PinmemberNathan Ridley25-Jun-03 12:40 
GeneralUsing showchildren in an XML Pinmemberbsleek11-Jun-03 11:00 
GeneralRe: Using showchildren in an XML PinmemberNathan Ridley11-Jun-03 12:27 
GeneralRe: Using showchildren in an XML Pinmemberbsleek11-Jun-03 13:53 
Generalgood job Pinmemberroger_ca28-May-03 4:07 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web04 | 2.8.140415.2 | Last Updated 7 Dec 2002
Article Copyright 2002 by Nathan Ridley
Everything else Copyright © CodeProject, 1999-2014
Terms of Use
Layout: fixed | fluid