496084707c92618ec73ba157bf7befc23c9ec098
[moodle.git] / lib / yui / chooserdialogue / chooserdialogue.js
1 YUI.add('moodle-core-chooserdialogue', function(Y) {
3     var CHOOSERDIALOGUE = function() {
4         CHOOSERDIALOGUE.superclass.constructor.apply(this, arguments);
5     }
7     Y.extend(CHOOSERDIALOGUE, Y.Base, {
8         // The overlay widget
9         overlay: null,
11         // The submit button - we disable this until an element is set
12         submitbutton : null,
14         // The chooserdialogue container
15         container : null,
17         // Any event listeners we may need to cancel later
18         listenevents : [],
20         // The initial overflow setting
21         initialoverflow : '',
23         bodycontent : null,
24         headercontent : null,
25         instanceconfig : null,
27         setup_chooser_dialogue : function(bodycontent, headercontent, config) {
28             this.bodycontent = bodycontent;
29             this.headercontent = headercontent;
30             this.instanceconfig = config;
31         },
33         prepare_chooser : function () {
34             if (this.overlay) {
35                 return;
36             }
38             // Set Default options
39             var params = {
40                 bodyContent : this.bodycontent.get('innerHTML'),
41                 headerContent : this.headercontent.get('innerHTML'),
42                 width : '540px',
43                 draggable : true,
44                 visible : false, // Hide by default
45                 zindex : 100, // Display in front of other items
46                 lightbox : true // This dialogue should be modal
47             };
49             // Override with additional options
50             for (paramkey in this.instanceconfig) {
51               params[paramkey] = this.instanceconfig[paramkey];
52             }
54             // Create the overlay
55             this.overlay = new M.core.dialogue(params);
57             // Remove the template for the chooser
58             this.bodycontent.remove();
59             this.headercontent.remove();
61             // Hide and then render the overlay
62             this.overlay.hide();
63             this.overlay.render();
65             // Set useful links
66             this.container = this.overlay.get('boundingBox').one('.choosercontainer');
67             this.options = this.container.all('.option input[type=radio]');
69             // Add the chooserdialogue class to the container for styling
70             this.overlay.get('boundingBox').addClass('chooserdialogue');
71         },
73         /**
74          * Display the module chooser
75          *
76          * @param e Event Triggering Event
77          * @return void
78          */
79         display_chooser : function (e) {
80             this.prepare_chooser();
82             // Stop the default event actions before we proceed
83             e.preventDefault();
85             var bb = this.overlay.get('boundingBox');
86             var dialogue = this.container.one('.alloptions');
88             // Get the overflow setting when the chooser was opened - we
89             // may need this later
90             if (Y.UA.ie > 0) {
91                 this.initialoverflow = Y.one('html').getStyle('overflow');
92             } else {
93                 this.initialoverflow = Y.one('body').getStyle('overflow');
94             }
96             var thisevent;
98             // This will detect a change in orientation and retrigger centering
99             thisevent = Y.one('document').on('orientationchange', function(e) {
100                 this.center_dialogue(dialogue);
101             }, this);
102             this.listenevents.push(thisevent);
104             // Detect window resizes (most browsers)
105             thisevent = Y.one('window').on('resize', function(e) {
106                 this.center_dialogue(dialogue);
107             }, this);
108             this.listenevents.push(thisevent);
110             // These will trigger a check_options call to display the correct help
111             thisevent = this.container.on('click', this.check_options, this);
112             this.listenevents.push(thisevent);
113             thisevent = this.container.on('key_up', this.check_options, this);
114             this.listenevents.push(thisevent);
115             thisevent = this.container.on('dblclick', function(e) {
116                 if (e.target.ancestor('div.option')) {
117                     this.check_options();
119                     // Prevent duplicate submissions
120                     this.submitbutton.setAttribute('disabled', 'disabled');
121                     this.options.setAttribute('disabled', 'disabled');
122                     this.cancel_listenevents();
124                     this.container.one('form').submit();
125                 }
126             }, this);
127             this.listenevents.push(thisevent);
129             this.container.one('form').on('submit', function(e) {
130                 // Prevent duplicate submissions on submit
131                 this.submitbutton.setAttribute('disabled', 'disabled');
132                 this.options.setAttribute('disabled', 'disabled');
133                 this.cancel_listenevents();
134             }, this);
136             // Hook onto the cancel button to hide the form
137             thisevent = this.container.one('.addcancel').on('click', this.cancel_popup, this);
138             this.listenevents.push(thisevent);
139             thisevent = bb.one('div.closebutton').on('click', this.cancel_popup, this);
140             this.listenevents.push(thisevent);
142             // Grab global keyup events and handle them
143             thisevent = Y.one('document').on('keyup', this.handle_key_press, this);
144             this.listenevents.push(thisevent);
146             // Add references to various elements we adjust
147             this.jumplink     = this.container.one('.jump');
148             this.submitbutton = this.container.one('.submitbutton');
150             // Disable the submit element until the user makes a selection
151             this.submitbutton.set('disabled', 'true');
153             // Ensure that the options are shown
154             this.options.removeAttribute('disabled');
156             // Display the overlay
157             this.overlay.show();
159             // Re-centre the dialogue after we've shown it.
160             this.center_dialogue(dialogue);
162             // Finally, focus the first radio element - this enables form selection via the keyboard
163             this.container.one('.option input[type=radio]').focus();
165             // Trigger check_options to set the initial jumpurl
166             this.check_options();
167         },
169         /**
170          * Cancel any listen events in the listenevents queue
171          *
172          * Several locations add event handlers which should only be called before the form is submitted. This provides
173          * a way of cancelling those events.
174          *
175          * @return void
176          */
177         cancel_listenevents : function () {
178             // Detach all listen events to prevent duplicate triggers
179             var thisevent;
180             while (thisevent = this.listenevents.shift()) {
181                 thisevent.detach();
182             }
183         },
185         /**
186          * Calculate the optimum height of the chooser dialogue
187          *
188          * This tries to set a sensible maximum and minimum to ensure that some options are always shown, and preferably
189          * all, whilst fitting the box within the current viewport.
190          *
191          * @param dialogue Y.Node The dialogue
192          * @return void
193          */
194         center_dialogue : function(dialogue) {
195             var bb = this.overlay.get('boundingBox');
197             var winheight = bb.get('winHeight');
198             var winwidth = bb.get('winWidth');
199             var offsettop = 0;
201             // Try and set a sensible max-height -- this must be done before setting the top
202             // Set a default height of 640px
203             var newheight = this.get('maxheight');
204             if (winheight <= newheight) {
205                 // Deal with smaller window sizes
206                 if (winheight <= this.get('minheight')) {
207                     newheight = this.get('minheight');
208                 } else {
209                     newheight = winheight;
210                 }
211             }
213             // Set a fixed position if the window is large enough
214             if (newheight > this.get('minheight')) {
215                 bb.setStyle('position', 'fixed');
216                 // Disable the page scrollbars
217                 if (Y.UA.ie > 0) {
218                     Y.one('html').setStyle('overflow', 'hidden');
219                 } else {
220                     Y.one('body').setStyle('overflow', 'hidden');
221                 }
222             } else {
223                 bb.setStyle('position', 'absolute');
224                 offsettop = Y.one('window').get('scrollTop');
225                 // Ensure that the page scrollbars are enabled
226                 if (Y.UA.ie > 0) {
227                     Y.one('html').setStyle('overflow', this.initialoverflow);
228                 } else {
229                     Y.one('body').setStyle('overflow', this.initialoverflow);
230                 }
231             }
233             // Take off 15px top and bottom for borders, plus 40px each for the title and button area before setting the
234             // new max-height
235             var totalheight = newheight;
236             newheight = newheight - (15 + 15 + 40 + 40);
237             dialogue.setStyle('max-height', newheight + 'px');
238             dialogue.setStyle('height', newheight + 'px');
240             // Re-calculate the location now that we've changed the size
241             var dialoguetop = Math.max(12, ((winheight - totalheight) / 2)) + offsettop;
243             // We need to set the height for the yui3-widget - can't work
244             // out what we're setting at present -- shoud be the boudingBox
245             bb.setStyle('top', dialoguetop + 'px');
247             // Calculate the left location of the chooser
248             // We don't set a minimum width in the same way as we do height as the width would be far lower than the
249             // optimal width for moodle anyway.
250             var dialoguewidth = bb.get('offsetWidth');
251             var dialogueleft = (winwidth - dialoguewidth) / 2;
252             bb.setStyle('left', dialogueleft + 'px');
253         },
255         handle_key_press : function(e) {
256             if (e.keyCode == 27) {
257                 this.cancel_popup(e);
258             }
259         },
261         cancel_popup : function (e) {
262             // Prevent normal form submission before hiding
263             e.preventDefault();
264             this.hide();
265         },
267         hide : function() {
268             // Cancel all listen events
269             this.cancel_listenevents();
271             // Re-enable the page scrollbars
272             if (Y.UA.ie > 0) {
273                 Y.one('html').setStyle('overflow', this.initialoverflow);
274             } else {
275                 Y.one('body').setStyle('overflow', this.initialoverflow);
276             }
278             this.container.detachAll();
279             this.overlay.hide();
280         },
282         check_options : function(e) {
283             // Check which options are set, and change the parent class
284             // to show/hide help as required
285             this.options.each(function(thisoption) {
286                 var optiondiv = thisoption.get('parentNode').get('parentNode');
287                 if (thisoption.get('checked')) {
288                     optiondiv.addClass('selected');
290                     // Trigger any events for this option
291                     this.option_selected(thisoption);
293                     // Ensure that the form may be submitted
294                     this.submitbutton.removeAttribute('disabled');
296                     // Ensure that the radio remains focus so that keyboard navigation is still possible
297                     thisoption.focus();
298                 } else {
299                     optiondiv.removeClass('selected');
300                 }
301             }, this);
302         },
304         option_selected : function(e) {
305         }
306     },
307     {
308         NAME : 'moodle-core-chooserdialogue',
309         ATTRS : {
310             minheight : {
311                 value : 300
312             },
313             maxheight : {
314                 value : 660
315             }
316         }
317     });
318     M.core = M.core || {};
319     M.core.chooserdialogue = CHOOSERDIALOGUE;
320 },
321 '@VERSION@', {
322     requires:['base', 'overlay', 'moodle-core-notification']
324 );