Return-Path: Delivered-To: apmail-click-commits-archive@www.apache.org Received: (qmail 46012 invoked from network); 20 Jun 2010 06:14:51 -0000 Received: from unknown (HELO mail.apache.org) (140.211.11.3) by 140.211.11.9 with SMTP; 20 Jun 2010 06:14:51 -0000 Received: (qmail 92282 invoked by uid 500); 20 Jun 2010 06:14:51 -0000 Delivered-To: apmail-click-commits-archive@click.apache.org Received: (qmail 92267 invoked by uid 500); 20 Jun 2010 06:14:50 -0000 Mailing-List: contact commits-help@click.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: click-dev@click.apache.org Delivered-To: mailing list commits@click.apache.org Received: (qmail 92259 invoked by uid 99); 20 Jun 2010 06:14:49 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 20 Jun 2010 06:14:49 +0000 X-ASF-Spam-Status: No, hits=-1809.0 required=10.0 tests=ALL_TRUSTED,AWL X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 20 Jun 2010 06:14:49 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 5A24C238899C; Sun, 20 Jun 2010 06:14:03 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r956320 - /click/trunk/click/extras/src/org/apache/click/extras/control/AbstractContainerField.java Date: Sun, 20 Jun 2010 06:14:03 -0000 To: commits@click.apache.org From: sabob@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20100620061403.5A24C238899C@eris.apache.org> 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. *

- * 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}. *

- * Here is an example of a Border Control that can wrap a Button and render - * a div border around it. + * Here is an example of a FieldBorder which wraps Fields in a + * <div> element. The FieldBorder container can be passed to the + * Form and will be treated as a normal Field. * * 

- * 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);
  *     }
  * }
+ * + * If you need to bind a request parameter to this field value, please see + * {@link #bindRequestValue()}. */ public abstract class AbstractContainerField extends Field implements Container {