svn commit: r783141 - in /incubator/click/trunk/click/framework/src/org/apache/click: Control.java Page.java

[sa...@apache.org]

Author: sabob
Date: Tue Jun  9 21:17:22 2009
New Revision: 783141

URL: http://svn.apache.org/viewvc?rev=783141&view=rev
Log:
javadoc

Modified:
    incubator/click/trunk/click/framework/src/org/apache/click/Control.java
    incubator/click/trunk/click/framework/src/org/apache/click/Page.java

Modified: incubator/click/trunk/click/framework/src/org/apache/click/Control.java
URL: http://svn.apache.org/viewvc/incubator/click/trunk/click/framework/src/org/apache/click/Control.java?rev=783141&r1=783140&r2=783141&view=diff
==============================================================================
--- incubator/click/trunk/click/framework/src/org/apache/click/Control.java (original)
+++ incubator/click/trunk/click/framework/src/org/apache/click/Control.java Tue Jun  9 21:17:22 2009
@@ -214,6 +214,10 @@
      *     }
      * } </pre>
      *
+     * The above approach is safe to use with controls added to <tt>stateful</tt>
+     * pages since the HEAD elements are only added to the list once, when the
+     * method is invoked the first time.
+     * <p/>
      * Alternatively one can add the HEAD elements in the Control's constructor:
      *
      * <pre class="prettyprint">
@@ -233,7 +237,7 @@
      * {@link #onInit()}, {@link #onProcess()}, {@link #onRender()}
      * etc.
      * <p/>
-     * <b>Please note:</b> when adding HEAD elements to event handlers,
+     * <b>Please note:</b> when adding HEAD elements from event handlers,
      * its possible that the control will be added to a
      * {@link Page#stateful Stateful} page, so you will need to set the HEAD
      * elements list to <tt>null</tt> in the Control's {@link #onDestroy()}

Modified: incubator/click/trunk/click/framework/src/org/apache/click/Page.java
URL: http://svn.apache.org/viewvc/incubator/click/trunk/click/framework/src/org/apache/click/Page.java?rev=783141&r1=783140&r2=783141&view=diff
==============================================================================
--- incubator/click/trunk/click/framework/src/org/apache/click/Page.java (original)
+++ incubator/click/trunk/click/framework/src/org/apache/click/Page.java Tue Jun  9 21:17:22 2009
@@ -696,6 +696,10 @@
      *     }
      * } </pre>
      *
+     * The above approach can safely be used with <tt>stateful</tt> pages since
+     * the HEAD elements are only added to the list once, when the method is
+     * invoked the first time.
+     * <p/>
      * Alternatively one can add the HEAD elements in the Page constructor:
      *
      * <pre class="prettyprint">
@@ -714,10 +718,10 @@
      * {@link #onInit()}, {@link #onGet()}, {@link #onPost()}, {@link #onRender()}
      * etc.
      * <p/>
-     * <b>Please note:</b> when using {@link #stateful Stateful} pages, you
-     * will need to set the HEAD elements list to <tt>null</tt> in the
-     * {@link #onDestroy()} event handler, otherwise the HEAD elements list will
-     * continue to grow with each request:
+     * <b>Please note:</b> when adding HEAD elements from event handlers on
+     * {@link #stateful Stateful} pages, you will need to set the HEAD elements
+     * list to <tt>null</tt> in the {@link #onDestroy()} event handler,
+     * otherwise the HEAD elements list will continue to grow with each request:
      *
      * <pre class="prettyprint">
      * public MyPage extends Page {