tapestry-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From andy...@apache.org
Subject svn commit: r432203 - /tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/form/AbstractFormComponent.java
Date Thu, 17 Aug 2006 10:51:55 GMT
Author: andyhot
Date: Thu Aug 17 03:51:54 2006
New Revision: 432203

URL: http://svn.apache.org/viewvc?rev=432203&view=rev
Log:
TAPESTRY-762: Improve docs regarding renderFormComponent and rewindFormComponent. 

Modified:
    tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/form/AbstractFormComponent.java

Modified: tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/form/AbstractFormComponent.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/form/AbstractFormComponent.java?rev=432203&r1=432202&r2=432203&view=diff
==============================================================================
--- tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/form/AbstractFormComponent.java
(original)
+++ tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/form/AbstractFormComponent.java
Thu Aug 17 03:51:54 2006
@@ -85,6 +85,14 @@
     }
 
     /**
+     * Invoked by {@link AbstractComponent#render(IMarkupWriter, IRequestCycle)} to actually

+     * render the component (with any parameter values already set). 
+     * This implementation checks the rewinding state of the {@link IForm} that contains
the
+     * component and forwards processing to either 
+     * {@link #renderFormComponent(IMarkupWriter, IRequestCycle)} or 
+     * {@link #rewindFormComponent(IMarkupWriter, IRequestCycle)}. 
+     * Those two are the methods that subclasses should implement. 
+     *  
      * @see org.apache.tapestry.AbstractComponent#renderComponent(org.apache.tapestry.IMarkupWriter,
      *      org.apache.tapestry.IRequestCycle)
      */
@@ -180,9 +188,19 @@
         return false;
     }
 
+    /**
+     * Invoked from {@link #renderComponent(IMarkupWriter, IRequestCycle)} 
+     * to render the component. 
+     *  
+     * @param writer
+     * @param cycle
+     */
     protected abstract void renderFormComponent(IMarkupWriter writer, IRequestCycle cycle);
 
     /**
+     * Invoked from {@link #renderComponent(IMarkupWriter, IRequestCycle)} to rewind the

+     * component. If the component is {@link IFormComponent#isDisabled() disabled} 
+     * this will not be invoked. 
      * 
      * @param writer
      * @param cycle



Mime
View raw message