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
The following commit(s) were added to refs/heads/bugix/reiern70/WICKET-7101 by
this push:
new d38102a8fb [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.
d38102a8fb is described below
commit d38102a8fb7bd671dd4baa5001ddc62668dbc9ca
Author: reiern70 <reier...@gmail.com>
AuthorDate: Tue Mar 19 18:06:56 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 | 17 ++++++++++++++---
.../org/apache/wicket/markup/html/form/Form.java | 3 ++-
.../wicket/markup/html/form/FormComponent.java | 22 +++++++++++++++++++---
.../wicket/markup/html/form/AutoLabelTest.java | 3 ++-
5 files changed, 39 insertions(+), 9 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 9464c562d3..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
@@ -30,6 +30,7 @@ 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;
@@ -73,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");
@@ -128,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);
@@ -214,16 +217,19 @@ 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);
}
@@ -258,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 62fc032384..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
@@ -306,7 +306,7 @@ public abstract class FormComponent<T> extends
LabeledWebMarkupContainer impleme
protected void onBeforeRender()
{
// WICKET-7101 update related auto-label
-
getRequestCycle().find(IPartialPageRequestHandler.class).ifPresent(this::updateAutoLabels);
+
getRequestCycle().find(IPartialPageRequestHandler.class).ifPresent(handler ->
updateAutoLabels(handler, true));
super.onBeforeRender();
}
@@ -1568,7 +1568,7 @@ public abstract class FormComponent<T> extends
LabeledWebMarkupContainer impleme
*
* @param target The {@link IPartialPageRequestHandler}
*/
- public final void updateAutoLabels(IPartialPageRequestHandler target)
+ public final void updateAutoLabels(IPartialPageRequestHandler target,
boolean auto)
{
AutoLabelMarker marker =
getMetaData(AutoLabelResolver.MARKER_KEY);
@@ -1578,12 +1578,28 @@ 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);
+ updateAutoLabels((IPartialPageRequestHandler) target, false);
}
/**
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 8a4961bfbc..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
@@ -175,9 +175,10 @@ class AutoLabelTest extends WicketTestCase
{
private static final long serialVersionUID = 1L;
+ // we define a label that is auto-synchronized with
component
MyAjaxTestPage()
{
- super("<label wicket:for='t'><span
class='label-text'>field</span></label>");
+ super("<label wicket:for='t'
wicket:auto='true'><span class='label-text'>field</span></label>");
}
}
