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(new EmptySelectionModel());
1484:     selectionModel.setSelectionMode(TreeSelectionModel.SINGLE_TREE_SELECTION);
1485:   }
1486: 
1487:   /**
1488:    * Creates a new <code>JTree</code> object.
1489:    * 
1490:    * @param root the root node
1491:    */
1492:   public JTree(TreeNode root)
1493:   {
1494:     this(root, false);
1495:   }
1496: 
1497:   /**
1498:    * Creates a new <code>JTree</code> object.
1499:    * 
1500:    * @param root the root node
1501:    * @param asksAllowChildren if false, all nodes without children are leaf
1502:    *        nodes. If true, only nodes that do not allow children are leaf
1503:    *        nodes.
1504:    */
1505:   public JTree(TreeNode root, boolean asksAllowChildren)
1506:   {
1507:     this(new DefaultTreeModel(root, asksAllowChildren));
1508:   }
1509: 
1510:   /**
1511:    * Creates a new <code>JTree</code> object.
1512:    * 
1513:    * @param value the initial nodes in the tree
1514:    */
1515:   public JTree(Vector value)
1516:   {
1517:     this(createTreeModel(value));
1518:   }
1519: 
1520:   public int getRowForPath(TreePath path)
1521:   {
1522:     TreeUI ui = getUI();
1523: 
1524:     if (ui != null)
1525:       return ui.getRowForPath(this, path);
1526: 
1527:     return -1;
1528:   }
1529: 
1530:   public TreePath getPathForRow(int row)
1531:   {
1532:     TreeUI ui = getUI();
1533:     return ui != null ? ui.getPathForRow(this, row) : null;
1534:   }
1535: 
1536:   protected TreePath[] getPathBetweenRows(int index0, int index1)
1537:   {
1538:     TreeUI ui = getUI();
1539: 
1540:     if (ui == null)
1541:       return null;
1542: 
1543:     int minIndex = Math.min(index0, index1);
1544:     int maxIndex = Math.max(index0, index1);
1545:     TreePath[] paths = new TreePath[maxIndex - minIndex + 1];
1546: 
1547:     for (int i = minIndex; i <= maxIndex; ++i)
1548:       paths[i - minIndex] = ui.getPathForRow(this, i);
1549: 
1550:     return paths;
1551:   }
1552: 
1553:   /**
1554:    * Creates a new <code>TreeModel</code> object.
1555:    * 
1556:    * @param value the values stored in the model
1557:    */
1558:   protected static TreeModel createTreeModel(Object value)
1559:   {
1560:     return new DefaultTreeModel(new DynamicUtilTreeNode(value, value));
1561:   }
1562: 
1563:   /**
1564:    * Return the UI associated with this <code>JTree</code> object.
1565:    * 
1566:    * @return the associated <code>TreeUI</code> object
1567:    */
1568:   public TreeUI getUI()
1569:   {
1570:     return (TreeUI) ui;
1571:   }
1572: 
1573:   /**
1574:    * Sets the UI associated with this <code>JTree</code> object.
1575:    * 
1576:    * @param ui the <code>TreeUI</code> to associate
1577:    */
1578:   public void setUI(TreeUI ui)
1579:   {
1580:     super.setUI(ui);
1581:   }
1582: 
1583:   /**
1584:    * This method resets the UI used to the Look and Feel defaults..
1585:    */
1586:   public void updateUI()
1587:   {
1588:     setUI((TreeUI) UIManager.getUI(this));
1589:   }
1590: 
1591:   /**
1592:    * This method returns the String ID of the UI class of Separator.
1593:    * 
1594:    * @return The UI class' String ID.
1595:    */
1596:   public String getUIClassID()
1597:   {
1598:     return "TreeUI";
1599:   }
1600: 
1601:   /**
1602:    * Gets the AccessibleContext associated with this
1603:    * <code>JTree</code>.
1604:    * 
1605:    * @return the associated context
1606:    */
1607:   public AccessibleContext getAccessibleContext()
1608:   {
1609:     return new AccessibleJTree();
1610:   }
1611: 
1612:   /**
1613:    * Returns the preferred viewport size.
1614:    * 
1615:    * @return the preferred size
1616:    */
1617:   public Dimension getPreferredScrollableViewportSize()
1618:   {
1619:     return new Dimension (getPreferredSize().width, getVisibleRowCount()*getRowHeight());
1620:   }
1621: 
1622:   public int getScrollableUnitIncrement(Rectangle visibleRect,
1623:                                         int orientation, int direction)
1624:   {
1625:     return 1;
1626:   }
1627: 
1628:   public int getScrollableBlockIncrement(Rectangle visibleRect,
1629:                                          int orientation, int direction)
1630:   {
1631:     return 1;
1632:   }
1633: 
1634:   public boolean getScrollableTracksViewportHeight()
1635:   {
1636:     if (getParent() instanceof JViewport)
1637:       return ((JViewport) getParent()).getHeight() > getPreferredSize().height;
1638:     return false;
1639:   }
1640: 
1641:   public boolean getScrollableTracksViewportWidth()
1642:   {
1643:     if (getParent() instanceof JViewport)
1644:       return ((JViewport) getParent()).getWidth() > getPreferredSize().width;
1645:     return false;
1646:   }
1647: 
1648:   /**
1649:    * Adds a <code>TreeExpansionListener</code> object to the tree.
1650:    * 
1651:    * @param listener the listener to add
1652:    */
1653:   public void addTreeExpansionListener(TreeExpansionListener listener)
1654:   {
1655:     listenerList.add(TreeExpansionListener.class, listener);
1656:   }
1657: 
1658:   /**
1659:    * Removes a <code>TreeExpansionListener</code> object from the tree.
1660:    * 
1661:    * @param listener the listener to remove
1662:    */
1663:   public void removeTreeExpansionListener(TreeExpansionListener listener)
1664:   {
1665:     listenerList.remove(TreeExpansionListener.class, listener);
1666:   }
1667: 
1668:   /**
1669:    * Returns all added <code>TreeExpansionListener</code> objects.
1670:    * 
1671:    * @return an array of listeners
1672:    */
1673:   public TreeExpansionListener[] getTreeExpansionListeners()
1674:   {
1675:     return (TreeExpansionListener[]) getListeners(TreeExpansionListener.class);
1676:   }
1677: 
1678:   /**
1679:    * Notifies all listeners that the tree was collapsed.
1680:    * 
1681:    * @param path the path to the node that was collapsed
1682:    */
1683:   public void fireTreeCollapsed(TreePath path)
1684:   {
1685:     TreeExpansionEvent event = new TreeExpansionEvent(this, path);
1686:     TreeExpansionListener[] listeners = getTreeExpansionListeners();
1687: 
1688:     for (int index = 0; index < listeners.length; ++index)
1689:       listeners[index].treeCollapsed(event);
1690:   }
1691: 
1692:   /**
1693:    * Notifies all listeners that the tree was expanded.
1694:    * 
1695:    * @param path the path to the node that was expanded
1696:    */
1697:   public void fireTreeExpanded(TreePath path)
1698:   {
1699:     TreeExpansionEvent event = new TreeExpansionEvent(this, path);
1700:     TreeExpansionListener[] listeners = getTreeExpansionListeners();
1701: 
1702:     for (int index = 0; index < listeners.length; ++index)
1703:       listeners[index].treeExpanded(event);
1704:   }
1705: 
1706:   /**
1707:    * Adds a <code>TreeSelctionListener</code> object to the tree.
1708:    * 
1709:    * @param listener the listener to add
1710:    */
1711:   public void addTreeSelectionListener(TreeSelectionListener listener)
1712:   {
1713:     listenerList.add(TreeSelectionListener.class, listener);
1714:   }
1715: 
1716:   /**
1717:    * Removes a <code>TreeSelectionListener</code> object from the tree.
1718:    * 
1719:    * @param listener the listener to remove
1720:    */
1721:   public void removeTreeSelectionListener(TreeSelectionListener listener)
1722:   {
1723:     listenerList.remove(TreeSelectionListener.class, listener);
1724:   }
1725: 
1726:   /**
1727:    * Returns all added <code>TreeSelectionListener</code> objects.
1728:    * 
1729:    * @return an array of listeners
1730:    */
1731:   public TreeSelectionListener[] getTreeSelectionListeners()
1732:   {
1733:     return (TreeSelectionListener[]) 
1734:     getListeners(TreeSelectionListener.class);
1735:   }
1736: 
1737:   /**
1738:    * Notifies all listeners when the selection of the tree changed.
1739:    * 
1740:    * @param event the event to send
1741:    */
1742:   protected void fireValueChanged(TreeSelectionEvent event)
1743:   {
1744:     TreeSelectionListener[] listeners = getTreeSelectionListeners();
1745: 
1746:     for (int index = 0; index < listeners.length; ++index)
1747:       listeners[index].valueChanged(event);
1748:   }
1749: 
1750:   /**
1751:    * Adds a <code>TreeWillExpandListener</code> object to the tree.
1752:    * 
1753:    * @param listener the listener to add
1754:    */
1755:   public void addTreeWillExpandListener(TreeWillExpandListener listener)
1756:   {
1757:     listenerList.add(TreeWillExpandListener.class, listener);
1758:   }
1759: 
1760:   /**
1761:    * Removes a <code>TreeWillExpandListener</code> object from the tree.
1762:    * 
1763:    * @param listener the listener to remove
1764:    */
1765:   public void removeTreeWillExpandListener(TreeWillExpandListener listener)
1766:   {
1767:     listenerList.remove(TreeWillExpandListener.class, listener);
1768:   }
1769: 
1770:   /**
1771:    * Returns all added <code>TreeWillExpandListener</code> objects.
1772:    * 
1773:    * @return an array of listeners
1774:    */
1775:   public TreeWillExpandListener[] getTreeWillExpandListeners()
1776:   {
1777:     return (TreeWillExpandListener[]) 
1778:     getListeners(TreeWillExpandListener.class);
1779:   }
1780: 
1781:   /**
1782:    * Notifies all listeners that the tree will collapse.
1783:    * 
1784:    * @param path the path to the node that will collapse
1785:    */
1786:   public void fireTreeWillCollapse(TreePath path) throws ExpandVetoException
1787:   {
1788:     TreeExpansionEvent event = new TreeExpansionEvent(this, path);
1789:     TreeWillExpandListener[] listeners = getTreeWillExpandListeners();
1790: 
1791:     for (int index = 0; index < listeners.length; ++index)
1792:       listeners[index].treeWillCollapse(event);
1793:   }
1794: 
1795:   /**
1796:    * Notifies all listeners that the tree will expand.
1797:    * 
1798:    * @param path the path to the node that will expand
1799:    */
1800:   public void fireTreeWillExpand(TreePath path) throws ExpandVetoException
1801:   {
1802:     TreeExpansionEvent event = new TreeExpansionEvent(this, path);
1803:     TreeWillExpandListener[] listeners = getTreeWillExpandListeners();
1804: 
1805:     for (int index = 0; index < listeners.length; ++index)
1806:       listeners[index].treeWillExpand(event);
1807:   }
1808: 
1809:   /**
1810:    * Returns the model of this <code>JTree</code> object.
1811:    * 
1812:    * @return the associated <code>TreeModel</code>
1813:    */
1814:   public TreeModel getModel()
1815:   {
1816:     return treeModel;
1817:   }
1818: 
1819:   /**
1820:    * Sets the model to use in <code>JTree</code>.
1821:    * 
1822:    * @param model the <code>TreeModel</code> to use
1823:    */
1824:   public void setModel(TreeModel model)
1825:   {
1826:     if (treeModel == model)
1827:       return;
1828: 
1829:     // add treeModelListener to the new model
1830:     if (treeModelListener == null)
1831:       treeModelListener = createTreeModelListener();
1832:     if (model != null) // as setModel(null) is allowed
1833:       model.addTreeModelListener(treeModelListener);
1834: 
1835:     TreeModel oldValue = treeModel;
1836:     treeModel = model;
1837: 
1838:     firePropertyChange(TREE_MODEL_PROPERTY, oldValue, model);
1839:     updateUI();
1840:   }
1841: 
1842:   /**
1843:    * Checks if this <code>JTree</code> object is editable.
1844:    * 
1845:    * @return <code>true</code> if this tree object is editable,
1846:    *         <code>false</code> otherwise
1847:    */
1848:   public boolean isEditable()
1849:   {
1850:     return editable;
1851:   }
1852: 
1853:   /**
1854:    * Sets the <code>editable</code> property.
1855:    * 
1856:    * @param flag <code>true</code> to make this tree object editable,
1857:    *        <code>false</code> otherwise
1858:    */
1859:   public void setEditable(boolean flag)
1860:   {
1861:     if (editable == flag)
1862:       return;
1863: 
1864:     boolean oldValue = editable;
1865:     editable = flag;
1866:     firePropertyChange(EDITABLE_PROPERTY, oldValue, editable);
1867:   }
1868: 
1869:   /**
1870:    * Checks if the root element is visible.
1871:    * 
1872:    * @return <code>true</code> if the root element is visible,
1873:    *         <code>false</code> otherwise
1874:    */
1875:   public boolean isRootVisible()
1876:   {
1877:     return rootVisible;
1878:   }
1879: 
1880:   public void setRootVisible(boolean flag)
1881:   {
1882:     if (rootVisible == flag)
1883:       return;
1884: 
1885:     boolean oldValue = rootVisible;
1886:     rootVisible = flag;
1887:     firePropertyChange(ROOT_VISIBLE_PROPERTY, oldValue, flag);
1888:   }
1889: 
1890:   public boolean getShowsRootHandles()
1891:   {
1892:     return showsRootHandles;
1893:   }
1894: 
1895:   public void setShowsRootHandles(boolean flag)
1896:   {
1897:     if (showsRootHandles == flag)
1898:       return;
1899:     
1900:     boolean oldValue = showsRootHandles;
1901:     showsRootHandles = flag;
1902:     firePropertyChange(SHOWS_ROOT_HANDLES_PROPERTY, oldValue, flag);
1903:   }
1904: 
1905:   public TreeCellEditor getCellEditor()
1906:   {
1907:     return cellEditor;
1908:   }
1909: 
1910:   public void setCellEditor(TreeCellEditor editor)
1911:   {
1912:     if (cellEditor == editor)
1913:       return;
1914: 
1915:     TreeCellEditor oldValue = cellEditor;
1916:     cellEditor = editor;
1917:     firePropertyChange(CELL_EDITOR_PROPERTY, oldValue, editor);
1918:   }
1919: 
1920:   public TreeCellRenderer getCellRenderer()
1921:   {
1922:     return cellRenderer;
1923:   }
1924: 
1925:   public void setCellRenderer(TreeCellRenderer newRenderer)
1926:   {
1927:     if (cellRenderer == newRenderer)
1928:       return;
1929: 
1930:     TreeCellRenderer oldValue = cellRenderer;
1931:     cellRenderer = newRenderer;
1932:     firePropertyChange(CELL_RENDERER_PROPERTY, oldValue, newRenderer);
1933:   }
1934: 
1935:   public TreeSelectionModel getSelectionModel()
1936:   {
1937:     return selectionModel;
1938:   }
1939: 
1940:   public void setSelectionModel(TreeSelectionModel model)
1941:   {
1942:     if (selectionModel == model)
1943:       return;
1944: 
1945:     if (selectionModel != null)
1946:       selectionModel.removeTreeSelectionListener(selectionRedirector);
1947: 
1948:     TreeSelectionModel oldValue = selectionModel;
1949:     selectionModel = model;
1950: 
1951:     if (selectionModel != null)
1952:       selectionModel.addTreeSelectionListener(selectionRedirector);
1953: 
1954:     firePropertyChange(SELECTION_MODEL_PROPERTY, oldValue, model);
1955:     revalidate();
1956:     repaint();
1957:   }
1958: 
1959:   public int getVisibleRowCount()
1960:   {
1961:     return visibleRowCount;
1962:   }
1963: 
1964:   public void setVisibleRowCount(int rows)
1965:   {
1966:     if (visibleRowCount == rows)
1967:       return;
1968: 
1969:     int oldValue = visibleRowCount;
1970:     visibleRowCount = rows;
1971:     firePropertyChange(VISIBLE_ROW_COUNT_PROPERTY, oldValue, rows);
1972:   }
1973: 
1974:   public boolean isLargeModel()
1975:   {
1976:     return largeModel;
1977:   }
1978: 
1979:   public void setLargeModel(boolean large)
1980:   {
1981:     if (largeModel == large)
1982:       return;
1983: 
1984:     boolean oldValue = largeModel;
1985:     largeModel = large;
1986:     firePropertyChange(LARGE_MODEL_PROPERTY, oldValue, large);
1987:   }
1988: 
1989:   public int getRowHeight()
1990:   {
1991:     return rowHeight;
1992:   }
1993: 
1994:   public void setRowHeight(int height)
1995:   {
1996:     if (rowHeight == height)
1997:       return;
1998: 
1999:     int oldValue = rowHeight;
2000:     rowHeight = height;
2001:     firePropertyChange(ROW_HEIGHT_PROPERTY, oldValue, height);
2002:   }
2003: 
2004:   public boolean isFixedRowHeight()
2005:   {
2006:     return rowHeight > 0;
2007:   }
2008: 
2009:   public boolean getInvokesStopCellEditing()
2010:   {
2011:     return invokesStopCellEditing;
2012:   }
2013: 
2014:   public void setInvokesStopCellEditing(boolean invoke)
2015:   {
2016:     if (invokesStopCellEditing == invoke)
2017:       return;
2018: 
2019:     boolean oldValue = invokesStopCellEditing;
2020:     invokesStopCellEditing = invoke;
2021:     firePropertyChange(INVOKES_STOP_CELL_EDITING_PROPERTY, 
2022:                        oldValue, invoke);
2023:   }
2024: 
2025:   /**
2026:    * @since 1.3
2027:    */
2028:   public int getToggleClickCount()
2029:   {
2030:     return toggleClickCount;
2031:   }
2032: 
2033:   /**
2034:    * @since 1.3
2035:    */
2036:   public void setToggleClickCount(int count)
2037:   {
2038:     if (toggleClickCount == count)
2039:       return;
2040: 
2041:     int oldValue = toggleClickCount;
2042:     toggleClickCount = count;
2043:     firePropertyChange(TOGGLE_CLICK_COUNT_PROPERTY, oldValue, count);
2044:   }
2045: 
2046:   public void scrollPathToVisible(TreePath path)
2047:   {
2048:     if (path == null)
2049:       return;
2050:     
2051:     Object[] oPath = path.getPath();
2052:     TreePath temp = new TreePath(oPath[0]);
2053:     boolean stop = false;
2054:     int i = 1;
2055:     while (!stop)
2056:       {
2057:         while (isVisible(temp))
2058:           if (i < oPath.length)
2059:             temp = temp.pathByAddingChild(oPath[i++]);
2060:           else
2061:             {
2062:               stop = true;
2063:               break;
2064:             }
2065:         makeVisible(temp);
2066:       }
2067:     Rectangle rect = getPathBounds(path);
2068:     scrollRectToVisible(rect);
2069:     revalidate();
2070:     repaint();
2071:   }
2072: 
2073:   public void scrollRowToVisible(int row)
2074:   {
2075:     scrollPathToVisible(getPathForRow(row));
2076:   }
2077: 
2078:   public boolean getScrollsOnExpand()
2079:   {
2080:     return scrollsOnExpand;
2081:   }
2082: 
2083:   public void setScrollsOnExpand(boolean scroll)
2084:   {
2085:     if (scrollsOnExpand == scroll)
2086:       return;
2087: 
2088:     boolean oldValue = scrollsOnExpand;
2089:     scrollsOnExpand = scroll;
2090:     firePropertyChange(SCROLLS_ON_EXPAND_PROPERTY, oldValue, scroll);
2091:   }
2092: 
2093:   public void setSelectionPath(TreePath path)
2094:   {
2095:     selectionModel.setSelectionPath(path);
2096:   }
2097: 
2098:   public void setSelectionPaths(TreePath[] paths)
2099:   {
2100:     selectionModel.setSelectionPaths(paths);
2101:   }
2102: 
2103:   public void setSelectionRow(int row)
2104:   {
2105:     TreePath path = getPathForRow(row);
2106: 
2107:     if (path != null)
2108:       selectionModel.setSelectionPath(path);
2109:   }
2110: 
2111:   public void setSelectionRows(int[] rows)
2112:   {
2113:     // Make sure we have an UI so getPathForRow() does not return null.
2114:     if (rows == null || getUI() == null)
2115:       return;
2116: 
2117:     TreePath[] paths = new TreePath[rows.length];
2118: 
2119:     for (int i = rows.length - 1; i >= 0; --i)
2120:       paths[i] = getPathForRow(rows[i]);
2121: 
2122:     setSelectionPaths(paths);
2123:   }
2124: 
2125:   public void setSelectionInterval(int index0, int index1)
2126:   {
2127:     TreePath[] paths = getPathBetweenRows(index0, index1);
2128: 
2129:     if (paths != null)
2130:       setSelectionPaths(paths);
2131:   }
2132: 
2133:   public void addSelectionPath(TreePath path)
2134:   {
2135:     selectionModel.addSelectionPath(path);
2136:   }
2137: 
2138:   public void addSelectionPaths(TreePath[] paths)
2139:   {
2140:     selectionModel.addSelectionPaths(paths);
2141:   }
2142: 
2143:   public void addSelectionRow(int row)
2144:   {
2145:     TreePath path = getPathForRow(row);
2146: 
2147:     if (path != null)
2148:       selectionModel.addSelectionPath(path);
2149:   }
2150: 
2151:   public void addSelectionRows(int[] rows)
2152:   {
2153:     // Make sure we have an UI so getPathForRow() does not return null.
2154:     if (rows == null || getUI() == null)
2155:       return;
2156: 
2157:     TreePath[] paths = new TreePath[rows.length];
2158: 
2159:     for (int i = rows.length - 1; i >= 0; --i)
2160:       paths[i] = getPathForRow(rows[i]);
2161: 
2162:     addSelectionPaths(paths);
2163:   }
2164: 
2165:   public void addSelectionInterval(int index0, int index1)
2166:   {
2167:     TreePath[] paths = getPathBetweenRows(index0, index1);
2168: 
2169:     if (paths != null)
2170:       addSelectionPaths(paths);
2171:   }
2172: 
2173:   public void removeSelectionPath(TreePath path)
2174:   {
2175:     selectionModel.removeSelectionPath(path);
2176:   }
2177: 
2178:   public void removeSelectionPaths(TreePath[] paths)
2179:   {
2180:     selectionModel.removeSelectionPaths(paths);
2181:   }
2182: 
2183:   public void removeSelectionRow(int row)
2184:   {
2185:     TreePath path = getPathForRow(row);
2186: 
2187:     if (path != null)
2188:       selectionModel.removeSelectionPath(path);
2189:   }
2190: 
2191:   public void removeSelectionRows(int[] rows)
2192:   {
2193:     if (rows == null || getUI() == null)
2194:       return;
2195: 
2196:     TreePath[] paths = new TreePath[rows.length];
2197: 
2198:     for (int i = rows.length - 1; i >= 0; --i)
2199:       paths[i] = getPathForRow(rows[i]);
2200: 
2201:     removeSelectionPaths(paths);
2202:   }
2203: 
2204:   public void removeSelectionInterval(int index0, int index1)
2205:   {
2206:     TreePath[] paths = getPathBetweenRows(index0, index1);
2207: 
2208:     if (paths != null)
2209:       removeSelectionPaths(paths);
2210:   }
2211: 
2212:   public void clearSelection()
2213:   {
2214:     selectionModel.clearSelection();
2215:     setLeadSelectionPath(null);
2216:   }
2217: 
2218:   public TreePath getLeadSelectionPath()
2219:   {
2220:     return leadSelectionPath;
2221:   }
2222: 
2223:   /**
2224:    * @since 1.3
2225:    */
2226:   public void setLeadSelectionPath(TreePath path)
2227:   {
2228:     if (leadSelectionPath == path)
2229:       return;
2230:     
2231:     TreePath oldValue = leadSelectionPath;
2232:     leadSelectionPath = path;
2233:     firePropertyChange(LEAD_SELECTION_PATH_PROPERTY, oldValue, path);
2234:   }
2235: 
2236:   /**
2237:    * @since 1.3
2238:    */
2239:   public TreePath getAnchorSelectionPath()
2240:   {
2241:     return anchorSelectionPath;
2242:   }
2243: 
2244:   /**
2245:    * @since 1.3
2246:    */
2247:   public void setAnchorSelectionPath(TreePath path)
2248:   {
2249:     if (anchorSelectionPath == path)
2250:       return;
2251: 
2252:     TreePath oldValue = anchorSelectionPath;
2253:     anchorSelectionPath = path;
2254:     firePropertyChange(ANCHOR_SELECTION_PATH_PROPERTY, oldValue, path);
2255:   }
2256: 
2257:   public int getLeadSelectionRow()
2258:   {
2259:     return selectionModel.getLeadSelectionRow();
2260:   }
2261: 
2262:   public int getMaxSelectionRow()
2263:   {
2264:     return selectionModel.getMaxSelectionRow();
2265:   }
2266: 
2267:   public int getMinSelectionRow()
2268:   {
2269:     return selectionModel.getMinSelectionRow();
2270:   }
2271: 
2272:   public int getSelectionCount()
2273:   {
2274:     return selectionModel.getSelectionCount();
2275:   }
2276: 
2277:   public TreePath getSelectionPath()
2278:   {
2279:     return selectionModel.getSelectionPath();
2280:   }
2281: 
2282:   public TreePath[] getSelectionPaths()
2283:   {
2284:     return selectionModel.getSelectionPaths();
2285:   }
2286: 
2287:   public int[] getSelectionRows()
2288:   {
2289:     return selectionModel.getSelectionRows();
2290:   }
2291: 
2292:   public boolean isPathSelected(TreePath path)
2293:   {
2294:     return selectionModel.isPathSelected(path);
2295:   }
2296: 
2297:   public boolean isRowSelected(int row)
2298:   {
2299:     return selectionModel.isPathSelected(getPathForRow(row));
2300:   }
2301: 
2302:   public boolean isSelectionEmpty()
2303:   {
2304:     return selectionModel.isSelectionEmpty();
2305:   }
2306: 
2307:   /**
2308:    * Return the value of the <code>dragEnabled</code> property.
2309:    * 
2310:    * @return the value
2311:    * 
2312:    * @since 1.4
2313:    */
2314:   public boolean getDragEnabled()
2315:   {
2316:     return dragEnabled;
2317:   }
2318: 
2319:   /**
2320:    * Set the <code>dragEnabled</code> property.
2321:    * 
2322:    * @param enabled new value
2323:    * 
2324:    * @since 1.4
2325:    */
2326:   public void setDragEnabled(boolean enabled)
2327:   {
2328:     dragEnabled = enabled;
2329:   }
2330: 
2331:   public int getRowCount()
2332:   {
2333:     TreeUI ui = getUI();
2334: 
2335:     if (ui != null)
2336:       return ui.getRowCount(this);
2337: 
2338:     return 0;
2339:   }
2340: 
2341:   public void collapsePath(TreePath path)
2342:   {
2343:     try
2344:       {
2345:         fireTreeWillCollapse(path);
2346:       }
2347:     catch (ExpandVetoException ev)
2348:       {
2349:         // We do nothing if attempt has been vetoed.
2350:       }
2351:     setExpandedState(path, false);
2352:     fireTreeCollapsed(path);
2353:   }
2354: 
2355:   public void collapseRow(int row)
2356:   {
2357:     if (row < 0 || row >= getRowCount())
2358:       return;
2359: 
2360:     TreePath path = getPathForRow(row);
2361: 
2362:     if (path != null)
2363:       collapsePath(path);
2364:   }
2365: 
2366:   public void expandPath(TreePath path)
2367:   {
2368:     // Don't expand if path is null
2369:     if (path == null)
2370:       return;
2371: 
2372:     try
2373:       {
2374:         fireTreeWillExpand(path);
2375:       }
2376:     catch (ExpandVetoException ev)
2377:       {
2378:         // We do nothing if attempt has been vetoed.
2379:       }
2380: 
2381:     setExpandedState(path, true);
2382:     fireTreeExpanded(path);
2383:   }
2384: 
2385:   public void expandRow(int row)
2386:   {
2387:     if (row < 0 || row >= getRowCount())
2388:       return;
2389: 
2390:     TreePath path = getPathForRow(row);
2391: 
2392:     if (path != null)
2393:       expandPath(path);
2394:   }
2395: 
2396:   public boolean isCollapsed(TreePath path)
2397:   {
2398:     return !isExpanded(path);
2399:   }
2400: 
2401:   public boolean isCollapsed(int row)
2402:   {
2403:     if (row < 0 || row >= getRowCount())
2404:       return false;
2405: 
2406:     TreePath path = getPathForRow(row);
2407: 
2408:     if (path != null)
2409:       return isCollapsed(path);
2410: 
2411:     return false;
2412:   }
2413: 
2414:   public boolean isExpanded(TreePath path)
2415:   {
2416:     if (path == null)
2417:       return false;
2418: 
2419:     Object state = nodeStates.get(path);
2420: 
2421:     if ((state == null) || (state != EXPANDED))
2422:       return false;
2423: 
2424:     TreePath parent = path.getParentPath();
2425: 
2426:     if (parent != null)
2427:       return isExpanded(parent);
2428: 
2429:     return true;
2430:   }
2431: 
2432:   public boolean isExpanded(int row)
2433:   {
2434:     if (row < 0 || row >= getRowCount())
2435:       return false;
2436: 
2437:     TreePath path = getPathForRow(row);
2438: 
2439:     if (path != null)
2440:       return isExpanded(path);
2441: 
2442:     return false;
2443:   }
2444: 
2445:   /**
2446:    * @since 1.3
2447:    */
2448:   public boolean getExpandsSelectedPaths()
2449:   {
2450:     return expandsSelectedPaths;
2451:   }
2452: 
2453:   /**
2454:    * @since 1.3
2455:    */
2456:   public void setExpandsSelectedPaths(boolean flag)
2457:   {
2458:     if (expandsSelectedPaths == flag)
2459:       return;
2460: 
2461:     boolean oldValue = expandsSelectedPaths;
2462:     expandsSelectedPaths = flag;
2463:     firePropertyChange(EXPANDS_SELECTED_PATHS_PROPERTY, oldValue, flag);
2464:   }
2465: 
2466:   public Rectangle getPathBounds(TreePath path)
2467:   {
2468:     TreeUI ui = getUI();
2469: 
2470:     if (ui == null)
2471:       return null;
2472: 
2473:     return ui.getPathBounds(this, path);
2474:   }
2475: 
2476:   public Rectangle getRowBounds(int row)
2477:   {
2478:     TreePath path = getPathForRow(row);
2479: 
2480:     if (path != null)
2481:       return getPathBounds(path);
2482: 
2483:     return null;
2484:   }
2485: 
2486:   public boolean isEditing()
2487:   {
2488:     TreeUI ui = getUI();
2489: 
2490:     if (ui != null)
2491:       return ui.isEditing(this);
2492: 
2493:     return false;
2494:   }
2495: 
2496:   public boolean stopEditing()
2497:   {
2498:     TreeUI ui = getUI();
2499: 
2500:     if (ui != null)
2501:       return ui.stopEditing(this);
2502: 
2503:     return false;
2504:   }
2505: 
2506:   public void cancelEditing()
2507:   {
2508:     TreeUI ui = getUI();
2509: 
2510:     if (ui != null)
2511:       ui.cancelEditing(this);
2512:   }
2513: 
2514:   public void startEditingAtPath(TreePath path)
2515:   {
2516:     TreeUI ui = getUI();
2517: 
2518:     if (ui != null)
2519:       ui.startEditingAtPath(this, path);
2520:   }
2521: 
2522:   public TreePath getEditingPath()
2523:   {
2524:     TreeUI ui = getUI();
2525: 
2526:     if (ui != null)
2527:       return ui.getEditingPath(this);
2528: 
2529:     return null;
2530:   }
2531: 
2532:   public TreePath getPathForLocation(int x, int y)
2533:   {
2534:     TreePath path = getClosestPathForLocation(x, y);
2535: 
2536:     if (path != null)
2537:       {
2538:         Rectangle rect = getPathBounds(path);
2539: 
2540:         if ((rect != null) && rect.contains(x, y))
2541:           return path;
2542:       }
2543: 
2544:     return null;
2545:   }
2546: 
2547:   public int getRowForLocation(int x, int y)
2548:   {
2549:     TreePath path = getPathForLocation(x, y);
2550: 
2551:     if (path != null)
2552:       return getRowForPath(path);
2553: 
2554:     return -1;
2555:   }
2556: 
2557:   public TreePath getClosestPathForLocation(int x, int y)
2558:   {
2559:     TreeUI ui = getUI();
2560: 
2561:     if (ui != null)
2562:       return ui.getClosestPathForLocation(this, x, y);
2563: 
2564:     return null;
2565:   }
2566: 
2567:   public int getClosestRowForLocation(int x, int y)
2568:   {
2569:     TreePath path = getClosestPathForLocation(x, y);
2570: 
2571:     if (path != null)
2572:       return getRowForPath(path);
2573: 
2574:     return -1;
2575:   }
2576: 
2577:   public Object getLastSelectedPathComponent()
2578:   {
2579:     TreePath path = getSelectionPath();
2580: 
2581:     if (path != null)
2582:       return path.getLastPathComponent();
2583: 
2584:     return null;
2585:   }
2586: 
2587:   private void doExpandParents(TreePath path, boolean state)
2588:   {
2589:     TreePath parent = path.getParentPath();        
2590: 
2591:     if (!isExpanded(parent) && parent != null)
2592:       doExpandParents(parent, false);
2593:     
2594:     nodeStates.put(path, state ? EXPANDED : COLLAPSED);
2595:   }
2596: 
2597:   protected void setExpandedState(TreePath path, boolean state)
2598:   {
2599:     if (path == null)
2600:       return;
2601: 
2602:     doExpandParents(path, state);
2603:   }
2604: 
2605:   protected void clearToggledPaths()
2606:   {
2607:     nodeStates.clear();
2608:   }
2609: 
2610:   protected Enumeration getDescendantToggledPaths(TreePath parent)
2611:   {
2612:     if (parent == null)
2613:       return null;
2614: 
2615:     Enumeration nodes = nodeStates.keys();
2616:     Vector result = new Vector();
2617: 
2618:     while (nodes.hasMoreElements())
2619:       {
2620:         TreePath path = (TreePath) nodes.nextElement();
2621: 
2622:         if (path.isDescendant(parent))
2623:           result.addElement(path);
2624:       }
2625: 
2626:     return result.elements();
2627:   }
2628: 
2629:   public boolean hasBeenExpanded(TreePath path)
2630:   {
2631:     if (path == null)
2632:       return false;
2633: 
2634:     return nodeStates.get(path) != null;
2635:   }
2636: 
2637:   public boolean isVisible(TreePath path)
2638:   {
2639:     if (path == null)
2640:       return false;
2641: 
2642:     TreePath parent = path.getParentPath();
2643: 
2644:     if (parent == null)
2645:       return true; // Is root node.
2646: 
2647:     return isExpanded(parent);
2648:   }
2649: 
2650:   public void makeVisible(TreePath path)
2651:   {
2652:     if (path == null)
2653:       return;
2654:     
2655:     expandPath(path.getParentPath());
2656:   }
2657: 
2658:   public boolean isPathEditable(TreePath path)
2659:   {
2660:     return isEditable();
2661:   }
2662: 
2663:   /**
2664:    * Creates and returns an instance of {@link TreeModelHandler}.
2665:    * 
2666:    * @return an instance of {@link TreeModelHandler}
2667:    */
2668:   protected TreeModelListener createTreeModelListener()
2669:   {
2670:     return new TreeModelHandler();
2671:   }
2672: 
2673:   /**
2674:    * Returns a sample TreeModel that can be used in a JTree. This can be used
2675:    * in Bean- or GUI-Builders to show something interesting.
2676:    * 
2677:    * @return a sample TreeModel that can be used in a JTree
2678:    */
2679:   protected static TreeModel getDefaultTreeModel()
2680:   {
2681:     DefaultMutableTreeNode root = new DefaultMutableTreeNode("Root node");
2682:     DefaultMutableTreeNode child1 = new DefaultMutableTreeNode("Child node 1");
2683:     DefaultMutableTreeNode child11 =
2684:       new DefaultMutableTreeNode("Child node 1.1");
2685:     DefaultMutableTreeNode child12 =
2686:       new DefaultMutableTreeNode("Child node 1.2");
2687:     DefaultMutableTreeNode child13 =
2688:       new DefaultMutableTreeNode("Child node 1.3");
2689:     DefaultMutableTreeNode child2 = new DefaultMutableTreeNode("Child node 2");
2690:     DefaultMutableTreeNode child21 =
2691:       new DefaultMutableTreeNode("Child node 2.1");
2692:     DefaultMutableTreeNode child22 =
2693:       new DefaultMutableTreeNode("Child node 2.2");
2694:     DefaultMutableTreeNode child23 =
2695:       new DefaultMutableTreeNode("Child node 2.3");
2696:     DefaultMutableTreeNode child24 =
2697:       new DefaultMutableTreeNode("Child node 2.4");
2698: 
2699:     DefaultMutableTreeNode child3 = new DefaultMutableTreeNode("Child node 3");
2700:     root.add(child1);
2701:     root.add(child2);
2702:     root.add(child3);
2703:     child1.add(child11);
2704:     child1.add(child12);
2705:     child1.add(child13);
2706:     child2.add(child21);
2707:     child2.add(child22);
2708:     child2.add(child23);
2709:     child2.add(child24);
2710:     return new DefaultTreeModel(root);
2711:   }
2712: 
2713:   /**
2714:    * Converts the specified value to a String. This is used by the renderers
2715:    * of this JTree and its nodes.
2716:    * 
2717:    * This implementation simply returns <code>value.toString()</code> and
2718:    * ignores all other parameters. Subclass this method to control the
2719:    * conversion.
2720:    * 
2721:    * @param value the value that is converted to a String
2722:    * @param selected indicates if that value is selected or not
2723:    * @param expanded indicates if that value is expanded or not
2724:    * @param leaf indicates if that value is a leaf node or not
2725:    * @param row the row of the node
2726:    * @param hasFocus indicates if that node has focus or not
2727:    */
2728:   public String convertValueToText(Object value, boolean selected,
2729:                                    boolean expanded, boolean leaf, int row, boolean hasFocus)
2730:   {
2731:     return value.toString();
2732:   }
2733: 
2734:   /**
2735:    * A String representation of this JTree. This is intended to be used for
2736:    * debugging. The returned string may be empty but may not be
2737:    * <code>null</code>.
2738:    * 
2739:    * @return a String representation of this JTree
2740:    */
2741:   public String paramString()
2742:   {
2743:     // TODO: this is completely legal, but it would possibly be nice
2744:     // to return some more content, like the tree structure, some properties
2745:     // etc ...
2746:     return "";
2747:   }
2748: 
2749:   /**
2750:    * Returns all TreePath objects which are a descendants of the given path
2751:    * and are exapanded at the moment of the execution of this method. If the
2752:    * state of any node is beeing toggled while this method is executing this
2753:    * change may be left unaccounted.
2754:    * 
2755:    * @param path The parent of this request
2756:    *
2757:    * @return An Enumeration containing TreePath objects
2758:    */
2759:   public Enumeration getExpandedDescendants(TreePath path)
2760:   {
2761:     Enumeration paths = nodeStates.keys();
2762:     Vector relevantPaths = new Vector();
2763:     while (paths.hasMoreElements())
2764:       {
2765:         TreePath nextPath = (TreePath) paths.nextElement();
2766:         if (nodeStates.get(nextPath) == EXPANDED
2767:             && path.isDescendant(nextPath))
2768:           {
2769:             relevantPaths.add(nextPath);
2770:           }
2771:       }
2772:     return relevantPaths.elements();
2773:   }
2774: 
2775:   /**
2776:    * Returns the next table element (beginning from the row
2777:    * <code>startingRow</code> that starts with <code>prefix</code>.
2778:    * Searching is done in the direction specified by <code>bias</code>.
2779:    * 
2780:    * @param prefix the prefix to search for in the cell values
2781:    * @param startingRow the index of the row where to start searching from
2782:    * @param bias the search direction, either {@link Position.Bias#Forward} or
2783:    *        {@link Position.Bias#Backward}
2784:    * 
2785:    * @return the path to the found element or -1 if no such element has been
2786:    *         found
2787:    * 
2788:    * @throws IllegalArgumentException if prefix is <code>null</code> or
2789:    *         startingRow is not valid
2790:    * 
2791:    * @since 1.4
2792:    */
2793:   public TreePath getNextMatch(String prefix, int startingRow,
2794:                                Position.Bias bias)
2795:   {
2796:     if (prefix == null)
2797:       throw new IllegalArgumentException("The argument 'prefix' must not be"
2798:                                          + " null.");
2799:     if (startingRow < 0)
2800:       throw new IllegalArgumentException("The argument 'startingRow' must not"
2801:                                          + " be less than zero.");
2802: 
2803:     int size = getRowCount();
2804:     if (startingRow > size)
2805:       throw new IllegalArgumentException("The argument 'startingRow' must not"
2806:                                          + " be greater than the number of"
2807:                                          + " elements in the TreeModel.");
2808: 
2809:     TreePath foundPath = null;
2810:     if (bias == Position.Bias.Forward)
2811:       {
2812:         for (int i = startingRow; i < size; i++)
2813:           {
2814:             TreePath path = getPathForRow(i);
2815:             Object o = path.getLastPathComponent();
2816:             // FIXME: in the following call to convertValueToText the
2817:             // last argument (hasFocus) should be done right.
2818:             String item = convertValueToText(o, isRowSelected(i),
2819:                                              isExpanded(i), treeModel.isLeaf(o),
2820:                                              i, false);
2821:             if (item.startsWith(prefix))
2822:               {
2823:                 foundPath = path;
2824:                 break;
2825:               }
2826:           }
2827:       }
2828:     else
2829:       {
2830:         for (int i = startingRow; i >= 0; i--)
2831:           {
2832:             TreePath path = getPathForRow(i);
2833:             Object o = path.getLastPathComponent();
2834:             // FIXME: in the following call to convertValueToText the
2835:             // last argument (hasFocus) should be done right.
2836:             String item = convertValueToText(o, isRowSelected(i),
2837:                                              isExpanded(i), treeModel.isLeaf(o), i, false);
2838:             if (item.startsWith(prefix))
2839:               {
2840:                 foundPath = path;
2841:                 break;
2842:               }
2843:           }
2844:       }
2845:     return foundPath;
2846:   }
2847: 
2848:   /**
2849:    * Removes any paths in the current set of selected paths that are
2850:    * descendants of <code>path</code>. If <code>includePath</code> is set
2851:    * to <code>true</code> and <code>path</code> itself is selected, then
2852:    * it will be removed too.
2853:    * 
2854:    * @param path the path from which selected descendants are to be removed
2855:    * @param includeSelected if <code>true</code> then <code>path</code> itself
2856:    *        will also be remove if it's selected
2857:    * 
2858:    * @return <code>true</code> if something has been removed,
2859:    *         <code>false</code> otherwise
2860:    * 
2861:    * @since 1.3
2862:    */
2863:   protected boolean removeDescendantSelectedPaths(TreePath path,
2864:                                                   boolean includeSelected)
2865:   {
2866:     boolean removedSomething = false;
2867:     TreePath[] selected = getSelectionPaths();
2868:     for (int index = 0; index < selected.length; index++)
2869:       {
2870:         if ((selected[index] == path && includeSelected)
2871:             || (selected[index].isDescendant(path)))
2872:           {
2873:             removeSelectionPath(selected[index]);
2874:             removedSomething = true;
2875:           }
2876:       }
2877:     return removedSomething;
2878:   }
2879:   
2880:   /**
2881:    * Removes any descendants of the TreePaths in toRemove that have been 
2882:    * expanded.
2883:    * 
2884:    * @param toRemove - Enumeration of TreePaths that need to be removed from
2885:    * cache of toggled tree paths.
2886:    */
2887:   protected void removeDescendantToggledPaths(Enumeration toRemove)
2888:   {
2889:     while (toRemove.hasMoreElements())
2890:       {
2891:         TreePath current = (TreePath) toRemove.nextElement();
2892:         Enumeration descendants = getDescendantToggledPaths(current);
2893:         
2894:         while (descendants.hasMoreElements())
2895:           {
2896:             TreePath currentDes = (TreePath) descendants.nextElement();
2897:             if (isExpanded(currentDes))
2898:                 nodeStates.remove(currentDes);
2899:           }
2900:       }
2901:   }
2902: 
2903:   /**
2904:    * Sent when the tree has changed enough that we need to resize the bounds, 
2905:    * but not enough that we need to remove the expanded node set (e.g nodes
2906:    * were expanded or collapsed, or nodes were inserted into the tree). You 
2907:    * should never have to invoke this, the UI will invoke this as it needs to. 
2908:    */
2909:   public void treeDidChange()
2910:   {
2911:     repaint();
2912:   }
2913: }