JSR-209 (Final Release)

javax.microedition.plaf
Interface TreeUI


public interface TreeUI

Pluggable look and feel interface for JTree.


Method Summary
 void cancelEditing(JTree tree)
          Cancels the current editing session.
 TreePath getClosestPathForLocation(JTree tree, int x, int y)
          Returns the path to the node that is closest to x,y.
 TreePath getEditingPath(JTree tree)
          Returns the path to the element that is being edited.
 Rectangle getPathBounds(JTree tree, TreePath path)
          Returns the Rectangle enclosing the label portion that the last item in path will be drawn into.
 TreePath getPathForRow(JTree tree, int row)
          Returns the path for passed in row.
 int getRowCount(JTree tree)
          Returns the number of rows that are being displayed.
 int getRowForPath(JTree tree, TreePath path)
          Returns the row that the last item identified in path is visible at.
 boolean isEditing(JTree tree)
          Returns true if the tree is being edited.
 void startEditingAtPath(JTree tree, TreePath path)
          Selects the last item in path and tries to edit it.
 boolean stopEditing(JTree tree)
          Stops the current editing session.
 

Method Detail

getPathBounds

public Rectangle getPathBounds(JTree tree,
                               TreePath path)
Returns the Rectangle enclosing the label portion that the last item in path will be drawn into. Will return null if any component in path is currently valid.


getPathForRow

public TreePath getPathForRow(JTree tree,
                              int row)
Returns the path for passed in row. If row is not visible null is returned.


getRowForPath

public int getRowForPath(JTree tree,
                         TreePath path)
Returns the row that the last item identified in path is visible at. Will return -1 if any of the elements in path are not currently visible.


getRowCount

public int getRowCount(JTree tree)
Returns the number of rows that are being displayed.


getClosestPathForLocation

public TreePath getClosestPathForLocation(JTree tree,
                                          int x,
                                          int y)
Returns the path to the node that is closest to x,y. If there is nothing currently visible this will return null, otherwise it'll always return a valid path. If you need to test if the returned object is exactly at x, y you should get the bounds for the returned path and test x, y against that.


isEditing

public boolean isEditing(JTree tree)
Returns true if the tree is being edited. The item that is being edited can be returned by getEditingPath().


stopEditing

public boolean stopEditing(JTree tree)
Stops the current editing session. This has no effect if the tree isn't being edited. Returns true if the editor allows the editing session to stop.


cancelEditing

public void cancelEditing(JTree tree)
Cancels the current editing session. This has no effect if the tree isn't being edited. Returns true if the editor allows the editing session to stop.


startEditingAtPath

public void startEditingAtPath(JTree tree,
                               TreePath path)
Selects the last item in path and tries to edit it. Editing will fail if the CellEditor won't allow it for the selected item.


getEditingPath

public TreePath getEditingPath(JTree tree)
Returns the path to the element that is being edited.


JSR-209 (Final Release)

Java and Java 2D are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries.
Copyright 1993 - 2006 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, California 95054, U.S.A. All Rights Reserved.
Use of this specification is subject to this license.