Source for javax.swing.tree.TreeModel

   1: /* TreeModel.java --
   2:    Copyright (C) 2002 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: 
  39: package javax.swing.tree;
  40: 
  41: import javax.swing.event.TreeModelListener;
  42: 
  43: /**
  44:  * TreeModel public interface
  45:  * @author Andrew Selkirk
  46:  */
  47: public interface TreeModel {
  48: 
  49:     //-------------------------------------------------------------
  50:     // Methods ----------------------------------------------------
  51:     //-------------------------------------------------------------
  52: 
  53:     /**
  54:      * getRoot
  55:      * @returns Object
  56:      */
  57:     Object getRoot();
  58: 
  59:     /**
  60:      * getChild
  61:      * @param parent TODO
  62:      * @param index TODO
  63:      * @returns Object
  64:      */
  65:     Object getChild(Object parent, int index);
  66: 
  67:     /**
  68:      * getChildCount
  69:      * @param parent TODO
  70:      * @returns int
  71:      */
  72:     int getChildCount(Object parent);
  73: 
  74:     /**
  75:      * isLeaf
  76:      * @param node TODO
  77:      * @returns boolean
  78:      */
  79:     boolean isLeaf(Object node);
  80: 
  81:     /**
  82:      * valueForPathChanged
  83:      * @param path TODO
  84:      * @param newvalue TODO
  85:      */
  86:     void valueForPathChanged(TreePath path, Object newvalue);
  87: 
  88:     /**
  89:      * getIndexOfChild
  90:      * @param parent TODO
  91:      * @param ild TODO
  92:      * @returns int
  93:      */
  94:     int getIndexOfChild(Object parent, Object child);
  95: 
  96:     /**
  97:      * addTreeModelListener
  98:      * @param listener TODO
  99:      */
 100:     void addTreeModelListener(TreeModelListener listener);
 101: 
 102:     /**
 103:      * removeTreeModelListener
 104:      * @param listener TODO
 105:      */
 106:     void removeTreeModelListener(TreeModelListener listener);
 107: 
 108: 
 109: } // TreeModel