Adding A Context Menu To A TreeView : Tree TreeView « YUI Library « JavaScript DHTML






Adding A Context Menu To A TreeView

 


<!--
Software License Agreement (BSD License)
Copyright (c) 2009, Yahoo! Inc.
All rights reserved.

Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, this list of conditions and the
      following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
    * Neither the name of Yahoo! Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission of Yahoo! Inc.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Sources of Intellectual Property Included in the YUI Library

YUI is issued by Yahoo! under the BSD license above. Below is a list of certain publicly available software that is the source of intellectual property in YUI, along with the licensing terms that pertain to thosesources of IP. This list is for informational purposes only and is not intended to represent an exhaustive list of third party contributions to the YUI.

    * Douglas Crockford's JSON parsing and stringifying methods: In the JSON Utility, Douglas Crockford's JSON parsing and stringifying methods are adapted from work published at JSON.org. The adapted work is in the public domain.
    * Robert Penner's animation-easing algorithms: In the Animation Utility, YUI makes use of Robert Penner's algorithms for easing.
    * Geoff Stearns's SWFObject: In the Charts Control and the Uploader versions through 2.7.0, YUI makes use of Geoff Stearns's SWFObject v1.5 for Flash Player detection and embedding. More information on SWFObject can be found here (http://blog.deconcept.com/swfobject/). SWFObject is (c) 2007 Geoff Stearns and is released under the MIT License (http://www.opensource.org/licenses/mit-license.php).
    * Diego Perini's IEContentLoaded technique: The Event Utility employs a technique developed by Diego Perini and licensed under GPL. YUI's use of this technique is included under our BSD license with the author's permission.

-->

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
        "http://www.w3.org/TR/html4/strict.dtd">
<html>
    <head>
        <meta http-equiv="content-type" content="text/html; charset=utf-8">
        <title>Example: Adding A Context Menu To A TreeView (YUI Library)</title>

        <!-- Standard reset and fonts -->

        <link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/reset/reset.css">
        <link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/fonts/fonts.css">
            

        <!-- CSS for TreeView -->
        <link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/treeview/assets/skins/sam/treeview.css">
         

        <!-- CSS for Menu -->

        <link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/menu/assets/skins/sam/menu.css"> 


        <!-- Page-specific styles -->

        <style type="text/css">

            h1 { 

                font-weight: bold; 
                margin: 0 0 1em 0;
            }

            body {
            
                padding: 1em;
            
            }

            p, ul {

                margin: 1em 0;

            }

            
            p em,
            #operainstructions li em {

                font-weight: bold;

            }

            #operainstructions {

                list-style-type: square;
                margin-left: 2em;

            }

        </style>


        <!-- Dependency source files -->

        <script type="text/javascript" src="yui_2.7.0b-lib/yahoo-dom-event/yahoo-dom-event.js"></script>
        <script type="text/javascript" src="yui_2.7.0b-lib/container/container_core.js"></script>
        <script type="text/javascript" src="yui_2.7.0b-lib/treeview/treeview.js"></script>


        <!-- Menu source file -->

        <script type="text/javascript" src="yui_2.7.0b-lib/menu/menu.js"></script>


        <!-- Page-specific script -->

        <script type="text/javascript">

            /*
                 Initialize the TreeView instance when the "mytreeview" <div>
                 is ready to be scripted.
            */

            YAHOO.util.Event.onAvailable("mytreeview", function () {

                /*
                     Map of YAHOO.widget.TextNode instances in the 
                     TreeView instance.
                */

                var oTextNodeMap = {};
            

                // Creates a TextNode instance and appends it to the TreeView 

                function buildRandomTextBranch(p_oNode) {

                    var oTextNode,
                        i;

                    if (p_oNode.depth < 6) {

                        for (i = 0; i < Math.floor(Math.random() * 4); i++) {

                            oTextNode = new YAHOO.widget.TextNode(p_oNode.label + "-" + i, p_oNode, false);

                            oTextNodeMap[oTextNode.labelElId] = oTextNode;
                            
                            buildRandomTextBranch(oTextNode);

                        }

                    }

                }


                // Create a TreeView instance

                var oTreeView = new YAHOO.widget.TreeView("mytreeview");

                var n, oTextNode;

                for (n = 0; n < Math.floor((Math.random()*4) + 3); n++) {

                    oTextNode = new YAHOO.widget.TextNode("label-" + n, oTreeView.getRoot(), false);
                    
                    /*
                         Add the TextNode instance to the map, using its
                         HTML id as the key.
                    */
                    
                    oTextNodeMap[oTextNode.labelElId] = oTextNode;
                    
                    buildRandomTextBranch(oTextNode);

                }
        
                oTreeView.draw();


                /*
                     The YAHOO.widget.TextNode instance whose "contextmenu" 
                     DOM event triggered the display of the 
                     ContextMenu instance.
                */

                var oCurrentTextNode = null;


                /*
                     Adds a new TextNode as a child of the TextNode instance 
                     that was the target of the "contextmenu" event that 
                     triggered the display of the ContextMenu instance.
                */

                function addNode() {

                    var sLabel = window.prompt("Enter a label for the new node: ", ""),
                        oChildNode;

                    if (sLabel && sLabel.length > 0) {
                        
                        oChildNode = new YAHOO.widget.TextNode(sLabel, oCurrentTextNode, false);
    
                        oCurrentTextNode.refresh();
                        oCurrentTextNode.expand();

                        oTextNodeMap[oChildNode.labelElId] = oChildNode;

                    }

                }
                

                /*
                     Edits the label of the TextNode that was the target of the
                     "contextmenu" event that triggered the display of the 
                     ContextMenu instance.
                */

                function editNodeLabel() {

                    var sLabel = window.prompt("Enter a new label for this node: ", oCurrentTextNode.getLabelEl().innerHTML);
    
                    if (sLabel && sLabel.length > 0) {
                        
                        oCurrentTextNode.getLabelEl().innerHTML = sLabel;
    
                    }

                }
                

                /*
                    Deletes the TextNode that was the target of the "contextmenu"
                    event that triggered the display of the ContextMenu instance.
                */

                function deleteNode() {

                    delete oTextNodeMap[oCurrentTextNode.labelElId];

                    oTreeView.removeNode(oCurrentTextNode);
                    oTreeView.draw();

                }


                /*
                    "contextmenu" event handler for the element(s) that 
                    triggered the display of the ContextMenu instance - used
                    to set a reference to the TextNode instance that triggered
                    the display of the ContextMenu instance.
                */

                function onTriggerContextMenu(p_oEvent) {

          var oTarget = this.contextEventTarget,
            Dom = YAHOO.util.Dom;

                    /*
                         Get the TextNode instance that that triggered the 
                         display of the ContextMenu instance.
                    */

                    var oTextNode = Dom.hasClass(oTarget, "ygtvlabel") ? 
                              oTarget : Dom.getAncestorByClassName(oTarget, "ygtvlabel");

                    if (oTextNode) {

                        oCurrentTextNode = oTextNodeMap[oTarget.id];

                    }
                    else {
                    
                        // Cancel the display of the ContextMenu instance.
                    
                        this.cancel();
                        
                    }
                
                }


                /*
          Instantiate a ContextMenu:  The first argument passed to the constructor
          is the id for the Menu element to be created, the second is an 
          object literal of configuration properties.
                */

                var oContextMenu = new YAHOO.widget.ContextMenu("mytreecontextmenu", {
                                                                trigger: "mytreeview",
                                                                lazyload: true, 
                                                                itemdata: [
                                                                    { text: "Add Child Node", onclick: { fn: addNode } },
                                                                    { text: "Edit Node Label", onclick: { fn: editNodeLabel } },
                                                                    { text: "Delete Node", onclick: { fn: deleteNode } }
                                                                ] });


                /*
                     Subscribe to the "contextmenu" event for the element(s)
                     specified as the "trigger" for the ContextMenu instance.
                */

                oContextMenu.subscribe("triggerContextMenu", onTriggerContextMenu);
            
            });

        </script>

    </head>
    <body class="yui-skin-sam">
        <div id="mytreeview"></div>
    </body>
</html><!-- presentbright.corp.yahoo.com uncompressed/chunked Thu Feb 19 10:53:17 PST 2009 -->

   
  








yui_2.7.0b.zip( 4,431 k)

Related examples in the same category

1.Using TreeView with Custom Icons
2.Dynamically Loading Node Data
3.Build a TabView from markup.
4.Build a TabView from JavaScript.
5.Menu-Style TreeView Design
6.TreeView with Tooltips
7.Tree built from a static definition
8.Copy of the tree above taken from its own definition
9.Create Tree from markup
10.Copy of the second branch of the tree at the top
11.Inline Editing of TreeView Node Labels
12.Folder-Style TreeView Design: transform the look of your TreeView Control by changing CSS
13.Default presentation for the TreeView Control.