svn commit: r588217 - /myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/component/dynaForm/DynaForm.java

[sk...@apache.org]

Author: skitching
Date: Thu Oct 25 05:40:54 2007
New Revision: 588217

URL: http://svn.apache.org/viewvc?rev=588217&view=rev
Log:
More docs.

Modified:
    myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/component/dynaForm/DynaForm.java

Modified: myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/component/dynaForm/DynaForm.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/component/dynaForm/DynaForm.java?rev=588217&r1=588216&r2=588217&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/component/dynaForm/DynaForm.java (original)
+++ myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/component/dynaForm/DynaForm.java Thu Oct 25 05:40:54 2007
@@ -60,6 +60,10 @@
  * <li>exclusiveFields: {@link #setUri(String)}
  * <li>idAsDisplayOnly: {@link #setIdAsDisplayOnly(String)}
  * </ul>
+ * <p>
+ * Note that this class has no Renderer; this class dynamically modifies the component
+ * tree to add components, but has no actual representation itself and therefore needs
+ * no renderer. See method initView.
  */
 public class DynaForm extends UIComponentBase
 {
@@ -507,6 +511,16 @@
 		return false;
 	}
 
+	/**
+	 * Dynamically compute and add child components to the current tree.
+	 * <p>
+	 * This method is required to be invoked from the TagHandler when an instance of
+	 * this component is created. Components are created based upon the class specified
+	 * by the "uri" property, and added as children of the parent component of this component.
+	 * <p>
+	 * This component itself never has any components, and never generates any output
+	 * into the response stream.
+	 */
 	public void initView(FacesContext context)
 	{
 		UIComponent layoutComponent = getParent();
@@ -577,7 +591,10 @@
 	}
 
 	/**
-	 * create and add the components to the layout component
+	 * create and add the components to the layout component.
+	 * 
+	 * TODO: clean this method up. It still had artefacts from when this code was in a separate
+	 * Renderer class.
 	 */
 	protected void addComponents(final FacesContext context,
 								 final DynaForm dynaForm, final UIComponent layoutComponent,