task/4.x/form leave notification

forms/src/main/java/org/devgateway/toolkit/forms/WebConstants.java → forms/src/main/java/org/devgateway/toolkit/forms/FormsConstants.java

@@ -19,10 +19,9 @@
 import java.util.List;
 import java.util.Locale;
 
-// TODO rename to FormConstants
-public final class WebConstants {
+public final class FormsConstants {
 
-    private WebConstants() {
+    private FormsConstants() {
 
     }
 
@@ -34,6 +33,10 @@ private WebConstants() {
 
     public static final String DISABLE_FORM_LEAVING_JS
             = "if(typeof disableFormLeavingConfirmation === 'function') disableFormLeavingConfirmation();";
+    public static final String ENABLE_FORM_LEAVING_JS
+            = "if(typeof enableFormLeavingConfirmation === 'function') enableFormLeavingConfirmation();";
+    public static final String BIND_FORM_LEAVING_CHECK = "if(typeof checkAnyChange === 'function') checkAnyChange();";
+    public static final String MARK_FORM_AS_CHANGED = "if(typeof checkAnyChange === 'function') markFormAsChanged();";
 
     public static final String PARAM_PRINT = "print";
 

forms/src/main/java/org/devgateway/toolkit/forms/models/ViewModeConverterModel.java

@@ -12,7 +12,7 @@
 package org.devgateway.toolkit.forms.models;
 
 import org.apache.wicket.model.IModel;
-import org.devgateway.toolkit.forms.WebConstants;
+import org.devgateway.toolkit.forms.FormsConstants;
 import org.devgateway.toolkit.forms.wicket.components.form.GenericBootstrapFormComponent;
 
 import java.text.SimpleDateFormat;
@@ -22,7 +22,7 @@
 /**
  * @author mpostelnicu Converter for {@link GenericBootstrapFormComponent}
  *         viewModeField This will be used when
- *         {@link WebConstants#PARAM_VIEW_MODE} is true in the browser and will
+ *         {@link FormsConstants#PARAM_VIEW_MODE} is true in the browser and will
  *         convert the model object to something printable (string-like)
  */
 public class ViewModeConverterModel<T> implements IModel<String> {

forms/src/main/java/org/devgateway/toolkit/forms/wicket/components/ComponentUtil.java

@@ -20,7 +20,7 @@
 import org.apache.wicket.markup.html.WebMarkupContainer;
 import org.apache.wicket.markup.html.form.FormComponent;
 import org.apache.wicket.request.cycle.RequestCycle;
-import org.devgateway.toolkit.forms.WebConstants;
+import org.devgateway.toolkit.forms.FormsConstants;
 import org.devgateway.toolkit.forms.wicket.components.form.GenericBootstrapFormComponent;
 import org.devgateway.toolkit.forms.wicket.events.EditingDisabledEvent;
 import org.devgateway.toolkit.forms.wicket.events.EditingEnabledEvent;
@@ -53,13 +53,13 @@ public static MarkupContainer addRequiredFlagBootstrapFormComponent(final boolea
     }
 
     /**
-     * Returns true if the {@link WebConstants#PARAM_VIEW_MODE} is used as a
+     * Returns true if the {@link FormsConstants#PARAM_VIEW_MODE} is used as a
      * parameter
      *
      * @return
      */
     public static boolean isViewMode() {
-        return RequestCycle.get().getRequest().getRequestParameters().getParameterValue(WebConstants.PARAM_VIEW_MODE)
+        return RequestCycle.get().getRequest().getRequestParameters().getParameterValue(FormsConstants.PARAM_VIEW_MODE)
                 .toBoolean(false);
     }
 

forms/src/main/java/org/devgateway/toolkit/forms/wicket/components/ListViewSectionPanel.java

@@ -14,6 +14,7 @@
 import org.apache.wicket.model.ResourceModel;
 import org.apache.wicket.model.StringResourceModel;
 import org.apache.wicket.request.cycle.RequestCycle;
+import org.devgateway.toolkit.forms.FormsConstants;
 import org.devgateway.toolkit.forms.util.JQueryUtil;
 import org.devgateway.toolkit.forms.wicket.components.form.BootstrapAddButton;
 import org.devgateway.toolkit.forms.wicket.components.form.BootstrapDeleteButton;
@@ -253,6 +254,14 @@ private BootstrapDeleteButton getRemoveChildButton(final T item) {
             @Serial
             private static final long serialVersionUID = 6350277641786762027L;
 
+            @Override
+            protected String getOnClickScript() {
+                if (item.isNew()) {
+                    return super.getOnClickScript();
+                }
+                return FormsConstants.MARK_FORM_AS_CHANGED;
+            }
+
             @Override
             protected void onSubmit(final AjaxRequestTarget target) {
                 ListViewSectionPanel.this.getModelObject().remove(item);
@@ -274,6 +283,11 @@ final BootstrapAddButton getAddNewChildButton() {
             @Serial
             private static final long serialVersionUID = 5195431828773253867L;
 
+            @Override
+            protected String getOnClickScript() {
+                return FormsConstants.MARK_FORM_AS_CHANGED;
+            }
+
             @Override
             protected void onSubmit(final AjaxRequestTarget target) {
                 final T newChild = createNewChild(

forms/src/main/java/org/devgateway/toolkit/forms/wicket/components/PageableTablePanel.java

@@ -8,7 +8,7 @@
 import org.apache.wicket.model.IModel;
 import org.apache.wicket.model.PropertyModel;
 import org.apache.wicket.model.StringResourceModel;
-import org.devgateway.toolkit.forms.WebConstants;
+import org.devgateway.toolkit.forms.FormsConstants;
 import org.devgateway.toolkit.forms.wicket.components.table.AjaxFallbackBootstrapDataTable;
 import org.devgateway.toolkit.forms.wicket.providers.ListDataProvider;
 
@@ -33,7 +33,7 @@ public class PageableTablePanel<T extends Serializable, PARENT extends Serializa
 
     protected ISortableDataProvider<T, String> dataProvider;
 
-    protected int rowsPerPage = WebConstants.PAGE_SIZE;
+    protected int rowsPerPage = FormsConstants.PAGE_SIZE;
 
     protected List<IColumn<T, String>> columns = new ArrayList<>();
 

forms/src/main/java/org/devgateway/toolkit/forms/wicket/components/form/AJAXDownload.java

@@ -3,6 +3,7 @@
 import org.apache.wicket.ajax.AjaxRequestTarget;
 import org.apache.wicket.behavior.AbstractAjaxBehavior;
 import org.apache.wicket.request.IRequestHandler;
+import org.devgateway.toolkit.forms.FormsConstants;
 
 /**
  * AJAX update and file download.
@@ -33,7 +34,11 @@ public void initiate(final AjaxRequestTarget target) {
         }
 
         // the timeout is needed to let Wicket release the channel
-        target.appendJavaScript("setTimeout(\"window.location.href='" + url + "'\", 100);");
+        target.appendJavaScript("setTimeout(function() {"
+                + FormsConstants.DISABLE_FORM_LEAVING_JS
+                + "window.location.href='" + url + "';"
+                + FormsConstants.ENABLE_FORM_LEAVING_JS
+                + "}, 100);");
     }
 
     @Override

forms/src/main/java/org/devgateway/toolkit/forms/wicket/components/form/EditableTablePanel.java

@@ -15,7 +15,7 @@
 import org.apache.wicket.model.PropertyModel;
 import org.apache.wicket.model.StringResourceModel;
 import org.apache.wicket.validation.IValidator;
-import org.devgateway.toolkit.forms.WebConstants;
+import org.devgateway.toolkit.forms.FormsConstants;
 import org.devgateway.toolkit.forms.wicket.components.PageableTablePanel;
 import org.devgateway.toolkit.forms.wicket.components.table.AbstractBootstrapPagingNavigationWithError;
 import org.devgateway.toolkit.forms.wicket.components.table.AjaxBootstrapNavigationToolbar;
@@ -68,7 +68,7 @@ public EditableTablePanel(final String id, final IModel<PARENT> parentModel) {
 
     protected AjaxFallbackBootstrapDataTable buildDataTable() {
         AjaxFallbackBootstrapDataTable dataTable = super.buildDataTable();
-        if (this.rowsPerPage != WebConstants.PAGE_SIZE_NO_LIMIT && usePagingWithErrors) {
+        if (this.rowsPerPage != FormsConstants.PAGE_SIZE_NO_LIMIT && usePagingWithErrors) {
             AjaxBootstrapNavigationToolbar navToolbar = dataTable.getNavigationToolbar();
             navToolbar.withPagingNavFactory(new PagingNavigationFactory(EditableTablePagination.class, this));
         }

forms/src/main/java/org/devgateway/toolkit/forms/wicket/components/form/OptionallyRequiredTextAreaFieldComponent.java

@@ -17,7 +17,7 @@
 import org.apache.wicket.markup.html.form.TextArea;
 import org.apache.wicket.model.IModel;
 import org.apache.wicket.validation.validator.StringValidator;
-import org.devgateway.toolkit.forms.WebConstants;
+import org.devgateway.toolkit.forms.FormsConstants;
 
 /**
  * @author mpostelnicu
@@ -26,7 +26,7 @@
  *
  */
 public abstract class OptionallyRequiredTextAreaFieldComponent<TYPE> extends TextAreaFieldBootstrapFormComponent<TYPE> {
-    private StringValidator validator = WebConstants.StringValidators.MAXIMUM_LENGTH_VALIDATOR_ONE_LINE_TEXTAREA;
+    private StringValidator validator = FormsConstants.StringValidators.MAXIMUM_LENGTH_VALIDATOR_ONE_LINE_TEXTAREA;
 
     private static final long serialVersionUID = 1L;
 

forms/src/main/java/org/devgateway/toolkit/forms/wicket/components/form/SummernoteBootstrapFormComponent.java

@@ -30,7 +30,7 @@
 import org.apache.wicket.validation.IValidator;
 import org.apache.wicket.validation.ValidationError;
 import org.apache.wicket.validation.validator.StringValidator;
-import org.devgateway.toolkit.forms.WebConstants;
+import org.devgateway.toolkit.forms.FormsConstants;
 import org.devgateway.toolkit.forms.wicket.components.ComponentUtil;
 
 /**
@@ -82,7 +82,7 @@ protected InputBehavior getInputBehavior() {
 
     private ToolkitSummernoteEditor summernoteEditor;
 
-    private StringValidator validator = WebConstants.StringValidators.MAXIMUM_LENGTH_VALIDATOR_ONE_LINE_TEXTAREA;
+    private StringValidator validator = FormsConstants.StringValidators.MAXIMUM_LENGTH_VALIDATOR_ONE_LINE_TEXTAREA;
 
     private ToolkitSummernoteEditor.ToolkitSummernoteConfig config;
 

forms/src/main/java/org/devgateway/toolkit/forms/wicket/components/form/TextAreaFieldBootstrapFormComponent.java

@@ -17,14 +17,14 @@
 import org.apache.wicket.markup.html.form.TextArea;
 import org.apache.wicket.model.IModel;
 import org.apache.wicket.validation.validator.StringValidator;
-import org.devgateway.toolkit.forms.WebConstants;
+import org.devgateway.toolkit.forms.FormsConstants;
 
 /**
  * @author mpostelnicu
  *
  */
 public class TextAreaFieldBootstrapFormComponent<TYPE> extends GenericBootstrapFormComponent<TYPE, TextArea<TYPE>> {
-    private StringValidator validator = WebConstants.StringValidators.MAXIMUM_LENGTH_VALIDATOR_ONE_LINE_TEXTAREA;
+    private StringValidator validator = FormsConstants.StringValidators.MAXIMUM_LENGTH_VALIDATOR_ONE_LINE_TEXTAREA;
 
     /**
      *

forms/src/main/java/org/devgateway/toolkit/forms/wicket/components/form/TextFieldBootstrapFormComponent.java

@@ -17,7 +17,7 @@
 import org.apache.wicket.markup.html.form.TextField;
 import org.apache.wicket.model.IModel;
 import org.apache.wicket.validation.validator.StringValidator;
-import org.devgateway.toolkit.forms.WebConstants;
+import org.devgateway.toolkit.forms.FormsConstants;
 
 import java.math.BigDecimal;
 
@@ -28,7 +28,7 @@
 public class TextFieldBootstrapFormComponent<TYPE> extends GenericBootstrapFormComponent<TYPE, TextField<TYPE>> {
     private static final long serialVersionUID = 8062663141536130313L;
 
-    private StringValidator validator = WebConstants.StringValidators.MAXIMUM_LENGTH_VALIDATOR_ONE_LINE_TEXT;
+    private StringValidator validator = FormsConstants.StringValidators.MAXIMUM_LENGTH_VALIDATOR_ONE_LINE_TEXT;
 
     public TextFieldBootstrapFormComponent(final String id, final IModel<String> labelModel, final IModel<TYPE> model) {
         super(id, labelModel, model);

forms/src/main/java/org/devgateway/toolkit/forms/wicket/components/table/AjaxBootstrapNavigationToolbar.java

@@ -19,6 +19,7 @@
 import org.apache.wicket.markup.html.WebMarkupContainer;
 import org.apache.wicket.markup.html.navigation.paging.PagingNavigator;
 import org.apache.wicket.model.IModel;
+import org.devgateway.toolkit.forms.FormsConstants;
 
 /**
  * @author idobre
@@ -53,6 +54,7 @@ protected PagingNavigator newPagingNavigator(final String navigatorId, final Dat
             @Override
             protected void onAjaxEvent(final AjaxRequestTarget target) {
                 target.add(table);
+                target.appendJavaScript(FormsConstants.BIND_FORM_LEAVING_CHECK);
             }
         }.withPagingNavFactory(navigationFactory);
     }

forms/src/main/java/org/devgateway/toolkit/forms/wicket/components/table/AjaxBootstrapNavigator.java

@@ -12,13 +12,11 @@
 package org.devgateway.toolkit.forms.wicket.components.table;
 
 import org.apache.wicket.Component;
-import org.apache.wicket.ajax.AjaxRequestTarget;
 import org.apache.wicket.ajax.markup.html.navigation.paging.AjaxPagingNavigator;
 import org.apache.wicket.markup.html.link.AbstractLink;
 import org.apache.wicket.markup.html.navigation.paging.IPageable;
 import org.apache.wicket.markup.html.navigation.paging.IPagingLabelProvider;
 import org.apache.wicket.markup.html.navigation.paging.PagingNavigation;
-import org.devgateway.toolkit.forms.WebConstants;
 
 /**
  * @author idobre

forms/src/main/java/org/devgateway/toolkit/forms/wicket/components/util/ComponentUtil.java

@@ -8,7 +8,7 @@
 import org.apache.wicket.request.cycle.RequestCycle;
 import org.apache.wicket.validation.IValidator;
 import org.apache.wicket.validation.validator.EmailAddressValidator;
-import org.devgateway.toolkit.forms.WebConstants;
+import org.devgateway.toolkit.forms.FormsConstants;
 import org.devgateway.toolkit.forms.wicket.components.form.CheckBoxBootstrapFormComponent;
 import org.devgateway.toolkit.forms.wicket.components.form.CheckBoxToggleBootstrapFormComponent;
 import org.devgateway.toolkit.forms.wicket.components.form.CheckBoxYesNoToggleBootstrapFormComponent;
@@ -42,23 +42,23 @@ private ComponentUtil() {
     }
 
     /**
-     * Returns true if the {@link WebConstants#PARAM_VIEW_MODE} is used as a
+     * Returns true if the {@link FormsConstants#PARAM_VIEW_MODE} is used as a
      * parameter
      *
      * @return
      */
     public static boolean isViewMode() {
-        return RequestCycle.get().getRequest().getRequestParameters().getParameterValue(WebConstants.PARAM_VIEW_MODE)
+        return RequestCycle.get().getRequest().getRequestParameters().getParameterValue(FormsConstants.PARAM_VIEW_MODE)
                 .toBoolean(false);
     }
 
     /**
-     * Returns true if the {@link WebConstants#PARAM_PRINT} is used as a parameter
+     * Returns true if the {@link FormsConstants#PARAM_PRINT} is used as a parameter
      *
      * @return
      */
     public static boolean isPrintMode() {
-        return RequestCycle.get().getRequest().getRequestParameters().getParameterValue(WebConstants.PARAM_PRINT)
+        return RequestCycle.get().getRequest().getRequestParameters().getParameterValue(FormsConstants.PARAM_PRINT)
                 .toBoolean(false);
     }
 

forms/src/main/java/org/devgateway/toolkit/forms/wicket/liveping/formLeavingHelper.js

@@ -1,27 +1,28 @@
 /*******************************************************************************
  * Copyright (c) 2015 Development Gateway, Inc and others.
- * 
+ *
  * All rights reserved. This program and the accompanying materials are made
  * available under the terms of the MIT License (MIT) which accompanies this
  * distribution, and is available at https://opensource.org/licenses/MIT
- * 
+ *
  * Contributors: Development Gateway - initial API and implementation
  ******************************************************************************/
 // if nothing has changed that the user can leave the page without any
 // confirmation
-var shouldConfirmFormLeaving = false;
+var shouldConfirmFormLeaving = true;
+var formChanged = false;
 
-$(document).ready(function () {
+function checkAnyChange() {
     $(':input').each(function () {
         $(this).on('change', function () {
-            shouldConfirmFormLeaving = true;
+            formChanged = true;
         });
     });
 
-    // set shouldConfirmFormLeaving when input has focus
+    // set formChanged when input has focus
     $(':input').each(function () {
         $(this).on('keyup', function () {
-            shouldConfirmFormLeaving = true;
+            formChanged = true;
         });
     });
 
@@ -38,7 +39,7 @@ $(document).ready(function () {
             that.trigger('change');
         }, 50);
 
-        shouldConfirmFormLeaving = true;
+        formChanged = true;
     });
 
     $(document).on('drop', ':input', function (e) {
@@ -53,14 +54,23 @@ $(document).ready(function () {
             that.trigger('change');
         }, 50);
 
-        shouldConfirmFormLeaving = true;
+        formChanged = true;
     });
-});
+}
+
+$(document).ready(function() { checkAnyChange(); });
+/*
+* Below works, but we only need to rebind on dynamic elements rendered based on some conditions.
+* Therefore better to append BIND_FORM_LEAVING_CHECK when dynamic content is loaded.
+$(document).ajaxComplete(function() { checkAnyChange(); });
+*/
 
 // confirmation modal before window unload
-$(window).on('beforeunload', function () {
-    if (shouldConfirmFormLeaving) {
-        return "${formLeavingWarning}";
+$(window).on('beforeunload', function (e) {
+    if (shouldConfirmFormLeaving && formChanged) {
+        e.preventDefault();
+        // heads up: the latest browsers use their own generic message, not customizable here.
+        return e.returnValue = "${formLeavingWarning}";
     }
 });
 
@@ -71,3 +81,7 @@ function enableFormLeavingConfirmation() {
 function disableFormLeavingConfirmation() {
     shouldConfirmFormLeaving = false;
 }
+
+function markFormAsChanged() {
+    formChanged = true;
+}