<Swing Dev> question on some swing docs

Steve Sides steve.sides at oracle.com
Thu Jun 5 17:15:49 UTC 2014


While adding @param and @return to various swing files, I came across 
this. The javadoc descriptions for 
javax.swing.plaf.TreeUI.getPathBounds() and 
javax.swing.plaf.basic.BasicTreeUI.getPathBounds()  have stated it 
returns null "if any component in path is currently valid".  Is that right?

The getPathBounds() in BasicTreeUI returns null if tree or treeState is 
null.  Should it be l "if any component in path is currently *invalid*"?
Since I essentially parrot this in the @return tag statement for 
TreeUI.getPathBound() , I'd rather make sure it 's correct in the first 
revision.

thanks for any help,

-steve

http://jre.us.oracle.com/java/re/jdk/9/promoted/latest/docs/api/javax/swing/plaf/TreeUI.html#getPathBounds-javax.swing.JTree-javax.swing.tree.TreePath-

  *


            getPathBounds

    public abstractRectangle  <http://jre.us.oracle.com/java/re/jdk/9/promoted/latest/docs/api/java/awt/Rectangle.html>  getPathBounds(JTree  <http://jre.us.oracle.com/java/re/jdk/9/promoted/latest/docs/api/javax/swing/JTree.html>  tree,
                                             TreePath  <http://jre.us.oracle.com/java/re/jdk/9/promoted/latest/docs/api/javax/swing/tree/TreePath.html>  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.



http://jre.us.oracle.com/java/re/jdk/9/promoted/latest/docs/api/javax/swing/plaf/basic/BasicTreeUI.html#getPathBounds-javax.swing.JTree-javax.swing.tree.TreePath-

  *


            getPathBounds

    publicRectangle  <http://jre.us.oracle.com/java/re/jdk/9/promoted/latest/docs/api/java/awt/Rectangle.html>  getPathBounds(JTree  <http://jre.us.oracle.com/java/re/jdk/9/promoted/latest/docs/api/javax/swing/JTree.html>  tree,
                                    TreePath  <http://jre.us.oracle.com/java/re/jdk/9/promoted/latest/docs/api/javax/swing/tree/TreePath.html>  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.

    Specified by:
        |getPathBounds
        <http://jre.us.oracle.com/java/re/jdk/9/promoted/latest/docs/api/javax/swing/plaf/TreeUI.html#getPathBounds-javax.swing.JTree-javax.swing.tree.TreePath->| in
        class |TreeUI
        <http://jre.us.oracle.com/java/re/jdk/9/promoted/latest/docs/api/javax/swing/plaf/TreeUI.html>|









-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.openjdk.java.net/pipermail/swing-dev/attachments/20140605/741963f9/attachment.html>


More information about the swing-dev mailing list