first commit

lib/pkp/js/controllers/modal/ButtonConfirmationModalHandler.js

@@ -0,0 +1,88 @@
+/**
+ * @file js/controllers/modal/ButtonConfirmationModalHandler.js
+ *
+ * Copyright (c) 2014-2021 Simon Fraser University
+ * Copyright (c) 2000-2021 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class ButtonConfirmationModalHandler
+ * @ingroup js_controllers_modal
+ *
+ * @brief A confirmation modal that displays a confirmation message before
+ *  actually triggering a click event on the calling element (usually a
+ *  button).
+ */
+(function($) {
+
+
+	/**
+	 * @constructor
+	 *
+	 * @extends $.pkp.controllers.modal.ConfirmationModalHandler
+	 *
+	 * @param {jQueryObject} $handledElement The modal.
+	 * @param {Object} options Non-default options to configure
+	 *  the modal.
+	 *
+	 *  Options are:
+	 *  - button jQuery The button to be clicked on success.
+	 *  - All options from the ConfirmationModalHandler and ModalHandler
+	 *    widgets.
+	 *  - All options documented for the jQueryUI dialog widget,
+	 *    except for the buttons parameter which is not supported.
+	 */
+	$.pkp.controllers.modal.ButtonConfirmationModalHandler =
+			function($handledElement, options) {
+
+		this.parent($handledElement, options);
+
+	};
+	$.pkp.classes.Helper.inherits(
+			$.pkp.controllers.modal.ButtonConfirmationModalHandler,
+			$.pkp.controllers.modal.ConfirmationModalHandler);
+
+
+	//
+	// Protected methods
+	//
+	/**
+	 * @inheritDoc
+	 */
+	$.pkp.controllers.modal.ButtonConfirmationModalHandler.prototype.checkOptions =
+			function(options) {
+		// Check inherited options
+		if (!this.parent('checkOptions', options)) {
+			return false;
+		}
+
+
+		return typeof options.$button == 'object' && options.$button.length == 1;
+	};
+
+
+	/**
+	 * Callback that will be activated when the modal is confirmed
+	 *
+	 * @param {HTMLElement} dialogElement The element the
+	 *  dialog was created on.
+	 * @param {Event} event The click event.
+	 */
+	$.pkp.controllers.modal.ButtonConfirmationModalHandler.prototype.modalConfirm =
+			function(dialogElement, event) {
+
+		var $button = (/** @type {{ $button: jQueryObject }} */ (this.options))
+				.$button;
+
+		// Close the modal first so that the linkaction is no longer disabled
+		this.modalClose(dialogElement);
+
+		// Trigger the link/button action
+		if ($button.attr('type') == 'submit') {
+			$button.trigger('submit');
+		} else {
+			$button.click();
+		}
+	};
+
+
+}(jQuery));