TreeUI (Java SE 15 & JDK 15) (original) (raw)

Direct Known Subclasses:

[BasicTreeUI](basic/BasicTreeUI.html "class in javax.swing.plaf.basic"), [MultiTreeUI](multi/MultiTreeUI.html "class in javax.swing.plaf.multi")

public abstract class TreeUI extends ComponentUI

Pluggable look and feel interface for JTree.

• Constructor Summary

Constructors

• Method Summary

Methods declared in class javax.swing.plaf.ComponentUI

[contains](ComponentUI.html#contains%28javax.swing.JComponent,int,int%29), [createUI](ComponentUI.html#createUI%28javax.swing.JComponent%29), [getAccessibleChild](ComponentUI.html#getAccessibleChild%28javax.swing.JComponent,int%29), [getAccessibleChildrenCount](ComponentUI.html#getAccessibleChildrenCount%28javax.swing.JComponent%29), [getBaseline](ComponentUI.html#getBaseline%28javax.swing.JComponent,int,int%29), [getBaselineResizeBehavior](ComponentUI.html#getBaselineResizeBehavior%28javax.swing.JComponent%29), [getMaximumSize](ComponentUI.html#getMaximumSize%28javax.swing.JComponent%29), [getMinimumSize](ComponentUI.html#getMinimumSize%28javax.swing.JComponent%29), [getPreferredSize](ComponentUI.html#getPreferredSize%28javax.swing.JComponent%29), [installUI](ComponentUI.html#installUI%28javax.swing.JComponent%29), [paint](ComponentUI.html#paint%28java.awt.Graphics,javax.swing.JComponent%29), [uninstallUI](ComponentUI.html#uninstallUI%28javax.swing.JComponent%29), [update](ComponentUI.html#update%28java.awt.Graphics,javax.swing.JComponent%29)

Methods declared in class java.lang.Object

[clone](../../../../java.base/java/lang/Object.html#clone%28%29), [equals](../../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../../java.base/java/lang/Object.html#finalize%28%29), [getClass](../../../../java.base/java/lang/Object.html#getClass%28%29), [hashCode](../../../../java.base/java/lang/Object.html#hashCode%28%29), [notify](../../../../java.base/java/lang/Object.html#notify%28%29), [notifyAll](../../../../java.base/java/lang/Object.html#notifyAll%28%29), [toString](../../../../java.base/java/lang/Object.html#toString%28%29), [wait](../../../../java.base/java/lang/Object.html#wait%28%29), [wait](../../../../java.base/java/lang/Object.html#wait%28long%29), [wait](../../../../java.base/java/lang/Object.html#wait%28long,int%29)

• Constructor Details

  • TreeUI

  public TreeUI()

• Method Details

  • getPathBounds

  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.
  Parameters:
  tree - the JTree for path
path - the TreePath identifying the node
  Returns:
  the Rectangle enclosing the label portion that the last item in path will be drawn into, null if any component in path is currently valid.

  • getPathForRow

  public abstract TreePath getPathForRow​(JTree tree, int row)
  Returns the path for passed in row. If row is not visible null is returned.
  Parameters:
  tree - a JTree object
  row - an integer specifying a row
  Returns:
  the path for row or null if row is not visible

  • getRowForPath

  public abstract 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.
  Parameters:
  tree - the JTree for path
path - the TreePath object to look in
  Returns:
  an integer specifying the row at which the last item identified is visible, -1 if any of the elements inpath are not currently visible

  • getRowCount

  public abstract int getRowCount​(JTree tree)
  Returns the number of rows that are being displayed.
  Parameters:
  tree - the JTree for which to count rows
  Returns:
  an integer specifying the number of row being displayed

  • getClosestPathForLocation

  public abstract 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.
  Parameters:
  tree - a JTree object
  x - an integer giving the number of pixels horizontally from the left edge of the display area
  y - an integer giving the number of pixels vertically from the top of the display area, minus any top margin
  Returns:
  the TreePath node closest to x,y or null if there is nothing currently visible

  • isEditing

  public abstract boolean isEditing​(JTree tree)
  Returns true if the tree is being edited. The item that is being edited can be returned by getEditingPath().
  Parameters:
  tree - a JTree object
  Returns:
  true if tree is being edited

  • stopEditing

  public abstract 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.
  Parameters:
  tree - a JTree object
  Returns:
  true if the editor allows the editing session to stop

  • cancelEditing

  public abstract void cancelEditing​(JTree tree)
  Cancels the current editing session. This has no effect if the tree isn't being edited.
  Parameters:
  tree - a JTree object

  • startEditingAtPath

  public abstract 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.
  Parameters:
  tree - the JTree being edited
  path - the TreePath to be edited

  • getEditingPath

  Returns the path to the element that is being edited.
  Parameters:
  tree - the JTree for which to return a path
  Returns:
  a TreePath containing the path to tree