svn commit: r692626 - in /wicket/sandbox/knopp/experimental/wicket/src/main/java/org/apache/wicket/ajaxng: form/AjaxFormComponentUpdatingBehavior.java form/AjaxFormSubmitBehavior.java js/wicket-ajax-ng-base62.js

[kn...@apache.org]

Author: knopp
Date: Sat Sep  6 03:21:29 2008
New Revision: 692626

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

Removed:
    wicket/sandbox/knopp/experimental/wicket/src/main/java/org/apache/wicket/ajaxng/js/wicket-ajax-ng-base62.js
Modified:
    wicket/sandbox/knopp/experimental/wicket/src/main/java/org/apache/wicket/ajaxng/form/AjaxFormComponentUpdatingBehavior.java
    wicket/sandbox/knopp/experimental/wicket/src/main/java/org/apache/wicket/ajaxng/form/AjaxFormSubmitBehavior.java

Modified: wicket/sandbox/knopp/experimental/wicket/src/main/java/org/apache/wicket/ajaxng/form/AjaxFormComponentUpdatingBehavior.java
URL: http://svn.apache.org/viewvc/wicket/sandbox/knopp/experimental/wicket/src/main/java/org/apache/wicket/ajaxng/form/AjaxFormComponentUpdatingBehavior.java?rev=692626&r1=692625&r2=692626&view=diff
==============================================================================
--- wicket/sandbox/knopp/experimental/wicket/src/main/java/org/apache/wicket/ajaxng/form/AjaxFormComponentUpdatingBehavior.java (original)
+++ wicket/sandbox/knopp/experimental/wicket/src/main/java/org/apache/wicket/ajaxng/form/AjaxFormComponentUpdatingBehavior.java Sat Sep  6 03:21:29 2008
@@ -19,20 +19,46 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import javax.swing.text.html.FormView;
-
 import org.apache.wicket.Component;
 import org.apache.wicket.WicketRuntimeException;
+import org.apache.wicket.ajax.form.AjaxFormChoiceComponentUpdatingBehavior;
 import org.apache.wicket.ajaxng.AjaxEventBehavior;
 import org.apache.wicket.ajaxng.AjaxRequestTarget;
 import org.apache.wicket.markup.html.form.Form;
 import org.apache.wicket.markup.html.form.FormComponent;
+import org.apache.wicket.markup.html.form.persistence.IValuePersister;
 import org.apache.wicket.markup.html.form.validation.IFormValidator;
 
+/**
+ * A behavior that updates the hosting {@link FormComponent}(s) via ajax when an event it is
+ * attached to is triggered. This behavior encapsulates the entire form-processing workflow as
+ * relevant only to this component so if validation is successful the component's model will be
+ * updated according to the submitted value.
+ * <p>
+ * NOTE: This behavior does not support persisting form component values into cookie or other
+ * {@link IValuePersister}. If this is necessary please add a request for enhancement.
+ * <p>
+ * NOTE: This behavior only validates {@link IFormValidator}s attached to this form that don't
+ * depend on any form components that are not bound to this behavior.
+ * <p>
+ * NOTE: This behavior does not work on Choices or Groups use the
+ * {@link AjaxFormChoiceComponentUpdatingBehavior} for that.
+ * 
+ * @since 1.2
+ * 
+ * @author Igor Vaynberg (ivaynberg)
+ * @author Matej Knopp
+ */
 public class AjaxFormComponentUpdatingBehavior extends AjaxEventBehavior
 {
 	private static final long serialVersionUID = 1L;
 
+	/**
+	 * Construct.
+	 * 
+	 * @param event
+	 *            event to trigger this behavior
+	 */
 	public AjaxFormComponentUpdatingBehavior(String event)
 	{
 		super(event);
@@ -81,9 +107,9 @@
 	protected Form<?> getForm(List<FormComponent<?>> components)
 	{
 		FormComponent<?> first = components.get(0);
-		return first.getForm();
+		return getForm(first);
 	}
-	
+
 	@Override
 	protected Form<?> getForm(Component component)
 	{

Modified: wicket/sandbox/knopp/experimental/wicket/src/main/java/org/apache/wicket/ajaxng/form/AjaxFormSubmitBehavior.java
URL: http://svn.apache.org/viewvc/wicket/sandbox/knopp/experimental/wicket/src/main/java/org/apache/wicket/ajaxng/form/AjaxFormSubmitBehavior.java?rev=692626&r1=692625&r2=692626&view=diff
==============================================================================
--- wicket/sandbox/knopp/experimental/wicket/src/main/java/org/apache/wicket/ajaxng/form/AjaxFormSubmitBehavior.java (original)
+++ wicket/sandbox/knopp/experimental/wicket/src/main/java/org/apache/wicket/ajaxng/form/AjaxFormSubmitBehavior.java Sat Sep  6 03:21:29 2008
@@ -16,8 +16,6 @@
  */
 package org.apache.wicket.ajaxng.form;
 
-import java.util.Map;
-
 import org.apache.wicket.Component;
 import org.apache.wicket.Page;
 import org.apache.wicket.ajaxng.AjaxEventBehavior;
@@ -27,17 +25,43 @@
 import org.apache.wicket.markup.html.form.IFormSubmittingComponent;
 import org.apache.wicket.markup.html.panel.FeedbackPanel;
 
+/**
+ * Ajax event behavior that submits a form via ajax when the event it is attached to is invoked.
+ * <p>
+ *  
+ * @see AjaxEventBehavior
+ * 
+ * @since 1.2
+ * 
+ * @author Igor Vaynberg (ivaynberg)
+ * 
+ */
 public abstract class AjaxFormSubmitBehavior extends AjaxEventBehavior
 {
 	private static final long serialVersionUID = 1L;
 
 	private Form<?> form;
 
+	/**
+	 * Constructor. This constructor can only be used when the component this behavior is attached
+	 * to is inside a form.
+	 * 
+	 * @param event
+	 *            javascript event this behavior is attached to
+	 */
 	public AjaxFormSubmitBehavior(String event)
 	{
 		this(null, event);
 	}
 
+	/**
+	 * Construct.
+	 * 
+	 * @param form
+	 *            form that will be submitted
+	 * @param event
+	 *            javascript event this behavior is attached to
+	 */
 	public AjaxFormSubmitBehavior(Form<?> form, String event)
 	{
 		super(event);