svn commit: r489510 - /incubator/adffaces/trunk/trinidad/trinidad-api/src/main/java/org/apache/myfaces/trinidad/component/UIXComponentBase.java

[aw...@apache.org]

Author: awiner
Date: Thu Dec 21 15:50:19 2006
New Revision: 489510

URL: http://svn.apache.org/viewvc?view=rev&rev=489510
Log:
Write a bit of Javadoc for UIXComponentBase

Modified:
    incubator/adffaces/trunk/trinidad/trinidad-api/src/main/java/org/apache/myfaces/trinidad/component/UIXComponentBase.java

Modified: incubator/adffaces/trunk/trinidad/trinidad-api/src/main/java/org/apache/myfaces/trinidad/component/UIXComponentBase.java
URL: http://svn.apache.org/viewvc/incubator/adffaces/trunk/trinidad/trinidad-api/src/main/java/org/apache/myfaces/trinidad/component/UIXComponentBase.java?view=diff&rev=489510&r1=489509&r2=489510
==============================================================================
--- incubator/adffaces/trunk/trinidad/trinidad-api/src/main/java/org/apache/myfaces/trinidad/component/UIXComponentBase.java (original)
+++ incubator/adffaces/trunk/trinidad/trinidad-api/src/main/java/org/apache/myfaces/trinidad/component/UIXComponentBase.java Thu Dec 21 15:50:19 2006
@@ -51,6 +51,31 @@
 
 
 /**
+ * Base implementation of components for all of Trinidad.  UIXComponentBase
+ * offers a number of features not supplied by the standard UIComponentBase
+ * class:
+ * <ul>
+ * <li>Use of FacesBean for better and easier state saving</li>
+ * <li>Support of the LifecycleRenderer class for greater Renderer
+ *  control over the lifecycle</li>
+ * <li>Built-in support for both the "partialTriggers" attribute 
+ *   (declarative support for being a PPR target) and for triggering
+ *   such components (for being a the source of a PPR-causing event).</li>
+ * </ul>
+ * <h3>FacesBean and UIXComponentBase</h3>
+ * <p>
+ * UIXComponentBase differs from UIXComponent most particularly
+ * in its use of FacesBeans to store all state.  This offers
+ * a number of advantages:
+ * <ul>
+ * <li>Subclassers - if they use FacesBean for their state as well -
+ *   do not need to write overrides of saveState() and restoreState().
+ *   </li>
+ * <li>State is optimized by default</li>
+ * <li>Future optimizations - partly exposed today with
+ *    markInitialState() - can offer major state saving improvements.
+ * </ul>
+ * </p>
  * @version $Name:  $ ($Revision: adfrt/faces/adf-faces-api/src/main/java/oracle/adf/view/faces/component/UIXComponentBase.java#0 $) $Date: 11-nov-2005.13:43:35 $
  * @author The Oracle ADF Faces Team
  * @todo Write Class Javadoc