Source for javax.swing.JTree

   1: /* JTree.java 
   2:    Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc.
   3:  
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package javax.swing;
  39: 
  40: import java.awt.Color;
  41: import java.awt.Cursor;
  42: import java.awt.Dimension;
  43: import java.awt.Font;
  44: import java.awt.FontMetrics;
  45: import java.awt.Point;
  46: import java.awt.Rectangle;
  47: import java.awt.event.FocusListener;
  48: import java.beans.PropertyChangeListener;
  49: import java.io.Serializable;
  50: import java.util.Enumeration;
  51: import java.util.Hashtable;
  52: import java.util.Iterator;
  53: import java.util.Locale;
  54: import java.util.Vector;
  55: 
  56: import javax.accessibility.Accessible;
  57: import javax.accessibility.AccessibleAction;
  58: import javax.accessibility.AccessibleComponent;
  59: import javax.accessibility.AccessibleContext;
  60: import javax.accessibility.AccessibleRole;
  61: import javax.accessibility.AccessibleSelection;
  62: import javax.accessibility.AccessibleState;
  63: import javax.accessibility.AccessibleStateSet;
  64: import javax.accessibility.AccessibleText;
  65: import javax.accessibility.AccessibleValue;
  66: import javax.swing.event.TreeExpansionEvent;
  67: import javax.swing.event.TreeExpansionListener;
  68: import javax.swing.event.TreeModelEvent;
  69: import javax.swing.event.TreeModelListener;
  70: import javax.swing.event.TreeSelectionEvent;
  71: import javax.swing.event.TreeSelectionListener;
  72: import javax.swing.event.TreeWillExpandListener;
  73: import javax.swing.plaf.TreeUI;
  74: import javax.swing.text.Position;
  75: import javax.swing.tree.DefaultMutableTreeNode;
  76: import javax.swing.tree.DefaultTreeModel;
  77: import javax.swing.tree.DefaultTreeSelectionModel;
  78: import javax.swing.tree.ExpandVetoException;
  79: import javax.swing.tree.TreeCellEditor;
  80: import javax.swing.tree.TreeCellRenderer;
  81: import javax.swing.tree.TreeModel;
  82: import javax.swing.tree.TreeNode;
  83: import javax.swing.tree.TreePath;
  84: import javax.swing.tree.TreeSelectionModel;
  85: 
  86: public class JTree extends JComponent implements Scrollable, Accessible
  87: {
  88: 
  89:   /**
  90:    * This class implements accessibility support for the JTree class. It 
  91:    * provides an implementation of the Java Accessibility API appropriate 
  92:    * to tree user-interface elements.
  93:    */
  94:   protected class AccessibleJTree extends JComponent.AccessibleJComponent
  95:       implements AccessibleSelection, TreeSelectionListener, TreeModelListener,
  96:       TreeExpansionListener
  97:   {
  98:     
  99:     /**
 100:      * This class implements accessibility support for the JTree child. It provides 
 101:      * an implementation of the Java Accessibility API appropriate to tree nodes.
 102:      */
 103:     protected class AccessibleJTreeNode extends AccessibleContext 
 104:        implements Accessible, AccessibleComponent, AccessibleSelection, 
 105:        AccessibleAction
 106:     {
 107:       
 108:       private JTree tree;
 109:       private TreePath tp;
 110:       private Accessible acc;
 111:       private AccessibleStateSet states;
 112:       private Vector selectionList;
 113:       private Vector actionList;
 114:       private TreeModel mod;
 115:       private Cursor cursor;
 116:       
 117:       /**
 118:        * Constructs an AccessibleJTreeNode
 119:        * 
 120:        * @param t - the current tree
 121:        * @param p - the current path to be dealt with
 122:        * @param ap - the accessible object to use
 123:        */
 124:       public AccessibleJTreeNode(JTree t, TreePath p, Accessible ap)
 125:       {
 126:         states = new AccessibleStateSet();
 127:         selectionList = new Vector();
 128:         actionList = new Vector();
 129:         mod = tree.getModel();
 130:         cursor = JTree.this.getCursor();
 131:                 
 132:         tree = t;
 133:         tp = p;
 134:         acc = ap;
 135:         
 136:         // Add all the children of this path that may already be
 137:         // selected to the selection list.
 138:         TreePath[] selected = tree.getSelectionPaths();
 139:         for (int i = 0; i < selected.length; i++)
 140:           {
 141:             TreePath sel = selected[i];
 142:             if ((sel.getParentPath()).equals(tp))
 143:               selectionList.add(sel);
 144:           }
 145:         
 146:         // Add all the actions available for a node to 
 147:         // the action list.
 148:         actionList.add("EXPAND");
 149:         actionList.add("COLLAPSE");
 150:         actionList.add("EDIT");
 151:         actionList.add("SELECT");
 152:         actionList.add("DESELECT");
 153:       }      
 154:       
 155:       /**
 156:        * Adds the specified selected item in the object to the object's
 157:        * selection.
 158:        * 
 159:        * @param i - the i-th child of this node.
 160:        */
 161:       public void addAccessibleSelection(int i)
 162:       {
 163:         if (mod != null)
 164:           {
 165:             Object child = mod.getChild(tp.getLastPathComponent(), i);
 166:             if (child != null)
 167:               {
 168:                 if (!states.contains(AccessibleState.MULTISELECTABLE))
 169:                   clearAccessibleSelection();
 170:                 selectionList.add(child);                  
 171:                 tree.addSelectionPath(tp.pathByAddingChild(child));
 172:               }
 173:           }
 174:       }
 175:       
 176:       /**
 177:        * Adds the specified focus listener to receive focus events 
 178:        * from this component.
 179:        * 
 180:        * @param l - the new focus listener
 181:        */
 182:       public void addFocusListener(FocusListener l)
 183:       {
 184:         tree.addFocusListener(l);
 185:       }
 186:       
 187:       /**
 188:        * Add a PropertyChangeListener to the listener list.
 189:        * 
 190:        * @param l - the new property change listener
 191:        */
 192:       public void addPropertyChangeListener(PropertyChangeListener l)
 193:       {
 194:         // Nothing to do here.
 195:       }
 196:       
 197:       /**
 198:        * Clears the selection in the object, so that nothing in the 
 199:        * object is selected.
 200:        */
 201:       public void clearAccessibleSelection()
 202:       {
 203:         selectionList.clear();
 204:       }
 205:       
 206:       /**
 207:        * Checks whether the specified point is within this object's 
 208:        * bounds, where the point's x and y coordinates are defined to be 
 209:        * relative to the coordinate system of the object. 
 210:        * 
 211:        * @param p - the point to check
 212:        * @return true if p is in the bounds
 213:        */
 214:       public boolean contains(Point p)
 215:       {
 216:         return getBounds().contains(p);
 217:       }
 218:       
 219:       /**
 220:        * Perform the specified Action on the tree node.
 221:        * 
 222:        * @param i - the i-th action to perform
 223:        * @return true if the the action was performed; else false.
 224:        */
 225:       public boolean doAccessibleAction(int i)
 226:       {
 227:         if (i >= actionList.size() || i < 0)
 228:           return false;
 229:         
 230:         if (actionList.get(i).equals("EXPAND"))
 231:           tree.expandPath(tp);
 232:         else if (actionList.get(i).equals("COLLAPSE"))
 233:           tree.collapsePath(tp);
 234:         else if (actionList.get(i).equals("SELECT"))
 235:           tree.addSelectionPath(tp);
 236:         else if (actionList.get(i).equals("DESELECT"))
 237:           tree.removeSelectionPath(tp);
 238:         else if (actionList.get(i).equals("EDIT"))
 239:           tree.startEditingAtPath(tp);
 240:         else
 241:           return false;
 242:         return true;
 243:       }
 244:       
 245:       /**
 246:        * Get the AccessibleAction associated with this object.
 247:        * 
 248:        * @return the action
 249:        */
 250:       public AccessibleAction getAccessibleAction()
 251:       {
 252:         return this;
 253:       }
 254:       
 255:       /**
 256:        * Returns the number of accessible actions available in this tree node.
 257:        * 
 258:        * @return the number of actions
 259:        */
 260:       public int getAccessibleActionCount()
 261:       {
 262:         return actionList.size();
 263:       }
 264:       
 265:       /**
 266:        * Return a description of the specified action of the tree node.
 267:        * 
 268:        * @param i - the i-th action's description
 269:        * @return a description of the action
 270:        */
 271:       public String getAccessibleActionDescription(int i)
 272:       {
 273:         if (i < 0 || i >= actionList.size())
 274:           return (actionList.get(i)).toString();
 275:         return super.getAccessibleDescription();
 276:       }
 277:       
 278:       /**
 279:        * Returns the Accessible child, if one exists, contained at the 
 280:        * local coordinate Point.
 281:        * 
 282:        * @param p - the point of the accessible
 283:        * @return the accessible at point p if it exists
 284:        */
 285:       public Accessible getAccessibleAt(Point p)
 286:       {
 287:         TreePath acc = tree.getClosestPathForLocation(p.x, p.y);
 288:         if (acc != null)
 289:           return new AccessibleJTreeNode(tree, acc, this);
 290:         return null;
 291:       }
 292:       
 293:       /**
 294:        * Return the specified Accessible child of the object.
 295:        * 
 296:        * @param i - the i-th child of the current path
 297:        * @return the child if it exists
 298:        */
 299:       public Accessible getAccessibleChild(int i)
 300:       {
 301:         if (mod != null)
 302:           {
 303:             Object child = mod.getChild(tp.getLastPathComponent(), i);
 304:             if (child != null)
 305:               return new AccessibleJTreeNode(tree, tp.pathByAddingChild(child),
 306:                                              acc);
 307:           }
 308:         return null;
 309:       }
 310:       
 311:       /**
 312:        * Returns the number of accessible children in the object.
 313:        * 
 314:        * @return the number of children the current node has
 315:        */
 316:       public int getAccessibleChildrenCount()
 317:       {
 318:         TreeModel mod = getModel();
 319:         if (mod != null)
 320:           return mod.getChildCount(tp.getLastPathComponent());
 321:         return 0;
 322:       }
 323:       
 324:       /**
 325:        * Get the AccessibleComponent associated with this object.
 326:        * 
 327:        * @return the accessible component if it is supported.
 328:        */
 329:       public AccessibleComponent getAccessibleComponent()
 330:       {
 331:         return this;
 332:       }
 333:       
 334:       /**
 335:        * Get the AccessibleContext associated with this tree node.
 336:        * 
 337:        * @return an instance of this class
 338:        */
 339:       public AccessibleContext getAccessibleContext()
 340:       {
 341:         return this;
 342:       }
 343:       
 344:       /**
 345:        * Get the accessible description of this object.
 346:        * 
 347:        * @return the accessible description
 348:        */
 349:       public String getAccessibleDescription()
 350:       {
 351:         return super.getAccessibleDescription();
 352:       }
 353:       
 354:       /**
 355:        * Get the index of this object in its accessible parent.
 356:        * 
 357:        * @return the index of this in the parent.
 358:        */
 359:       public int getAccessibleIndexInParent()
 360:       {
 361:         AccessibleContext parent = getAccessibleParent().getAccessibleContext();
 362:         if (parent != null)
 363:           for (int i = 0; i < parent.getAccessibleChildrenCount(); i++)
 364:             {
 365:               if ((parent.getAccessibleChild(i)).equals(this))
 366:                 return i;
 367:             }
 368:         return -1;
 369:       }
 370:       
 371:       /**
 372:        * Get the accessible name of this object.
 373:        * 
 374:        * @return the accessible name
 375:        */
 376:       public String getAccessibleName()
 377:       {
 378:         return super.getAccessibleName();
 379:       }
 380:       
 381:       /**
 382:        * Get the Accessible parent of this object.
 383:        * 
 384:        * @return the accessible parent if it exists.
 385:        */
 386:       public Accessible getAccessibleParent()
 387:       {
 388:         return super.getAccessibleParent();
 389:       }
 390:       
 391:       /**
 392:        * Get the role of this object.
 393:        * 
 394:        * @return the accessible role
 395:        */
 396:       public AccessibleRole getAccessibleRole()
 397:       {
 398:         return AccessibleJTree.this.getAccessibleRole();
 399:       }
 400:       
 401:       /**
 402:        * Get the AccessibleSelection associated with this object if one exists.
 403:        * 
 404:        * @return the accessible selection for this.
 405:        */
 406:       public AccessibleSelection getAccessibleSelection()
 407:       {
 408:         return this;
 409:       }
 410:       
 411:       /**
 412:        * Returns an Accessible representing the specified selected item 
 413:        * in the object.
 414:        * 
 415:        * @return the accessible representing a certain selected item.
 416:        */
 417:       public Accessible getAccessibleSelection(int i)
 418:       {
 419:         if (i > 0 && i < getAccessibleSelectionCount())
 420:             return new AccessibleJTreeNode(tree, 
 421:                   tp.pathByAddingChild(selectionList.get(i)), acc);
 422:         return null;
 423:       }
 424:       
 425:       /**
 426:        * Returns the number of items currently selected.
 427:        * 
 428:        * @return the number of items selected.
 429:        */
 430:       public int getAccessibleSelectionCount()
 431:       {
 432:         return selectionList.size();
 433:       }
 434:       
 435:       /**
 436:        * Get the state set of this object.
 437:        * 
 438:        * @return the state set for this object
 439:        */
 440:       public AccessibleStateSet getAccessibleStateSet()
 441:       {
 442:         if (isVisible())
 443:           states.add(AccessibleState.VISIBLE);
 444:         if (tree.isCollapsed(tp))
 445:           states.add(AccessibleState.COLLAPSED);
 446:         if (tree.isEditable())
 447:           states.add(AccessibleState.EDITABLE);
 448:         if (mod != null && 
 449:             !mod.isLeaf(tp.getLastPathComponent()))
 450:           states.add(AccessibleState.EXPANDABLE);
 451:         if (tree.isExpanded(tp))
 452:           states.add(AccessibleState.EXPANDED);
 453:         if (isFocusable())
 454:           states.add(AccessibleState.FOCUSABLE);
 455:         if (hasFocus())
 456:           states.add(AccessibleState.FOCUSED);
 457:         if (tree.getSelectionModel().getSelectionMode() != 
 458:           TreeSelectionModel.SINGLE_TREE_SELECTION)
 459:           states.add(AccessibleState.MULTISELECTABLE);
 460:         if (tree.isOpaque())
 461:           states.add(AccessibleState.OPAQUE);
 462:         if (tree.isPathSelected(tp))
 463:           states.add(AccessibleState.SELECTED);
 464:         if (isShowing())
 465:           states.add(AccessibleState.SHOWING);
 466: 
 467:         states.add(AccessibleState.SELECTABLE);
 468:         return states;
 469:       }
 470:       
 471:       /**
 472:        * Get the AccessibleText associated with this object if one exists.
 473:        * 
 474:        * @return the accessible text
 475:        */
 476:       public AccessibleText getAccessibleText()
 477:       {
 478:         return super.getAccessibleText();
 479:       }
 480:       
 481:       /**
 482:        * Get the AccessibleValue associated with this object if one exists.
 483:        * 
 484:        * @return the accessible value if it exists
 485:        */
 486:       public AccessibleValue getAccessibleValue()
 487:       {
 488:         return super.getAccessibleValue();
 489:       }
 490:       
 491:       /**
 492:        * Get the background color of this object.
 493:        * 
 494:        * @return the color of the background.
 495:        */
 496:       public Color getBackground()
 497:       {
 498:         return tree.getBackground();
 499:       }
 500:       
 501:       /**
 502:        * Gets the bounds of this object in the form of a Rectangle object.
 503:        * 
 504:        * @return the bounds of the current node.
 505:        */
 506:       public Rectangle getBounds()
 507:       {
 508:         return tree.getPathBounds(tp);
 509:       }
 510:       
 511:       /**
 512:        * Gets the Cursor of this object.
 513:        * 
 514:        * @return the cursor for the current node
 515:        */
 516:       public Cursor getCursor()
 517:       {
 518:         return cursor;
 519:       }
 520:       
 521:       /**
 522:        * Gets the Font of this object.
 523:        * 
 524:        * @return the font for the current node
 525:        */
 526:       public Font getFont()
 527:       {
 528:         return tree.getFont();
 529:       }
 530:       
 531:       /**
 532:        * Gets the FontMetrics of this object.
 533:        * 
 534:        * @param f - the current font.
 535:        * @return the font metrics for the given font.
 536:        */
 537:       public FontMetrics getFontMetrics(Font f)
 538:       {
 539:         return tree.getFontMetrics(f);
 540:       }
 541:       
 542:       /**
 543:        * Get the foreground color of this object.
 544:        * 
 545:        * @return the foreground for this object.
 546:        */
 547:       public Color getForeground()
 548:       {
 549:         return tree.getForeground();
 550:       }
 551:       
 552:       /**
 553:        * Gets the locale of the component.
 554:        * 
 555:        * @return the locale of the component.
 556:        */
 557:       public Locale getLocale()
 558:       {
 559:         return tree.getLocale();
 560:       }
 561:       
 562:       /**
 563:        * Gets the location of the object relative to the 
 564:        * parent in the form of a point specifying the object's 
 565:        * top-left corner in the screen's coordinate space. 
 566:        * 
 567:        * @return the location of the current node.
 568:        */
 569:       public Point getLocation()
 570:       {
 571:         return getLocationInJTree();
 572:       }
 573:       
 574:       /**
 575:        * Returns the location in the tree.
 576:        * 
 577:        * @return the location in the JTree.
 578:        */
 579:       protected Point getLocationInJTree()
 580:       {
 581:         Rectangle bounds = tree.getPathBounds(tp);
 582:         return new Point(bounds.x, bounds.y);
 583:       }
 584:       
 585:       /**
 586:        * Returns the location of the object on the screen.
 587:        * 
 588:        * @return the location of the object on the screen.
 589:        */
 590:       public Point getLocationOnScreen()
 591:       {
 592:         Point loc = getLocation();
 593:         SwingUtilities.convertPointToScreen(loc, tree);
 594:         return loc;
 595:       }
 596:       
 597:       /**
 598:        * Returns the size of this object in the form of a Dimension object.
 599:        * 
 600:        * @return the size of the object
 601:        */
 602:       public Dimension getSize()
 603:       {
 604:         Rectangle b = getBounds();
 605:         return b.getSize();
 606:       }
 607:       
 608:       /**
 609:        * Returns true if the current child of this object is selected.
 610:        * 
 611:        * @param i - the child of the current node
 612:        * @return true if the child is selected.
 613:        */
 614:       public boolean isAccessibleChildSelected(int i)
 615:       {
 616:         Object child = mod.getChild(tp.getLastPathComponent(), i);
 617:         if (child != null)
 618:           return tree.isPathSelected(tp.pathByAddingChild(child));
 619:         return false;
 620:       }
 621:       
 622:       /**
 623:        * Determines if the object is enabled.
 624:        * 
 625:        * @return true if the tree is enabled
 626:        */
 627:       public boolean isEnabled()
 628:       {
 629:         return tree.isEnabled();
 630:       }
 631:       
 632:       /**
 633:        * Returns whether this object can accept focus or not.
 634:        * 
 635:        * @return true, it is always focus traversable
 636:        */
 637:       public boolean isFocusTraversable()
 638:       {
 639:         return true;
 640:       }
 641:       
 642:       /**
 643:        * Determines if the object is showing.
 644:        * 
 645:        * @return true if the object is visible and the
 646:        * parent is visible.
 647:        */
 648:       public boolean isShowing()
 649:       {
 650:         return isVisible() && tree.isShowing();
 651:       }
 652:       
 653:       /**
 654:        * Determines if the object is visible.
 655:        * 
 656:        * @return true if the object is visible.
 657:        */
 658:       public boolean isVisible()
 659:       {
 660:         return tree.isVisible(tp);
 661:       }
 662:       
 663:       /**
 664:        * Removes the specified selected item in the object from the
 665:        * object's selection.
 666:        * 
 667:        * @param i - the specified item to remove
 668:        */
 669:       public void removeAccessibleSelection(int i)
 670:       {
 671:         if (mod != null)
 672:           {
 673:             Object child = mod.getChild(tp.getLastPathComponent(), i);
 674:             if (child != null)
 675:               {
 676:                 if (!states.contains(AccessibleState.MULTISELECTABLE))
 677:                   clearAccessibleSelection();
 678:                 if (selectionList.contains(child))
 679:                   {
 680:                     selectionList.remove(child);                  
 681:                     tree.removeSelectionPath(tp.pathByAddingChild(child));
 682:                   }
 683:               }
 684:           }
 685:       }
 686:       
 687:       /**
 688:        * Removes the specified focus listener so it no longer receives focus 
 689:        * events from this component.
 690:        * 
 691:        * @param l - the focus listener to remove
 692:        */
 693:       public void removeFocusListener(FocusListener l)
 694:       {
 695:         tree.removeFocusListener(l);
 696:       }
 697:       
 698:       /**
 699:        * Remove a PropertyChangeListener from the listener list.
 700:        * 
 701:        * @param l - the property change listener to remove.
 702:        */
 703:       public void removePropertyChangeListener(PropertyChangeListener l)
 704:       {
 705:         // Nothing to do here.
 706:       }
 707:       
 708:       /**
 709:        * Requests focus for this object.
 710:        */
 711:       public void requestFocus()
 712:       {
 713:         tree.requestFocus();
 714:       }
 715:       
 716:       /**
 717:        * Causes every selected item in the object to be selected if the object 
 718:        * supports multiple selections.
 719:        */
 720:       public void selectAllAccessibleSelection()
 721:       {
 722:         Object parent = tp.getLastPathComponent();
 723:         if (mod != null)
 724:           {
 725:             for (int i = 0; i < mod.getChildCount(parent); i++)
 726:               {
 727:                 Object child = mod.getChild(parent, i);
 728:                 if (child != null)
 729:                   {
 730:                     if (!states.contains(AccessibleState.MULTISELECTABLE))
 731:                       clearAccessibleSelection();
 732:                     if (selectionList.contains(child))
 733:                       {
 734:                         selectionList.add(child);
 735:                         tree.addSelectionPath(tp.pathByAddingChild(child));
 736:                       }
 737:                   }
 738:               }
 739:           }
 740:       }
 741:       
 742:       /**
 743:        * Set the accessible description of this object.
 744:        * 
 745:        * @param s - the string to set the accessible description to.
 746:        */
 747:       public void setAccessibleDescription(String s)
 748:       {
 749:         super.setAccessibleDescription(s);
 750:       }
 751:       
 752:       /**
 753:        * Set the localized accessible name of this object.
 754:        * 
 755:        * @param s - the string to set the accessible name to.
 756:        */
 757:       public void setAccessibleName(String s)
 758:       {
 759:         super.setAccessibleName(s);
 760:       }
 761:       
 762:       /**
 763:        * Set the background color of this object.
 764:        * 
 765:        * @param c - the color to set the background to.
 766:        */
 767:       public void setBackground(Color c)
 768:       {
 769:         // Nothing to do here.
 770:       }
 771:       
 772:       /**
 773:        * Sets the bounds of this object in the form of a Rectangle object.
 774:        * 
 775:        * @param r - the bounds to set the object o
 776:        */
 777:       public void setBounds(Rectangle r)
 778:       {
 779:         // Nothing to do here.
 780:       }
 781:       
 782:       /**
 783:        * Sets the Cursor of this object.
 784:        * 
 785:        * @param c - the new cursor
 786:        */
 787:       public void setCursor(Cursor c)
 788:       {
 789:         cursor = c;
 790:       }
 791:       
 792:       /**
 793:        * Sets the enabled state of the object.
 794:        * 
 795:        * @param b - boolean to enable or disable object
 796:        */
 797:       public void setEnabled(boolean b)
 798:       {
 799:          // Nothing to do here.
 800:       }
 801:       
 802:       /**
 803:        * Sets the Font of this object.
 804:        * 
 805:        * @param f - the new font.
 806:        */
 807:       public void setFont(Font f)
 808:       {
 809:          // Nothing to do here.
 810:       }
 811:       
 812:       /**
 813:        * Sets the foreground color of this object.
 814:        * 
 815:        * @param c - the new foreground color.
 816:        */
 817:       public void setForeground(Color c)
 818:       {
 819:         // Nothing to do here.
 820:       }
 821:       
 822:       /**
 823:        * Sets the location of the object relative to the parent.
 824:        * 
 825:        * @param p - the new location for the object.
 826:        */
 827:       public void setLocation(Point p)
 828:       {
 829:         // Nothing to do here.
 830:       }
 831:       
 832:       /**
 833:        * Resizes this object so that it has width and height.
 834:        * 
 835:        * @param d - the new size for the object.
 836:        */
 837:       public void setSize(Dimension d)
 838:       {
 839:         // Nothing to do here.
 840:       }
 841:       
 842:       /**
 843:        * Sets the visible state of the object.
 844:        * 
 845:        * @param b - sets the objects visibility.
 846:        */
 847:       public void setVisible(boolean b)
 848:       {
 849:         // Nothing to do here.
 850:       }
 851:     }
 852:     
 853:     /**
 854:      * Constructor
 855:      */
 856:     public AccessibleJTree()
 857:     {
 858:       // Nothing to do here.
 859:     }
 860:     
 861:     /**
 862:      * Adds the specified selected item in the object to the object's selection.
 863:      * 
 864:      * @param i - the row to add to the tree's selection
 865:      */
 866:     public void addAccessibleSelection(int i)
 867:     {
 868:       addSelectionInterval(i, i);
 869:     }
 870:     
 871:     /**
 872:      * Clears the selection in the object, so that nothing in the object is selected.
 873:      */
 874:     public void clearAccessibleSelection()
 875:     {
 876:       clearSelection();
 877:     }
 878:     
 879:     /**
 880:      * Fire a visible data property change notification.
 881:      */
 882:     public void fireVisibleDataPropertyChange()
 883:     {
 884:       treeDidChange();
 885:     }
 886:     
 887:     /**
 888:      * Returns the Accessible child, if one exists, contained at the local 
 889:      * coordinate Point.
 890:      * 
 891:      * @param p - the point of the accessible to get.
 892:      * @return the accessible at point p.
 893:      */
 894:     public Accessible getAccessibleAt(Point p)
 895:     {
 896:       TreePath tp = getClosestPathForLocation(p.x, p.y);
 897:       if (tp != null)
 898:         return new AccessibleJTreeNode(JTree.this, tp, null);
 899:       return null;
 900:     }
 901:     
 902:     /**
 903:      * Return the nth Accessible child of the object.
 904:      * 
 905:      * @param i - the accessible child to get
 906:      * @return the i-th child
 907:      */
 908:     public Accessible getAccessibleChild(int i)
 909:     {
 910:       return null;
 911:     }
 912:     
 913:     /**
 914:      * Returns the number of top-level children nodes of this JTree.
 915:      * 
 916:      * @return the number of top-level children
 917:      */
 918:     public int getAccessibleChildrenCount()
 919:     {
 920:       TreeModel model = getModel();
 921:       if (model != null)
 922:         return model.getChildCount(model.getRoot());
 923:       return 0;
 924:     }
 925:     
 926:     /**
 927:      * Get the index of this object in its accessible parent.
 928:      * 
 929:      * @return the index of this object.
 930:      */
 931:     public int getAccessibleIndexInParent()
 932:     {
 933:       return 0;
 934:     }
 935:     
 936:     /**
 937:      * Get the role of this object.
 938:      * 
 939:      * @return the role of this object
 940:      */
 941:     public AccessibleRole getAccessibleRole()
 942:     {
 943:       return AccessibleRole.TREE;
 944:     }
 945:     
 946:     /**
 947:      * Get the AccessibleSelection associated with this object.
 948:      * 
 949:      * @return the accessible selection of the tree
 950:      */
 951:     public AccessibleSelection getAccessibleSelection()
 952:     {
 953:       TreeModel mod = getModel();
 954:       if (mod != null)
 955:         return (new AccessibleJTreeNode(JTree.this, 
 956:                   new TreePath(mod.getRoot()), null)).getAccessibleSelection();
 957:       return null;
 958:     }
 959:     
 960:     /**
 961:      * Returns an Accessible representing the specified selected item in the object.
 962:      * 
 963:      * @return the i-th accessible in the selection
 964:      */
 965:     public Accessible getAccessibleSelection(int i)
 966:     {
 967:       TreeModel mod = getModel();
 968:       if (mod != null)
 969:         return (new AccessibleJTreeNode(JTree.this, 
 970:                   new TreePath(mod.getRoot()), null)).getAccessibleSelection(i);
 971:       return null;
 972:     }
 973:     
 974:     /**
 975:      * Returns the number of items currently selected.
 976:      * 
 977:      * @return the number of selected accessibles.
 978:      */
 979:     public int getAccessibleSelectionCount()
 980:     {
 981:       return getSelectionCount();
 982:     }
 983:     
 984:     /**
 985:      * Returns true if the current child of this object is selected.
 986:      * 
 987:      * @param i - the child of this object
 988:      * @return true if the i-th child is selected.
 989:      */
 990:     public boolean isAccessibleChildSelected(int i)
 991:     {
 992:       // Nothing to do here.
 993:       return false;
 994:     }
 995:     
 996:     /**
 997:      * Removes the specified selected item in the object from the object's
 998:      * selection.
 999:      * 
1000:      * @param i - the i-th selected item to remove
1001:      */
1002:     public void removeAccessibleSelection(int i)
1003:     {
1004:       removeSelectionInterval(i, i);
1005:     }
1006:     
1007:     /**
1008:      * Causes every selected item in the object to be selected if the object
1009:      * supports multiple selections.
1010:      */
1011:     public void selectAllAccessibleSelection()
1012:     {
1013:       if (getSelectionModel().getSelectionMode() != 
1014:         TreeSelectionModel.SINGLE_TREE_SELECTION)
1015:       addSelectionInterval(0, getVisibleRowCount());
1016:     }
1017:     
1018:     /**
1019:      * Tree Collapsed notification
1020:      * 
1021:      * @param e - the event
1022:      */
1023:     public void treeCollapsed(TreeExpansionEvent e)
1024:     {
1025:       fireTreeCollapsed(e.getPath());
1026:     }
1027:    
1028:     /**
1029:      * Tree Model Expansion notification.
1030:      * 
1031:      * @param e - the event
1032:      */
1033:     public void treeExpanded(TreeExpansionEvent e)
1034:     {
1035:       fireTreeExpanded(e.getPath());
1036:     }
1037:     
1038:     /**
1039:      * Tree Model Node change notification.
1040:      * 
1041:      * @param e - the event
1042:      */
1043:     public void treeNodesChanged(TreeModelEvent e)
1044:     {
1045:       // Nothing to do here.
1046:     }
1047:     
1048:     /**
1049:      * Tree Model Node change notification.
1050:      * 
1051:      * @param e - the event
1052:      */
1053:     public void treeNodesInserted(TreeModelEvent e)
1054:     {
1055:       // Nothing to do here.
1056:     }
1057:     
1058:     /**
1059:      * Tree Model Node change notification.
1060:      * 
1061:      * @param e - the event
1062:      */
1063:     public void treeNodesRemoved(TreeModelEvent e)
1064:     {
1065:       // Nothing to do here.
1066:     }
1067:     
1068:     /**
1069:      * Tree Model structure change change notification.
1070:      * 
1071:      * @param e - the event
1072:      */
1073:     public void treeStructureChanged(TreeModelEvent e)
1074:     {
1075:       // Nothing to do here.
1076:     }
1077:     
1078:     /**
1079:      * Tree Selection Listener value change method.
1080:      * 
1081:      * @param e - the event
1082:      */
1083:     public void valueChanged(TreeSelectionEvent e)
1084:     {
1085:       fireValueChanged(e);
1086:     }
1087:   }
1088:   
1089:   public static class DynamicUtilTreeNode extends DefaultMutableTreeNode
1090:   {
1091:     protected Object childValue;
1092: 
1093:     protected boolean loadedChildren;
1094: 
1095:     /**
1096:      * Currently not set or used by this class. It might be set and used in
1097:      * later versions of this class.
1098:      */
1099:     protected boolean hasChildren;
1100: 
1101:     public DynamicUtilTreeNode(Object value, Object children)
1102:     {
1103:       super(value);
1104:       childValue = children;
1105:       loadedChildren = false;
1106:     }
1107: 
1108:     public int getChildCount()
1109:     {
1110:       loadChildren();
1111:       return super.getChildCount();
1112:     }
1113: 
1114:     protected void loadChildren()
1115:     {
1116:       if (!loadedChildren)
1117:         {
1118:           createChildren(this, childValue);
1119:           loadedChildren = true;
1120:         }
1121:     }
1122: 
1123:     public Enumeration children()
1124:     {
1125:       loadChildren();
1126:       return super.children();
1127:     }
1128: 
1129:     /**
1130:      * Returns the child node at position <code>pos</code>. Subclassed
1131:      * here to load the children if necessary.
1132:      * 
1133:      * @param pos the position of the child node to fetch
1134:      * 
1135:      * @return the childnode at the specified position
1136:      */
1137:     public TreeNode getChildAt(int pos)
1138:     {
1139:       loadChildren();
1140:       return super.getChildAt(pos);
1141:     }
1142: 
1143:     public boolean isLeaf()
1144:     {
1145:       return (childValue == null || !(childValue instanceof Hashtable
1146:           || childValue instanceof Vector || childValue.getClass()
1147:           .isArray()));
1148:     }
1149: 
1150:     public static void createChildren(DefaultMutableTreeNode parent,
1151:                                       Object children)
1152:     {
1153:       if (children instanceof Hashtable)
1154:         {
1155:           Hashtable tab = (Hashtable) children;
1156:           Enumeration e = tab.keys();
1157:           while (e.hasMoreElements())
1158:             {
1159:               Object key = e.nextElement();
1160:               Object val = tab.get(key);
1161:               parent.add(new DynamicUtilTreeNode(key, val));
1162:             }
1163:         }
1164:       else if (children instanceof Vector)
1165:         {
1166:           Iterator i = ((Vector) children).iterator();
1167:           while (i.hasNext())
1168:             {
1169:               Object n = i.next();
1170:               parent.add(new DynamicUtilTreeNode(n, n));
1171:             }
1172:         }
1173:       else if (children != null && children.getClass().isArray())
1174:         {
1175:           Object[] arr = (Object[]) children;
1176:           for (int i = 0; i < arr.length; ++i)
1177:             parent.add(new DynamicUtilTreeNode(arr[i], arr[i]));
1178:         }
1179:     }
1180:   }
1181: 
1182:   /**
1183:    * Listens to the model of the JTree and updates the property 
1184:    * <code>expandedState</code> if nodes are removed or changed.
1185:    */
1186:   protected class TreeModelHandler implements TreeModelListener
1187:   {
1188: 
1189:     /**
1190:      * Creates a new instance of TreeModelHandler.
1191:      */
1192:     protected TreeModelHandler()
1193:     {
1194:       // Nothing to do here.
1195:     }
1196: 
1197:     /**
1198:      * Notifies when a node has changed in some ways. This does not include
1199:      * that a node has changed its location or changed it's children. It
1200:      * only means that some attributes of the node have changed that might
1201:      * affect its presentation.
1202:      * 
1203:      * This method is called after the actual change occured.
1204:      * 
1205:      * @param ev the TreeModelEvent describing the change
1206:      */
1207:     public void treeNodesChanged(TreeModelEvent ev)
1208:     {
1209:       // Nothing to do here.
1210:     }
1211: 
1212:     /**
1213:      * Notifies when a node is inserted into the tree.
1214:      * 
1215:      * This method is called after the actual change occured.
1216:      * 
1217:      * @param ev the TreeModelEvent describing the change
1218:      */
1219:     public void treeNodesInserted(TreeModelEvent ev)
1220:     {
1221:       // nothing to do here
1222:     }
1223: 
1224:     /**
1225:      * Notifies when a node is removed from the tree.
1226:      * 
1227:      * This method is called after the actual change occured.
1228:      *
1229:      * @param ev the TreeModelEvent describing the change
1230:      */
1231:     public void treeNodesRemoved(TreeModelEvent ev)
1232:     {
1233:       // TODO: The API docs suggest that this method should do something
1234:       // but I cannot really see what has to be done here ...
1235:     }
1236: 
1237:     /**
1238:      * Notifies when the structure of the tree is changed.
1239:      * 
1240:      * This method is called after the actual change occured.
1241:      * 
1242:      * @param ev the TreeModelEvent describing the change
1243:      */
1244:     public void treeStructureChanged(TreeModelEvent ev)
1245:     {
1246:       // Set state of new path.
1247:       TreePath path = ev.getTreePath();
1248:       setExpandedState(path, isExpanded(path));
1249:     }
1250:   }
1251: 
1252:   /**
1253:    * This redirects TreeSelectionEvents and rewrites the source of it to be
1254:    * this JTree. This is typically done when the tree model generates an
1255:    * event, but the JTree object associated with that model should be listed
1256:    * as the actual source of the event.
1257:    */
1258:   protected class TreeSelectionRedirector implements TreeSelectionListener,
1259:                                                      Serializable
1260:   {
1261:     /** The serial version UID. */
1262:     private static final long serialVersionUID = -3505069663646241664L;
1263: 
1264:     /**
1265:      * Creates a new instance of TreeSelectionRedirector
1266:      */
1267:     protected TreeSelectionRedirector()
1268:     {
1269:       // Nothing to do here.
1270:     }
1271: 
1272:     /**
1273:      * Notifies when the tree selection changes.
1274:      * 
1275:      * @param ev the TreeSelectionEvent that describes the change
1276:      */
1277:     public void valueChanged(TreeSelectionEvent ev)
1278:     {
1279:       TreeSelectionEvent rewritten =
1280:         (TreeSelectionEvent) ev.cloneWithSource(JTree.this);
1281:       fireValueChanged(rewritten);
1282:       JTree.this.repaint();
1283:     }
1284:   }
1285: 
1286:   /**
1287:    * A TreeModel that does not allow anything to be selected.
1288:    */
1289:   protected static class EmptySelectionModel extends DefaultTreeSelectionModel
1290:   {
1291:     /** The serial version UID. */
1292:     private static final long serialVersionUID = -5815023306225701477L;
1293: 
1294:     /**
1295:      * The shared instance of this model.
1296:      */
1297:     protected static final EmptySelectionModel sharedInstance =
1298:       new EmptySelectionModel();
1299: 
1300:     /**
1301:      * Creates a new instance of EmptySelectionModel.
1302:      */
1303:     protected EmptySelectionModel()
1304:     {
1305:       // Nothing to do here.
1306:     }
1307: 
1308:     /**
1309:      * Returns the shared instance of EmptySelectionModel.
1310:      * 
1311:      * @return the shared instance of EmptySelectionModel
1312:      */
1313:     public static EmptySelectionModel sharedInstance()
1314:     {
1315:       return sharedInstance;
1316:     }
1317: 
1318:     /**
1319:      * This catches attempts to set a selection and sets nothing instead.
1320:      * 
1321:      * @param paths not used here
1322:      */
1323:     public void setSelectionPaths(TreePath[] paths)
1324:     {
1325:       // We don't allow selections in this class.
1326:     }
1327: 
1328:     /**
1329:      * This catches attempts to add something to the selection.
1330:      * 
1331:      * @param paths not used here
1332:      */
1333:     public void addSelectionPaths(TreePath[] paths)
1334:     {
1335:       // We don't allow selections in this class.
1336:     }
1337: 
1338:     /**
1339:      * This catches attempts to remove something from the selection.
1340:      * 
1341:      * @param paths not used here
1342:      */
1343:     public void removeSelectionPaths(TreePath[] paths)
1344:     {
1345:       // We don't allow selections in this class.
1346:     }
1347:   }
1348: 
1349:   private static final long serialVersionUID = 7559816092864483649L;
1350: 
1351:   public static final String CELL_EDITOR_PROPERTY = "cellEditor";
1352: 
1353:   public static final String CELL_RENDERER_PROPERTY = "cellRenderer";
1354: 
1355:   public static final String EDITABLE_PROPERTY = "editable";
1356: 
1357:   public static final String INVOKES_STOP_CELL_EDITING_PROPERTY =
1358:     "invokesStopCellEditing";
1359: 
1360:   public static final String LARGE_MODEL_PROPERTY = "largeModel";
1361: 
1362:   public static final String ROOT_VISIBLE_PROPERTY = "rootVisible";
1363: 
1364:   public static final String ROW_HEIGHT_PROPERTY = "rowHeight";
1365: 
1366:   public static final String SCROLLS_ON_EXPAND_PROPERTY = "scrollsOnExpand";
1367: 
1368:   public static final String SELECTION_MODEL_PROPERTY = "selectionModel";
1369: 
1370:   public static final String SHOWS_ROOT_HANDLES_PROPERTY = "showsRootHandles";
1371: 
1372:   public static final String TOGGLE_CLICK_COUNT_PROPERTY = "toggleClickCount";
1373: 
1374:   public static final String TREE_MODEL_PROPERTY = "model";
1375: 
1376:   public static final String VISIBLE_ROW_COUNT_PROPERTY = "visibleRowCount";
1377: 
1378:   /** @since 1.3 */
1379:   public static final String ANCHOR_SELECTION_PATH_PROPERTY =
1380:     "anchorSelectionPath";
1381: 
1382:     /** @since 1.3 */
1383:   public static final String LEAD_SELECTION_PATH_PROPERTY = "leadSelectionPath";
1384: 
1385:   /** @since 1.3 */
1386:   public static final String EXPANDS_SELECTED_PATHS_PROPERTY =
1387:     "expandsSelectedPaths";
1388: 
1389:   private static final Object EXPANDED = new Object();
1390: 
1391:   private static final Object COLLAPSED = new Object();
1392: 
1393:   private boolean dragEnabled;
1394: 
1395:   private boolean expandsSelectedPaths;
1396: 
1397:   private TreePath anchorSelectionPath;
1398: 
1399:   private TreePath leadSelectionPath;
1400: 
1401:   /**
1402:    * This contains the state of all nodes in the tree. Al/ entries map the
1403:    * TreePath of a note to to its state. Valid states are EXPANDED and
1404:    * COLLAPSED. Nodes not in this Hashtable are assumed state COLLAPSED.
1405:    */
1406:   private Hashtable nodeStates = new Hashtable();
1407: 
1408:   protected transient TreeCellEditor cellEditor;
1409: 
1410:   protected transient TreeCellRenderer cellRenderer;
1411: 
1412:   protected boolean editable;
1413: 
1414:   protected boolean invokesStopCellEditing;
1415: 
1416:   protected boolean largeModel;
1417: 
1418:   protected boolean rootVisible;
1419: 
1420:   protected int rowHeight;
1421: 
1422:   protected boolean scrollsOnExpand;
1423: 
1424:   protected transient TreeSelectionModel selectionModel;
1425: 
1426:   protected boolean showsRootHandles;
1427: 
1428:   protected int toggleClickCount;
1429: 
1430:   protected transient TreeModel treeModel;
1431: 
1432:   protected int visibleRowCount;
1433: 
1434:   /**
1435:    * Handles TreeModelEvents to update the expandedState.
1436:    */
1437:   protected transient TreeModelListener treeModelListener;
1438: 
1439:   /**
1440:    * Redirects TreeSelectionEvents so that the source is this JTree.
1441:    */
1442:   protected TreeSelectionRedirector selectionRedirector =
1443:     new TreeSelectionRedirector();
1444: 
1445:   /**
1446:    * Creates a new <code>JTree</code> object.
1447:    */
1448:   public JTree()
1449:   {
1450:     this(createTreeModel(null));
1451:   }
1452: 
1453:   /**
1454:    * Creates a new <code>JTree</code> object.
1455:    * 
1456:    * @param value the initial nodes in the tree
1457:    */
1458:   public JTree(Hashtable value)
1459:   {
1460:     this(createTreeModel(value));
1461:   }
1462: 
1463:   /**
1464:    * Creates a new <code>JTree</code> object.
1465:    * 
1466:    * @param value the initial nodes in the tree
1467:    */
1468:   public JTree(Object[] value)
1469:   {
1470:     this(createTreeModel(value));
1471:   }
1472: 
1473:   /**
1474:    * Creates a new <code>JTree</code> object.
1475:    * 
1476:    * @param model the model to use
1477:    */
1478:   public JTree(TreeModel model)
1479:   {
1480:     updateUI();
1481:     setRootVisible(true);
1482:     setModel(model);
1483:     setSelectionModel(EmptySelectionModel.sharedInstance());
1484:   }
1485: 
1486:   /**
1487:    * Creates a new <code>JTree</code> object.
1488:    * 
1489:    * @param root the root node
1490:    */
1491:   public JTree(TreeNode root)
1492:   {
1493:     this(root, false);
1494:   }
1495: 
1496:   /**
1497:    * Creates a new <code>JTree</code> object.
1498:    * 
1499:    * @param root the root node
1500:    * @param asksAllowChildren if false, all nodes without children are leaf
1501:    *        nodes. If true, only nodes that do not allow children are leaf
1502:    *        nodes.
1503:    */
1504:   public JTree(TreeNode root, boolean asksAllowChildren)
1505:   {
1506:     this(new DefaultTreeModel(root, asksAllowChildren));
1507:   }
1508: 
1509:   /**
1510:    * Creates a new <code>JTree</code> object.
1511:    * 
1512:    * @param value the initial nodes in the tree
1513:    */
1514:   public JTree(Vector value)
1515:   {
1516:     this(createTreeModel(value));
1517:   }
1518: 
1519:   public int getRowForPath(TreePath path)
1520:   {
1521:     TreeUI ui = getUI();
1522: 
1523:     if (ui != null)
1524:       return ui.getRowForPath(this, path);
1525: 
1526:     return -1;
1527:   }
1528: 
1529:   public TreePath getPathForRow(int row)
1530:   {
1531:     TreeUI ui = getUI();
1532:     return ui != null ? ui.getPathForRow(this, row) : null;
1533:   }
1534: 
1535:   protected TreePath[] getPathBetweenRows(int index0, int index1)
1536:   {
1537:     TreeUI ui = getUI();
1538: 
1539:     if (ui == null)
1540:       return null;
1541: 
1542:     int minIndex = Math.min(index0, index1);
1543:     int maxIndex = Math.max(index0, index1);
1544:     TreePath[] paths = new TreePath[maxIndex - minIndex + 1];
1545: 
1546:     for (int i = minIndex; i <= maxIndex; ++i)
1547:       paths[i - minIndex] = ui.getPathForRow(this, i);
1548: 
1549:     return paths;
1550:   }
1551: 
1552:   /**
1553:    * Creates a new <code>TreeModel</code> object.
1554:    * 
1555:    * @param value the values stored in the model
1556:    */
1557:   protected static TreeModel createTreeModel(Object value)
1558:   {
1559:     return new DefaultTreeModel(new DynamicUtilTreeNode(value, value));
1560:   }
1561: 
1562:   /**
1563:    * Return the UI associated with this <code>JTree</code> object.
1564:    * 
1565:    * @return the associated <code>TreeUI</code> object
1566:    */
1567:   public TreeUI getUI()
1568:   {
1569:     return (TreeUI) ui;
1570:   }
1571: 
1572:   /**
1573:    * Sets the UI associated with this <code>JTree</code> object.
1574:    * 
1575:    * @param ui the <code>TreeUI</code> to associate
1576:    */
1577:   public void setUI(TreeUI ui)
1578:   {
1579:     super.setUI(ui);
1580:   }
1581: 
1582:   /**
1583:    * This method resets the UI used to the Look and Feel defaults..
1584:    */
1585:   public void updateUI()
1586:   {
1587:     setUI((TreeUI) UIManager.getUI(this));
1588:   }
1589: 
1590:   /**
1591:    * This method returns the String ID of the UI class of Separator.
1592:    * 
1593:    * @return The UI class' String ID.
1594:    */
1595:   public String getUIClassID()
1596:   {
1597:     return "TreeUI";
1598:   }
1599: 
1600:   /**
1601:    * Gets the AccessibleContext associated with this
1602:    * <code>JTree</code>.
1603:    * 
1604:    * @return the associated context
1605:    */
1606:   public AccessibleContext getAccessibleContext()
1607:   {
1608:     return new AccessibleJTree();
1609:   }
1610: 
1611:   /**
1612:    * Returns the preferred viewport size.
1613:    * 
1614:    * @return the preferred size
1615:    */
1616:   public Dimension getPreferredScrollableViewportSize()
1617:   {
1618:     return new Dimension (getPreferredSize().width, getVisibleRowCount()*getRowHeight());
1619:   }
1620: 
1621:   public int getScrollableUnitIncrement(Rectangle visibleRect,
1622:                                         int orientation, int direction)
1623:   {
1624:     return 1;
1625:   }
1626: 
1627:   public int getScrollableBlockIncrement(Rectangle visibleRect,
1628:                                          int orientation, int direction)
1629:   {
1630:     return 1;
1631:   }
1632: 
1633:   public boolean getScrollableTracksViewportHeight()
1634:   {
1635:     if (getParent() instanceof JViewport)
1636:       return ((JViewport) getParent()).getHeight() > getPreferredSize().height;
1637:     return false;
1638:   }
1639: 
1640:   public boolean getScrollableTracksViewportWidth()
1641:   {
1642:     if (getParent() instanceof JViewport)
1643:       return ((JViewport) getParent()).getWidth() > getPreferredSize().width;
1644:     return false;
1645:   }
1646: 
1647:   /**
1648:    * Adds a <code>TreeExpansionListener</code> object to the tree.
1649:    * 
1650:    * @param listener the listener to add
1651:    */
1652:   public void addTreeExpansionListener(TreeExpansionListener listener)
1653:   {
1654:     listenerList.add(TreeExpansionListener.class, listener);
1655:   }
1656: 
1657:   /**
1658:    * Removes a <code>TreeExpansionListener</code> object from the tree.
1659:    * 
1660:    * @param listener the listener to remove
1661:    */
1662:   public void removeTreeExpansionListener(TreeExpansionListener listener)
1663:   {
1664:     listenerList.remove(TreeExpansionListener.class, listener);
1665:   }
1666: 
1667:   /**
1668:    * Returns all added <code>TreeExpansionListener</code> objects.
1669:    * 
1670:    * @return an array of listeners
1671:    */
1672:   public TreeExpansionListener[] getTreeExpansionListeners()
1673:   {
1674:     return (TreeExpansionListener[]) getListeners(TreeExpansionListener.class);
1675:   }
1676: 
1677:   /**
1678:    * Notifies all listeners that the tree was collapsed.
1679:    * 
1680:    * @param path the path to the node that was collapsed
1681:    */
1682:   public void fireTreeCollapsed(TreePath path)
1683:   {
1684:     TreeExpansionEvent event = new TreeExpansionEvent(this, path);
1685:     TreeExpansionListener[] listeners = getTreeExpansionListeners();
1686: 
1687:     for (int index = 0; index < listeners.length; ++index)
1688:       listeners[index].treeCollapsed(event);
1689:   }
1690: 
1691:   /**
1692:    * Notifies all listeners that the tree was expanded.
1693:    * 
1694:    * @param path the path to the node that was expanded
1695:    */
1696:   public void fireTreeExpanded(TreePath path)
1697:   {
1698:     TreeExpansionEvent event = new TreeExpansionEvent(this, path);
1699:     TreeExpansionListener[] listeners = getTreeExpansionListeners();
1700: 
1701:     for (int index = 0; index < listeners.length; ++index)
1702:       listeners[index].treeExpanded(event);
1703:   }
1704: 
1705:   /**
1706:    * Adds a <code>TreeSelctionListener</code> object to the tree.
1707:    * 
1708:    * @param listener the listener to add
1709:    */
1710:   public void addTreeSelectionListener(TreeSelectionListener listener)
1711:   {
1712:     listenerList.add(TreeSelectionListener.class, listener);
1713:   }
1714: 
1715:   /**
1716:    * Removes a <code>TreeSelectionListener</code> object from the tree.
1717:    * 
1718:    * @param listener the listener to remove
1719:    */
1720:   public void removeTreeSelectionListener(TreeSelectionListener listener)
1721:   {
1722:     listenerList.remove(TreeSelectionListener.class, listener);
1723:   }
1724: 
1725:   /**
1726:    * Returns all added <code>TreeSelectionListener</code> objects.
1727:    * 
1728:    * @return an array of listeners
1729:    */
1730:   public TreeSelectionListener[] getTreeSelectionListeners()
1731:   {
1732:     return (TreeSelectionListener[]) 
1733:     getListeners(TreeSelectionListener.class);
1734:   }
1735: 
1736:   /**
1737:    * Notifies all listeners when the selection of the tree changed.
1738:    * 
1739:    * @param event the event to send
1740:    */
1741:   protected void fireValueChanged(TreeSelectionEvent event)
1742:   {
1743:     TreeSelectionListener[] listeners = getTreeSelectionListeners();
1744: 
1745:     for (int index = 0; index < listeners.length; ++index)
1746:       listeners[index].valueChanged(event);
1747:   }
1748: 
1749:   /**
1750:    * Adds a <code>TreeWillExpandListener</code> object to the tree.
1751:    * 
1752:    * @param listener the listener to add
1753:    */
1754:   public void addTreeWillExpandListener(TreeWillExpandListener listener)
1755:   {
1756:     listenerList.add(TreeWillExpandListener.class, listener);
1757:   }
1758: 
1759:   /**
1760:    * Removes a <code>TreeWillExpandListener</code> object from the tree.
1761:    * 
1762:    * @param listener the listener to remove
1763:    */
1764:   public void removeTreeWillExpandListener(TreeWillExpandListener listener)
1765:   {
1766:     listenerList.remove(TreeWillExpandListener.class, listener);
1767:   }
1768: 
1769:   /**
1770:    * Returns all added <code>TreeWillExpandListener</code> objects.
1771:    * 
1772:    * @return an array of listeners
1773:    */
1774:   public TreeWillExpandListener[] getTreeWillExpandListeners()
1775:   {
1776:     return (TreeWillExpandListener[]) 
1777:     getListeners(TreeWillExpandListener.class);
1778:   }
1779: 
1780:   /**
1781:    * Notifies all listeners that the tree will collapse.
1782:    * 
1783:    * @param path the path to the node that will collapse
1784:    */
1785:   public void fireTreeWillCollapse(TreePath path) throws ExpandVetoException
1786:   {
1787:     TreeExpansionEvent event = new TreeExpansionEvent(this, path);
1788:     TreeWillExpandListener[] listeners = getTreeWillExpandListeners();
1789: 
1790:     for (int index = 0; index < listeners.length; ++index)
1791:       listeners[index].treeWillCollapse(event);
1792:   }
1793: 
1794:   /**
1795:    * Notifies all listeners that the tree will expand.
1796:    * 
1797:    * @param path the path to the node that will expand
1798:    */
1799:   public void fireTreeWillExpand(TreePath path) throws ExpandVetoException
1800:   {
1801:     TreeExpansionEvent event = new TreeExpansionEvent(this, path);
1802:     TreeWillExpandListener[] listeners = getTreeWillExpandListeners();
1803: 
1804:     for (int index = 0; index < listeners.length; ++index)
1805:       listeners[index].treeWillExpand(event);
1806:   }
1807: 
1808:   /**
1809:    * Returns the model of this <code>JTree</code> object.
1810:    * 
1811:    * @return the associated <code>TreeModel</code>
1812:    */
1813:   public TreeModel getModel()
1814:   {
1815:     return treeModel;
1816:   }
1817: 
1818:   /**
1819:    * Sets the model to use in <code>JTree</code>.
1820:    * 
1821:    * @param model the <code>TreeModel</code> to use
1822:    */
1823:   public void setModel(TreeModel model)
1824:   {
1825:     if (treeModel == model)
1826:       return;
1827: 
1828:     // add treeModelListener to the new model
1829:     if (treeModelListener == null)
1830:       treeModelListener = createTreeModelListener();
1831:     if (model != null) // as setModel(null) is allowed
1832:       model.addTreeModelListener(treeModelListener);
1833: 
1834:     TreeModel oldValue = treeModel;
1835:     treeModel = model;
1836: 
1837:     firePropertyChange(TREE_MODEL_PROPERTY, oldValue, model);
1838:     updateUI();
1839:   }
1840: 
1841:   /**
1842:    * Checks if this <code>JTree</code> object is editable.
1843:    * 
1844:    * @return <code>true</code> if this tree object is editable,
1845:    *         <code>false</code> otherwise
1846:    */
1847:   public boolean isEditable()
1848:   {
1849:     return editable;
1850:   }
1851: 
1852:   /**
1853:    * Sets the <code>editable</code> property.
1854:    * 
1855:    * @param flag <code>true</code> to make this tree object editable,
1856:    *        <code>false</code> otherwise
1857:    */
1858:   public void setEditable(boolean flag)
1859:   {
1860:     if (editable == flag)
1861:       return;
1862: 
1863:     boolean oldValue = editable;
1864:     editable = flag;
1865:     firePropertyChange(EDITABLE_PROPERTY, oldValue, editable);
1866:   }
1867: 
1868:   /**
1869:    * Checks if the root element is visible.
1870:    * 
1871:    * @return <code>true</code> if the root element is visible,
1872:    *         <code>false</code> otherwise
1873:    */
1874:   public boolean isRootVisible()
1875:   {
1876:     return rootVisible;
1877:   }
1878: 
1879:   public void setRootVisible(boolean flag)
1880:   {
1881:     if (rootVisible == flag)
1882:       return;
1883: 
1884:     boolean oldValue = rootVisible;
1885:     rootVisible = flag;
1886:     firePropertyChange(ROOT_VISIBLE_PROPERTY, oldValue, flag);
1887:   }
1888: 
1889:   public boolean getShowsRootHandles()
1890:   {
1891:     return showsRootHandles;
1892:   }
1893: 
1894:   public void setShowsRootHandles(boolean flag)
1895:   {
1896:     if (showsRootHandles == flag)
1897:       return;
1898:     
1899:     boolean oldValue = showsRootHandles;
1900:     showsRootHandles = flag;
1901:     firePropertyChange(SHOWS_ROOT_HANDLES_PROPERTY, oldValue, flag);
1902:   }
1903: 
1904:   public TreeCellEditor getCellEditor()
1905:   {
1906:     return cellEditor;
1907:   }
1908: 
1909:   public void setCellEditor(TreeCellEditor editor)
1910:   {
1911:     if (cellEditor == editor)
1912:       return;
1913: 
1914:     TreeCellEditor oldValue = cellEditor;
1915:     cellEditor = editor;
1916:     firePropertyChange(CELL_EDITOR_PROPERTY, oldValue, editor);
1917:   }
1918: 
1919:   public TreeCellRenderer getCellRenderer()
1920:   {
1921:     return cellRenderer;
1922:   }
1923: 
1924:   public void setCellRenderer(TreeCellRenderer newRenderer)
1925:   {
1926:     if (cellRenderer == newRenderer)
1927:       return;
1928: 
1929:     TreeCellRenderer oldValue = cellRenderer;
1930:     cellRenderer = newRenderer;
1931:     firePropertyChange(CELL_RENDERER_PROPERTY, oldValue, newRenderer);
1932:   }
1933: 
1934:   public TreeSelectionModel getSelectionModel()
1935:   {
1936:     return selectionModel;
1937:   }
1938: 
1939:   public void setSelectionModel(TreeSelectionModel model)
1940:   {
1941:     if (selectionModel == model)
1942:       return;
1943: 
1944:     if (selectionModel != null)
1945:       selectionModel.removeTreeSelectionListener(selectionRedirector);
1946: 
1947:     TreeSelectionModel oldValue = selectionModel;
1948:     selectionModel = model;
1949: 
1950:     if (selectionModel != null)
1951:       selectionModel.addTreeSelectionListener(selectionRedirector);
1952: 
1953:     firePropertyChange(SELECTION_MODEL_PROPERTY, oldValue, model);
1954:     revalidate();
1955:     repaint();
1956:   }
1957: 
1958:   public int getVisibleRowCount()
1959:   {
1960:     return visibleRowCount;
1961:   }
1962: 
1963:   public void setVisibleRowCount(int rows)
1964:   {
1965:     if (visibleRowCount == rows)
1966:       return;
1967: 
1968:     int oldValue = visibleRowCount;
1969:     visibleRowCount = rows;
1970:     firePropertyChange(VISIBLE_ROW_COUNT_PROPERTY, oldValue, rows);
1971:   }
1972: 
1973:   public boolean isLargeModel()
1974:   {
1975:     return largeModel;
1976:   }
1977: 
1978:   public void setLargeModel(boolean large)
1979:   {
1980:     if (largeModel == large)
1981:       return;
1982: 
1983:     boolean oldValue = largeModel;
1984:     largeModel = large;
1985:     firePropertyChange(LARGE_MODEL_PROPERTY, oldValue, large);
1986:   }
1987: 
1988:   public int getRowHeight()
1989:   {
1990:     return rowHeight;
1991:   }
1992: 
1993:   public void setRowHeight(int height)
1994:   {
1995:     if (rowHeight == height)
1996:       return;
1997: 
1998:     int oldValue = rowHeight;
1999:     rowHeight = height;
2000:     firePropertyChange(ROW_HEIGHT_PROPERTY, oldValue, height);
2001:   }
2002: 
2003:   public boolean isFixedRowHeight()
2004:   {
2005:     return rowHeight > 0;
2006:   }
2007: 
2008:   public boolean getInvokesStopCellEditing()
2009:   {
2010:     return invokesStopCellEditing;
2011:   }
2012: 
2013:   public void setInvokesStopCellEditing(boolean invoke)
2014:   {
2015:     if (invokesStopCellEditing == invoke)
2016:       return;
2017: 
2018:     boolean oldValue = invokesStopCellEditing;
2019:     invokesStopCellEditing = invoke;
2020:     firePropertyChange(INVOKES_STOP_CELL_EDITING_PROPERTY, 
2021:                        oldValue, invoke);
2022:   }
2023: 
2024:   /**
2025:    * @since 1.3
2026:    */
2027:   public int getToggleClickCount()
2028:   {
2029:     return toggleClickCount;
2030:   }
2031: 
2032:   /**
2033:    * @since 1.3
2034:    */
2035:   public void setToggleClickCount(int count)
2036:   {
2037:     if (toggleClickCount == count)
2038:       return;
2039: 
2040:     int oldValue = toggleClickCount;
2041:     toggleClickCount = count;
2042:     firePropertyChange(TOGGLE_CLICK_COUNT_PROPERTY, oldValue, count);
2043:   }
2044: 
2045:   public void scrollPathToVisible(TreePath path)
2046:   {
2047:     if (path == null)
2048:       return;
2049:     
2050:     Object[] oPath = path.getPath();
2051:     TreePath temp = new TreePath(oPath[0]);
2052:     boolean stop = false;
2053:     int i = 1;
2054:     while (!stop)
2055:       {
2056:         while (isVisible(temp))
2057:           if (i < oPath.length)
2058:             temp = temp.pathByAddingChild(oPath[i++]);
2059:           else
2060:             {
2061:               stop = true;
2062:               break;
2063:             }
2064:         makeVisible(temp);
2065:       }
2066:     Rectangle rect = getPathBounds(path);
2067:     scrollRectToVisible(rect);
2068:     setSelectionPath(temp);
2069:   }
2070: 
2071:   public void scrollRowToVisible(int row)
2072:   {
2073:     scrollPathToVisible(getPathForRow(row));
2074:   }
2075: 
2076:   public boolean getScrollsOnExpand()
2077:   {
2078:     return scrollsOnExpand;
2079:   }
2080: 
2081:   public void setScrollsOnExpand(boolean scroll)
2082:   {
2083:     if (scrollsOnExpand == scroll)
2084:       return;
2085: 
2086:     boolean oldValue = scrollsOnExpand;
2087:     scrollsOnExpand = scroll;
2088:     firePropertyChange(SCROLLS_ON_EXPAND_PROPERTY, oldValue, scroll);
2089:   }
2090: 
2091:   public void setSelectionPath(TreePath path)
2092:   {
2093:     selectionModel.setSelectionPath(path);
2094:   }
2095: 
2096:   public void setSelectionPaths(TreePath[] paths)
2097:   {
2098:     selectionModel.setSelectionPaths(paths);
2099:   }
2100: 
2101:   public void setSelectionRow(int row)
2102:   {
2103:     TreePath path = getPathForRow(row);
2104: 
2105:     if (path != null)
2106:       selectionModel.setSelectionPath(path);
2107:   }
2108: 
2109:   public void setSelectionRows(int[] rows)
2110:   {
2111:     // Make sure we have an UI so getPathForRow() does not return null.
2112:     if (rows == null || getUI() == null)
2113:       return;
2114: 
2115:     TreePath[] paths = new TreePath[rows.length];
2116: 
2117:     for (int i = rows.length - 1; i >= 0; --i)
2118:       paths[i] = getPathForRow(rows[i]);
2119: 
2120:     setSelectionPaths(paths);
2121:   }
2122: 
2123:   public void setSelectionInterval(int index0, int index1)
2124:   {
2125:     TreePath[] paths = getPathBetweenRows(index0, index1);
2126: 
2127:     if (paths != null)
2128:       setSelectionPaths(paths);
2129:   }
2130: 
2131:   public void addSelectionPath(TreePath path)
2132:   {
2133:     selectionModel.addSelectionPath(path);
2134:   }
2135: 
2136:   public void addSelectionPaths(TreePath[] paths)
2137:   {
2138:     selectionModel.addSelectionPaths(paths);
2139:   }
2140: 
2141:   public void addSelectionRow(int row)
2142:   {
2143:     TreePath path = getPathForRow(row);
2144: 
2145:     if (path != null)
2146:       selectionModel.addSelectionPath(path);
2147:   }
2148: 
2149:   public void addSelectionRows(int[] rows)
2150:   {
2151:     // Make sure we have an UI so getPathForRow() does not return null.
2152:     if (rows == null || getUI() == null)
2153:       return;
2154: 
2155:     TreePath[] paths = new TreePath[rows.length];
2156: 
2157:     for (int i = rows.length - 1; i >= 0; --i)
2158:       paths[i] = getPathForRow(rows[i]);
2159: 
2160:     addSelectionPaths(paths);
2161:   }
2162: 
2163:   public void addSelectionInterval(int index0, int index1)
2164:   {
2165:     TreePath[] paths = getPathBetweenRows(index0, index1);
2166: 
2167:     if (paths != null)
2168:       addSelectionPaths(paths);
2169:   }
2170: 
2171:   public void removeSelectionPath(TreePath path)
2172:   {
2173:     selectionModel.removeSelectionPath(path);
2174:   }
2175: 
2176:   public void removeSelectionPaths(TreePath[] paths)
2177:   {
2178:     selectionModel.removeSelectionPaths(paths);
2179:   }
2180: 
2181:   public void removeSelectionRow(int row)
2182:   {
2183:     TreePath path = getPathForRow(row);
2184: 
2185:     if (path != null)
2186:       selectionModel.removeSelectionPath(path);
2187:   }
2188: 
2189:   public void removeSelectionRows(int[] rows)
2190:   {
2191:     if (rows == null || getUI() == null)
2192:       return;
2193: 
2194:     TreePath[] paths = new TreePath[rows.length];
2195: 
2196:     for (int i = rows.length - 1; i >= 0; --i)
2197:       paths[i] = getPathForRow(rows[i]);
2198: 
2199:     removeSelectionPaths(paths);
2200:   }
2201: 
2202:   public void removeSelectionInterval(int index0, int index1)
2203:   {
2204:     TreePath[] paths = getPathBetweenRows(index0, index1);
2205: 
2206:     if (paths != null)
2207:       removeSelectionPaths(paths);
2208:   }
2209: 
2210:   public void clearSelection()
2211:   {
2212:     selectionModel.clearSelection();
2213:     setLeadSelectionPath(null);
2214:   }
2215: 
2216:   public TreePath getLeadSelectionPath()
2217:   {
2218:     return leadSelectionPath;
2219:   }
2220: 
2221:   /**
2222:    * @since 1.3
2223:    */
2224:   public void setLeadSelectionPath(TreePath path)
2225:   {
2226:     if (leadSelectionPath == path)
2227:       return;
2228:     
2229:     TreePath oldValue = leadSelectionPath;
2230:     leadSelectionPath = path;
2231:     firePropertyChange(LEAD_SELECTION_PATH_PROPERTY, oldValue, path);
2232:   }
2233: 
2234:   /**
2235:    * @since 1.3
2236:    */
2237:   public TreePath getAnchorSelectionPath()
2238:   {
2239:     return anchorSelectionPath;
2240:   }
2241: 
2242:   /**
2243:    * @since 1.3
2244:    */
2245:   public void setAnchorSelectionPath(TreePath path)
2246:   {
2247:     if (anchorSelectionPath == path)
2248:       return;
2249: 
2250:     TreePath oldValue = anchorSelectionPath;
2251:     anchorSelectionPath = path;
2252:     firePropertyChange(ANCHOR_SELECTION_PATH_PROPERTY, oldValue, path);
2253:   }
2254: 
2255:   public int getLeadSelectionRow()
2256:   {
2257:     return selectionModel.getLeadSelectionRow();
2258:   }
2259: 
2260:   public int getMaxSelectionRow()
2261:   {
2262:     return selectionModel.getMaxSelectionRow();
2263:   }
2264: 
2265:   public int getMinSelectionRow()
2266:   {
2267:     return selectionModel.getMinSelectionRow();
2268:   }
2269: 
2270:   public int getSelectionCount()
2271:   {
2272:     return selectionModel.getSelectionCount();
2273:   }
2274: 
2275:   public TreePath getSelectionPath()
2276:   {
2277:     return selectionModel.getSelectionPath();
2278:   }
2279: 
2280:   public TreePath[] getSelectionPaths()
2281:   {
2282:     return selectionModel.getSelectionPaths();
2283:   }
2284: 
2285:   public int[] getSelectionRows()
2286:   {
2287:     return selectionModel.getSelectionRows();
2288:   }
2289: 
2290:   public boolean isPathSelected(TreePath path)
2291:   {
2292:     return selectionModel.isPathSelected(path);
2293:   }
2294: 
2295:   public boolean isRowSelected(int row)
2296:   {
2297:     return selectionModel.isPathSelected(getPathForRow(row));
2298:   }
2299: 
2300:   public boolean isSelectionEmpty()
2301:   {
2302:     return selectionModel.isSelectionEmpty();
2303:   }
2304: 
2305:   /**
2306:    * Return the value of the <code>dragEnabled</code> property.
2307:    * 
2308:    * @return the value
2309:    * 
2310:    * @since 1.4
2311:    */
2312:   public boolean getDragEnabled()
2313:   {
2314:     return dragEnabled;
2315:   }
2316: 
2317:   /**
2318:    * Set the <code>dragEnabled</code> property.
2319:    * 
2320:    * @param enabled new value
2321:    * 
2322:    * @since 1.4
2323:    */
2324:   public void setDragEnabled(boolean enabled)
2325:   {
2326:     dragEnabled = enabled;
2327:   }
2328: 
2329:   public int getRowCount()
2330:   {
2331:     TreeUI ui = getUI();
2332: 
2333:     if (ui != null)
2334:       return ui.getRowCount(this);
2335: 
2336:     return 0;
2337:   }
2338: 
2339:   public void collapsePath(TreePath path)
2340:   {
2341:     try
2342:       {
2343:         fireTreeWillCollapse(path);
2344:       }
2345:     catch (ExpandVetoException ev)
2346:       {
2347:         // We do nothing if attempt has been vetoed.
2348:       }
2349:     setExpandedState(path, false);
2350:     fireTreeCollapsed(path);
2351:   }
2352: 
2353:   public void collapseRow(int row)
2354:   {
2355:     if (row < 0 || row >= getRowCount())
2356:       return;
2357: 
2358:     TreePath path = getPathForRow(row);
2359: 
2360:     if (path != null)
2361:       collapsePath(path);
2362:   }
2363: 
2364:   public void expandPath(TreePath path)
2365:   {
2366:     // Don't expand if last path component is a leaf node.
2367:     if ((path == null) || (treeModel.isLeaf(path.getLastPathComponent())))
2368:       return;
2369: 
2370:     try
2371:       {
2372:         fireTreeWillExpand(path);
2373:       }
2374:     catch (ExpandVetoException ev)
2375:       {
2376:         // We do nothing if attempt has been vetoed.
2377:       }
2378: 
2379:     setExpandedState(path, true);
2380:     fireTreeExpanded(path);
2381:   }
2382: 
2383:   public void expandRow(int row)
2384:   {
2385:     if (row < 0 || row >= getRowCount())
2386:       return;
2387: 
2388:     TreePath path = getPathForRow(row);
2389: 
2390:     if (path != null)
2391:       expandPath(path);
2392:   }
2393: 
2394:   public boolean isCollapsed(TreePath path)
2395:   {
2396:     return !isExpanded(path);
2397:   }
2398: 
2399:   public boolean isCollapsed(int row)
2400:   {
2401:     if (row < 0 || row >= getRowCount())
2402:       return false;
2403: 
2404:     TreePath path = getPathForRow(row);
2405: 
2406:     if (path != null)
2407:       return isCollapsed(path);
2408: 
2409:     return false;
2410:   }
2411: 
2412:   public boolean isExpanded(TreePath path)
2413:   {
2414:     if (path == null)
2415:       return false;
2416: 
2417:     Object state = nodeStates.get(path);
2418: 
2419:     if ((state == null) || (state != EXPANDED))
2420:       return false;
2421: 
2422:     TreePath parent = path.getParentPath();
2423: 
2424:     if (parent != null)
2425:       return isExpanded(parent);
2426: 
2427:     return true;
2428:   }
2429: 
2430:   public boolean isExpanded(int row)
2431:   {
2432:     if (row < 0 || row >= getRowCount())
2433:       return false;
2434: 
2435:     TreePath path = getPathForRow(row);
2436: 
2437:     if (path != null)
2438:       return isExpanded(path);
2439: 
2440:     return false;
2441:   }
2442: 
2443:   /**
2444:    * @since 1.3
2445:    */
2446:   public boolean getExpandsSelectedPaths()
2447:   {
2448:     return expandsSelectedPaths;
2449:   }
2450: 
2451:   /**
2452:    * @since 1.3
2453:    */
2454:   public void setExpandsSelectedPaths(boolean flag)
2455:   {
2456:     if (expandsSelectedPaths == flag)
2457:       return;
2458: 
2459:     boolean oldValue = expandsSelectedPaths;
2460:     expandsSelectedPaths = flag;
2461:     firePropertyChange(EXPANDS_SELECTED_PATHS_PROPERTY, oldValue, flag);
2462:   }
2463: 
2464:   public Rectangle getPathBounds(TreePath path)
2465:   {
2466:     TreeUI ui = getUI();
2467: 
2468:     if (ui == null)
2469:       return null;
2470: 
2471:     return ui.getPathBounds(this, path);
2472:   }
2473: 
2474:   public Rectangle getRowBounds(int row)
2475:   {
2476:     TreePath path = getPathForRow(row);
2477: 
2478:     if (path != null)
2479:       return getPathBounds(path);
2480: 
2481:     return null;
2482:   }
2483: 
2484:   public boolean isEditing()
2485:   {
2486:     TreeUI ui = getUI();
2487: 
2488:     if (ui != null)
2489:       return ui.isEditing(this);
2490: 
2491:     return false;
2492:   }
2493: 
2494:   public boolean stopEditing()
2495:   {
2496:     TreeUI ui = getUI();
2497: 
2498:     if (ui != null)
2499:       return ui.stopEditing(this);
2500: 
2501:     return false;
2502:   }
2503: 
2504:   public void cancelEditing()
2505:   {
2506:     TreeUI ui = getUI();
2507: 
2508:     if (ui != null)
2509:       ui.cancelEditing(this);
2510:   }
2511: 
2512:   public void startEditingAtPath(TreePath path)
2513:   {
2514:     TreeUI ui = getUI();
2515: 
2516:     if (ui != null)
2517:       ui.startEditingAtPath(this, path);
2518:   }
2519: 
2520:   public TreePath getEditingPath()
2521:   {
2522:     TreeUI ui = getUI();
2523: 
2524:     if (ui != null)
2525:       return ui.getEditingPath(this);
2526: 
2527:     return null;
2528:   }
2529: 
2530:   public TreePath getPathForLocation(int x, int y)
2531:   {
2532:     TreePath path = getClosestPathForLocation(x, y);
2533: 
2534:     if (path != null)
2535:       {
2536:         Rectangle rect = getPathBounds(path);
2537: 
2538:         if ((rect != null) && rect.contains(x, y))
2539:           return path;
2540:       }
2541: 
2542:     return null;
2543:   }
2544: 
2545:   public int getRowForLocation(int x, int y)
2546:   {
2547:     TreePath path = getPathForLocation(x, y);
2548: 
2549:     if (path != null)
2550:       return getRowForPath(path);
2551: 
2552:     return -1;
2553:   }
2554: 
2555:   public TreePath getClosestPathForLocation(int x, int y)
2556:   {
2557:     TreeUI ui = getUI();
2558: 
2559:     if (ui != null)
2560:       return ui.getClosestPathForLocation(this, x, y);
2561: 
2562:     return null;
2563:   }
2564: 
2565:   public int getClosestRowForLocation(int x, int y)
2566:   {
2567:     TreePath path = getClosestPathForLocation(x, y);
2568: 
2569:     if (path != null)
2570:       return getRowForPath(path);
2571: 
2572:     return -1;
2573:   }
2574: 
2575:   public Object getLastSelectedPathComponent()
2576:   {
2577:     TreePath path = getSelectionPath();
2578: 
2579:     if (path != null)
2580:       return path.getLastPathComponent();
2581: 
2582:     return null;
2583:   }
2584: 
2585:   private void doExpandParents(TreePath path, boolean state)
2586:   {
2587:     TreePath parent = path.getParentPath();        
2588: 
2589:     if (!isExpanded(parent) && parent != null)
2590:       doExpandParents(parent, false);
2591: 
2592:     nodeStates.put(path, state ? EXPANDED : COLLAPSED);
2593:   }
2594: 
2595:   protected void setExpandedState(TreePath path, boolean state)
2596:   {
2597:     if (path == null)
2598:       return;
2599:     TreePath parent = path.getParentPath();
2600: 
2601:     doExpandParents(path, state);
2602:   }
2603: 
2604:   protected void clearToggledPaths()
2605:   {
2606:     nodeStates.clear();
2607:   }
2608: 
2609:   protected Enumeration getDescendantToggledPaths(TreePath parent)
2610:   {
2611:     if (parent == null)
2612:       return null;
2613: 
2614:     Enumeration nodes = nodeStates.keys();
2615:     Vector result = new Vector();
2616: 
2617:     while (nodes.hasMoreElements())
2618:       {
2619:         TreePath path = (TreePath) nodes.nextElement();
2620: 
2621:         if (path.isDescendant(parent))
2622:           result.addElement(path);
2623:       }
2624: 
2625:     return result.elements();
2626:   }
2627: 
2628:   public boolean hasBeenExpanded(TreePath path)
2629:   {
2630:     if (path == null)
2631:       return false;
2632: 
2633:     return nodeStates.get(path) != null;
2634:   }
2635: 
2636:   public boolean isVisible(TreePath path)
2637:   {
2638:     if (path == null)
2639:       return false;
2640: 
2641:     TreePath parent = path.getParentPath();
2642: 
2643:     if (parent == null)
2644:       return true; // Is root node.
2645: 
2646:     return isExpanded(parent);
2647:   }
2648: 
2649:   public void makeVisible(TreePath path)
2650:   {
2651:     if (path == null)
2652:       return;
2653: 
2654:     expandPath(path.getParentPath());
2655:   }
2656: 
2657:   public boolean isPathEditable(TreePath path)
2658:   {
2659:     return isEditable();
2660:   }
2661: 
2662:   /**
2663:    * Creates and returns an instance of {@link TreeModelHandler}.
2664:    * 
2665:    * @return an instance of {@link TreeModelHandler}
2666:    */
2667:   protected TreeModelListener createTreeModelListener()
2668:   {
2669:     return new TreeModelHandler();
2670:   }
2671: 
2672:   /**
2673:    * Returns a sample TreeModel that can be used in a JTree. This can be used
2674:    * in Bean- or GUI-Builders to show something interesting.
2675:    * 
2676:    * @return a sample TreeModel that can be used in a JTree
2677:    */
2678:   protected static TreeModel getDefaultTreeModel()
2679:   {
2680:     DefaultMutableTreeNode root = new DefaultMutableTreeNode("Root node");
2681:     DefaultMutableTreeNode child1 = new DefaultMutableTreeNode("Child node 1");
2682:     DefaultMutableTreeNode child11 =
2683:       new DefaultMutableTreeNode("Child node 1.1");
2684:     DefaultMutableTreeNode child12 =
2685:       new DefaultMutableTreeNode("Child node 1.2");
2686:     DefaultMutableTreeNode child13 =
2687:       new DefaultMutableTreeNode("Child node 1.3");
2688:     DefaultMutableTreeNode child2 = new DefaultMutableTreeNode("Child node 2");
2689:     DefaultMutableTreeNode child21 =
2690:       new DefaultMutableTreeNode("Child node 2.1");
2691:     DefaultMutableTreeNode child22 =
2692:       new DefaultMutableTreeNode("Child node 2.2");
2693:     DefaultMutableTreeNode child23 =
2694:       new DefaultMutableTreeNode("Child node 2.3");
2695:     DefaultMutableTreeNode child24 =
2696:       new DefaultMutableTreeNode("Child node 2.4");
2697: 
2698:     DefaultMutableTreeNode child3 = new DefaultMutableTreeNode("Child node 3");
2699:     root.add(child1);
2700:     root.add(child2);
2701:     root.add(child3);
2702:     child1.add(child11);
2703:     child1.add(child12);
2704:     child1.add(child13);
2705:     child2.add(child21);
2706:     child2.add(child22);
2707:     child2.add(child23);
2708:     child2.add(child24);
2709:     return new DefaultTreeModel(root);
2710:   }
2711: 
2712:   /**
2713:    * Converts the specified value to a String. This is used by the renderers
2714:    * of this JTree and its nodes.
2715:    * 
2716:    * This implementation simply returns <code>value.toString()</code> and
2717:    * ignores all other parameters. Subclass this method to control the
2718:    * conversion.
2719:    * 
2720:    * @param value the value that is converted to a String
2721:    * @param selected indicates if that value is selected or not
2722:    * @param expanded indicates if that value is expanded or not
2723:    * @param leaf indicates if that value is a leaf node or not
2724:    * @param row the row of the node
2725:    * @param hasFocus indicates if that node has focus or not
2726:    */
2727:   public String convertValueToText(Object value, boolean selected,
2728:                                    boolean expanded, boolean leaf, int row, boolean hasFocus)
2729:   {
2730:     return value.toString();
2731:   }
2732: 
2733:   /**
2734:    * A String representation of this JTree. This is intended to be used for
2735:    * debugging. The returned string may be empty but may not be
2736:    * <code>null</code>.
2737:    * 
2738:    * @return a String representation of this JTree
2739:    */
2740:   public String paramString()
2741:   {
2742:     // TODO: this is completely legal, but it would possibly be nice
2743:     // to return some more content, like the tree structure, some properties
2744:     // etc ...
2745:     return "";
2746:   }
2747: 
2748:   /**
2749:    * Returns all TreePath objects which are a descendants of the given path
2750:    * and are exapanded at the moment of the execution of this method. If the
2751:    * state of any node is beeing toggled while this method is executing this
2752:    * change may be left unaccounted.
2753:    * 
2754:    * @param path The parent of this request
2755:    *
2756:    * @return An Enumeration containing TreePath objects
2757:    */
2758:   public Enumeration getExpandedDescendants(TreePath path)
2759:   {
2760:     Enumeration paths = nodeStates.keys();
2761:     Vector relevantPaths = new Vector();
2762:     while (paths.hasMoreElements())
2763:       {
2764:         TreePath nextPath = (TreePath) paths.nextElement();
2765:         if (nodeStates.get(nextPath) == EXPANDED
2766:             && path.isDescendant(nextPath))
2767:           {
2768:             relevantPaths.add(nextPath);
2769:           }
2770:       }
2771:     return relevantPaths.elements();
2772:   }
2773: 
2774:   /**
2775:    * Returns the next table element (beginning from the row
2776:    * <code>startingRow</code> that starts with <code>prefix</code>.
2777:    * Searching is done in the direction specified by <code>bias</code>.
2778:    * 
2779:    * @param prefix the prefix to search for in the cell values
2780:    * @param startingRow the index of the row where to start searching from
2781:    * @param bias the search direction, either {@link Position.Bias#Forward} or
2782:    *        {@link Position.Bias#Backward}
2783:    * 
2784:    * @return the path to the found element or -1 if no such element has been
2785:    *         found
2786:    * 
2787:    * @throws IllegalArgumentException if prefix is <code>null</code> or
2788:    *         startingRow is not valid
2789:    * 
2790:    * @since 1.4
2791:    */
2792:   public TreePath getNextMatch(String prefix, int startingRow,
2793:                                Position.Bias bias)
2794:   {
2795:     if (prefix == null)
2796:       throw new IllegalArgumentException("The argument 'prefix' must not be"
2797:                                          + " null.");
2798:     if (startingRow < 0)
2799:       throw new IllegalArgumentException("The argument 'startingRow' must not"
2800:                                          + " be less than zero.");
2801: 
2802:     int size = getRowCount();
2803:     if (startingRow > size)
2804:       throw new IllegalArgumentException("The argument 'startingRow' must not"
2805:                                          + " be greater than the number of"
2806:                                          + " elements in the TreeModel.");
2807: 
2808:     TreePath foundPath = null;
2809:     if (bias == Position.Bias.Forward)
2810:       {
2811:         for (int i = startingRow; i < size; i++)
2812:           {
2813:             TreePath path = getPathForRow(i);
2814:             Object o = path.getLastPathComponent();
2815:             // FIXME: in the following call to convertValueToText the
2816:             // last argument (hasFocus) should be done right.
2817:             String item = convertValueToText(o, isRowSelected(i),
2818:                                              isExpanded(i), treeModel.isLeaf(o),
2819:                                              i, false);
2820:             if (item.startsWith(prefix))
2821:               {
2822:                 foundPath = path;
2823:                 break;
2824:               }
2825:           }
2826:       }
2827:     else
2828:       {
2829:         for (int i = startingRow; i >= 0; i--)
2830:           {
2831:             TreePath path = getPathForRow(i);
2832:             Object o = path.getLastPathComponent();
2833:             // FIXME: in the following call to convertValueToText the
2834:             // last argument (hasFocus) should be done right.
2835:             String item = convertValueToText(o, isRowSelected(i),
2836:                                              isExpanded(i), treeModel.isLeaf(o), i, false);
2837:             if (item.startsWith(prefix))
2838:               {
2839:                 foundPath = path;
2840:                 break;
2841:               }
2842:           }
2843:       }
2844:     return foundPath;
2845:   }
2846: 
2847:   /**
2848:    * Removes any paths in the current set of selected paths that are
2849:    * descendants of <code>path</code>. If <code>includePath</code> is set
2850:    * to <code>true</code> and <code>path</code> itself is selected, then
2851:    * it will be removed too.
2852:    * 
2853:    * @param path the path from which selected descendants are to be removed
2854:    * @param includeSelected if <code>true</code> then <code>path</code> itself
2855:    *        will also be remove if it's selected
2856:    * 
2857:    * @return <code>true</code> if something has been removed,
2858:    *         <code>false</code> otherwise
2859:    * 
2860:    * @since 1.3
2861:    */
2862:   protected boolean removeDescendantSelectedPaths(TreePath path,
2863:                                                   boolean includeSelected)
2864:   {
2865:     boolean removedSomething = false;
2866:     TreePath[] selected = getSelectionPaths();
2867:     for (int index = 0; index < selected.length; index++)
2868:       {
2869:         if ((selected[index] == path && includeSelected)
2870:             || (selected[index].isDescendant(path)))
2871:           {
2872:             removeSelectionPath(selected[index]);
2873:             removedSomething = true;
2874:           }
2875:       }
2876:     return removedSomething;
2877:   }
2878:   
2879:   /**
2880:    * Removes any descendants of the TreePaths in toRemove that have been 
2881:    * expanded.
2882:    * 
2883:    * @param toRemove - Enumeration of TreePaths that need to be removed from
2884:    * cache of toggled tree paths.
2885:    */
2886:   protected void removeDescendantToggledPaths(Enumeration toRemove)
2887:   {
2888:     while (toRemove.hasMoreElements())
2889:       {
2890:         TreePath current = (TreePath) toRemove.nextElement();
2891:         Enumeration descendants = getDescendantToggledPaths(current);
2892:         
2893:         while (descendants.hasMoreElements())
2894:           {
2895:             TreePath currentDes = (TreePath) descendants.nextElement();
2896:             if (isExpanded(currentDes))
2897:                 nodeStates.remove(currentDes);
2898:           }
2899:       }
2900:   }
2901: 
2902:   /**
2903:    * Sent when the tree has changed enough that we need to resize the bounds, 
2904:    * but not enough that we need to remove the expanded node set (e.g nodes
2905:    * were expanded or collapsed, or nodes were inserted into the tree). You 
2906:    * should never have to invoke this, the UI will invoke this as it needs to. 
2907:    */
2908:   public void treeDidChange()
2909:   {
2910:     repaint();
2911:   }
2912: }