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/16 12:19:56 UTC
(wicket) branch bugix/reiern70/WICKET-7101 updated (5560aeefe7 -> ef50d9f506)
This is an automated email from the ASF dual-hosted git repository.
reiern70 pushed a change to branch bugix/reiern70/WICKET-7101
in repository https://gitbox.apache.org/repos/asf/wicket.git
discard 5560aeefe7 [WICKET-7101] The label associated with a 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
new ef50d9f506 [WICKET-7101] The label associated with a 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 update added new revisions after undoing existing revisions.
That is to say, some revisions that were in the old version of the
branch are not in the new version. This situation occurs
when a user --force pushes a change and generates a repository
containing something like this:
* -- * -- B -- O -- O -- O (5560aeefe7)
\
N -- N -- N refs/heads/bugix/reiern70/WICKET-7101 (ef50d9f506)
You should already have received notification emails for all of the O
revisions, and so the following emails describe only the N revisions
from the common base, B.
Any revisions marked "omit" are not gone; other references still
refer to them. Any revisions marked "discard" are gone forever.
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../java/org/apache/wicket/markup/html/form/AutoLabelResolver.java | 5 +++++
.../main/java/org/apache/wicket/markup/html/form/FormComponent.java | 6 ++++++
2 files changed, 11 insertions(+)
(wicket) 01/01: [WICKET-7101] The label associated with a 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
Posted by re...@apache.org.
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 ef50d9f506c88ab5d235ea7825175f231b4dc3b2
Author: reiern70 <re...@gmail.com>
AuthorDate: Thu Mar 14 14:06:58 2024 -0500
[WICKET-7101] The label associated with a 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
---
.../wicket/markup/html/form/AutoLabelResolver.java | 11 +-
.../wicket/markup/html/form/FormComponent.java | 17 ++-
.../wicket/markup/html/form/AutoLabelTest.java | 135 ++++++++++++++++++++-
3 files changed, 152 insertions(+), 11 deletions(-)
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..9464c562d3 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,6 +24,7 @@ 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;
@@ -223,15 +224,19 @@ public class AutoLabelResolver implements IComponentResolver
setFlag(ENABLED, component.isEnabledInHierarchy());
}
- public void updateFrom(FormComponent<?> component, AjaxRequestTarget target)
+ public void updateFrom(FormComponent<?> component, AjaxRequestTarget target) {
+ updateFrom(component, (IPartialPageRequestHandler)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)
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..62fc032384 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(this::updateAutoLabels);
+ 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)
{
AutoLabelMarker marker = getMetaData(AutoLabelResolver.MARKER_KEY);
@@ -1573,6 +1581,11 @@ public abstract class FormComponent<T> extends LabeledWebMarkupContainer impleme
marker.updateFrom(this, target);
}
+ public final void updateAutoLabels(AjaxRequestTarget target)
+ {
+ updateAutoLabels((IPartialPageRequestHandler) target);
+ }
+
/**
* 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..8a4961bfbc 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,79 @@ class AutoLabelTest extends WicketTestCase
}
+ // WICKET-7101
+ @Test
+ void labelTagClassesAreUpdatedWhenRelatedFormComponentIsUpdated()
+ {
+ class MyAjaxTestPage extends TestPage
+ {
+ private static final long serialVersionUID = 1L;
+
+ MyAjaxTestPage()
+ {
+ super("<label wicket:for='t'><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 +248,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>");
}
}
}