Files
moodle/lib/amd/src/event.js
T
Damyon Wiese 260565e305 MDL-64573 output: ajax form event
Add an event that can be fired when an mform is about to be submitted via ajax.
This allows custom field types to perform an action when the form is submitted.

The atto text editor will reset any autosaves when the form is submitted.
2019-04-24 16:17:49 +08:00

117 lines
4.0 KiB
JavaScript

// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Global registry of core events that can be triggered/listened for.
*
* @module core/event
* @package core
* @class event
* @copyright 2015 Damyon Wiese <damyon@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since 3.0
*/
define(['jquery', 'core/yui'],
function($, Y) {
return /** @alias module:core/event */ {
// Public variables and functions.
// These are AMD only events - no backwards compatibility for new things.
Events: {
FORM_FIELD_VALIDATION: "core_form-field-validation"
},
/**
* Load the legacy YUI module which defines events in M.core.event and return it.
*
* @method getLegacyEvents
* @return {Promise}
*/
getLegacyEvents: function() {
var result = $.Deferred();
Y.use('event', 'moodle-core-event', function() {
result.resolve(window.M.core.event);
});
return result.promise();
},
/**
* Trigger an event using both JQuery and YUI
*
* @method notifyFilterContentUpdated
* @param {string|JQuery} nodes - Selector or list of elements that were inserted.
*/
notifyFilterContentUpdated: function(nodes) {
nodes = $(nodes);
Y.use('event', 'moodle-core-event', function(Y) {
// Trigger it the JQuery way.
$(document).trigger(M.core.event.FILTER_CONTENT_UPDATED, [nodes]);
// Create a YUI NodeList from our JQuery Object.
var yuiNodes = new Y.NodeList(nodes.get());
// And again for YUI.
Y.fire(M.core.event.FILTER_CONTENT_UPDATED, {nodes: yuiNodes});
});
},
/**
* Trigger an event using both JQuery and YUI
*
* @method notifyFormSubmittedAjax
* @param {DOMElement} form
* @param {boolean} skipValidation Submit the form without validation. E.g. "Cancel".
*/
notifyFormSubmitAjax: function(form, skipValidation) {
// Argument is optional.
skipValidation = skipValidation || false;
Y.use('event', 'moodle-core-event', function(Y) {
if (skipValidation) {
window.skipClientValidation = true;
}
// Trigger it the JQuery way.
$(form).trigger(M.core.event.FORM_SUBMIT_AJAX);
// And again for YUI.
Y.one(form).fire(M.core.event.FORM_SUBMIT_AJAX, {currentTarget: Y.one(form)});
if (skipValidation) {
window.skipClientValidation = false;
}
});
},
/**
* Trigger an event using both JQuery and YUI
* This event alerts the world that the editor has restored some content.
*
* @method notifyEditorContentRestored
*/
notifyEditorContentRestored: function() {
Y.use('event', 'moodle-core-event', function(Y) {
// Trigger it the JQuery way.
$(document).trigger(M.core.event.EDITOR_CONTENT_RESTORED);
// And again for YUI.
Y.fire(M.core.event.EDITOR_CONTENT_RESTORED);
});
},
};
});