svn commit: r564754 - /wicket/trunk/jdk-1.4/wicket-extensions/src/main/java/org/apache/wicket/extensions/ajax/markup/html/autocomplete/IAutoCompleteRenderer.java

[iv...@apache.org]

Author: ivaynberg
Date: Fri Aug 10 13:32:40 2007
New Revision: 564754

URL: http://svn.apache.org/viewvc?view=rev&rev=564754
Log:
WICKET-818 javadoc

Modified:
    wicket/trunk/jdk-1.4/wicket-extensions/src/main/java/org/apache/wicket/extensions/ajax/markup/html/autocomplete/IAutoCompleteRenderer.java

Modified: wicket/trunk/jdk-1.4/wicket-extensions/src/main/java/org/apache/wicket/extensions/ajax/markup/html/autocomplete/IAutoCompleteRenderer.java
URL: http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket-extensions/src/main/java/org/apache/wicket/extensions/ajax/markup/html/autocomplete/IAutoCompleteRenderer.java?view=diff&rev=564754&r1=564753&r2=564754
==============================================================================
--- wicket/trunk/jdk-1.4/wicket-extensions/src/main/java/org/apache/wicket/extensions/ajax/markup/html/autocomplete/IAutoCompleteRenderer.java (original)
+++ wicket/trunk/jdk-1.4/wicket-extensions/src/main/java/org/apache/wicket/extensions/ajax/markup/html/autocomplete/IAutoCompleteRenderer.java Fri Aug 10 13:32:40 2007
@@ -22,29 +22,37 @@
 /**
  * A renderer used to generate html output for the {@link AutoCompleteBehavior}.
  * <p>
- * Helper implementations of this interface may abstract the implementation specific
- * details. Direct implementations of this interface should only be used when
- * total control is required.
+ * Helper implementations of this interface may abstract the implementation
+ * specific details. Direct implementations of this interface should only be
+ * used when total control is required.
  * <p>
- * The autocompletion value is supplied via an attribute on the first html element
- * named <code>textvalue</code>, if no attribute is found the innerHtml property
- * of the first element will be used instead.
+ * The autocompletion value is supplied via an attribute on the first html
+ * element named <code>textvalue</code>, if no attribute is found the
+ * innerHtml property of the first element will be used instead.
  * 
  * For example:
  * 
  * <pre>
  * new IAutoCompleteRenderer() {
- *     void renderHead(Response r) { r.write("<ul>"); }
+ *     void renderHead(Response r) { r.write(&quot;
+ * <ul>
+ * &quot;); }
  *     
  *     void render(Object o, Response r) {
  *        // notice the textvalue attribute we define for li element
- *        r.write("<li textvalue=\""+o.toString()+"\"><i>"+o.toString()+"</i></li>";
+ *        r.write(&quot;
+ * <li textvalue=\""+o.toString()+"\">
+ * &lt;i&gt;&quot;+o.toString()+&quot;&lt;/i&gt;
+ * </li>
+ * &quot;;
  *     }
  *     
- *     void renderFooter(Response r) { r.write("</ul>"); }
+ *     void renderFooter(Response r) { r.write(&quot;
+ * </ul>
+ * &quot;); }
  * }
  * </pre>
- *     
+ * 
  * @since 1.2
  * 
  * @author Igor Vaynberg (ivaynberg)
@@ -60,21 +68,25 @@
 	 * @param object
 	 *            completion choice object
 	 * @param response
-	 * @param criteria 
+	 *            response object
+	 * @param criteria
+	 *            text entered by user so far
 	 */
 	void render(Object object, Response response, String criteria);
 
 
 	/**
-	 * Render the html header fragment for the completion. Usually the
-	 * html is written out by calling {@link Response#write(CharSequence)}.
+	 * Render the html header fragment for the completion. Usually the html is
+	 * written out by calling {@link Response#write(CharSequence)}.
+	 * 
 	 * @param response
 	 */
 	void renderHeader(Response response);
 
 	/**
-	 * Render the html footer fragment for the completion. Usually the
-	 * html is written out by calling {@link Response#write(CharSequence)}.
+	 * Render the html footer fragment for the completion. Usually the html is
+	 * written out by calling {@link Response#write(CharSequence)}.
+	 * 
 	 * @param response
 	 */
 	void renderFooter(Response response);