MDL-64573 output: ajax form event
[moodle.git] / lib / amd / src / event.js
1 // This file is part of Moodle - http://moodle.org/
2 //
3 // Moodle is free software: you can redistribute it and/or modify
4 // it under the terms of the GNU General Public License as published by
5 // the Free Software Foundation, either version 3 of the License, or
6 // (at your option) any later version.
7 //
8 // Moodle is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 // GNU General Public License for more details.
12 //
13 // You should have received a copy of the GNU General Public License
14 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16 /**
17  * Global registry of core events that can be triggered/listened for.
18  *
19  * @module     core/event
20  * @package    core
21  * @class      event
22  * @copyright  2015 Damyon Wiese <damyon@moodle.com>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  * @since      3.0
25  */
26 define(['jquery', 'core/yui'],
27        function($, Y) {
29     return /** @alias module:core/event */ {
32         // Public variables and functions.
33         // These are AMD only events - no backwards compatibility for new things.
34         Events: {
35             FORM_FIELD_VALIDATION: "core_form-field-validation"
36         },
38         /**
39          * Load the legacy YUI module which defines events in M.core.event and return it.
40          *
41          * @method getLegacyEvents
42          * @return {Promise}
43          */
44         getLegacyEvents: function() {
45             var result = $.Deferred();
46             Y.use('event', 'moodle-core-event', function() {
47                 result.resolve(window.M.core.event);
48             });
49             return result.promise();
50         },
52         /**
53          * Trigger an event using both JQuery and YUI
54          *
55          * @method notifyFilterContentUpdated
56          * @param {string|JQuery} nodes - Selector or list of elements that were inserted.
57          */
58         notifyFilterContentUpdated: function(nodes) {
59             nodes = $(nodes);
60             Y.use('event', 'moodle-core-event', function(Y) {
61                 // Trigger it the JQuery way.
62                 $(document).trigger(M.core.event.FILTER_CONTENT_UPDATED, [nodes]);
64                 // Create a YUI NodeList from our JQuery Object.
65                 var yuiNodes = new Y.NodeList(nodes.get());
67                 // And again for YUI.
68                 Y.fire(M.core.event.FILTER_CONTENT_UPDATED, {nodes: yuiNodes});
69             });
70         },
72         /**
73          * Trigger an event using both JQuery and YUI
74          *
75          * @method notifyFormSubmittedAjax
76          * @param {DOMElement} form
77          * @param {boolean} skipValidation Submit the form without validation. E.g. "Cancel".
78          */
79         notifyFormSubmitAjax: function(form, skipValidation) {
81             // Argument is optional.
82             skipValidation = skipValidation || false;
84             Y.use('event', 'moodle-core-event', function(Y) {
85                 if (skipValidation) {
86                     window.skipClientValidation = true;
87                 }
88                 // Trigger it the JQuery way.
89                 $(form).trigger(M.core.event.FORM_SUBMIT_AJAX);
91                 // And again for YUI.
92                 Y.one(form).fire(M.core.event.FORM_SUBMIT_AJAX, {currentTarget: Y.one(form)});
94                 if (skipValidation) {
95                     window.skipClientValidation = false;
96                 }
97             });
98         },
100         /**
101          * Trigger an event using both JQuery and YUI
102          * This event alerts the world that the editor has restored some content.
103          *
104          * @method notifyEditorContentRestored
105          */
106         notifyEditorContentRestored: function() {
107             Y.use('event', 'moodle-core-event', function(Y) {
108                 // Trigger it the JQuery way.
109                 $(document).trigger(M.core.event.EDITOR_CONTENT_RESTORED);
111                 // And again for YUI.
112                 Y.fire(M.core.event.EDITOR_CONTENT_RESTORED);
113             });
114         },
115     };
116 });