weekly release 2.6dev
[moodle.git] / lib / editor / atto / yui / src / editor / js / editor.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  * Atto editor main class.
18  * Common functions required by editor plugins.
19  *
20  * @package    editor-atto
21  * @copyright  2013 Damyon Wiese  <damyon@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
24 M.editor_atto = M.editor_atto || {
25     /**
26      * List of attached button handlers to prevent duplicates.
27      */
28     buttonhandlers : {},
30     /**
31      * List of YUI overlays for custom menus.
32      */
33     menus : {},
35     /**
36      * List of attached menu handlers to prevent duplicates.
37      */
38     menuhandlers : {},
40     /**
41      * List of file picker options for specific editor instances.
42      */
43     filepickeroptions : {},
45     /**
46      * List of buttons and menus that have been added to the toolbar.
47      */
48     widgets : {},
50     /**
51      * Toggle a menu.
52      * @param event e
53      */
54     showhide_menu_handler : function(e) {
55         e.preventDefault();
56         var disabled = this.getAttribute('disabled');
57         var overlayid = this.getAttribute('data-menu');
58         var overlay = M.editor_atto.menus[overlayid];
59         var menu = overlay.get('bodyContent');
60         if (overlay.get('visible') || disabled) {
61             overlay.hide();
62             menu.detach('clickoutside');
63         } else {
64             menu.on('clickoutside', function(ev) {
65                 if ((ev.target.ancestor() !== this) && (ev.target !== this)) {
66                     if (overlay.get('visible')) {
67                         menu.detach('clickoutside');
68                         overlay.hide();
69                     }
70                 }
71             }, this);
72             overlay.show();
73         }
74     },
76     /**
77      * Handle clicks on editor buttons.
78      * @param event e
79      */
80     buttonclicked_handler : function(e) {
81         var elementid = this.getAttribute('data-editor');
82         var plugin = this.getAttribute('data-plugin');
83         var handler = this.getAttribute('data-handler');
84         var overlay = M.editor_atto.menus[plugin + '_' + elementid];
86         if (overlay) {
87             overlay.hide();
88         }
90         if (M.editor_atto.is_enabled(elementid, plugin)) {
91             // Pass it on.
92             handler = M.editor_atto.buttonhandlers[handler];
93             return handler(e, elementid);
94         }
95     },
97     /**
98      * Determine if the specified toolbar button/menu is enabled.
99      * @param string elementid, the element id of this editor.
100      * @param string plugin, the plugin that created the button/menu.
101      */
102     is_enabled : function(elementid, plugin) {
103         var element = Y.one('#' + elementid + '_toolbar .atto_' + plugin + '_button');
105         return !element.hasAttribute('disabled');
106     },
107     /**
108      * Disable all buttons and menus in the toolbar.
109      * @param string elementid, the element id of this editor.
110      */
111     disable_all_widgets : function(elementid) {
112         var plugin, element;
113         for (plugin in M.editor_atto.widgets) {
114             element = Y.one('#' + elementid + '_toolbar .atto_' + plugin + '_button');
116             if (element) {
117                 element.setAttribute('disabled', 'true');
118             }
119         }
120     },
122     /**
123      * Enable a single widget in the toolbar.
124      * @param string elementid, the element id of this editor.
125      * @param string plugin, the name of the plugin that created the widget.
126      */
127     enable_widget : function(elementid, plugin) {
128         var element = Y.one('#' + elementid + '_toolbar .atto_' + plugin + '_button');
130         if (element) {
131             element.removeAttribute('disabled');
132         }
133     },
135     /**
136      * Enable all buttons and menus in the toolbar.
137      * @param string elementid, the element id of this editor.
138      */
139     enable_all_widgets : function(elementid) {
140         var plugin, element;
141         for (plugin in M.editor_atto.widgets) {
142             element = Y.one('#' + elementid + '_toolbar .atto_' + plugin + '_button');
144             if (element) {
145                 element.removeAttribute('disabled');
146             }
147         }
148     },
150     /**
151      * Add a button to the toolbar belonging to the editor for element with id "elementid".
152      * @param string elementid - the id of the textarea we created this editor from.
153      * @param string plugin - the plugin defining the button
154      * @param string icon - the html used for the content of the button
155      * @param string groupname - the group the button should be appended to.
156      * @handler function handler- A function to call when the button is clicked.
157      */
158     add_toolbar_menu : function(elementid, plugin, icon, groupname, entries) {
159         var toolbar = Y.one('#' + elementid + '_toolbar'),
160             group = Y.one('#' + elementid + '_toolbar .atto_group.' + groupname + '_group'),
161             currentfocus,
162             button;
164         if (!group) {
165             group = Y.Node.create('<div class="atto_group ' + groupname + '_group"></div>');
166             toolbar.append(group);
167         }
168         button = Y.Node.create('<button class="atto_' + plugin + '_button atto_hasmenu" ' +
169                                     'data-editor="' + Y.Escape.html(elementid) + '" ' +
170                                     'tabindex="-1" ' +
171                                     'data-menu="' + plugin + '_' + elementid + '" >' +
172                                     icon +
173                                     '</button>');
175         group.append(button);
177         currentfocus = toolbar.getAttribute('aria-activedescendant');
178         if (!currentfocus) {
179             button.setAttribute('tabindex', '0');
180             toolbar.setAttribute('aria-activedescendant', button.generateID());
181         }
183         // Save the name of the plugin.
184         M.editor_atto.widgets[plugin] = plugin;
186         var menu = Y.Node.create('<div class="atto_' + plugin + '_menu' +
187                                  ' atto_menu" data-editor="' + Y.Escape.html(elementid) + '"></div>');
188         var i = 0, entry = {};
190         for (i = 0; i < entries.length; i++) {
191             entry = entries[i];
193             menu.append(Y.Node.create('<div class="atto_menuentry">' +
194                                        '<a href="#" class="atto_' + plugin + '_action_' + i + '" ' +
195                                        'data-editor="' + Y.Escape.html(elementid) + '" ' +
196                                        'data-plugin="' + Y.Escape.html(plugin) + '" ' +
197                                        'data-handler="' + Y.Escape.html(plugin + '_action_' + i) + '">' +
198                                        entry.text +
199                                        '</a>' +
200                                        '</div>'));
201             if (!M.editor_atto.buttonhandlers[plugin + '_action_' + i]) {
202                 Y.one('body').delegate('click', M.editor_atto.buttonclicked_handler, '.atto_' + plugin + '_action_' + i);
203                 M.editor_atto.buttonhandlers[plugin + '_action_' + i] = entry.handler;
204             }
205         }
207         if (!M.editor_atto.buttonhandlers[plugin]) {
208             Y.one('body').delegate('click', M.editor_atto.showhide_menu_handler, '.atto_' + plugin + '_button');
209             M.editor_atto.buttonhandlers[plugin] = true;
210         }
212         var overlay = new M.core.dialogue({
213             bodyContent : menu,
214             visible : false,
215             width: '14em',
216             zindex: 100,
217             lightbox: false,
218             closeButton: false,
219             centered : false,
220             align: {node: button, points: [Y.WidgetPositionAlign.TL, Y.WidgetPositionAlign.BL]}
221         });
223         M.editor_atto.menus[plugin + '_' + elementid] = overlay;
224         overlay.render();
225         overlay.hide();
226         overlay.headerNode.hide();
227     },
229     /**
230      * Add a button to the toolbar belonging to the editor for element with id "elementid".
231      * @param string elementid - the id of the textarea we created this editor from.
232      * @param string plugin - the plugin defining the button.
233      * @param string icon - the html used for the content of the button.
234      * @param string groupname - the group the button should be appended to.
235      * @handler function handler- A function to call when the button is clicked.
236      */
237     add_toolbar_button : function(elementid, plugin, icon, groupname, handler) {
238         var toolbar = Y.one('#' + elementid + '_toolbar'),
239             group = Y.one('#' + elementid + '_toolbar .atto_group.' + groupname + '_group'),
240             button,
241             currentfocus;
243         if (!group) {
244             group = Y.Node.create('<div class="atto_group ' + groupname +'_group"></div>');
245             toolbar.append(group);
246         }
247         button = Y.Node.create('<button class="atto_' + plugin + '_button" ' +
248                                'data-editor="' + Y.Escape.html(elementid) + '" ' +
249                                'data-plugin="' + Y.Escape.html(plugin) + '" ' +
250                                'tabindex="-1" ' +
251                                'data-handler="' + Y.Escape.html(plugin) + '">' +
252                                icon +
253                                '</button>');
255         group.append(button);
257         currentfocus = toolbar.getAttribute('aria-activedescendant');
258         if (!currentfocus) {
259             button.setAttribute('tabindex', '0');
260             toolbar.setAttribute('aria-activedescendant', button.generateID());
261         }
263         // We only need to attach this once.
264         if (!M.editor_atto.buttonhandlers[plugin]) {
265             Y.one('body').delegate('click', M.editor_atto.buttonclicked_handler, '.atto_' + plugin + '_button');
266             M.editor_atto.buttonhandlers[plugin] = handler;
267         }
269         // Save the name of the plugin.
270         M.editor_atto.widgets[plugin] = plugin;
272     },
274     /**
275      * Work out if the cursor is in the editable area for this editor instance.
276      * @param string elementid of this editor
277      * @return bool
278      */
279     is_active : function(elementid) {
280         var selection = M.editor_atto.get_selection();
282         if (selection.length) {
283             selection = selection.pop();
284         }
286         var node = null;
287         if (selection.parentElement) {
288             node = Y.one(selection.parentElement());
289         } else {
290             node = Y.one(selection.startContainer);
291         }
293         return node && node.ancestor('#' + elementid + 'editable') !== null;
294     },
296     /**
297      * Focus on the editable area for this editor.
298      * @param string elementid of this editor
299      */
300     focus : function(elementid) {
301         Y.one('#' + elementid + 'editable').focus();
302     },
304     /**
305      * Initialise the editor
306      * @param object params for this editor instance.
307      */
308     init : function(params) {
309         var textarea = Y.one('#' +params.elementid);
310         var atto = Y.Node.create('<div id="' + params.elementid + 'editable" ' +
311                                             'contenteditable="true" ' +
312                                             'spellcheck="true" ' +
313                                             'class="editor_atto"/>');
314         var cssfont = '';
315         var toolbar = Y.Node.create('<div class="editor_atto_toolbar" id="' + params.elementid + '_toolbar" role="toolbar"/>');
317         // Bleh - why are we sent a url and not the css to apply directly?
318         var css = Y.io(params.content_css, { sync: true });
319         var pos = css.responseText.indexOf('font:');
320         if (pos) {
321             cssfont = css.responseText.substring(pos + 'font:'.length, css.responseText.length - 1);
322             atto.setStyle('font', cssfont);
323         }
324         atto.setStyle('minHeight', (1.2 * (textarea.getAttribute('rows') - 1)) + 'em');
326         // Copy text to editable div.
327         atto.append(textarea.get('value'));
329         // Add the toolbar to the page.
330         textarea.get('parentNode').insert(toolbar, textarea);
331         // Add the editable div to the page.
332         textarea.get('parentNode').insert(atto, textarea);
333         atto.setStyle('color', textarea.getStyle('color'));
334         atto.setStyle('lineHeight', textarea.getStyle('lineHeight'));
335         atto.setStyle('fontSize', textarea.getStyle('fontSize'));
336         // Hide the old textarea.
337         textarea.hide();
339         // Copy the current value back to the textarea when focus leaves us.
340         atto.on('blur', function() {
341             textarea.set('value', atto.getHTML());
342         });
344         // Listen for Arrow left and Arrow right keys.
345         Y.one(Y.config.doc.body).delegate('key',
346                                           this.keyboard_navigation,
347                                           'down:37,39',
348                                           '#' + params.elementid + '_toolbar',
349                                           this,
350                                           params.elementid);
352         // Save the file picker options for later.
353         M.editor_atto.filepickeroptions[params.elementid] = params.filepickeroptions;
354     },
356     /**
357      * Implement arrow key navigation for the buttons in the toolbar.
358      * @param Event e - the keyboard event.
359      * @param string elementid - the id of the textarea we created this editor from.
360      */
361     keyboard_navigation : function(e, elementid) {
362         var buttons,
363             current,
364             currentid,
365             currentindex;
367         e.preventDefault();
369         buttons = Y.all('#' + elementid + '_toolbar button');
370         currentid = Y.one('#' + elementid + '_toolbar').getAttribute('aria-activedescendant');
371         if (!currentid) {
372             return;
373         }
374         current = Y.one('#' + currentid);
375         current.setAttribute('tabindex', '-1');
377         currentindex = buttons.indexOf(current);
379         if (e.keyCode === 37) {
380             // Left
381             currentindex--;
382             if (currentindex < 0) {
383                 currentindex = buttons.size()-1;
384             }
385         } else {
386             // Right
387             currentindex++;
388             if (currentindex >= buttons.size()) {
389                 currentindex = 0;
390             }
391         }
393         current = buttons.item(currentindex);
394         current.setAttribute('tabindex', '0');
395         current.focus();
396         Y.one('#' + elementid + '_toolbar').setAttribute('aria-activedescendant', current.generateID());
397     },
399     /**
400      * Show the filepicker.
401      * @param string elementid for this editor instance.
402      * @param string type The media type for the file picker
403      * @param function callback
404      */
405     show_filepicker : function(elementid, type, callback) {
406         Y.use('core_filepicker', function (Y) {
407             var options = M.editor_atto.filepickeroptions[elementid][type];
409             options.formcallback = callback;
410             options.editor_target = Y.one(elementid);
412             M.core_filepicker.show(Y, options);
413         });
414     },
416     /**
417      * Create a cross browser selection object that represents a yui node.
418      * @param Node yui node for the selection
419      * @return range (browser dependent)
420      */
421     get_selection_from_node: function(node) {
422         var range;
424         if (window.getSelection) {
425             range = document.createRange();
427             range.setStartBefore(node.getDOMNode());
428             range.setEndAfter(node.getDOMNode());
429             return [range];
430         } else if (document.selection) {
431             range = document.body.createTextRange();
432             range.moveToElementText(node.getDOMNode());
433             return range;
434         }
435         return false;
436     },
438     /**
439      * Get the selection object that can be passed back to set_selection.
440      * @return range (browser dependent)
441      */
442     get_selection : function() {
443         if (window.getSelection) {
444             var sel = window.getSelection();
445             var ranges = [], i = 0;
446             for (i = 0; i < sel.rangeCount; i++) {
447                 ranges.push(sel.getRangeAt(i));
448             }
449             return ranges;
450         } else if (document.selection) {
451             // IE < 9
452             if (document.selection.createRange) {
453                 return document.selection.createRange();
454             }
455         }
456         return false;
457     },
459     /**
460      * Get the dom node representing the common anscestor of the selection nodes.
461      * @return DOMNode
462      */
463     get_selection_parent_node : function() {
464         var selection = M.editor_atto.get_selection();
465         if (selection.length > 0) {
466             return selection[0].commonAncestorContainer;
467         }
468     },
470     /**
471      * Get the list of child nodes of the selection.
472      * @return DOMNode[]
473      */
474     get_selection_text : function() {
475         var selection = M.editor_atto.get_selection();
476         if (selection.length > 0 && selection[0].cloneContents) {
477             return selection[0].cloneContents();
478         }
479     },
481     /**
482      * Set the current selection. Used to restore a selection.
483      */
484     set_selection : function(selection) {
485         var sel, i;
487         if (window.getSelection) {
488             sel = window.getSelection();
489             sel.removeAllRanges();
490             for (i = 0; i < selection.length; i++) {
491                 sel.addRange(selection[i]);
492             }
493         } else if (document.selection) {
494             // IE < 9
495             if (selection.select) {
496                 selection.select();
497             }
498         }
499     }
501 };