svn commit: r178503 - /incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeHelpers.java /incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeRootElement.java

[ri...@apache.org]

Author: rich
Date: Wed May 25 11:27:21 2005
New Revision: 178503

URL: http://svn.apache.org/viewcvs?rev=178503&view=rev
Log:
This is a javadoc-only contribution from Carlin Rogers to address the documentation side of http://issues.apache.org/jira/browse/BEEHIVE-760 : selected tree item getting set after the selectionAction is run.

tests: bvt in netui (WinXP)
BB: self (linux)


Modified:
    incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeHelpers.java
    incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeRootElement.java

Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeHelpers.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeHelpers.java?rev=178503&r1=178502&r2=178503&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeHelpers.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeHelpers.java Wed May 25 11:27:21 2005
@@ -105,6 +105,13 @@
 
     /**
      * This will return the currently selected node from a tree.
+     *
+     * <p>Implementation Note: The method that changes the selected node based on the request,
+     * {@link #processTreeRequest(String, TreeElement, HttpServletRequest, HttpServletResponse)},
+     * gets called during the processing of the {@link Tree} tag within a JSP. If the
+     * <code>findSelected</code> method is called from an Action in a Page Flow Controller,
+     * the value of the selected node will have not yet been updated.</p>
+     *
      * @param root the root element of the tree.
      * @return a TreeElement that is the currently selected node.  This may return null.
      */

Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeRootElement.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeRootElement.java?rev=178503&r1=178502&r2=178503&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeRootElement.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeRootElement.java Wed May 25 11:27:21 2005
@@ -65,6 +65,13 @@
     /**
      * Return the currently selected <code>TreeElement</code>.  This method
      * will return null if no element is currently selected.
+     *
+     * <p>Implementation Note: The method that changes the selected node based on the request,
+     * {@link TreeHelpers#processTreeRequest(String, TreeElement, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)},
+     * gets called during the processing of the {@link Tree} tag within a JSP. If the
+     * <code>getSelectedNode</code> method is called from an Action in a Page Flow Controller,
+     * the value of the selected node will have not yet been updated.</p>
+     *
      * @return the currently selected node.
      */
     public TreeElement getSelectedNode()