diff options
Diffstat (limited to 'libjava/javax/swing/plaf/basic/BasicTreeUI.java')
| -rw-r--r-- | libjava/javax/swing/plaf/basic/BasicTreeUI.java | 197 |
1 files changed, 194 insertions, 3 deletions
diff --git a/libjava/javax/swing/plaf/basic/BasicTreeUI.java b/libjava/javax/swing/plaf/basic/BasicTreeUI.java index 17ba4b56e61..d9af1010ba7 100644 --- a/libjava/javax/swing/plaf/basic/BasicTreeUI.java +++ b/libjava/javax/swing/plaf/basic/BasicTreeUI.java @@ -1,5 +1,5 @@ /* BasicTreeUI.java - Copyright (C) 2002 Free Software Foundation, Inc. + Copyright (C) 2002, 2003 Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -38,8 +38,199 @@ exception statement from your version. */ package javax.swing.plaf.basic; -import javax.swing.plaf.*; +import java.awt.Rectangle; +import javax.swing.JTree; +import javax.swing.plaf.TreeUI; +import javax.swing.tree.TreePath; -public class BasicTreeUI extends TreeUI + +/** + * A delegate providing the user interface for <code>JTree</code> + * according to the Basic look and feel. The current implementation + * of GNU Classpath does really work; it is just a stub that allows + * compiling the code. + * + * @see javax.swing.JTree + * + * @author Sascha Brawer (brawer@dandelis.ch) + */ +public class BasicTreeUI + extends TreeUI { + /** + * Determines the geometric extent of the label that is + * drawn for a path. + * + * @param tree the <code>JTree</code> for which this delegate + * object provides the user interface. + * + * @param path the path whose label extent is requested. + * + * @return a rectangle enclosing the label, or <code>null</code> + * if <code>path</code> contains invalid nodes. + */ + public Rectangle getPathBounds(JTree tree, TreePath path) + { + return null; // FIXME: not implemented + } + + + /** + * Creates a <code>TreePath</code> for the specified row. + * + * @param tree the <code>JTree</code> for which this delegate + * object provides the user interface. + * + * @param row the index of the row, which should be a number + * in the range <code>[0, getRowCount(tree) - 1]</code>. + * + * @return a <code>TreePath</code> for the specified row, or + * <code>null</code> if <code>row</code> is outside + * the valid range. + */ + public TreePath getPathForRow(JTree tree, int row) + { + return null; // FIXME: not implemented + } + + + /** + * Determines in which row a <code>TreePath</code> is currently + * being displayed. + * + * @param tree the <code>JTree</code> for which this delegate + * object provides the user interface. + * + * @param path the path for which the caller wants to know + * in which row it is being displayed. + * + * @return a number in the range <code>[0, getRowCount(tree) + * - 1]</code> if the path is currently on display; + * <code>-1</code> if the path is not shown to the + * user. + */ + public int getRowForPath(JTree tree, TreePath path) + { + return -1; // FIXME: not implemented + } + + + /** + * Counts how many rows are currently displayed. + * + * @param tree the <code>JTree</code> for which this delegate + * object provides the user interface. + * + * @return the number of visible rows. + */ + public int getRowCount(JTree tree) + { + return 0; // FIXME: not implemented + } + + + /** + * Finds the path that is closest to the specified position. + * + * <p><img src="../TreeUI-1.png" width="300" height="250" + * alt="[A screen shot of a JTree] /> + * + * <p>As shown by the above illustration, the bounds of the + * closest path do not necessarily need to contain the passed + * location. + * + * @param tree the <code>JTree</code> for which this delegate + * object provides the user interface. + * + * @param x the horizontal location, relative to the origin + * of <code>tree</code>. + * + * @param y the vertical location, relative to the origin + * of <code>tree</code>. + * + * @return the closest path, or <code>null</code> if the + * tree is currenlty not displaying any paths at all. + */ + public TreePath getClosestPathForLocation(JTree tree, + int x, int y) + { + return null; // FIXME: not implemented + } + + + /** + * Determines whether the user is currently editing a tree cell. + * + * @param tree the <code>JTree</code> for which this delegate + * object provides the user interface. + * + * @see #getEditingPath + */ + public boolean isEditing(JTree tree) + { + return false; // FIXME: not implemented + } + + + /** + * Stops editing a tree cell, committing the entered value into the + * tree’s model. If no editing session is active, or if the + * active editor does not agree to stopping, nothing happens. In + * some look and feels, this action happens when the user has + * pressed the enter key. + * + * @param tree the <code>JTree</code> for which this delegate + * object provides the user interface. + * + * @return <code>false</code> if the editing still goes on because + * the cell editor has objected to stopping the session; + * <code>true</code> if editing has been stopped. + */ + public boolean stopEditing(JTree tree) + { + return true; // FIXME: not implemented + } + + + /** + * Cancels editing a tree cell, discarding any entered value. + * If no editing session is active, nothing happens. The cell + * editor is not given an opportunity to veto the canceling. + * In some look and feels, this action happens when the user has + * pressed the escape key. + * + * @param tree the <code>JTree</code> for which this delegate + * object provides the user interface. + */ + public void cancelEditing(JTree tree) + { + // FIXME: not implemented + } + + + /** + * Starts a session to edit a tree cell. If the cell editor + * rejects editing the cell, it will just be selected. + * + * @param tree the <code>JTree</code> for which this delegate + * object provides the user interface. + * + * @param path the cell to edit. + */ + public void startEditingAtPath(JTree tree, TreePath path) + { + // FIXME: not implemented + } + + + /** + * Retrieves the tree cell that is currently being edited. + * + * @return the currently edited path, or <code>null</code> + * if no editing session is currently active. + */ + public TreePath getEditingPath(JTree tree) + { + return null; // FIXME: not implemented + } } |
