click-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sa...@apache.org
Subject svn commit: r956320 - /click/trunk/click/extras/src/org/apache/click/extras/control/AbstractContainerField.java
Date Sun, 20 Jun 2010 06:14:03 GMT
Author: sabob
Date: Sun Jun 20 06:14:03 2010
New Revision: 956320

URL: http://svn.apache.org/viewvc?rev=956320&view=rev
Log:
javadoc

Modified:
    click/trunk/click/extras/src/org/apache/click/extras/control/AbstractContainerField.java

Modified: click/trunk/click/extras/src/org/apache/click/extras/control/AbstractContainerField.java
URL: http://svn.apache.org/viewvc/click/trunk/click/extras/src/org/apache/click/extras/control/AbstractContainerField.java?rev=956320&r1=956319&r2=956320&view=diff
==============================================================================
--- click/trunk/click/extras/src/org/apache/click/extras/control/AbstractContainerField.java
(original)
+++ click/trunk/click/extras/src/org/apache/click/extras/control/AbstractContainerField.java
Sun Jun 20 06:14:03 2010
@@ -33,15 +33,17 @@ import org.apache.click.util.HtmlStringB
 /**
  * Provides an abstract convenience class that implements Container and extend Field.
  * <p/>
- * If you need to bind a request parameter to this field's value, please see
- * {@link #bindRequestValue()}.
+ * This control is only rarely used or necessary. The primary use case is for
+ * creating custom Containers that will be treated as {@link org.apache.click.control.Field}
+ * instances by the {@link org.apache.click.control.Form}.
  * <p/>
- * Here is an example of a Border Control that can wrap a Button and render
- * a <tt>div</tt> border around it.
+ * Here is an example of a FieldBorder which wraps Fields in a
+ * <tt>&lt;div&gt;</tt> element. The FieldBorder container can be passed
to the
+ * Form and will be treated as a normal Field.
  *
  * <pre class="prettyprint">
- * public class ButtonBorder extends AbstractContainerField {
- *     public ButtonBorder(String name) {
+ * public class FieldBorder extends AbstractContainerField {
+ *     public FieldBorder(String name) {
  *         super(name);
  *     }
  *
@@ -49,10 +51,13 @@ import org.apache.click.util.HtmlStringB
  *         return "div";
  *     }
  *
- *     public Control add(Button button) {
- *         return getContainer().add(button);
+ *     public Control add(Field field) {
+ *         return getContainer().add(field);
  *     }
  * } </pre>
+ *
+ * If you need to bind a request parameter to this field value, please see
+ * {@link #bindRequestValue()}.
  */
 public abstract class AbstractContainerField extends Field implements Container {
 



Mime
View raw message