001/* TreeModel.java --
002   Copyright (C) 2002 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.swing.tree;
040
041import javax.swing.event.TreeModelListener;
042
043/**
044 * TreeModel public interface
045 * @author Andrew Selkirk
046 */
047public interface TreeModel
048{
049  /**
050   * getRoot
051   * @returns Object
052   */
053  Object getRoot();
054
055  /**
056   * getChild
057   * @param parent TODO
058   * @param index TODO
059   * @returns Object
060   */
061  Object getChild(Object parent, int index);
062
063  /**
064   * getChildCount
065   * @param parent TODO
066   * @returns int
067   */
068  int getChildCount(Object parent);
069
070  /**
071   * isLeaf
072   * @param node TODO
073   * @returns boolean
074   */
075  boolean isLeaf(Object node);
076
077  /**
078   * valueForPathChanged
079   * @param path TODO
080   * @param newvalue TODO
081   */
082  void valueForPathChanged(TreePath path, Object newvalue);
083
084  /**
085   * getIndexOfChild
086   * @param parent TODO
087   * @param child TODO
088   * @returns int
089   */
090  int getIndexOfChild(Object parent, Object child);
091
092  /**
093   * addTreeModelListener
094   * @param listener TODO
095   */
096  void addTreeModelListener(TreeModelListener listener);
097
098  /**
099   * removeTreeModelListener
100   * @param listener TODO
101   */
102  void removeTreeModelListener(TreeModelListener listener);
103
104
105}