This is an automated email from the ASF dual-hosted git repository.
papegaaij pushed a commit to branch csp-form
in repository https://gitbox.apache.org/repos/asf/wicket.git
The following commit(s) were added to refs/heads/csp-form by this push:
new ec8c759 WICKET-6726: move inline JS to an event handler
ec8c759 is described below
commit ec8c759c15259ab5c51a4416a31100e5665be418
Author: Emond Papegaaij <[email protected]>
AuthorDate: Wed Jan 22 21:19:37 2020 +0100
WICKET-6726: move inline JS to an event handler
---
.../org/apache/wicket/markup/html/form/Form.java | 93 +++++++++++++++++-----
1 file changed, 75 insertions(+), 18 deletions(-)
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 9987c01..4d669c2 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
@@ -38,6 +38,8 @@ import org.apache.wicket.behavior.Behavior;
import org.apache.wicket.event.IEvent;
import org.apache.wicket.markup.ComponentTag;
import org.apache.wicket.markup.MarkupStream;
+import org.apache.wicket.markup.head.IHeaderResponse;
+import org.apache.wicket.markup.head.OnDomReadyHeaderItem;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.markup.html.form.upload.FileUploadField;
import org.apache.wicket.markup.html.form.validation.FormValidatorAdapter;
@@ -297,6 +299,16 @@ public class Form<T> extends WebMarkupContainer
private static final short MULTIPART_HINT_NO = 0x04;
/**
+ * The index of the hidden fields used to pass parameters.
+ */
+ private static final int HIDDEN_FIELDS_PARAMS_IDX = 0;
+
+ /**
+ * The index of the hidden fields used for the default submit button.
+ */
+ private static final int HIDDEN_FIELDS_SUBMIT_IDX = 1;
+
+ /**
* Constructs a form with no validation.
*
* @param id
@@ -524,7 +536,8 @@ public class Form<T> extends WebMarkupContainer
String action = url.toString();
if (root.encodeUrlInHiddenFields()) {
-
buffer.append(String.format("document.getElementById('%s').innerHTML = '",
root.getHiddenFieldsId()));
+
buffer.append(String.format("document.getElementById('%s').innerHTML = '",
+
root.getHiddenFieldsId(HIDDEN_FIELDS_PARAMS_IDX)));
// parameter must be sent as hidden field, as it would
be ignored in the action URL
int i = action.indexOf('?');
@@ -562,7 +575,8 @@ public class Form<T> extends WebMarkupContainer
buffer.append(String.format("var f =
document.getElementById('%s');", root.getMarkupId()));
if (root.encodeUrlInHiddenFields())
{
-
buffer.append(String.format("document.getElementById('%s').innerHTML += '",
root.getHiddenFieldsId()));
+
buffer.append(String.format("document.getElementById('%s').innerHTML += '",
+
root.getHiddenFieldsId(HIDDEN_FIELDS_PARAMS_IDX)));
writeParamsAsHiddenFields(new String[] {param}, buffer);
@@ -1219,6 +1233,8 @@ public class Form<T> extends WebMarkupContainer
* will do a form submit using this component. This method is
overridable as what we do is best
* effort only, and may not what you want in specific situations. So if
you have specific
* usability concerns, or want to follow another strategy, you may
override this method.
+ *
+ * @see #addDefaultSubmitButtonHandler(IHeaderResponse)
*/
protected void appendDefaultButtonField()
{
@@ -1231,13 +1247,10 @@ public class Form<T> extends WebMarkupContainer
buffer.append("<input type=\"text\" tabindex=\"-1\"
autocomplete=\"off\"/>");
// add the submitting component
- final Component submittingComponent =
(Component)defaultSubmittingComponent;
- buffer.append("<input type=\"submit\" tabindex=\"-1\" name=\"");
- buffer.append(defaultSubmittingComponent.getInputName());
- buffer.append("\" onclick=\" var b=document.getElementById('");
- buffer.append(submittingComponent.getMarkupId());
- buffer.append("'); if
(b!=null&&b.onclick!=null&&typeof(b.onclick) != 'undefined') {
var r = Wicket.bind(b.onclick, b)(); if (r != false) b.click(); } else {
b.click(); }; return false;\" ");
- buffer.append(" />");
+ buffer
+ .append(String.format("<input id=\"%s\" type=\"submit\"
tabindex=\"-1\" name=\"%s\" />",
+ getHiddenFieldsId(HIDDEN_FIELDS_SUBMIT_IDX),
+ defaultSubmittingComponent.getInputName()));
// close div
buffer.append("</div>");
@@ -1246,6 +1259,31 @@ public class Form<T> extends WebMarkupContainer
}
/**
+ * Where {@link #appendDefaultButtonField()} renders the markup for
default submit button
+ * handling, this method attaches the event handler to its 'click'
event. The 'click' event on
+ * the hidden submit button will be dispatched to the selected default
submit button. As with
+ * {@link #appendDefaultButtonField()} this method can be overridden
when the generated code
+ * needs to be adjusted for a specific usecase.
+ *
+ * @param headerResponse
+ * The header response.
+ */
+ protected void addDefaultSubmitButtonHandler(IHeaderResponse
headerResponse)
+ {
+ final Component submittingComponent = (Component)
defaultSubmittingComponent;
+ AppendingStringBuffer buffer = new AppendingStringBuffer();
+ buffer.append("Wicket.Event.add('" +
getHiddenFieldsId(HIDDEN_FIELDS_SUBMIT_IDX)
+ + "', 'click', function(event) { var
b=document.getElementById('");
+ buffer.append(submittingComponent.getMarkupId());
+ buffer.append(
+ "'); if (b!=null && b.onclick!=null &&
typeof(b.onclick) != 'undefined') ");
+ buffer.append(
+ "{ var r = Wicket.bind(b.onclick, b)(); if (r !=
false) b.click(); } else { b.click(); }; return false;");
+ buffer.append("});");
+
headerResponse.render(OnDomReadyHeaderItem.forScript(buffer.toString()));
+ }
+
+ /**
* Template method to allow clients to do any processing (like
recording the current model so
* that, in case onSubmit does further validation, the model can be
rolled back) before the
* actual updating of form component models is done.
@@ -1313,11 +1351,13 @@ public class Form<T> extends WebMarkupContainer
/**
* Returns the id which will be used for the hidden div containing all
parameter fields.
*
+ * @param idx
+ * The index of the div to keep different divs apart.
* @return the id of the hidden div
*/
- private final String getHiddenFieldsId()
+ private final String getHiddenFieldsId(int idx)
{
- return getInputNamePrefix() + getMarkupId() + "_hf_0";
+ return getInputNamePrefix() + getMarkupId() + "_hf_" + idx;
}
/**
@@ -1698,6 +1738,17 @@ public class Form<T> extends WebMarkupContainer
super.onComponentTagBody(markupStream, openTag);
}
+ @Override
+ public void renderHead(IHeaderResponse response)
+ {
+ super.renderHead(response);
+
+ if (hasDefaultSubmittingComponent())
+ {
+ addDefaultSubmitButtonHandler(response);
+ }
+ }
+
/**
* Writes the markup for the hidden input fields and default button
field if applicable to the
* current response.
@@ -1709,7 +1760,7 @@ public class Form<T> extends WebMarkupContainer
if (encodeUrlInHiddenFields())
{
getResponse().write(String.format("<div id=\"%s\"
class=\"wicket--hidden-fields\">",
- getHiddenFieldsId()));
+ getHiddenFieldsId(HIDDEN_FIELDS_PARAMS_IDX)));
AppendingStringBuffer buffer = new
AppendingStringBuffer();
@@ -1726,15 +1777,21 @@ public class Form<T> extends WebMarkupContainer
}
// if a default submitting component was set, handle the
rendering of that
+ if (hasDefaultSubmittingComponent())
+ {
+ appendDefaultButtonField();
+ }
+ }
+
+ private boolean hasDefaultSubmittingComponent()
+ {
if (defaultSubmittingComponent instanceof Component)
{
- final Component submittingComponent =
(Component)defaultSubmittingComponent;
- if (submittingComponent.isVisibleInHierarchy() &&
- submittingComponent.isEnabledInHierarchy())
- {
- appendDefaultButtonField();
- }
+ final Component submittingComponent = (Component)
defaultSubmittingComponent;
+ return submittingComponent.isVisibleInHierarchy()
+ && submittingComponent.isEnabledInHierarchy();
}
+ return false;
}
/**
