This patch (committed) adds API doc comments to a couple of interfaces:
2006-03-11 David Gilbert <[EMAIL PROTECTED]>
* javax/swing/tree/TreeCellEditor.java: Added API docs,
* javax/swing/tree/TreeCellRenderer.java: Likewise.
Regards,
Dave
Index: javax/swing/tree/TreeCellEditor.java
===================================================================
RCS file: /sources/classpath/classpath/javax/swing/tree/TreeCellEditor.java,v
retrieving revision 1.8
diff -u -r1.8 TreeCellEditor.java
--- javax/swing/tree/TreeCellEditor.java 2 Jul 2005 20:32:52 -0000
1.8
+++ javax/swing/tree/TreeCellEditor.java 11 Mar 2006 06:13:55 -0000
@@ -1,5 +1,5 @@
/* TreeCellEditor.java --
- Copyright (C) 2002, 2004 Free Software Foundation, Inc.
+ Copyright (C) 2002, 2004, 2006, Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -44,20 +44,26 @@
import javax.swing.JTree;
/**
- * TreeCellEditor public interface
+ * A <code>TreeCellEditor</code> is used by the [EMAIL PROTECTED] JTree}
component to
+ * edit individual tree elements (nodes).
+ *
* @author Andrew Selkirk
*/
public interface TreeCellEditor extends CellEditor
{
/**
- * getTreeCellEditorComponent
- * @param tree TODO
- * @param value TODO
- * @param isSelected TODO
- * @param expanded TODO
- * @param leaf TODO
- * @param row TODO
- * @return TODO
+ * Returns a component that has been configured to edit one element (or
+ * node) in a [EMAIL PROTECTED] JTree} component. The arguments to this
method are used
+ * to pass in the value and state of the element to be edited.
+ *
+ * @param tree the tree.
+ * @param value the value to render.
+ * @param isSelected is the tree element selected?
+ * @param expanded is the tree element expanded?
+ * @param leaf is the tree element a leaf node?
+ * @param row the row index.
+ *
+ * @return A component that is configured for editing the tree element.
*/
Component getTreeCellEditorComponent(JTree tree, Object value,
boolean isSelected, boolean expanded,
Index: javax/swing/tree/TreeCellRenderer.java
===================================================================
RCS file: /sources/classpath/classpath/javax/swing/tree/TreeCellRenderer.java,v
retrieving revision 1.5
diff -u -r1.5 TreeCellRenderer.java
--- javax/swing/tree/TreeCellRenderer.java 19 Oct 2005 15:03:15 -0000
1.5
+++ javax/swing/tree/TreeCellRenderer.java 11 Mar 2006 06:13:55 -0000
@@ -1,5 +1,5 @@
/* TreeCellRenderer.java --
- Copyright (C) 2002, 2004 Free Software Foundation, Inc.
+ Copyright (C) 2002, 2004, 2006, Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -43,27 +43,31 @@
import javax.swing.JTree;
/**
- * TreeCellRenderer public interface
+ * A <code>TreeCellRenderer</code> is used by the [EMAIL PROTECTED] JTree}
component to
+ * paint individual tree elements (nodes).
+ *
* @author Andrew Selkirk
*/
public interface TreeCellRenderer
{
-
/**
- * getTreeCellRendererComponent
- * @param tree TODO
- * @param value TODO
- * @param selected TODO
- * @param expanded TODO
- * @param leaf TODO
- * @param row TODO
- * @param hasFocus TODO
- * @returns TODO
+ * Returns a component that has been configured to display one element (or
+ * node) in a [EMAIL PROTECTED] JTree} component. The arguments to this
method are used
+ * to pass in the value and state of the element to be rendered.
+ *
+ * @param tree the tree.
+ * @param value the value to render.
+ * @param selected is the tree element selected?
+ * @param expanded is the tree element expanded?
+ * @param leaf is the tree element a leaf node?
+ * @param row the row index.
+ * @param hasFocus does the tree element have the focus?
+ *
+ * @return A component that is configured for rendering the tree element.
*/
Component getTreeCellRendererComponent(JTree tree, Object value,
boolean selected, boolean expanded,
boolean leaf, int row,
boolean hasFocus);
-
}
