svn commit: r475143 - /incubator/wicket/trunk/wicket/src/main/java/wicket/markup/html/list/ListView.java

[ivaynberg]

Author: ivaynberg
Date: Tue Nov 14 23:31:19 2006
New Revision: 475143

URL: http://svn.apache.org/viewvc?view=rev&rev=475143
Log:
WICKET-71: javadoc patch

Modified:
    
incubator/wicket/trunk/wicket/src/main/java/wicket/markup/html/list/ListView.java

Modified: 
incubator/wicket/trunk/wicket/src/main/java/wicket/markup/html/list/ListView.java
URL: 
http://svn.apache.org/viewvc/incubator/wicket/trunk/wicket/src/main/java/wicket/markup/html/list/ListView.java?view=diff&rev=475143&r1=475142&r2=475143
==============================================================================
--- 
incubator/wicket/trunk/wicket/src/main/java/wicket/markup/html/list/ListView.java
 (original)
+++ 
incubator/wicket/trunk/wicket/src/main/java/wicket/markup/html/list/ListView.java
 Tue Nov 14 23:31:19 2006
@@ -36,10 +36,10 @@
  * Example:
  * 
  * <pre>
- * &lt;tbody&gt;
- *   &lt;tr wicket:id=&quot;rows&quot; class=&quot;even&quot;&gt;
- *   &lt;td&gt;&lt;span wicket:id=&quot;id&quot;&gt;Test 
ID&lt;/span&gt;&lt;/td&gt;
- * ...    
+ *  &lt;tbody&gt;
+ *    &lt;tr wicket:id=&quot;rows&quot; class=&quot;even&quot;&gt;
+ *    &lt;td&gt;&lt;span wicket:id=&quot;id&quot;&gt;Test 
ID&lt;/span&gt;&lt;/td&gt;
+ *  ...    
  * </pre>
  * 
  * <p>
@@ -60,6 +60,18 @@
  * </pre>
  * 
  * <p>
+ * <strong>NOTE:</strong>
+ * 
+ * When you want to change the default generated markup it is important to
+ * realise that the ListView instance itself does not correspond to any markup,
+ * however, the generated ListItems do.<br/>
+ * 
+ * This means that methods like [EMAIL PROTECTED] #setRenderBodyOnly(boolean)} 
and
+ * [EMAIL PROTECTED] #add(wicket.behavior.IBehavior)} should be invoked on the
+ * [EMAIL PROTECTED] ListItem} that is given in [EMAIL PROTECTED] 
#populateItem(ListItem)} method.
+ * </p>
+ * 
+ * <p>
  * WARNING: though you can nest ListViews within Forms, you HAVE to set the
  * setReuseItems property to true in order to have validation work properly. By
  * default, reuseItems is false, which has the effect that ListView replaces 
all
@@ -613,7 +625,7 @@
                                renderItem(item);
                        }
                }
-               
+
                markupStream.skipComponent();
        }