JTree.java 82.1 KB
Newer Older
Tom Tromey committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
/* JTree.java 
   Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc.
 
This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */

package javax.swing;

40 41
import java.awt.Color;
import java.awt.Cursor;
Tom Tromey committed
42
import java.awt.Dimension;
43 44 45
import java.awt.Font;
import java.awt.FontMetrics;
import java.awt.Point;
Tom Tromey committed
46
import java.awt.Rectangle;
47 48
import java.awt.event.FocusListener;
import java.beans.PropertyChangeListener;
Tom Tromey committed
49 50 51 52
import java.io.Serializable;
import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Iterator;
53
import java.util.Locale;
Tom Tromey committed
54 55 56
import java.util.Vector;

import javax.accessibility.Accessible;
57 58
import javax.accessibility.AccessibleAction;
import javax.accessibility.AccessibleComponent;
Tom Tromey committed
59
import javax.accessibility.AccessibleContext;
60 61 62 63 64 65
import javax.accessibility.AccessibleRole;
import javax.accessibility.AccessibleSelection;
import javax.accessibility.AccessibleState;
import javax.accessibility.AccessibleStateSet;
import javax.accessibility.AccessibleText;
import javax.accessibility.AccessibleValue;
Tom Tromey committed
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
import javax.swing.event.TreeExpansionEvent;
import javax.swing.event.TreeExpansionListener;
import javax.swing.event.TreeModelEvent;
import javax.swing.event.TreeModelListener;
import javax.swing.event.TreeSelectionEvent;
import javax.swing.event.TreeSelectionListener;
import javax.swing.event.TreeWillExpandListener;
import javax.swing.plaf.TreeUI;
import javax.swing.text.Position;
import javax.swing.tree.DefaultMutableTreeNode;
import javax.swing.tree.DefaultTreeModel;
import javax.swing.tree.DefaultTreeSelectionModel;
import javax.swing.tree.ExpandVetoException;
import javax.swing.tree.TreeCellEditor;
import javax.swing.tree.TreeCellRenderer;
import javax.swing.tree.TreeModel;
import javax.swing.tree.TreeNode;
import javax.swing.tree.TreePath;
import javax.swing.tree.TreeSelectionModel;

86
public class JTree extends JComponent implements Scrollable, Accessible
Tom Tromey committed
87
{
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144

  /**
   * This class implements accessibility support for the JTree class. It 
   * provides an implementation of the Java Accessibility API appropriate 
   * to tree user-interface elements.
   */
  protected class AccessibleJTree extends JComponent.AccessibleJComponent
      implements AccessibleSelection, TreeSelectionListener, TreeModelListener,
      TreeExpansionListener
  {
    
    /**
     * This class implements accessibility support for the JTree child. It provides 
     * an implementation of the Java Accessibility API appropriate to tree nodes.
     */
    protected class AccessibleJTreeNode extends AccessibleContext 
       implements Accessible, AccessibleComponent, AccessibleSelection, 
       AccessibleAction
    {
      
      private JTree tree;
      private TreePath tp;
      private Accessible acc;
      private AccessibleStateSet states;
      private Vector selectionList;
      private Vector actionList;
      private TreeModel mod;
      private Cursor cursor;
      
      /**
       * Constructs an AccessibleJTreeNode
       * 
       * @param t - the current tree
       * @param p - the current path to be dealt with
       * @param ap - the accessible object to use
       */
      public AccessibleJTreeNode(JTree t, TreePath p, Accessible ap)
      {
        states = new AccessibleStateSet();
        selectionList = new Vector();
        actionList = new Vector();
        mod = tree.getModel();
        cursor = JTree.this.getCursor();
                
        tree = t;
        tp = p;
        acc = ap;
        
        // Add all the children of this path that may already be
        // selected to the selection list.
        TreePath[] selected = tree.getSelectionPaths();
        for (int i = 0; i < selected.length; i++)
          {
            TreePath sel = selected[i];
            if ((sel.getParentPath()).equals(tp))
              selectionList.add(sel);
          }
        
        // Add all the actions available for a node to 
        // the action list.
        actionList.add("EXPAND");
        actionList.add("COLLAPSE");
        actionList.add("EDIT");
        actionList.add("SELECT");
        actionList.add("DESELECT");
      }      
      
      /**
       * Adds the specified selected item in the object to the object's
       * selection.
       * 
       * @param i - the i-th child of this node.
       */
      public void addAccessibleSelection(int i)
      {
        if (mod != null)
          {
            Object child = mod.getChild(tp.getLastPathComponent(), i);
            if (child != null)
              {
                if (!states.contains(AccessibleState.MULTISELECTABLE))
                  clearAccessibleSelection();
                selectionList.add(child);                  
                tree.addSelectionPath(tp.pathByAddingChild(child));
              }
          }
      }
      
      /**
       * Adds the specified focus listener to receive focus events 
       * from this component.
       * 
       * @param l - the new focus listener
       */
      public void addFocusListener(FocusListener l)
      {
        tree.addFocusListener(l);
      }
      
      /**
       * Add a PropertyChangeListener to the listener list.
       * 
       * @param l - the new property change listener
       */
      public void addPropertyChangeListener(PropertyChangeListener l)
      {
        // Nothing to do here.
      }
      
      /**
       * Clears the selection in the object, so that nothing in the 
       * object is selected.
       */
      public void clearAccessibleSelection()
      {
        selectionList.clear();
      }
      
      /**
       * Checks whether the specified point is within this object's 
       * bounds, where the point's x and y coordinates are defined to be 
       * relative to the coordinate system of the object. 
       * 
       * @param p - the point to check
       * @return true if p is in the bounds
       */
      public boolean contains(Point p)
      {
        return getBounds().contains(p);
      }
      
      /**
       * Perform the specified Action on the tree node.
       * 
       * @param i - the i-th action to perform
       * @return true if the the action was performed; else false.
       */
      public boolean doAccessibleAction(int i)
      {
        if (i >= actionList.size() || i < 0)
          return false;
        
        if (actionList.get(i).equals("EXPAND"))
          tree.expandPath(tp);
        else if (actionList.get(i).equals("COLLAPSE"))
          tree.collapsePath(tp);
        else if (actionList.get(i).equals("SELECT"))
          tree.addSelectionPath(tp);
        else if (actionList.get(i).equals("DESELECT"))
          tree.removeSelectionPath(tp);
        else if (actionList.get(i).equals("EDIT"))
          tree.startEditingAtPath(tp);
        else
          return false;
        return true;
      }
      
      /**
       * Get the AccessibleAction associated with this object.
       * 
       * @return the action
       */
      public AccessibleAction getAccessibleAction()
      {
        return this;
      }
      
      /**
       * Returns the number of accessible actions available in this tree node.
       * 
       * @return the number of actions
       */
      public int getAccessibleActionCount()
      {
        return actionList.size();
      }
      
      /**
       * Return a description of the specified action of the tree node.
       * 
       * @param i - the i-th action's description
       * @return a description of the action
       */
      public String getAccessibleActionDescription(int i)
      {
        if (i < 0 || i >= actionList.size())
          return (actionList.get(i)).toString();
        return super.getAccessibleDescription();
      }
      
      /**
       * Returns the Accessible child, if one exists, contained at the 
       * local coordinate Point.
       * 
       * @param p - the point of the accessible
       * @return the accessible at point p if it exists
       */
      public Accessible getAccessibleAt(Point p)
      {
        TreePath acc = tree.getClosestPathForLocation(p.x, p.y);
        if (acc != null)
          return new AccessibleJTreeNode(tree, acc, this);
        return null;
      }
      
      /**
       * Return the specified Accessible child of the object.
       * 
       * @param i - the i-th child of the current path
       * @return the child if it exists
       */
      public Accessible getAccessibleChild(int i)
      {
        if (mod != null)
          {
            Object child = mod.getChild(tp.getLastPathComponent(), i);
            if (child != null)
              return new AccessibleJTreeNode(tree, tp.pathByAddingChild(child),
                                             acc);
          }
        return null;
      }
      
      /**
       * Returns the number of accessible children in the object.
       * 
       * @return the number of children the current node has
       */
      public int getAccessibleChildrenCount()
      {
        TreeModel mod = getModel();
        if (mod != null)
          return mod.getChildCount(tp.getLastPathComponent());
        return 0;
      }
      
      /**
       * Get the AccessibleComponent associated with this object.
       * 
       * @return the accessible component if it is supported.
       */
      public AccessibleComponent getAccessibleComponent()
      {
        return this;
      }
      
      /**
       * Get the AccessibleContext associated with this tree node.
       * 
       * @return an instance of this class
       */
      public AccessibleContext getAccessibleContext()
      {
        return this;
      }
      
      /**
       * Get the accessible description of this object.
       * 
       * @return the accessible description
       */
      public String getAccessibleDescription()
      {
        return super.getAccessibleDescription();
      }
      
      /**
       * Get the index of this object in its accessible parent.
       * 
       * @return the index of this in the parent.
       */
      public int getAccessibleIndexInParent()
      {
        AccessibleContext parent = getAccessibleParent().getAccessibleContext();
        if (parent != null)
          for (int i = 0; i < parent.getAccessibleChildrenCount(); i++)
            {
              if ((parent.getAccessibleChild(i)).equals(this))
                return i;
            }
        return -1;
      }
      
      /**
       * Get the accessible name of this object.
       * 
       * @return the accessible name
       */
      public String getAccessibleName()
      {
        return super.getAccessibleName();
      }
      
      /**
       * Get the Accessible parent of this object.
       * 
       * @return the accessible parent if it exists.
       */
      public Accessible getAccessibleParent()
      {
        return super.getAccessibleParent();
      }
      
      /**
       * Get the role of this object.
       * 
       * @return the accessible role
       */
      public AccessibleRole getAccessibleRole()
      {
        return AccessibleJTree.this.getAccessibleRole();
      }
      
      /**
       * Get the AccessibleSelection associated with this object if one exists.
       * 
       * @return the accessible selection for this.
       */
      public AccessibleSelection getAccessibleSelection()
      {
        return this;
      }
      
      /**
       * Returns an Accessible representing the specified selected item 
       * in the object.
       * 
       * @return the accessible representing a certain selected item.
       */
      public Accessible getAccessibleSelection(int i)
      {
        if (i > 0 && i < getAccessibleSelectionCount())
            return new AccessibleJTreeNode(tree, 
                  tp.pathByAddingChild(selectionList.get(i)), acc);
        return null;
      }
      
      /**
       * Returns the number of items currently selected.
       * 
       * @return the number of items selected.
       */
      public int getAccessibleSelectionCount()
      {
        return selectionList.size();
      }
      
      /**
       * Get the state set of this object.
       * 
       * @return the state set for this object
       */
      public AccessibleStateSet getAccessibleStateSet()
      {
        if (isVisible())
          states.add(AccessibleState.VISIBLE);
        if (tree.isCollapsed(tp))
          states.add(AccessibleState.COLLAPSED);
        if (tree.isEditable())
          states.add(AccessibleState.EDITABLE);
        if (mod != null && 
            !mod.isLeaf(tp.getLastPathComponent()))
          states.add(AccessibleState.EXPANDABLE);
        if (tree.isExpanded(tp))
          states.add(AccessibleState.EXPANDED);
        if (isFocusable())
          states.add(AccessibleState.FOCUSABLE);
        if (hasFocus())
          states.add(AccessibleState.FOCUSED);
        if (tree.getSelectionModel().getSelectionMode() != 
          TreeSelectionModel.SINGLE_TREE_SELECTION)
          states.add(AccessibleState.MULTISELECTABLE);
        if (tree.isOpaque())
          states.add(AccessibleState.OPAQUE);
        if (tree.isPathSelected(tp))
          states.add(AccessibleState.SELECTED);
        if (isShowing())
          states.add(AccessibleState.SHOWING);

        states.add(AccessibleState.SELECTABLE);
        return states;
      }
      
      /**
       * Get the AccessibleText associated with this object if one exists.
       * 
       * @return the accessible text
       */
      public AccessibleText getAccessibleText()
      {
        return super.getAccessibleText();
      }
      
      /**
       * Get the AccessibleValue associated with this object if one exists.
       * 
       * @return the accessible value if it exists
       */
      public AccessibleValue getAccessibleValue()
      {
        return super.getAccessibleValue();
      }
      
      /**
       * Get the background color of this object.
       * 
       * @return the color of the background.
       */
      public Color getBackground()
      {
        return tree.getBackground();
      }
      
      /**
       * Gets the bounds of this object in the form of a Rectangle object.
       * 
       * @return the bounds of the current node.
       */
      public Rectangle getBounds()
      {
        return tree.getPathBounds(tp);
      }
      
      /**
       * Gets the Cursor of this object.
       * 
       * @return the cursor for the current node
       */
      public Cursor getCursor()
      {
        return cursor;
      }
      
      /**
       * Gets the Font of this object.
       * 
       * @return the font for the current node
       */
      public Font getFont()
      {
        return tree.getFont();
      }
      
      /**
       * Gets the FontMetrics of this object.
       * 
       * @param f - the current font.
       * @return the font metrics for the given font.
       */
      public FontMetrics getFontMetrics(Font f)
      {
        return tree.getFontMetrics(f);
      }
      
      /**
       * Get the foreground color of this object.
       * 
       * @return the foreground for this object.
       */
      public Color getForeground()
      {
        return tree.getForeground();
      }
      
      /**
       * Gets the locale of the component.
       * 
       * @return the locale of the component.
       */
      public Locale getLocale()
      {
        return tree.getLocale();
      }
      
      /**
       * Gets the location of the object relative to the 
       * parent in the form of a point specifying the object's 
       * top-left corner in the screen's coordinate space. 
       * 
       * @return the location of the current node.
       */
      public Point getLocation()
      {
        return getLocationInJTree();
      }
      
      /**
       * Returns the location in the tree.
       * 
       * @return the location in the JTree.
       */
      protected Point getLocationInJTree()
      {
        Rectangle bounds = tree.getPathBounds(tp);
        return new Point(bounds.x, bounds.y);
      }
      
      /**
       * Returns the location of the object on the screen.
       * 
       * @return the location of the object on the screen.
       */
      public Point getLocationOnScreen()
      {
        Point loc = getLocation();
        SwingUtilities.convertPointToScreen(loc, tree);
        return loc;
      }
      
      /**
       * Returns the size of this object in the form of a Dimension object.
       * 
       * @return the size of the object
       */
      public Dimension getSize()
      {
        Rectangle b = getBounds();
        return b.getSize();
      }
      
      /**
       * Returns true if the current child of this object is selected.
       * 
       * @param i - the child of the current node
       * @return true if the child is selected.
       */
      public boolean isAccessibleChildSelected(int i)
      {
        Object child = mod.getChild(tp.getLastPathComponent(), i);
        if (child != null)
          return tree.isPathSelected(tp.pathByAddingChild(child));
        return false;
      }
      
      /**
       * Determines if the object is enabled.
       * 
       * @return true if the tree is enabled
       */
      public boolean isEnabled()
      {
        return tree.isEnabled();
      }
      
      /**
       * Returns whether this object can accept focus or not.
       * 
       * @return true, it is always focus traversable
       */
      public boolean isFocusTraversable()
      {
        return true;
      }
      
      /**
       * Determines if the object is showing.
       * 
       * @return true if the object is visible and the
       * parent is visible.
       */
      public boolean isShowing()
      {
        return isVisible() && tree.isShowing();
      }
      
      /**
       * Determines if the object is visible.
       * 
       * @return true if the object is visible.
       */
      public boolean isVisible()
      {
        return tree.isVisible(tp);
      }
      
      /**
       * Removes the specified selected item in the object from the
       * object's selection.
       * 
       * @param i - the specified item to remove
       */
      public void removeAccessibleSelection(int i)
      {
        if (mod != null)
          {
            Object child = mod.getChild(tp.getLastPathComponent(), i);
            if (child != null)
              {
                if (!states.contains(AccessibleState.MULTISELECTABLE))
                  clearAccessibleSelection();
                if (selectionList.contains(child))
                  {
                    selectionList.remove(child);                  
                    tree.removeSelectionPath(tp.pathByAddingChild(child));
                  }
              }
          }
      }
      
      /**
       * Removes the specified focus listener so it no longer receives focus 
       * events from this component.
       * 
       * @param l - the focus listener to remove
       */
      public void removeFocusListener(FocusListener l)
      {
        tree.removeFocusListener(l);
      }
      
      /**
       * Remove a PropertyChangeListener from the listener list.
       * 
       * @param l - the property change listener to remove.
       */
      public void removePropertyChangeListener(PropertyChangeListener l)
      {
        // Nothing to do here.
      }
      
      /**
       * Requests focus for this object.
       */
      public void requestFocus()
      {
        tree.requestFocus();
      }
      
      /**
       * Causes every selected item in the object to be selected if the object 
       * supports multiple selections.
       */
      public void selectAllAccessibleSelection()
      {
        Object parent = tp.getLastPathComponent();
        if (mod != null)
          {
            for (int i = 0; i < mod.getChildCount(parent); i++)
              {
                Object child = mod.getChild(parent, i);
                if (child != null)
                  {
                    if (!states.contains(AccessibleState.MULTISELECTABLE))
                      clearAccessibleSelection();
                    if (selectionList.contains(child))
                      {
                        selectionList.add(child);
                        tree.addSelectionPath(tp.pathByAddingChild(child));
                      }
                  }
              }
          }
      }
      
      /**
       * Set the accessible description of this object.
       * 
       * @param s - the string to set the accessible description to.
       */
      public void setAccessibleDescription(String s)
      {
        super.setAccessibleDescription(s);
      }
      
      /**
       * Set the localized accessible name of this object.
       * 
       * @param s - the string to set the accessible name to.
       */
      public void setAccessibleName(String s)
      {
        super.setAccessibleName(s);
      }
      
      /**
       * Set the background color of this object.
       * 
       * @param c - the color to set the background to.
       */
      public void setBackground(Color c)
      {
        // Nothing to do here.
      }
      
      /**
       * Sets the bounds of this object in the form of a Rectangle object.
       * 
       * @param r - the bounds to set the object o
       */
      public void setBounds(Rectangle r)
      {
        // Nothing to do here.
      }
      
      /**
       * Sets the Cursor of this object.
       * 
       * @param c - the new cursor
       */
      public void setCursor(Cursor c)
      {
        cursor = c;
      }
      
      /**
       * Sets the enabled state of the object.
       * 
       * @param b - boolean to enable or disable object
       */
      public void setEnabled(boolean b)
      {
         // Nothing to do here.
      }
      
      /**
       * Sets the Font of this object.
       * 
       * @param f - the new font.
       */
      public void setFont(Font f)
      {
         // Nothing to do here.
      }
      
      /**
       * Sets the foreground color of this object.
       * 
       * @param c - the new foreground color.
       */
      public void setForeground(Color c)
      {
        // Nothing to do here.
      }
      
      /**
       * Sets the location of the object relative to the parent.
       * 
       * @param p - the new location for the object.
       */
      public void setLocation(Point p)
      {
        // Nothing to do here.
      }
      
      /**
       * Resizes this object so that it has width and height.
       * 
       * @param d - the new size for the object.
       */
      public void setSize(Dimension d)
      {
        // Nothing to do here.
      }
      
      /**
       * Sets the visible state of the object.
       * 
       * @param b - sets the objects visibility.
       */
      public void setVisible(boolean b)
      {
        // Nothing to do here.
      }
    }
    
    /**
     * Constructor
     */
    public AccessibleJTree()
    {
      // Nothing to do here.
    }
    
    /**
     * Adds the specified selected item in the object to the object's selection.
     * 
     * @param i - the row to add to the tree's selection
     */
    public void addAccessibleSelection(int i)
    {
      addSelectionInterval(i, i);
    }
    
    /**
     * Clears the selection in the object, so that nothing in the object is selected.
     */
    public void clearAccessibleSelection()
    {
      clearSelection();
    }
    
    /**
     * Fire a visible data property change notification.
     */
    public void fireVisibleDataPropertyChange()
    {
      treeDidChange();
    }
    
    /**
     * Returns the Accessible child, if one exists, contained at the local 
     * coordinate Point.
     * 
     * @param p - the point of the accessible to get.
     * @return the accessible at point p.
     */
    public Accessible getAccessibleAt(Point p)
    {
      TreePath tp = getClosestPathForLocation(p.x, p.y);
      if (tp != null)
        return new AccessibleJTreeNode(JTree.this, tp, null);
      return null;
    }
    
    /**
     * Return the nth Accessible child of the object.
     * 
     * @param i - the accessible child to get
     * @return the i-th child
     */
    public Accessible getAccessibleChild(int i)
    {
      return null;
    }
    
    /**
     * Returns the number of top-level children nodes of this JTree.
     * 
     * @return the number of top-level children
     */
    public int getAccessibleChildrenCount()
    {
      TreeModel model = getModel();
      if (model != null)
        return model.getChildCount(model.getRoot());
      return 0;
    }
    
    /**
     * Get the index of this object in its accessible parent.
     * 
     * @return the index of this object.
     */
    public int getAccessibleIndexInParent()
    {
      return 0;
    }
    
    /**
     * Get the role of this object.
     * 
     * @return the role of this object
     */
    public AccessibleRole getAccessibleRole()
    {
      return AccessibleRole.TREE;
    }
    
    /**
     * Get the AccessibleSelection associated with this object.
     * 
     * @return the accessible selection of the tree
     */
    public AccessibleSelection getAccessibleSelection()
    {
      TreeModel mod = getModel();
      if (mod != null)
        return (new AccessibleJTreeNode(JTree.this, 
                  new TreePath(mod.getRoot()), null)).getAccessibleSelection();
      return null;
    }
    
    /**
     * Returns an Accessible representing the specified selected item in the object.
     * 
     * @return the i-th accessible in the selection
     */
    public Accessible getAccessibleSelection(int i)
    {
      TreeModel mod = getModel();
      if (mod != null)
        return (new AccessibleJTreeNode(JTree.this, 
                  new TreePath(mod.getRoot()), null)).getAccessibleSelection(i);
      return null;
    }
    
    /**
     * Returns the number of items currently selected.
     * 
     * @return the number of selected accessibles.
     */
    public int getAccessibleSelectionCount()
    {
      return getSelectionCount();
    }
    
    /**
     * Returns true if the current child of this object is selected.
     * 
     * @param i - the child of this object
     * @return true if the i-th child is selected.
     */
    public boolean isAccessibleChildSelected(int i)
    {
      // Nothing to do here.
      return false;
    }
    
    /**
     * Removes the specified selected item in the object from the object's
     * selection.
     * 
     * @param i - the i-th selected item to remove
     */
    public void removeAccessibleSelection(int i)
    {
      removeSelectionInterval(i, i);
    }
    
    /**
     * Causes every selected item in the object to be selected if the object
     * supports multiple selections.
     */
    public void selectAllAccessibleSelection()
    {
      if (getSelectionModel().getSelectionMode() != 
        TreeSelectionModel.SINGLE_TREE_SELECTION)
      addSelectionInterval(0, getVisibleRowCount());
    }
    
    /**
     * Tree Collapsed notification
     * 
     * @param e - the event
     */
    public void treeCollapsed(TreeExpansionEvent e)
    {
      fireTreeCollapsed(e.getPath());
    }
   
    /**
     * Tree Model Expansion notification.
     * 
     * @param e - the event
     */
    public void treeExpanded(TreeExpansionEvent e)
    {
      fireTreeExpanded(e.getPath());
    }
    
    /**
     * Tree Model Node change notification.
     * 
     * @param e - the event
     */
    public void treeNodesChanged(TreeModelEvent e)
    {
      // Nothing to do here.
    }
    
    /**
     * Tree Model Node change notification.
     * 
     * @param e - the event
     */
    public void treeNodesInserted(TreeModelEvent e)
    {
      // Nothing to do here.
    }
    
    /**
     * Tree Model Node change notification.
     * 
     * @param e - the event
     */
    public void treeNodesRemoved(TreeModelEvent e)
    {
      // Nothing to do here.
    }
    
    /**
     * Tree Model structure change change notification.
     * 
     * @param e - the event
     */
    public void treeStructureChanged(TreeModelEvent e)
    {
      // Nothing to do here.
    }
    
    /**
     * Tree Selection Listener value change method.
     * 
     * @param e - the event
     */
    public void valueChanged(TreeSelectionEvent e)
    {
      fireValueChanged(e);
    }
  }
  
  public static class DynamicUtilTreeNode extends DefaultMutableTreeNode
  {
    protected Object childValue;

    protected boolean loadedChildren;

    /**
     * Currently not set or used by this class. It might be set and used in
     * later versions of this class.
     */
    protected boolean hasChildren;

    public DynamicUtilTreeNode(Object value, Object children)
    {
      super(value);
      childValue = children;
      loadedChildren = false;
    }

    public int getChildCount()
    {
      loadChildren();
      return super.getChildCount();
    }

    protected void loadChildren()
    {
      if (!loadedChildren)
        {
          createChildren(this, childValue);
          loadedChildren = true;
        }
    }

    public Enumeration children()
    {
      loadChildren();
      return super.children();
    }

    /**
     * Returns the child node at position <code>pos</code>. Subclassed
     * here to load the children if necessary.
     * 
     * @param pos the position of the child node to fetch
     * 
     * @return the childnode at the specified position
     */
    public TreeNode getChildAt(int pos)
    {
      loadChildren();
      return super.getChildAt(pos);
    }

    public boolean isLeaf()
    {
1145 1146 1147
      return childValue == null || !(childValue instanceof Hashtable
          || childValue instanceof Vector 
          || childValue.getClass().isArray());
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
    }

    public static void createChildren(DefaultMutableTreeNode parent,
                                      Object children)
    {
      if (children instanceof Hashtable)
        {
          Hashtable tab = (Hashtable) children;
          Enumeration e = tab.keys();
          while (e.hasMoreElements())
            {
              Object key = e.nextElement();
              Object val = tab.get(key);
              parent.add(new DynamicUtilTreeNode(key, val));
            }
        }
      else if (children instanceof Vector)
        {
          Iterator i = ((Vector) children).iterator();
          while (i.hasNext())
            {
              Object n = i.next();
              parent.add(new DynamicUtilTreeNode(n, n));
            }
        }
      else if (children != null && children.getClass().isArray())
        {
          Object[] arr = (Object[]) children;
          for (int i = 0; i < arr.length; ++i)
            parent.add(new DynamicUtilTreeNode(arr[i], arr[i]));
        }
    }
  }

  /**
   * Listens to the model of the JTree and updates the property 
   * <code>expandedState</code> if nodes are removed or changed.
   */
  protected class TreeModelHandler implements TreeModelListener
  {

    /**
     * Creates a new instance of TreeModelHandler.
     */
    protected TreeModelHandler()
    {
      // Nothing to do here.
    }

    /**
     * Notifies when a node has changed in some ways. This does not include
     * that a node has changed its location or changed it's children. It
     * only means that some attributes of the node have changed that might
     * affect its presentation.
     * 
     * This method is called after the actual change occured.
     * 
     * @param ev the TreeModelEvent describing the change
     */
    public void treeNodesChanged(TreeModelEvent ev)
    {
      // Nothing to do here.
    }

    /**
     * Notifies when a node is inserted into the tree.
     * 
     * This method is called after the actual change occured.
     * 
     * @param ev the TreeModelEvent describing the change
     */
    public void treeNodesInserted(TreeModelEvent ev)
    {
      // nothing to do here
    }

    /**
     * Notifies when a node is removed from the tree.
     * 
     * This method is called after the actual change occured.
     *
     * @param ev the TreeModelEvent describing the change
Tom Tromey committed
1230
	 */
1231 1232
    public void treeNodesRemoved(TreeModelEvent ev)
    {
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
      if (ev != null)
        {
          TreePath parent = ev.getTreePath();
          Object[] children = ev.getChildren();
          TreeSelectionModel sm = getSelectionModel();
          if (children != null)
            {
              TreePath path;
              Vector toRemove = new Vector();
              // Collect items that we must remove.
              for (int i = children.length - 1; i >= 0; i--)
                {
                  path = parent.pathByAddingChild(children[i]);
                  if (nodeStates.containsKey(path))
                    toRemove.add(path);
                  // Clear selection while we are at it.
                  if (sm != null)
                    removeDescendantSelectedPaths(path, true);
                }
              if (toRemove.size() > 0)
                removeDescendantToggledPaths(toRemove.elements());
              TreeModel model = getModel();
              if (model == null || model.isLeaf(parent.getLastPathComponent()))
                nodeStates.remove(parent);
            }
        }
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269
    }

    /**
     * Notifies when the structure of the tree is changed.
     * 
     * This method is called after the actual change occured.
     * 
     * @param ev the TreeModelEvent describing the change
     */
    public void treeStructureChanged(TreeModelEvent ev)
    {
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
      if (ev != null)
        {
          TreePath parent = ev.getTreePath();
          if (parent != null)
            {
              if (parent.getPathCount() == 1)
                {
                  // We have a new root, clear everything.
                  clearToggledPaths();
                  Object root = treeModel.getRoot();
                  if (root != null && treeModel.isLeaf(root))
                    nodeStates.put(parent, Boolean.TRUE);
                }
              else if (nodeStates.containsKey(parent))
                {
                  Vector toRemove = new Vector();
                  boolean expanded = isExpanded(parent);
                  toRemove.add(parent);
                  removeDescendantToggledPaths(toRemove.elements());
                  if (expanded)
                    {
                      TreeModel model = getModel();
                      if (model != null
                          || model.isLeaf(parent.getLastPathComponent()))
                        collapsePath(parent);
                      else
                        nodeStates.put(parent, Boolean.TRUE);
                    }
                }
              removeDescendantSelectedPaths(parent, false);
            }
        }
1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
    }
  }

  /**
   * This redirects TreeSelectionEvents and rewrites the source of it to be
   * this JTree. This is typically done when the tree model generates an
   * event, but the JTree object associated with that model should be listed
   * as the actual source of the event.
   */
  protected class TreeSelectionRedirector implements TreeSelectionListener,
                                                     Serializable
  {
    /** The serial version UID. */
    private static final long serialVersionUID = -3505069663646241664L;

    /**
     * Creates a new instance of TreeSelectionRedirector
     */
    protected TreeSelectionRedirector()
    {
      // Nothing to do here.
    }

    /**
     * Notifies when the tree selection changes.
     * 
     * @param ev the TreeSelectionEvent that describes the change
     */
    public void valueChanged(TreeSelectionEvent ev)
    {
1332
      TreeSelectionEvent rewritten = 
1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440
        (TreeSelectionEvent) ev.cloneWithSource(JTree.this);
      fireValueChanged(rewritten);
    }
  }

  /**
   * A TreeModel that does not allow anything to be selected.
   */
  protected static class EmptySelectionModel extends DefaultTreeSelectionModel
  {
    /** The serial version UID. */
    private static final long serialVersionUID = -5815023306225701477L;

    /**
     * The shared instance of this model.
     */
    protected static final EmptySelectionModel sharedInstance =
      new EmptySelectionModel();

    /**
     * Creates a new instance of EmptySelectionModel.
     */
    protected EmptySelectionModel()
    {
      // Nothing to do here.
    }

    /**
     * Returns the shared instance of EmptySelectionModel.
     * 
     * @return the shared instance of EmptySelectionModel
     */
    public static EmptySelectionModel sharedInstance()
    {
      return sharedInstance;
    }

    /**
     * This catches attempts to set a selection and sets nothing instead.
     * 
     * @param paths not used here
     */
    public void setSelectionPaths(TreePath[] paths)
    {
      // We don't allow selections in this class.
    }

    /**
     * This catches attempts to add something to the selection.
     * 
     * @param paths not used here
     */
    public void addSelectionPaths(TreePath[] paths)
    {
      // We don't allow selections in this class.
    }

    /**
     * This catches attempts to remove something from the selection.
     * 
     * @param paths not used here
     */
    public void removeSelectionPaths(TreePath[] paths)
    {
      // We don't allow selections in this class.
    }
  }

  private static final long serialVersionUID = 7559816092864483649L;

  public static final String CELL_EDITOR_PROPERTY = "cellEditor";

  public static final String CELL_RENDERER_PROPERTY = "cellRenderer";

  public static final String EDITABLE_PROPERTY = "editable";

  public static final String INVOKES_STOP_CELL_EDITING_PROPERTY =
    "invokesStopCellEditing";

  public static final String LARGE_MODEL_PROPERTY = "largeModel";

  public static final String ROOT_VISIBLE_PROPERTY = "rootVisible";

  public static final String ROW_HEIGHT_PROPERTY = "rowHeight";

  public static final String SCROLLS_ON_EXPAND_PROPERTY = "scrollsOnExpand";

  public static final String SELECTION_MODEL_PROPERTY = "selectionModel";

  public static final String SHOWS_ROOT_HANDLES_PROPERTY = "showsRootHandles";

  public static final String TOGGLE_CLICK_COUNT_PROPERTY = "toggleClickCount";

  public static final String TREE_MODEL_PROPERTY = "model";

  public static final String VISIBLE_ROW_COUNT_PROPERTY = "visibleRowCount";

  /** @since 1.3 */
  public static final String ANCHOR_SELECTION_PATH_PROPERTY =
    "anchorSelectionPath";

	/** @since 1.3 */
  public static final String LEAD_SELECTION_PATH_PROPERTY = "leadSelectionPath";

  /** @since 1.3 */
  public static final String EXPANDS_SELECTED_PATHS_PROPERTY =
    "expandsSelectedPaths";

1441
  private static final Object EXPANDED = Boolean.TRUE;
1442

1443
  private static final Object COLLAPSED = Boolean.FALSE;
1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454

  private boolean dragEnabled;

  private boolean expandsSelectedPaths;

  private TreePath anchorSelectionPath;

  /**
   * This contains the state of all nodes in the tree. Al/ entries map the
   * TreePath of a note to to its state. Valid states are EXPANDED and
   * COLLAPSED. Nodes not in this Hashtable are assumed state COLLAPSED.
1455 1456
   *
   * This is package private to avoid accessor methods.
1457
   */
1458
  Hashtable nodeStates = new Hashtable();
1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497

  protected transient TreeCellEditor cellEditor;

  protected transient TreeCellRenderer cellRenderer;

  protected boolean editable;

  protected boolean invokesStopCellEditing;

  protected boolean largeModel;

  protected boolean rootVisible;

  protected int rowHeight;

  protected boolean scrollsOnExpand;

  protected transient TreeSelectionModel selectionModel;

  protected boolean showsRootHandles;

  protected int toggleClickCount;

  protected transient TreeModel treeModel;

  protected int visibleRowCount;

  /**
   * Handles TreeModelEvents to update the expandedState.
   */
  protected transient TreeModelListener treeModelListener;

  /**
   * Redirects TreeSelectionEvents so that the source is this JTree.
   */
  protected TreeSelectionRedirector selectionRedirector =
    new TreeSelectionRedirector();

  /**
1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524
   * Indicates if the rowHeight property has been set by a client
   * program or by the UI.
   *
   * @see #setUIProperty(String, Object)
   * @see LookAndFeel#installProperty(JComponent, String, Object)
   */
  private boolean clientRowHeightSet = false;

  /**
   * Indicates if the scrollsOnExpand property has been set by a client
   * program or by the UI.
   *
   * @see #setUIProperty(String, Object)
   * @see LookAndFeel#installProperty(JComponent, String, Object)
   */
  private boolean clientScrollsOnExpandSet = false;

  /**
   * Indicates if the showsRootHandles property has been set by a client
   * program or by the UI.
   *
   * @see #setUIProperty(String, Object)
   * @see LookAndFeel#installProperty(JComponent, String, Object)
   */
  private boolean clientShowsRootHandlesSet = false;

  /**
1525 1526 1527 1528
   * Creates a new <code>JTree</code> object.
   */
  public JTree()
  {
1529
    this(getDefaultTreeModel());
1530 1531 1532 1533 1534 1535 1536
  }

  /**
   * Creates a new <code>JTree</code> object.
   * 
   * @param value the initial nodes in the tree
   */
1537
  public JTree(Hashtable<?, ?> value)
1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
  {
    this(createTreeModel(value));
  }

  /**
   * Creates a new <code>JTree</code> object.
   * 
   * @param value the initial nodes in the tree
   */
  public JTree(Object[] value)
  {
    this(createTreeModel(value));
  }

  /**
   * Creates a new <code>JTree</code> object.
   * 
   * @param model the model to use
   */
  public JTree(TreeModel model)
  {
    setRootVisible(true);
1560
    setSelectionModel( new DefaultTreeSelectionModel() );
1561 1562
    
    // The root node appears expanded by default.
1563 1564
    nodeStates = new Hashtable();

1565 1566 1567
    // The cell renderer gets set by the UI.
    cellRenderer = null;

1568 1569 1570 1571 1572 1573
    // Install the UI before installing the model. This way we avoid double
    // initialization of lots of UI and model stuff inside the UI and related
    // classes. The necessary UI updates are performed via property change
    // events to the UI.
    updateUI();
    setModel(model);
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
  }

  /**
   * Creates a new <code>JTree</code> object.
   * 
   * @param root the root node
   */
  public JTree(TreeNode root)
  {
    this(root, false);
  }

  /**
   * Creates a new <code>JTree</code> object.
   * 
   * @param root the root node
   * @param asksAllowChildren if false, all nodes without children are leaf
   *        nodes. If true, only nodes that do not allow children are leaf
   *        nodes.
   */
  public JTree(TreeNode root, boolean asksAllowChildren)
  {
    this(new DefaultTreeModel(root, asksAllowChildren));
  }

  /**
   * Creates a new <code>JTree</code> object.
   * 
   * @param value the initial nodes in the tree
   */
1604
  public JTree(Vector<?> value)
1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623
  {
    this(createTreeModel(value));
  }

  public int getRowForPath(TreePath path)
  {
    TreeUI ui = getUI();

    if (ui != null)
      return ui.getRowForPath(this, path);

    return -1;
  }

  public TreePath getPathForRow(int row)
  {
    TreeUI ui = getUI();
    return ui != null ? ui.getPathForRow(this, row) : null;
  }
1624 1625 1626 1627 1628 1629 1630 1631 1632
  
  /**
   * Get the pathes that are displayes between the two given rows.
   * 
   * @param index0 the starting row, inclusive
   * @param index1 the ending row, inclusive
   * 
   * @return the array of the tree pathes
   */
1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715
  protected TreePath[] getPathBetweenRows(int index0, int index1)
  {
    TreeUI ui = getUI();

    if (ui == null)
      return null;

    int minIndex = Math.min(index0, index1);
    int maxIndex = Math.max(index0, index1);
    TreePath[] paths = new TreePath[maxIndex - minIndex + 1];

    for (int i = minIndex; i <= maxIndex; ++i)
      paths[i - minIndex] = ui.getPathForRow(this, i);

    return paths;
  }

  /**
   * Creates a new <code>TreeModel</code> object.
   * 
   * @param value the values stored in the model
   */
  protected static TreeModel createTreeModel(Object value)
  {
    return new DefaultTreeModel(new DynamicUtilTreeNode(value, value));
  }

  /**
   * Return the UI associated with this <code>JTree</code> object.
   * 
   * @return the associated <code>TreeUI</code> object
   */
  public TreeUI getUI()
  {
    return (TreeUI) ui;
  }

  /**
   * Sets the UI associated with this <code>JTree</code> object.
   * 
   * @param ui the <code>TreeUI</code> to associate
   */
  public void setUI(TreeUI ui)
  {
    super.setUI(ui);
  }

  /**
   * This method resets the UI used to the Look and Feel defaults..
   */
  public void updateUI()
  {
    setUI((TreeUI) UIManager.getUI(this));
  }

  /**
   * This method returns the String ID of the UI class of Separator.
   * 
   * @return The UI class' String ID.
   */
  public String getUIClassID()
  {
    return "TreeUI";
  }

  /**
   * Gets the AccessibleContext associated with this
   * <code>JTree</code>.
   * 
   * @return the associated context
   */
  public AccessibleContext getAccessibleContext()
  {
    return new AccessibleJTree();
  }

  /**
   * Returns the preferred viewport size.
   * 
   * @return the preferred size
   */
  public Dimension getPreferredScrollableViewportSize()
  {
1716
    return getPreferredSize();
1717
  }
1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733
  
  /**
   * Return the preferred scrolling amount (in pixels) for the given scrolling
   * direction and orientation. This method handles a partially exposed row by
   * returning the distance required to completely expose the item.
   * 
   * @param visibleRect the currently visible part of the component.
   * @param orientation the scrolling orientation
   * @param direction the scrolling direction (negative - up, positive -down).
   *          The values greater than one means that more mouse wheel or similar
   *          events were generated, and hence it is better to scroll the longer
   *          distance.
   * @author Audrius Meskauskas (audriusa@bioinformatics.org)
   */
  public int getScrollableUnitIncrement(Rectangle visibleRect, int orientation,
                                        int direction)
1734
  {
1735
    int delta = 0;
1736 1737 1738 1739

    // Round so that the top would start from the row boundary
    if (orientation == SwingConstants.VERTICAL)
      {
1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764
        int row = getClosestRowForLocation(0, visibleRect.y);
        if (row != -1)
          {
            Rectangle b = getRowBounds(row);
            if (b.y != visibleRect.y)
              {
                if (direction < 0)
                  delta = Math.max(0, visibleRect.y - b.y);
                else
                  delta = b.y + b.height - visibleRect.y;
              }
            else
              {
                if (direction < 0)
                  {
                    if (row != 0)
                      {
                        b = getRowBounds(row - 1);
                        delta = b.height;
                      }
                  }
                else
                  delta = b.height;
              }
          }
1765 1766
      }
    else
1767 1768
      // The RI always  returns 4 for HORIZONTAL scrolling.
      delta = 4;
1769
    return delta;
1770 1771 1772 1773 1774
  }

  public int getScrollableBlockIncrement(Rectangle visibleRect,
                                         int orientation, int direction)
  {
1775 1776 1777 1778 1779 1780
    int block;
    if (orientation == SwingConstants.VERTICAL)
      block = visibleRect.height;
    else
      block = visibleRect.width;
    return block;
1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977
  }

  public boolean getScrollableTracksViewportHeight()
  {
    if (getParent() instanceof JViewport)
      return ((JViewport) getParent()).getHeight() > getPreferredSize().height;
    return false;
  }

  public boolean getScrollableTracksViewportWidth()
  {
    if (getParent() instanceof JViewport)
      return ((JViewport) getParent()).getWidth() > getPreferredSize().width;
    return false;
  }

  /**
   * Adds a <code>TreeExpansionListener</code> object to the tree.
   * 
   * @param listener the listener to add
   */
  public void addTreeExpansionListener(TreeExpansionListener listener)
  {
    listenerList.add(TreeExpansionListener.class, listener);
  }

  /**
   * Removes a <code>TreeExpansionListener</code> object from the tree.
   * 
   * @param listener the listener to remove
   */
  public void removeTreeExpansionListener(TreeExpansionListener listener)
  {
    listenerList.remove(TreeExpansionListener.class, listener);
  }

  /**
   * Returns all added <code>TreeExpansionListener</code> objects.
   * 
   * @return an array of listeners
   */
  public TreeExpansionListener[] getTreeExpansionListeners()
  {
    return (TreeExpansionListener[]) getListeners(TreeExpansionListener.class);
  }

  /**
   * Notifies all listeners that the tree was collapsed.
   * 
   * @param path the path to the node that was collapsed
   */
  public void fireTreeCollapsed(TreePath path)
  {
    TreeExpansionEvent event = new TreeExpansionEvent(this, path);
    TreeExpansionListener[] listeners = getTreeExpansionListeners();

    for (int index = 0; index < listeners.length; ++index)
      listeners[index].treeCollapsed(event);
  }

  /**
   * Notifies all listeners that the tree was expanded.
   * 
   * @param path the path to the node that was expanded
   */
  public void fireTreeExpanded(TreePath path)
  {
    TreeExpansionEvent event = new TreeExpansionEvent(this, path);
    TreeExpansionListener[] listeners = getTreeExpansionListeners();

    for (int index = 0; index < listeners.length; ++index)
      listeners[index].treeExpanded(event);
  }

  /**
   * Adds a <code>TreeSelctionListener</code> object to the tree.
   * 
   * @param listener the listener to add
   */
  public void addTreeSelectionListener(TreeSelectionListener listener)
  {
    listenerList.add(TreeSelectionListener.class, listener);
  }

  /**
   * Removes a <code>TreeSelectionListener</code> object from the tree.
   * 
   * @param listener the listener to remove
   */
  public void removeTreeSelectionListener(TreeSelectionListener listener)
  {
    listenerList.remove(TreeSelectionListener.class, listener);
  }

  /**
   * Returns all added <code>TreeSelectionListener</code> objects.
   * 
   * @return an array of listeners
   */
  public TreeSelectionListener[] getTreeSelectionListeners()
  {
    return (TreeSelectionListener[]) 
    getListeners(TreeSelectionListener.class);
  }

  /**
   * Notifies all listeners when the selection of the tree changed.
   * 
   * @param event the event to send
   */
  protected void fireValueChanged(TreeSelectionEvent event)
  {
    TreeSelectionListener[] listeners = getTreeSelectionListeners();

    for (int index = 0; index < listeners.length; ++index)
      listeners[index].valueChanged(event);
  }

  /**
   * Adds a <code>TreeWillExpandListener</code> object to the tree.
   * 
   * @param listener the listener to add
   */
  public void addTreeWillExpandListener(TreeWillExpandListener listener)
  {
    listenerList.add(TreeWillExpandListener.class, listener);
  }

  /**
   * Removes a <code>TreeWillExpandListener</code> object from the tree.
   * 
   * @param listener the listener to remove
   */
  public void removeTreeWillExpandListener(TreeWillExpandListener listener)
  {
    listenerList.remove(TreeWillExpandListener.class, listener);
  }

  /**
   * Returns all added <code>TreeWillExpandListener</code> objects.
   * 
   * @return an array of listeners
   */
  public TreeWillExpandListener[] getTreeWillExpandListeners()
  {
    return (TreeWillExpandListener[]) 
    getListeners(TreeWillExpandListener.class);
  }

  /**
   * Notifies all listeners that the tree will collapse.
   * 
   * @param path the path to the node that will collapse
   */
  public void fireTreeWillCollapse(TreePath path) throws ExpandVetoException
  {
    TreeExpansionEvent event = new TreeExpansionEvent(this, path);
    TreeWillExpandListener[] listeners = getTreeWillExpandListeners();

    for (int index = 0; index < listeners.length; ++index)
      listeners[index].treeWillCollapse(event);
  }

  /**
   * Notifies all listeners that the tree will expand.
   * 
   * @param path the path to the node that will expand
   */
  public void fireTreeWillExpand(TreePath path) throws ExpandVetoException
  {
    TreeExpansionEvent event = new TreeExpansionEvent(this, path);
    TreeWillExpandListener[] listeners = getTreeWillExpandListeners();

    for (int index = 0; index < listeners.length; ++index)
      listeners[index].treeWillExpand(event);
  }

  /**
   * Returns the model of this <code>JTree</code> object.
   * 
   * @return the associated <code>TreeModel</code>
   */
  public TreeModel getModel()
  {
    return treeModel;
  }

  /**
   * Sets the model to use in <code>JTree</code>.
   * 
   * @param model the <code>TreeModel</code> to use
   */
  public void setModel(TreeModel model)
  {
    if (treeModel == model)
      return;

1978 1979 1980 1981
    // Remove listeners from old model.
    if (treeModel != null && treeModelListener != null)
      treeModel.removeTreeModelListener(treeModelListener);

1982 1983 1984 1985 1986 1987 1988 1989
    // add treeModelListener to the new model
    if (treeModelListener == null)
      treeModelListener = createTreeModelListener();
    if (model != null) // as setModel(null) is allowed
      model.addTreeModelListener(treeModelListener);

    TreeModel oldValue = treeModel;
    treeModel = model;
1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003
    clearToggledPaths();

    if (treeModel != null)
      {
        if (treeModelListener == null)
          treeModelListener = createTreeModelListener();
        if (treeModelListener != null)
          treeModel.addTreeModelListener(treeModelListener);
        Object root = treeModel.getRoot();
        if (root != null && !treeModel.isLeaf(root))
          {
            nodeStates.put(new TreePath(root), Boolean.TRUE);
          }
      }
2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050

    firePropertyChange(TREE_MODEL_PROPERTY, oldValue, model);
  }

  /**
   * Checks if this <code>JTree</code> object is editable.
   * 
   * @return <code>true</code> if this tree object is editable,
   *         <code>false</code> otherwise
   */
  public boolean isEditable()
  {
    return editable;
  }

  /**
   * Sets the <code>editable</code> property.
   * 
   * @param flag <code>true</code> to make this tree object editable,
   *        <code>false</code> otherwise
   */
  public void setEditable(boolean flag)
  {
    if (editable == flag)
      return;

    boolean oldValue = editable;
    editable = flag;
    firePropertyChange(EDITABLE_PROPERTY, oldValue, editable);
  }

  /**
   * Checks if the root element is visible.
   * 
   * @return <code>true</code> if the root element is visible,
   *         <code>false</code> otherwise
   */
  public boolean isRootVisible()
  {
    return rootVisible;
  }

  public void setRootVisible(boolean flag)
  {
    if (rootVisible == flag)
      return;

2051 2052 2053 2054 2055 2056 2057 2058 2059
    // If the root is currently selected, unselect it
    if (rootVisible && !flag)
      {
        TreeSelectionModel model = getSelectionModel();
        // The root is always shown in the first row
        TreePath rootPath = getPathForRow(0);
        model.removeSelectionPath(rootPath);
      }
    
2060 2061 2062
    boolean oldValue = rootVisible;
    rootVisible = flag;
    firePropertyChange(ROOT_VISIBLE_PROPERTY, oldValue, flag);
2063
    
2064 2065 2066 2067 2068 2069 2070 2071 2072
  }

  public boolean getShowsRootHandles()
  {
    return showsRootHandles;
  }

  public void setShowsRootHandles(boolean flag)
  {
2073 2074
    clientShowsRootHandlesSet = true;

2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122
    if (showsRootHandles == flag)
      return;
    
    boolean oldValue = showsRootHandles;
    showsRootHandles = flag;
    firePropertyChange(SHOWS_ROOT_HANDLES_PROPERTY, oldValue, flag);
  }

  public TreeCellEditor getCellEditor()
  {
    return cellEditor;
  }

  public void setCellEditor(TreeCellEditor editor)
  {
    if (cellEditor == editor)
      return;

    TreeCellEditor oldValue = cellEditor;
    cellEditor = editor;
    firePropertyChange(CELL_EDITOR_PROPERTY, oldValue, editor);
  }

  public TreeCellRenderer getCellRenderer()
  {
    return cellRenderer;
  }

  public void setCellRenderer(TreeCellRenderer newRenderer)
  {
    if (cellRenderer == newRenderer)
      return;

    TreeCellRenderer oldValue = cellRenderer;
    cellRenderer = newRenderer;
    firePropertyChange(CELL_RENDERER_PROPERTY, oldValue, newRenderer);
  }

  public TreeSelectionModel getSelectionModel()
  {
    return selectionModel;
  }

  public void setSelectionModel(TreeSelectionModel model)
  {
    if (selectionModel == model)
      return;

2123 2124 2125
    if( model == null )
      model = EmptySelectionModel.sharedInstance();

2126 2127 2128 2129 2130 2131
    if (selectionModel != null)
      selectionModel.removeTreeSelectionListener(selectionRedirector);

    TreeSelectionModel oldValue = selectionModel;
    selectionModel = model;

2132
    selectionModel.addTreeSelectionListener(selectionRedirector);
2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175

    firePropertyChange(SELECTION_MODEL_PROPERTY, oldValue, model);
    revalidate();
    repaint();
  }

  public int getVisibleRowCount()
  {
    return visibleRowCount;
  }

  public void setVisibleRowCount(int rows)
  {
    if (visibleRowCount == rows)
      return;

    int oldValue = visibleRowCount;
    visibleRowCount = rows;
    firePropertyChange(VISIBLE_ROW_COUNT_PROPERTY, oldValue, rows);
  }

  public boolean isLargeModel()
  {
    return largeModel;
  }

  public void setLargeModel(boolean large)
  {
    if (largeModel == large)
      return;

    boolean oldValue = largeModel;
    largeModel = large;
    firePropertyChange(LARGE_MODEL_PROPERTY, oldValue, large);
  }

  public int getRowHeight()
  {
    return rowHeight;
  }

  public void setRowHeight(int height)
  {
2176 2177
    clientRowHeightSet = true;

2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247
    if (rowHeight == height)
      return;

    int oldValue = rowHeight;
    rowHeight = height;
    firePropertyChange(ROW_HEIGHT_PROPERTY, oldValue, height);
  }

  public boolean isFixedRowHeight()
  {
    return rowHeight > 0;
  }

  public boolean getInvokesStopCellEditing()
  {
    return invokesStopCellEditing;
  }

  public void setInvokesStopCellEditing(boolean invoke)
  {
    if (invokesStopCellEditing == invoke)
      return;

    boolean oldValue = invokesStopCellEditing;
    invokesStopCellEditing = invoke;
    firePropertyChange(INVOKES_STOP_CELL_EDITING_PROPERTY, 
                       oldValue, invoke);
  }

  /**
   * @since 1.3
   */
  public int getToggleClickCount()
  {
    return toggleClickCount;
  }

  /**
   * @since 1.3
   */
  public void setToggleClickCount(int count)
  {
    if (toggleClickCount == count)
      return;

    int oldValue = toggleClickCount;
    toggleClickCount = count;
    firePropertyChange(TOGGLE_CLICK_COUNT_PROPERTY, oldValue, count);
  }

  public void scrollPathToVisible(TreePath path)
  {
    if (path == null)
      return;
    Rectangle rect = getPathBounds(path);
    scrollRectToVisible(rect);
  }

  public void scrollRowToVisible(int row)
  {
    scrollPathToVisible(getPathForRow(row));
  }

  public boolean getScrollsOnExpand()
  {
    return scrollsOnExpand;
  }

  public void setScrollsOnExpand(boolean scroll)
  {
2248
    clientScrollsOnExpandSet = true;
2249 2250 2251 2252 2253 2254 2255 2256 2257 2258
    if (scrollsOnExpand == scroll)
      return;

    boolean oldValue = scrollsOnExpand;
    scrollsOnExpand = scroll;
    firePropertyChange(SCROLLS_ON_EXPAND_PROPERTY, oldValue, scroll);
  }

  public void setSelectionPath(TreePath path)
  {
2259
    clearSelectionPathStates();
2260 2261
    selectionModel.setSelectionPath(path);
  }
Tom Tromey committed
2262

2263 2264
  public void setSelectionPaths(TreePath[] paths)
  {
2265
    clearSelectionPathStates();
2266 2267
    selectionModel.setSelectionPaths(paths);
  }
2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280
  
  /**
   * This method, and all calls to it, should be removed once the
   * DefaultTreeModel fires events properly.  Maintenance of the nodeStates
   * table should really be done in the TreeModelHandler.  
   */
  private void clearSelectionPathStates()
  {
    TreePath[] oldPaths = selectionModel.getSelectionPaths();
    if (oldPaths != null)
      for (int i = 0; i < oldPaths.length; i++)
        nodeStates.remove(oldPaths[i]);
  }
Tom Tromey committed
2281

2282 2283 2284
  public void setSelectionRow(int row)
  {
    TreePath path = getPathForRow(row);
Tom Tromey committed
2285

2286
    if (path != null)
2287
      setSelectionPath(path);
2288
  }
Tom Tromey committed
2289

2290 2291 2292 2293 2294
  public void setSelectionRows(int[] rows)
  {
    // Make sure we have an UI so getPathForRow() does not return null.
    if (rows == null || getUI() == null)
      return;
Tom Tromey committed
2295

2296
    TreePath[] paths = new TreePath[rows.length];
Tom Tromey committed
2297

2298 2299
    for (int i = rows.length - 1; i >= 0; --i)
      paths[i] = getPathForRow(rows[i]);
Tom Tromey committed
2300

2301 2302 2303 2304
    setSelectionPaths(paths);
  }

  public void setSelectionInterval(int index0, int index1)
Tom Tromey committed
2305
  {
2306 2307 2308 2309
    TreePath[] paths = getPathBetweenRows(index0, index1);

    if (paths != null)
      setSelectionPaths(paths);
Tom Tromey committed
2310
  }
2311 2312

  public void addSelectionPath(TreePath path)
Tom Tromey committed
2313
  {
2314
    selectionModel.addSelectionPath(path);
Tom Tromey committed
2315
  }
Tom Tromey committed
2316

2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342
  public void addSelectionPaths(TreePath[] paths)
  {
    selectionModel.addSelectionPaths(paths);
  }

  public void addSelectionRow(int row)
  {
    TreePath path = getPathForRow(row);

    if (path != null)
      selectionModel.addSelectionPath(path);
  }

  public void addSelectionRows(int[] rows)
  {
    // Make sure we have an UI so getPathForRow() does not return null.
    if (rows == null || getUI() == null)
      return;

    TreePath[] paths = new TreePath[rows.length];

    for (int i = rows.length - 1; i >= 0; --i)
      paths[i] = getPathForRow(rows[i]);

    addSelectionPaths(paths);
  }
2343 2344 2345 2346 2347 2348 2349 2350 2351
  
  /**
   * Select all rows between the two given indexes, inclusive. The method
   * will not select the inner leaves and braches of the currently collapsed
   * nodes in this interval.
   * 
   * @param index0 the starting row, inclusive
   * @param index1 the ending row, inclusive
   */
2352 2353 2354 2355 2356 2357 2358 2359 2360 2361
  public void addSelectionInterval(int index0, int index1)
  {
    TreePath[] paths = getPathBetweenRows(index0, index1);

    if (paths != null)
      addSelectionPaths(paths);
  }

  public void removeSelectionPath(TreePath path)
  {
2362
    clearSelectionPathStates();
2363 2364 2365 2366 2367
    selectionModel.removeSelectionPath(path);
  }

  public void removeSelectionPaths(TreePath[] paths)
  {
2368
    clearSelectionPathStates();
2369 2370 2371 2372 2373 2374 2375 2376
    selectionModel.removeSelectionPaths(paths);
  }

  public void removeSelectionRow(int row)
  {
    TreePath path = getPathForRow(row);

    if (path != null)
2377
      removeSelectionPath(path);
2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408
  }

  public void removeSelectionRows(int[] rows)
  {
    if (rows == null || getUI() == null)
      return;

    TreePath[] paths = new TreePath[rows.length];

    for (int i = rows.length - 1; i >= 0; --i)
      paths[i] = getPathForRow(rows[i]);

    removeSelectionPaths(paths);
  }

  public void removeSelectionInterval(int index0, int index1)
  {
    TreePath[] paths = getPathBetweenRows(index0, index1);

    if (paths != null)
      removeSelectionPaths(paths);
  }

  public void clearSelection()
  {
    selectionModel.clearSelection();
    setLeadSelectionPath(null);
  }

  public TreePath getLeadSelectionPath()
  {
2409 2410 2411 2412
    if (selectionModel == null)
      return null;
    else
      return selectionModel.getLeadSelectionPath();
2413 2414 2415 2416 2417 2418 2419
  }

  /**
   * @since 1.3
   */
  public void setLeadSelectionPath(TreePath path)
  {
2420 2421 2422
    if (selectionModel != null)
      {
        TreePath oldValue = selectionModel.getLeadSelectionPath();
2423
        if (path == oldValue || path != null && path.equals(oldValue))
2424 2425 2426 2427 2428 2429 2430 2431 2432
          return;
       
        // Repaint the previous and current rows with the lead selection path.
        if (path != null)
          {
            repaint(getPathBounds(path));
            selectionModel.addSelectionPath(path);
          }
        
2433
        if (oldValue != null)
2434 2435 2436 2437
          repaint(getPathBounds(oldValue));
        
        firePropertyChange(LEAD_SELECTION_PATH_PROPERTY, oldValue, path);
      }
2438
  }
Tom Tromey committed
2439

2440 2441 2442 2443 2444 2445 2446
  /**
   * @since 1.3
   */
  public TreePath getAnchorSelectionPath()
  {
    return anchorSelectionPath;
  }
Tom Tromey committed
2447

2448 2449 2450 2451 2452 2453 2454
  /**
   * @since 1.3
   */
  public void setAnchorSelectionPath(TreePath path)
  {
    if (anchorSelectionPath == path)
      return;
Tom Tromey committed
2455

2456 2457 2458 2459 2460 2461 2462 2463 2464
    TreePath oldValue = anchorSelectionPath;
    anchorSelectionPath = path;
    firePropertyChange(ANCHOR_SELECTION_PATH_PROPERTY, oldValue, path);
  }

  public int getLeadSelectionRow()
  {
    return selectionModel.getLeadSelectionRow();
  }
Tom Tromey committed
2465

2466 2467 2468 2469
  public int getMaxSelectionRow()
  {
    return selectionModel.getMaxSelectionRow();
  }
Tom Tromey committed
2470

2471 2472 2473 2474
  public int getMinSelectionRow()
  {
    return selectionModel.getMinSelectionRow();
  }
Tom Tromey committed
2475

2476 2477 2478 2479
  public int getSelectionCount()
  {
    return selectionModel.getSelectionCount();
  }
Tom Tromey committed
2480

2481 2482 2483 2484
  public TreePath getSelectionPath()
  {
    return selectionModel.getSelectionPath();
  }
Tom Tromey committed
2485

2486 2487 2488 2489
  public TreePath[] getSelectionPaths()
  {
    return selectionModel.getSelectionPaths();
  }
Tom Tromey committed
2490

2491 2492 2493 2494
  public int[] getSelectionRows()
  {
    return selectionModel.getSelectionRows();
  }
Tom Tromey committed
2495

2496 2497 2498 2499
  public boolean isPathSelected(TreePath path)
  {
    return selectionModel.isPathSelected(path);
  }
Tom Tromey committed
2500

2501 2502 2503 2504 2505 2506 2507 2508 2509 2510
  /**
   * Returns <code>true</code> when the specified row is selected,
   * <code>false</code> otherwise. This call is delegated to the
   * {@link TreeSelectionModel#isRowSelected(int)} method.
   *
   * @param row the row to check
   *
   * @return <code>true</code> when the specified row is selected,
   *         <code>false</code> otherwise
   */
2511 2512
  public boolean isRowSelected(int row)
  {
2513
    return selectionModel.isRowSelected(row);
2514
  }
Tom Tromey committed
2515

2516 2517 2518 2519
  public boolean isSelectionEmpty()
  {
    return selectionModel.isSelectionEmpty();
  }
Tom Tromey committed
2520

2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531
  /**
   * Return the value of the <code>dragEnabled</code> property.
   * 
   * @return the value
   * 
   * @since 1.4
   */
  public boolean getDragEnabled()
  {
    return dragEnabled;
  }
Tom Tromey committed
2532

2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543
  /**
   * Set the <code>dragEnabled</code> property.
   * 
   * @param enabled new value
   * 
   * @since 1.4
   */
  public void setDragEnabled(boolean enabled)
  {
    dragEnabled = enabled;
  }
Tom Tromey committed
2544

2545 2546 2547
  public int getRowCount()
  {
    TreeUI ui = getUI();
Tom Tromey committed
2548

2549 2550
    if (ui != null)
      return ui.getRowCount(this);
Tom Tromey committed
2551

2552 2553
    return 0;
  }
Tom Tromey committed
2554

2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567
  public void collapsePath(TreePath path)
  {
    try
      {
        fireTreeWillCollapse(path);
      }
    catch (ExpandVetoException ev)
      {
        // We do nothing if attempt has been vetoed.
      }
    setExpandedState(path, false);
    fireTreeCollapsed(path);
  }
Tom Tromey committed
2568

2569 2570 2571 2572
  public void collapseRow(int row)
  {
    if (row < 0 || row >= getRowCount())
      return;
Tom Tromey committed
2573

2574
    TreePath path = getPathForRow(row);
Tom Tromey committed
2575

2576 2577 2578
    if (path != null)
      collapsePath(path);
  }
Tom Tromey committed
2579

2580 2581 2582
  public void expandPath(TreePath path)
  {
    // Don't expand if path is null
2583 2584
    // or is already expanded.
    if (path == null || isExpanded(path))
2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598
      return;

    try
      {
        fireTreeWillExpand(path);
      }
    catch (ExpandVetoException ev)
      {
        // We do nothing if attempt has been vetoed.
      }

    setExpandedState(path, true);
    fireTreeExpanded(path);
  }
Tom Tromey committed
2599

2600 2601 2602 2603
  public void expandRow(int row)
  {
    if (row < 0 || row >= getRowCount())
      return;
Tom Tromey committed
2604

2605
    TreePath path = getPathForRow(row);
Tom Tromey committed
2606

2607 2608 2609
    if (path != null)
      expandPath(path);
  }
Tom Tromey committed
2610

2611 2612 2613 2614
  public boolean isCollapsed(TreePath path)
  {
    return !isExpanded(path);
  }
Tom Tromey committed
2615

2616 2617 2618 2619
  public boolean isCollapsed(int row)
  {
    if (row < 0 || row >= getRowCount())
      return false;
Tom Tromey committed
2620

2621
    TreePath path = getPathForRow(row);
Tom Tromey committed
2622

2623 2624
    if (path != null)
      return isCollapsed(path);
Tom Tromey committed
2625

2626 2627
    return false;
  }
Tom Tromey committed
2628

2629 2630 2631 2632
  public boolean isExpanded(TreePath path)
  {
    if (path == null)
      return false;
Tom Tromey committed
2633

2634
    Object state = nodeStates.get(path);
Tom Tromey committed
2635

2636 2637
    if ((state == null) || (state != EXPANDED))
      return false;
Tom Tromey committed
2638

2639
    TreePath parent = path.getParentPath();
Tom Tromey committed
2640

2641 2642
    if (parent != null)
      return isExpanded(parent);
Tom Tromey committed
2643

2644 2645
    return true;
  }
Tom Tromey committed
2646

2647 2648 2649 2650
  public boolean isExpanded(int row)
  {
    if (row < 0 || row >= getRowCount())
      return false;
Tom Tromey committed
2651

2652
    TreePath path = getPathForRow(row);
Tom Tromey committed
2653

2654 2655
    if (path != null)
      return isExpanded(path);
Tom Tromey committed
2656

2657 2658
    return false;
  }
Tom Tromey committed
2659

2660 2661 2662 2663 2664 2665 2666
  /**
   * @since 1.3
   */
  public boolean getExpandsSelectedPaths()
  {
    return expandsSelectedPaths;
  }
Tom Tromey committed
2667

2668 2669 2670 2671 2672 2673 2674
  /**
   * @since 1.3
   */
  public void setExpandsSelectedPaths(boolean flag)
  {
    if (expandsSelectedPaths == flag)
      return;
Tom Tromey committed
2675

2676 2677 2678 2679
    boolean oldValue = expandsSelectedPaths;
    expandsSelectedPaths = flag;
    firePropertyChange(EXPANDS_SELECTED_PATHS_PROPERTY, oldValue, flag);
  }
Tom Tromey committed
2680

2681 2682 2683
  public Rectangle getPathBounds(TreePath path)
  {
    TreeUI ui = getUI();
Tom Tromey committed
2684

2685 2686
    if (ui == null)
      return null;
Tom Tromey committed
2687

2688 2689
    return ui.getPathBounds(this, path);
  }
Tom Tromey committed
2690

2691 2692 2693
  public Rectangle getRowBounds(int row)
  {
    TreePath path = getPathForRow(row);
Tom Tromey committed
2694

2695 2696
    if (path != null)
      return getPathBounds(path);
Tom Tromey committed
2697

2698 2699
    return null;
  }
Tom Tromey committed
2700

2701 2702 2703
  public boolean isEditing()
  {
    TreeUI ui = getUI();
Tom Tromey committed
2704

2705 2706
    if (ui != null)
      return ui.isEditing(this);
Tom Tromey committed
2707

2708 2709
    return false;
  }
Tom Tromey committed
2710

2711 2712 2713
  public boolean stopEditing()
  {
    TreeUI ui = getUI();
Tom Tromey committed
2714

2715 2716 2717
    if (isEditing())
      if (ui != null)
        return ui.stopEditing(this);
Tom Tromey committed
2718

2719 2720
    return false;
  }
Tom Tromey committed
2721

2722 2723 2724
  public void cancelEditing()
  {
    TreeUI ui = getUI();
2725 2726 2727 2728
      
    if (isEditing())
      if (ui != null)
        ui.cancelEditing(this);
2729
  }
Tom Tromey committed
2730

2731 2732 2733
  public void startEditingAtPath(TreePath path)
  {
    TreeUI ui = getUI();
Tom Tromey committed
2734

2735 2736 2737
    if (ui != null)
      ui.startEditingAtPath(this, path);
  }
Tom Tromey committed
2738

2739 2740 2741
  public TreePath getEditingPath()
  {
    TreeUI ui = getUI();
Tom Tromey committed
2742

2743 2744
    if (ui != null)
      return ui.getEditingPath(this);
Tom Tromey committed
2745

2746 2747
    return null;
  }
Tom Tromey committed
2748

2749 2750 2751
  public TreePath getPathForLocation(int x, int y)
  {
    TreePath path = getClosestPathForLocation(x, y);
Tom Tromey committed
2752

2753 2754 2755
    if (path != null)
      {
        Rectangle rect = getPathBounds(path);
Tom Tromey committed
2756

2757 2758 2759
        if ((rect != null) && rect.contains(x, y))
          return path;
      }
Tom Tromey committed
2760

2761 2762
    return null;
  }
Tom Tromey committed
2763

2764 2765 2766
  public int getRowForLocation(int x, int y)
  {
    TreePath path = getPathForLocation(x, y);
Tom Tromey committed
2767

2768 2769
    if (path != null)
      return getRowForPath(path);
Tom Tromey committed
2770

2771 2772
    return -1;
  }
Tom Tromey committed
2773

2774 2775 2776
  public TreePath getClosestPathForLocation(int x, int y)
  {
    TreeUI ui = getUI();
Tom Tromey committed
2777

2778 2779
    if (ui != null)
      return ui.getClosestPathForLocation(this, x, y);
Tom Tromey committed
2780

2781 2782
    return null;
  }
Tom Tromey committed
2783

2784 2785 2786
  public int getClosestRowForLocation(int x, int y)
  {
    TreePath path = getClosestPathForLocation(x, y);
Tom Tromey committed
2787

2788 2789
    if (path != null)
      return getRowForPath(path);
Tom Tromey committed
2790

2791 2792
    return -1;
  }
Tom Tromey committed
2793

2794 2795 2796
  public Object getLastSelectedPathComponent()
  {
    TreePath path = getSelectionPath();
Tom Tromey committed
2797

2798 2799
    if (path != null)
      return path.getLastPathComponent();
Tom Tromey committed
2800

2801 2802
    return null;
  }
Tom Tromey committed
2803

2804 2805 2806
  private void doExpandParents(TreePath path, boolean state)
  {
    TreePath parent = path.getParentPath();		
Tom Tromey committed
2807

2808 2809 2810 2811 2812
    if (!isExpanded(parent) && parent != null)
      doExpandParents(parent, false);
    
    nodeStates.put(path, state ? EXPANDED : COLLAPSED);
  }
Tom Tromey committed
2813

2814 2815 2816 2817
  protected void setExpandedState(TreePath path, boolean state)
  {
    if (path == null)
      return;
Tom Tromey committed
2818

2819 2820
    doExpandParents(path, state);
  }
Tom Tromey committed
2821

2822 2823 2824 2825
  protected void clearToggledPaths()
  {
    nodeStates.clear();
  }
Tom Tromey committed
2826

2827
  protected Enumeration<TreePath> getDescendantToggledPaths(TreePath parent)
2828 2829 2830
  {
    if (parent == null)
      return null;
Tom Tromey committed
2831

2832 2833
    Enumeration nodes = nodeStates.keys();
    Vector result = new Vector();
Tom Tromey committed
2834

2835 2836 2837
    while (nodes.hasMoreElements())
      {
        TreePath path = (TreePath) nodes.nextElement();
Tom Tromey committed
2838

2839 2840 2841
        if (path.isDescendant(parent))
          result.addElement(path);
      }
Tom Tromey committed
2842

2843 2844
    return result.elements();
  }
Tom Tromey committed
2845

2846 2847 2848 2849
  public boolean hasBeenExpanded(TreePath path)
  {
    if (path == null)
      return false;
Tom Tromey committed
2850

2851 2852
    return nodeStates.get(path) != null;
  }
Tom Tromey committed
2853

2854 2855 2856 2857
  public boolean isVisible(TreePath path)
  {
    if (path == null)
      return false;
Tom Tromey committed
2858

2859
    TreePath parent = path.getParentPath();
Tom Tromey committed
2860

2861 2862
    if (parent == null)
      return true; // Is root node.
Tom Tromey committed
2863

2864 2865
    return isExpanded(parent);
  }
Tom Tromey committed
2866

2867 2868 2869 2870 2871 2872 2873
  public void makeVisible(TreePath path)
  {
    if (path == null)
      return;
    
    expandPath(path.getParentPath());
  }
Tom Tromey committed
2874

2875 2876 2877 2878
  public boolean isPathEditable(TreePath path)
  {
    return isEditable();
  }
Tom Tromey committed
2879

2880 2881 2882 2883 2884 2885 2886 2887 2888
  /**
   * Creates and returns an instance of {@link TreeModelHandler}.
   * 
   * @return an instance of {@link TreeModelHandler}
   */
  protected TreeModelListener createTreeModelListener()
  {
    return new TreeModelHandler();
  }
Tom Tromey committed
2889

2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928
  /**
   * Returns a sample TreeModel that can be used in a JTree. This can be used
   * in Bean- or GUI-Builders to show something interesting.
   * 
   * @return a sample TreeModel that can be used in a JTree
   */
  protected static TreeModel getDefaultTreeModel()
  {
    DefaultMutableTreeNode root = new DefaultMutableTreeNode("Root node");
    DefaultMutableTreeNode child1 = new DefaultMutableTreeNode("Child node 1");
    DefaultMutableTreeNode child11 =
      new DefaultMutableTreeNode("Child node 1.1");
    DefaultMutableTreeNode child12 =
      new DefaultMutableTreeNode("Child node 1.2");
    DefaultMutableTreeNode child13 =
      new DefaultMutableTreeNode("Child node 1.3");
    DefaultMutableTreeNode child2 = new DefaultMutableTreeNode("Child node 2");
    DefaultMutableTreeNode child21 =
      new DefaultMutableTreeNode("Child node 2.1");
    DefaultMutableTreeNode child22 =
      new DefaultMutableTreeNode("Child node 2.2");
    DefaultMutableTreeNode child23 =
      new DefaultMutableTreeNode("Child node 2.3");
    DefaultMutableTreeNode child24 =
      new DefaultMutableTreeNode("Child node 2.4");

    DefaultMutableTreeNode child3 = new DefaultMutableTreeNode("Child node 3");
    root.add(child1);
    root.add(child2);
    root.add(child3);
    child1.add(child11);
    child1.add(child12);
    child1.add(child13);
    child2.add(child21);
    child2.add(child22);
    child2.add(child23);
    child2.add(child24);
    return new DefaultTreeModel(root);
  }
Tom Tromey committed
2929

2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949
  /**
   * Converts the specified value to a String. This is used by the renderers
   * of this JTree and its nodes.
   * 
   * This implementation simply returns <code>value.toString()</code> and
   * ignores all other parameters. Subclass this method to control the
   * conversion.
   * 
   * @param value the value that is converted to a String
   * @param selected indicates if that value is selected or not
   * @param expanded indicates if that value is expanded or not
   * @param leaf indicates if that value is a leaf node or not
   * @param row the row of the node
   * @param hasFocus indicates if that node has focus or not
   */
  public String convertValueToText(Object value, boolean selected,
                                   boolean expanded, boolean leaf, int row, boolean hasFocus)
  {
    return value.toString();
  }
Tom Tromey committed
2950

2951 2952 2953 2954 2955 2956 2957
  /**
   * A String representation of this JTree. This is intended to be used for
   * debugging. The returned string may be empty but may not be
   * <code>null</code>.
   * 
   * @return a String representation of this JTree
   */
2958
  protected String paramString()
2959 2960 2961 2962 2963 2964
  {
    // TODO: this is completely legal, but it would possibly be nice
    // to return some more content, like the tree structure, some properties
    // etc ...
    return "";
  }
Tom Tromey committed
2965

2966 2967 2968 2969 2970 2971 2972 2973 2974 2975
  /**
   * Returns all TreePath objects which are a descendants of the given path
   * and are exapanded at the moment of the execution of this method. If the
   * state of any node is beeing toggled while this method is executing this
   * change may be left unaccounted.
   * 
   * @param path The parent of this request
   *
   * @return An Enumeration containing TreePath objects
   */
2976
  public Enumeration<TreePath> getExpandedDescendants(TreePath path)
2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990
  {
    Enumeration paths = nodeStates.keys();
    Vector relevantPaths = new Vector();
    while (paths.hasMoreElements())
      {
        TreePath nextPath = (TreePath) paths.nextElement();
        if (nodeStates.get(nextPath) == EXPANDED
            && path.isDescendant(nextPath))
          {
            relevantPaths.add(nextPath);
          }
      }
    return relevantPaths.elements();
  }
Tom Tromey committed
2991

2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063
  /**
   * Returns the next table element (beginning from the row
   * <code>startingRow</code> that starts with <code>prefix</code>.
   * Searching is done in the direction specified by <code>bias</code>.
   * 
   * @param prefix the prefix to search for in the cell values
   * @param startingRow the index of the row where to start searching from
   * @param bias the search direction, either {@link Position.Bias#Forward} or
   *        {@link Position.Bias#Backward}
   * 
   * @return the path to the found element or -1 if no such element has been
   *         found
   * 
   * @throws IllegalArgumentException if prefix is <code>null</code> or
   *         startingRow is not valid
   * 
   * @since 1.4
   */
  public TreePath getNextMatch(String prefix, int startingRow,
                               Position.Bias bias)
  {
    if (prefix == null)
      throw new IllegalArgumentException("The argument 'prefix' must not be"
                                         + " null.");
    if (startingRow < 0)
      throw new IllegalArgumentException("The argument 'startingRow' must not"
                                         + " be less than zero.");

    int size = getRowCount();
    if (startingRow > size)
      throw new IllegalArgumentException("The argument 'startingRow' must not"
                                         + " be greater than the number of"
                                         + " elements in the TreeModel.");

    TreePath foundPath = null;
    if (bias == Position.Bias.Forward)
      {
        for (int i = startingRow; i < size; i++)
          {
            TreePath path = getPathForRow(i);
            Object o = path.getLastPathComponent();
            // FIXME: in the following call to convertValueToText the
            // last argument (hasFocus) should be done right.
            String item = convertValueToText(o, isRowSelected(i),
                                             isExpanded(i), treeModel.isLeaf(o),
                                             i, false);
            if (item.startsWith(prefix))
              {
                foundPath = path;
                break;
              }
          }
      }
    else
      {
        for (int i = startingRow; i >= 0; i--)
          {
            TreePath path = getPathForRow(i);
            Object o = path.getLastPathComponent();
            // FIXME: in the following call to convertValueToText the
            // last argument (hasFocus) should be done right.
            String item = convertValueToText(o, isRowSelected(i),
                                             isExpanded(i), treeModel.isLeaf(o), i, false);
            if (item.startsWith(prefix))
              {
                foundPath = path;
                break;
              }
          }
      }
    return foundPath;
  }
Tom Tromey committed
3064

3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103
  /**
   * Removes any paths in the current set of selected paths that are
   * descendants of <code>path</code>. If <code>includePath</code> is set
   * to <code>true</code> and <code>path</code> itself is selected, then
   * it will be removed too.
   * 
   * @param path the path from which selected descendants are to be removed
   * @param includeSelected if <code>true</code> then <code>path</code> itself
   *        will also be remove if it's selected
   * 
   * @return <code>true</code> if something has been removed,
   *         <code>false</code> otherwise
   * 
   * @since 1.3
   */
  protected boolean removeDescendantSelectedPaths(TreePath path,
                                                  boolean includeSelected)
  {
    boolean removedSomething = false;
    TreePath[] selected = getSelectionPaths();
    for (int index = 0; index < selected.length; index++)
      {
        if ((selected[index] == path && includeSelected)
            || (selected[index].isDescendant(path)))
          {
            removeSelectionPath(selected[index]);
            removedSomething = true;
          }
      }
    return removedSomething;
  }
  
  /**
   * Removes any descendants of the TreePaths in toRemove that have been 
   * expanded.
   * 
   * @param toRemove - Enumeration of TreePaths that need to be removed from
   * cache of toggled tree paths.
   */
3104
  protected void removeDescendantToggledPaths(Enumeration<TreePath> toRemove)
3105 3106 3107
  {
    while (toRemove.hasMoreElements())
      {
3108
        TreePath current = toRemove.nextElement();
3109 3110 3111 3112 3113 3114 3115 3116 3117 3118
        Enumeration descendants = getDescendantToggledPaths(current);
        
        while (descendants.hasMoreElements())
          {
            TreePath currentDes = (TreePath) descendants.nextElement();
            if (isExpanded(currentDes))
                nodeStates.remove(currentDes);
          }
      }
  }
Tom Tromey committed
3119

3120
  /**
3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134
   * <p>
   * Sent when the tree has changed enough that we need to resize the bounds,
   * but not enough that we need to remove the expanded node set (e.g nodes were
   * expanded or collapsed, or nodes were inserted into the tree). You should
   * never have to invoke this, the UI will invoke this as it needs to.
   * </p>
   * <p>
   * If the tree uses {@link DefaultTreeModel}, you must call
   * {@link DefaultTreeModel#reload(TreeNode)} or
   * {@link DefaultTreeModel#reload()} after adding or removing nodes. Following
   * the official Java 1.5 API standard, just calling treeDidChange, repaint()
   * or revalidate() does <i>not</i> update the tree appearance properly.
   * 
   * @see DefaultTreeModel#reload()
3135 3136 3137 3138 3139
   */
  public void treeDidChange()
  {
    repaint();
  }
3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185

  /**
   * Helper method for
   * {@link LookAndFeel#installProperty(JComponent, String, Object)}.
   * 
   * @param propertyName the name of the property
   * @param value the value of the property
   *
   * @throws IllegalArgumentException if the specified property cannot be set
   *         by this method
   * @throws ClassCastException if the property value does not match the
   *         property type
   * @throws NullPointerException if <code>c</code> or
   *         <code>propertyValue</code> is <code>null</code>
   */
  void setUIProperty(String propertyName, Object value)
  {
    if (propertyName.equals("rowHeight"))
      {
        if (! clientRowHeightSet)
          {
            setRowHeight(((Integer) value).intValue());
            clientRowHeightSet = false;
          }
      }
    else if (propertyName.equals("scrollsOnExpand"))
      {
        if (! clientScrollsOnExpandSet)
          {
            setScrollsOnExpand(((Boolean) value).booleanValue());
            clientScrollsOnExpandSet = false;
          }
      }
    else if (propertyName.equals("showsRootHandles"))
      {
        if (! clientShowsRootHandlesSet)
          {
            setShowsRootHandles(((Boolean) value).booleanValue());
            clientShowsRootHandlesSet = false;
          }
      }
    else
      {
        super.setUIProperty(propertyName, value);
      }
  }
Tom Tromey committed
3186
}