ee8e4d96ae3e5de35f46c689a31130ae421f042e
[moodle.git] / lib / editor / tinymce / module.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  * TinyMCE helper javascript functions.
18  *
19  * @package    editor_tinymce
20  * @copyright  2010 Petr Skoda (http://skodak.org)
21  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  */
24 M.editor_tinymce = M.editor_tinymce || {};
26 M.editor_tinymce.editor_options = M.editor_tinymce.options || {};
27 M.editor_tinymce.filepicker_options = M.editor_tinymce.filepicker_options || {};
28 M.editor_tinymce.initialised = false;
30 M.editor_tinymce.init_editor = function(Y, editorid, options) {
32     if (!M.editor_tinymce.initialised) {
33         // Load all language strings for all plugins - we do not use standard TinyMCE lang pack loading!
34         tinymce.ScriptLoader.add(M.cfg.wwwroot + '/lib/editor/tinymce/all_strings.php?elanguage=' + options.language + '&rev=' + options.langrev);
36         // Monkey patch for MDL-35284 - this hack ignores empty toolbars.
37         tinymce.ui.Toolbar.prototype.oldRenderHTML = tinymce.ui.Toolbar.prototype.renderHTML;
38         tinymce.ui.Toolbar.prototype.renderHTML = function() {
39             if (this.controls.length == 0) {
40                 return;
41             }
42             return tinymce.ui.Toolbar.prototype.oldRenderHTML.call(this);
43         };
45         M.editor_tinymce.initialised = true;
46         M.util.js_pending('editors');
47         options.oninit = "M.editor_tinymce.init_callback";
48     }
50     M.editor_tinymce.editor_options[editorid] = options;
52     // Load necessary Moodle plugins into editor.
53     if (options.moodle_init_plugins) {
54         var extraplugins = options.moodle_init_plugins.split(',');
55         for (var i=0; i<extraplugins.length; i++) {
56             var filedetails = extraplugins[i].split(':');
57             tinyMCE.PluginManager.load(filedetails[0],
58                 M.cfg.wwwroot + '/lib/editor/tinymce/plugins/' + filedetails[1]);
59         }
60     }
62     // Retain any setup which is already defined.
63     options.originalSetupFunction = options.setup || function(){};
64     options.setup = function(editor) {
65         options.originalSetupFunction();
66         editor.onChange.add(function(ed) {
67             ed.save();
68         });
69         Y.use('event', 'moodle-core-event', function(Y) {
70             var form = Y.one(document.getElementById(editor.id)).ancestor('form');
71             form.on(M.core.event.FORM_SUBMIT_AJAX, function() {
72                 editor.save();
73             }, this)
74         });
75     };
77     tinyMCE.init(options);
79     var item = document.getElementById(editorid+'_filemanager');
80     if (item) {
81         item.parentNode.removeChild(item);
82     }
84     document.getElementById(editorid).addEventListener('form:editorUpdated', function() {
85         M.editor_tinymce.updateEditorState(editorid);
86     });
87 };
89 M.editor_tinymce.init_callback = function() {
90     M.util.js_complete('editors');
91 }
93 M.editor_tinymce.init_filepicker = function(Y, editorid, options) {
94     M.editor_tinymce.filepicker_options[editorid] = options;
95 };
97 M.editor_tinymce.toggle = function(id) {
98     tinyMCE.execCommand('mceToggleEditor', false, id);
99 };
101 /**
102  * Update the state of the editor.
103  * @param {String} id
104  */
105 M.editor_tinymce.updateEditorState = function(id) {
106     var instance = window.tinyMCE.get(id),
107         content = instance.getBody(),
108         controls = instance.controlManager.controls,
109         disabled = instance.getElement().readOnly;
110     // Enable/Disable all plugins.
111     for (var key in controls) {
112         if (controls.hasOwnProperty(key)) {
113             controls[key].setDisabled(disabled);
114         }
115     }
116     // Enable/Disable body content.
117     content.setAttribute('contenteditable', !disabled);
118 };
120 M.editor_tinymce.filepicker_callback = function(args) {
121 };
123 M.editor_tinymce.filepicker = function(target_id, url, type, win) {
124     YUI().use('core_filepicker', function (Y) {
125         var editor_id = tinyMCE.selectedInstance.editorId;
126         if (editor_id == 'mce_fullscreen') {
127             editor_id = tinyMCE.selectedInstance.settings.elements;
128         }
129         var options = null;
130         if (type == 'media') {
131             // When media button clicked.
132             options = M.editor_tinymce.filepicker_options[editor_id]['media'];
133         } else if (type == 'file') {
134             // When link button clicked.
135             options = M.editor_tinymce.filepicker_options[editor_id]['link'];
136         } else if (type == 'image') {
137             // When image button clicked.
138             options = M.editor_tinymce.filepicker_options[editor_id]['image'];
139         }
141         options.formcallback = M.editor_tinymce.filepicker_callback;
142         options.editor_target = win.document.getElementById(target_id);
144         M.core_filepicker.show(Y, options);
145     });
146 };
148 M.editor_tinymce.onblur_event = function(ed) {
149     // Attach event only after tinymce is initialized.
150     if (ed.onInit != undefined) {
151         var s = ed.settings;
152         // Save before event is attached, so that if this event is not generated then textarea should
153         // have loaded contents and submitting form should not throw error.
154         ed.save();
156         // Attach blur event for tinymce to save contents to textarea.
157         var doc = s.content_editable ? ed.getBody() : (tinymce.isGecko ? ed.getDoc() : ed.getWin());
158         tinymce.dom.Event.add(doc, 'blur', function() {
159             // Save contents to textarea before calling validation script.
160             ed.save();
161         });
162     };
163 };