svn commit: r1204716 - in /myfaces/trinidad/trunk: trinidad-api/src/main/java/org/apache/myfaces/trinidad/context/ trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/trinidad/html/

[ar...@apache.org]

Author: arobinson74
Date: Mon Nov 21 21:33:50 2011
New Revision: 1204716

URL: http://svn.apache.org/viewvc?rev=1204716&view=rev
Log:
TRINIDAD-2168 - document when the component context manager is suspended in the framework

Modified:
    myfaces/trinidad/trunk/trinidad-api/src/main/java/org/apache/myfaces/trinidad/context/ComponentContextManager.java
    myfaces/trinidad/trunk/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/trinidad/html/HtmlBody.xml
    myfaces/trinidad/trunk/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/trinidad/html/HtmlHead.xml

Modified: myfaces/trinidad/trunk/trinidad-api/src/main/java/org/apache/myfaces/trinidad/context/ComponentContextManager.java
URL: http://svn.apache.org/viewvc/myfaces/trinidad/trunk/trinidad-api/src/main/java/org/apache/myfaces/trinidad/context/ComponentContextManager.java?rev=1204716&r1=1204715&r2=1204716&view=diff
==============================================================================
--- myfaces/trinidad/trunk/trinidad-api/src/main/java/org/apache/myfaces/trinidad/context/ComponentContextManager.java (original)
+++ myfaces/trinidad/trunk/trinidad-api/src/main/java/org/apache/myfaces/trinidad/context/ComponentContextManager.java Mon Nov 21 21:33:50 2011
@@ -35,6 +35,9 @@ import javax.faces.context.FacesContext;
  * while the table is iterating. By saving off these variables and restoring them, the EL will
  * be correct should code perform an invoke on component or visit tree call, reentering the
  * component tree from the view root.</p>
+ * <p>The changes are automatically suspended during an invoke on component or visit tree
+ * invocation. This work is performed by the trh:head, trh:body and the tr:document components.
+ * Components outside of these components are not restore to the root context.</p>
  */
 public abstract class ComponentContextManager
 {

Modified: myfaces/trinidad/trunk/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/trinidad/html/HtmlBody.xml
URL: http://svn.apache.org/viewvc/myfaces/trinidad/trunk/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/trinidad/html/HtmlBody.xml?rev=1204716&r1=1204715&r2=1204716&view=diff
==============================================================================
--- myfaces/trinidad/trunk/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/trinidad/html/HtmlBody.xml (original)
+++ myfaces/trinidad/trunk/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/trinidad/html/HtmlBody.xml Mon Nov 21 21:33:50 2011
@@ -264,7 +264,12 @@
 to providing support for the standard HTML body functionality,
 the Trinidad body component enables partial-page rendering (PPR) support
 and assigning initial page focus.
-          </html:p>]]>
+          </html:p>
+<html:p>
+  The body component resets the Trinidad EL context when code re-enters the component via
+  an invoke on component call or a visit tree call. See the
+  org.apache.myfaces.trinidad.context.ComponentContextManager for more information.
+</html:p>]]>
       </mfp:long-description>
       <mfp:example>
         <mfp:source-code>

Modified: myfaces/trinidad/trunk/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/trinidad/html/HtmlHead.xml
URL: http://svn.apache.org/viewvc/myfaces/trinidad/trunk/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/trinidad/html/HtmlHead.xml?rev=1204716&r1=1204715&r2=1204716&view=diff
==============================================================================
--- myfaces/trinidad/trunk/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/trinidad/html/HtmlHead.xml (original)
+++ myfaces/trinidad/trunk/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/trinidad/html/HtmlHead.xml Mon Nov 21 21:33:50 2011
@@ -70,7 +70,12 @@
             current look-and-feel.  Page authors
             that use this do not need to use a styleSheet component, as it
             will automatically be included.
-          </html:p>]]>
+          </html:p>
+<html:p>
+  The head component resets the Trinidad EL context when code re-enters the component via
+  an invoke on component call or a visit tree call. See the
+  org.apache.myfaces.trinidad.context.ComponentContextManager for more information.
+</html:p>]]>
       </mfp:long-description>
       <mfp:example>
         <mfp:source-code>