You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by re...@apache.org on 2024/03/20 01:22:30 UTC
(wicket) 01/01: [WICKET-7101] The label associated with form component should always be rendered when the form component is rendered via AJAX. This way we ensure the state of the label is consistent with form component's state. This introduces a new wicket attribute wicket:auto that controls that auto-label is bound to form component.
This is an automated email from the ASF dual-hosted git repository.
reiern70 pushed a commit to branch bugix/reiern70/WICKET-7101
in repository https://gitbox.apache.org/repos/asf/wicket.git
commit 0d97df028d6db7e764cd0516dc9cd000b5b998f8
Author: reiern70 <re...@gmail.com>
AuthorDate: Thu Mar 14 14:06:58 2024 -0500
[WICKET-7101] The label associated with form component should always be rendered when the form component is rendered via AJAX. This way we ensure the state of the label is consistent with form component's state. This introduces a new wicket attribute wicket:auto that controls that auto-label is bound to form component.
---
.../form/AjaxFormComponentUpdatingBehavior.java | 3 +-
.../wicket/markup/html/form/AutoLabelResolver.java | 28 ++++-
.../org/apache/wicket/markup/html/form/Form.java | 3 +-
.../wicket/markup/html/form/FormComponent.java | 33 ++++-
.../wicket/markup/html/form/AutoLabelTest.java | 136 ++++++++++++++++++++-
5 files changed, 187 insertions(+), 16 deletions(-)
diff --git a/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormComponentUpdatingBehavior.java b/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormComponentUpdatingBehavior.java
index e162048a80..2c3fff1073 100644
--- a/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormComponentUpdatingBehavior.java
+++ b/wicket-core/src/main/java/org/apache/wicket/ajax/form/AjaxFormComponentUpdatingBehavior.java
@@ -25,6 +25,7 @@ import org.apache.wicket.ajax.AjaxEventBehavior;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.ajax.attributes.AjaxRequestAttributes;
import org.apache.wicket.ajax.attributes.AjaxRequestAttributes.Method;
+import org.apache.wicket.core.request.handler.IPartialPageRequestHandler;
import org.apache.wicket.markup.html.form.FormComponent;
import org.apache.wicket.markup.html.form.validation.IFormValidator;
import org.apache.wicket.util.lang.Args;
@@ -157,7 +158,7 @@ public abstract class AjaxFormComponentUpdatingBehavior extends AjaxEventBehavio
{
onError(target, e);
}
- formComponent.updateAutoLabels(target);
+ formComponent.updateAutoLabels((IPartialPageRequestHandler)target, false);
}
/**
diff --git a/wicket-core/src/main/java/org/apache/wicket/markup/html/form/AutoLabelResolver.java b/wicket-core/src/main/java/org/apache/wicket/markup/html/form/AutoLabelResolver.java
index c39addd443..948cea77a3 100644
--- a/wicket-core/src/main/java/org/apache/wicket/markup/html/form/AutoLabelResolver.java
+++ b/wicket-core/src/main/java/org/apache/wicket/markup/html/form/AutoLabelResolver.java
@@ -24,11 +24,13 @@ import org.apache.wicket.MetaDataKey;
import org.apache.wicket.WicketRuntimeException;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.core.request.handler.ComponentNotFoundException;
+import org.apache.wicket.core.request.handler.IPartialPageRequestHandler;
import org.apache.wicket.core.util.string.CssUtils;
import org.apache.wicket.markup.ComponentTag;
import org.apache.wicket.markup.MarkupStream;
import org.apache.wicket.markup.html.TransparentWebMarkupContainer;
import org.apache.wicket.markup.resolver.IComponentResolver;
+import org.apache.wicket.util.string.Strings;
import org.apache.wicket.util.visit.IVisit;
import org.apache.wicket.util.visit.IVisitor;
import org.slf4j.Logger;
@@ -72,7 +74,8 @@ public class AutoLabelResolver implements IComponentResolver
private static final Logger logger = LoggerFactory.getLogger(AutoLabelResolver.class);
static final String WICKET_FOR = ":for";
-
+ static final String WICKET_AUTO = ":auto";
+
public static final String LABEL_ATTR = "label_attr";
public static final String CSS_REQUIRED_KEY = CssUtils.key(AutoLabel.class, "required");
@@ -127,7 +130,8 @@ public class AutoLabelResolver implements IComponentResolver
if (component instanceof FormComponent)
{
- component.setMetaData(MARKER_KEY, new AutoLabelMarker((FormComponent<?>)component));
+ final String auto = tag.getAttribute(getWicketNamespace(markupStream) + WICKET_AUTO);
+ component.setMetaData(MARKER_KEY, new AutoLabelMarker((FormComponent<?>)component, !Strings.isEmpty(auto) && Boolean.parseBoolean(auto.trim())));
}
return new AutoLabel(tag.getId(), component);
@@ -213,25 +217,32 @@ public class AutoLabelResolver implements IComponentResolver
public static final short VALID = 0x01;
public static final short REQUIRED = 0x02;
public static final short ENABLED = 0x04;
+ public static final short AUTO = 0x08;
private short flags;
- public AutoLabelMarker(FormComponent<?> component)
+ public AutoLabelMarker(FormComponent<?> component, boolean auto)
{
setFlag(VALID, component.isValid());
setFlag(REQUIRED, component.isRequired());
setFlag(ENABLED, component.isEnabledInHierarchy());
+ setFlag(AUTO, auto);
+ }
+
+ @Deprecated(since = "9.17.0, 10.0.0", forRemoval = true)
+ public void updateFrom(FormComponent<?> component, AjaxRequestTarget target) {
+ updateFrom(component, (IPartialPageRequestHandler)target);
}
- public void updateFrom(FormComponent<?> component, AjaxRequestTarget target)
+ public void updateFrom(FormComponent<?> component, IPartialPageRequestHandler target)
{
boolean valid = component.isValid(), required = component.isRequired(), enabled = component.isEnabledInHierarchy();
if (isValid() != valid)
{
target.appendJavaScript(String.format("Wicket.DOM.toggleClass('%s', '%s', %s);",
- getLabelIdFor(component), component.getString(CSS_ERROR_KEY, null, CSS_ERROR_DEFAULT),
- !valid));
+ getLabelIdFor(component), component.getString(CSS_ERROR_KEY, null, CSS_ERROR_DEFAULT),
+ !valid));
}
if (isRequired() != required)
@@ -253,6 +264,11 @@ public class AutoLabelResolver implements IComponentResolver
setFlag(ENABLED, enabled);
}
+ public boolean isAuto()
+ {
+ return getFlag(AUTO);
+ }
+
public boolean isValid()
{
return getFlag(VALID);
diff --git a/wicket-core/src/main/java/org/apache/wicket/markup/html/form/Form.java b/wicket-core/src/main/java/org/apache/wicket/markup/html/form/Form.java
index 0a4971f3e4..d3888fa107 100644
--- a/wicket-core/src/main/java/org/apache/wicket/markup/html/form/Form.java
+++ b/wicket-core/src/main/java/org/apache/wicket/markup/html/form/Form.java
@@ -36,6 +36,7 @@ import org.apache.wicket.Page;
import org.apache.wicket.WicketRuntimeException;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.behavior.Behavior;
+import org.apache.wicket.core.request.handler.IPartialPageRequestHandler;
import org.apache.wicket.core.util.string.CssUtils;
import org.apache.wicket.event.IEvent;
import org.apache.wicket.markup.ComponentTag;
@@ -873,7 +874,7 @@ public class Form<T> extends WebMarkupContainer
@Override
public void component(FormComponent<?> component, IVisit<Void> visit)
{
- component.updateAutoLabels(target);
+ component.updateAutoLabels((IPartialPageRequestHandler)target, false);
}
});
});
diff --git a/wicket-core/src/main/java/org/apache/wicket/markup/html/form/FormComponent.java b/wicket-core/src/main/java/org/apache/wicket/markup/html/form/FormComponent.java
index 3286dae26b..f95894d737 100644
--- a/wicket-core/src/main/java/org/apache/wicket/markup/html/form/FormComponent.java
+++ b/wicket-core/src/main/java/org/apache/wicket/markup/html/form/FormComponent.java
@@ -39,6 +39,7 @@ import org.apache.wicket.Localizer;
import org.apache.wicket.WicketRuntimeException;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.behavior.Behavior;
+import org.apache.wicket.core.request.handler.IPartialPageRequestHandler;
import org.apache.wicket.core.util.lang.WicketObjects;
import org.apache.wicket.markup.ComponentTag;
import org.apache.wicket.markup.html.form.AutoLabelResolver.AutoLabelMarker;
@@ -301,6 +302,13 @@ public abstract class FormComponent<T> extends LabeledWebMarkupContainer impleme
}
}
+ @Override
+ protected void onBeforeRender()
+ {
+ // WICKET-7101 update related auto-label
+ getRequestCycle().find(IPartialPageRequestHandler.class).ifPresent(handler -> updateAutoLabels(handler, true));
+ super.onBeforeRender();
+ }
/**
* Adapter that makes this component appear as {@link IValidatable}
@@ -1558,9 +1566,9 @@ public abstract class FormComponent<T> extends LabeledWebMarkupContainer impleme
* Updates auto label css classes such as error/required during ajax updates when the labels may
* not be directly repainted in the response.
*
- * @param target
+ * @param target The {@link IPartialPageRequestHandler}
*/
- public final void updateAutoLabels(AjaxRequestTarget target)
+ public final void updateAutoLabels(IPartialPageRequestHandler target, boolean auto)
{
AutoLabelMarker marker = getMetaData(AutoLabelResolver.MARKER_KEY);
@@ -1570,9 +1578,30 @@ public abstract class FormComponent<T> extends LabeledWebMarkupContainer impleme
return;
}
+ if (auto)
+ {
+ if (marker.isAuto())
+ {
+ marker.updateFrom(this, target);
+ return;
+ } else {
+ return;
+ }
+ }
+
marker.updateFrom(this, target);
}
+
+ /**
+ * @deprecated method in favor of the one receiving {@link IPartialPageRequestHandler}
+ */
+ @Deprecated(since = "9.17.0, 10.0.0", forRemoval = true)
+ public final void updateAutoLabels(AjaxRequestTarget target)
+ {
+ updateAutoLabels((IPartialPageRequestHandler) target, false);
+ }
+
/**
* Update the model of a {@link FormComponent} containing a {@link Collection}.
*
diff --git a/wicket-core/src/test/java/org/apache/wicket/markup/html/form/AutoLabelTest.java b/wicket-core/src/test/java/org/apache/wicket/markup/html/form/AutoLabelTest.java
index 36cf933f33..dbeda24d81 100644
--- a/wicket-core/src/test/java/org/apache/wicket/markup/html/form/AutoLabelTest.java
+++ b/wicket-core/src/test/java/org/apache/wicket/markup/html/form/AutoLabelTest.java
@@ -21,9 +21,13 @@ import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;
import org.apache.wicket.Page;
+import org.apache.wicket.ajax.AjaxRequestTarget;
+import org.apache.wicket.ajax.markup.html.AjaxLink;
+import org.apache.wicket.ajax.markup.html.form.AjaxSubmitLink;
import org.apache.wicket.markup.IMarkupFragment;
import org.apache.wicket.markup.Markup;
import org.apache.wicket.markup.html.WebPage;
+import org.apache.wicket.markup.html.panel.FeedbackPanel;
import org.apache.wicket.model.Model;
import org.apache.wicket.util.tester.WicketTestCase;
import org.junit.jupiter.api.Test;
@@ -163,22 +167,80 @@ class AutoLabelTest extends WicketTestCase
}
+ // WICKET-7101
+ @Test
+ void labelTagClassesAreUpdatedWhenRelatedFormComponentIsUpdated()
+ {
+ class MyAjaxTestPage extends TestPage
+ {
+ private static final long serialVersionUID = 1L;
+
+ // we define a label that is auto-synchronized with component
+ MyAjaxTestPage()
+ {
+ super("<label wicket:for='t' wicket:auto='true'><span class='label-text'>field</span></label>");
+ }
+ }
+
+ TestPage page = new MyAjaxTestPage();
+ assertNotRendered(page, "class='required'");
+ page.field.setRequired(true);
+ assertRendered(page, "class='required'");
+
+ tester.executeAjaxEvent(page.submit, "click");
+ assertRendered("class='required error'");
+ // toggling required and updating the field.
+ tester.executeAjaxEvent(page.toggleRequired, "click");
+ //required should be removed from associated label
+ assertRendered(toggleString(page.field, "required", false));
+ // now when submitting label has no error.
+ tester.executeAjaxEvent(page.submit, "click");
+ assertNotRendered( "class='error'");
+ // set required back.
+ tester.executeAjaxEvent(page.toggleRequired, "click");
+ //required should be added from associated label
+ assertRendered(toggleString(page.field, "required", true));
+ // again whe have reqiered and error
+ tester.executeAjaxEvent(page.submit, "click");
+ assertRendered("class='required error'");
+ // clear the errors
+ tester.executeAjaxEvent(page.clearErrors, "click");
+ assertRendered(toggleString(page.field, "error", false));
+ // add some error
+ tester.executeAjaxEvent(page.addError, "click");
+ assertRendered(toggleString(page.field, "error", true));
+ }
+
+ private String toggleString(FormComponent<?> component, String cssClass, boolean flag) {
+ // check
+ return "Wicket.DOM.toggleClass('" + component.getMarkupId() + "-w-lbl', '" + cssClass + "', " + flag + ")";
+ }
+
private void assertRendered(Page page, String markupFragment)
{
tester.startPage(page);
+ assertRendered(markupFragment);
+ }
+
+ private void assertRendered(String markupFragment)
+ {
String markup = tester.getLastResponse().getDocument();
markup = markup.replace("'", "\"");
assertTrue(markup.contains(markupFragment.replace("'", "\"")),
- "fragment: [" + markupFragment + "] not found in generated markup: [" + markup + "]");
+ "fragment: [" + markupFragment + "] not found in generated markup: [" + markup + "]");
}
- private void assertNotRendered(Page page, String markupFragment)
- {
+ private void assertNotRendered(Page page, String markupFragment) {
tester.startPage(page);
+ assertNotRendered(markupFragment);
+ }
+
+ private void assertNotRendered(String markupFragment)
+ {
String markup = tester.getLastResponse().getDocument();
markup = markup.replace("'", "\"");
assertFalse(markup.contains(markupFragment.replace("'", "\"")),
- "fragment: [" + markupFragment + "] not found in generated markup: [" + markup + "]");
+ "fragment: [" + markupFragment + "] not found in generated markup: [" + markup + "]");
}
private static class TestPage extends WebPage
@@ -187,19 +249,81 @@ class AutoLabelTest extends WicketTestCase
private final String labelMarkup;
TextField<String> field;
+ AjaxSubmitLink submit;
+
+ FeedbackPanel feedback;
+
+ AjaxLink<Void> toggleRequired;
+
+ AjaxLink<Void> clearErrors;
+
+ AjaxLink<Void> addError;
+
TestPage(String labelMarkup)
{
this.labelMarkup = labelMarkup;
+ feedback = new FeedbackPanel("feedback");
+ feedback.setOutputMarkupId(true);
+ add(feedback);
Form<?> form = new Form<Void>("f");
+ form.setOutputMarkupPlaceholderTag(true);
add(form);
form.add(field = new TextField<String>("t", Model.of("")));
+
+ field.setOutputMarkupId(true);
+ submit = new AjaxSubmitLink("submit")
+ {
+ @Override
+ protected void onSubmit(AjaxRequestTarget target)
+ {
+ target.add(form, feedback);
+ }
+
+ @Override
+ protected void onError(AjaxRequestTarget target)
+ {
+ target.add(form, feedback);
+ }
+ };
+
+ form.add(submit);
+ toggleRequired = new AjaxLink<Void>("toggleRequired")
+ {
+ @Override
+ public void onClick(AjaxRequestTarget target)
+ {
+ field.setRequired(!field.isRequired());
+ target.add(field, feedback);
+ }
+ };
+
+ add(toggleRequired);
+
+ clearErrors = new AjaxLink<Void>("clearErrors") {
+ @Override
+ public void onClick(AjaxRequestTarget target) {
+ field.getFeedbackMessages().clear();
+ target.add(field, feedback);
+ }
+ };
+ add(clearErrors);
+
+ addError = new AjaxLink<Void>("addError") {
+ @Override
+ public void onClick(AjaxRequestTarget target) {
+ field.error("Test");
+ target.add(field, feedback);
+ }
+ };
+ add(addError);
}
@Override
public IMarkupFragment getMarkup()
{
- return Markup.of("<html><body><form wicket:id='f'>\n" + labelMarkup +
- "\n<input type='text' wicket:id='t'/>\n</form></body></html>");
+ return Markup.of("<html><body><div wicket:id='feedback'></div><form wicket:id='f'>\n" + labelMarkup +
+ "\n<input type='text' wicket:id='t'/>\n<a wicket:id='submit'>Submit</a></form>\n<a wicket:id='toggleRequired'>Toggle required</a>" +
+ "\n<a wicket:id='clearErrors'>clearErrors</a>\n<a wicket:id='addError'>addError</a></body></html>");
}
}
}