MDL-20067 new IMS Content package module, includes migrate from old mod/resource...
[moodle.git] / mod / imscp / functions.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  * Javascript helper function for IMS Content Package module including
18  * dummy SCORM API.
19  *
20  * @package   mod-imscp
21  * @copyright 2009 Petr Skoda (http://skodak.org)
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 /** Dummy SCORM API adapter */
26 var API = new function () {
27     this.LMSCommit         = function (parameter) {return "true";};
28     this.LMSFinish         = function (parameter) {return "true";};
29     this.LMSGetDiagnostic  = function (errorCode) {return "n/a";};
30     this.LMSGetErrorString = function (errorCode) {return "n/a";};
31     this.LMSGetLastError   = function () {return "0";};
32     this.LMSGetValue       = function (element) {return "";};
33     this.LMSInitialize     = function (parameter) {return "true";};
34     this.LMSSetValue       = function (element, value) {return "true";};
35 };
37 var imscp_layout_widget;
38 var imscp_current_node;
39 var imscp_buttons = [];
40 var imscp_bloody_labelclick = false;
41 var imscp_panel;
43 function imscp_init() {
44     YAHOO.util.Event.onDOMReady(function () {
45         imscp_setup();
46     });
47 }
49 function imscp_setup() {
50     // layout
51     YAHOO.widget.LayoutUnit.prototype.STR_COLLAPSE = mstr.moodle.hide;
52     YAHOO.widget.LayoutUnit.prototype.STR_EXPAND = mstr.moodle.show;
54     imscp_layout_widget = new YAHOO.widget.Layout('imscp_layout', {
55         minWidth: 600,
56         minHeight: 400,
57         units: [
58             { position: 'left', body: 'imscp_toc', header: mstr.imscp.toc, width: 250, resize: true, gutter: '2px 5px 5px 2px', collapse: true, minWidth:150},
59             { position: 'center', body: '<div id="imscp_content"></div>', gutter: '2px 5px 5px 2px', scroll: true}
60         ]
61     });
62     imscp_layout_widget.render();
63     var left = imscp_layout_widget.getUnitByPosition('left');
64     left.on('collapse', function() {
65         imscp_resize_frame();
66     });
67     left.on('expand', function() {
68         imscp_resize_frame();
69     });
71     // ugly resizing hack that works around problems with resizing of iframes and objects
72     left._resize.on('startResize', function() {
73         var obj = YAHOO.util.Dom.get('imscp_object');
74         obj.style.display = 'none';
75     });
76     left._resize.on('endResize', function() {
77         var obj = YAHOO.util.Dom.get('imscp_object');
78         obj.style.display = 'block';
79         imscp_resize_frame();
80     });
82     // TOC tree
83     var tree = new YAHOO.widget.TreeView('imscp_tree');
84     tree.singleNodeHighlight = true;
85     tree.subscribe('labelClick', function(node) {
86         imscp_activate_item(node);
87         if (node.children.length) {
88             imscp_bloody_labelclick = true;
89         }
90     });
91     tree.subscribe('collapse', function(node) {
92         if (imscp_bloody_labelclick) {
93             imscp_bloody_labelclick = false;
94             return false;
95         }
96     });
97     tree.subscribe('expand', function(node) {
98         if (imscp_bloody_labelclick) {
99             imscp_bloody_labelclick = false;
100             return false;
101         }
102     });
103     tree.expandAll();
104     tree.render();
106     // navigation
107     imscp_panel = new YAHOO.widget.Panel('imscp_navpanel', { visible:true, draggable:true, close:false,
108                                                            context: ['page', 'bl', 'bl', ["windowScroll", "textResize", "windowResize"]], constraintoviewport:true} );
109     imscp_panel.setHeader(mstr.imscp.navigation);
110     //TODO: make some better&accessible buttons
111     imscp_panel.setBody('<span id="imscp_nav"><button id="nav_skipprev">&lt;&lt;</button><button id="nav_prev">&lt;</button><button id="nav_up">^</button><button id="nav_next">&gt;</button><button id="nav_skipnext">&gt;&gt;</button></span>');
112     imscp_panel.render();
113     imscp_buttons[0] = new YAHOO.widget.Button('nav_skipprev');
114     imscp_buttons[1] = new YAHOO.widget.Button('nav_prev');
115     imscp_buttons[2] = new YAHOO.widget.Button('nav_up');
116     imscp_buttons[3] = new YAHOO.widget.Button('nav_next');
117     imscp_buttons[4] = new YAHOO.widget.Button('nav_skipnext');
118     imscp_buttons[0].on('click', function(ev) {
119         imscp_activate_item(imscp_skipprev(imscp_current_node));
120     });
121     imscp_buttons[1].on('click', function(ev) {
122         imscp_activate_item(imscp_prev(imscp_current_node));
123     });
124     imscp_buttons[2].on('click', function(ev) {
125         imscp_activate_item(imscp_up(imscp_current_node));
126     });
127     imscp_buttons[3].on('click', function(ev) {
128         imscp_activate_item(imscp_next(imscp_current_node));
129     });
130     imscp_buttons[4].on('click', function(ev) {
131         imscp_activate_item(imscp_skipnext(imscp_current_node));
132     });
133     imscp_panel.render();
135     // finally activate the first item
136     imscp_activate_item(tree.getRoot().children[0]);
138     // resizing
139     imscp_resize_layout(false);
141     // fix layout if window resized
142     window.onresize = function() {
143         imscp_resize_layout(true);
144     };
148 function imscp_activate_item(node) {
149     if (!node) {
150         return;
151     }
152     imscp_current_node = node;
153     imscp_current_node.highlight();
155     var content = new YAHOO.util.Element('imscp_content');
156     try {
157         // first try IE way - it can not set name attribute later
158         // and also it has some restrictions on DOM access from object tag
159         var obj = document.createElement('<iframe id="imscp_object" src="'+node.href+'">');
160     } catch (e) {
161         var obj = document.createElement('object');
162         obj.setAttribute('id', 'imscp_object');
163         obj.setAttribute('type', 'text/html');
164         obj.setAttribute('data', node.href);
165     }
166     var old = YAHOO.util.Dom.get('imscp_object');
167     if (old) {
168         content.replaceChild(obj, old);
169     } else {
170         content.appendChild(obj);
171     }
172     imscp_resize_frame();
174     imscp_current_node.focus();
175     imscp_fixnav();
178 /**
179  * Enables/disables navigation buttons as needed.
180  * @return void
181  */
182 function imscp_fixnav() {
183     imscp_buttons[0].set('disabled', (imscp_skipprev(imscp_current_node) == null));
184     imscp_buttons[1].set('disabled', (imscp_prev(imscp_current_node) == null));
185     imscp_buttons[2].set('disabled', (imscp_up(imscp_current_node) == null));
186     imscp_buttons[3].set('disabled', (imscp_next(imscp_current_node) == null));
187     imscp_buttons[4].set('disabled', (imscp_skipnext(imscp_current_node) == null));
191 function imscp_resize_layout(alsowidth) {
192     if (alsowidth) {
193         var layout = YAHOO.util.Dom.get('imscp_layout');
194         layout.style.width = '500px';
195         var newwidth = imscp_get_htmlelement_size('content', 'width');
196         if (newwidth > 500) {
197             layout.style.width = newwidth+'px';
198         }
199     }
200     var pageheight = imscp_get_htmlelement_size('page', 'height');
201     var layoutheight = imscp_get_htmlelement_size(imscp_layout_widget, 'height');
202     var newheight = layoutheight + parseInt(YAHOO.util.Dom.getViewportHeight()) - pageheight - 20;
203     if (newheight > 400) {
204         imscp_layout_widget.setStyle('height', newheight+'px');
205     }
206     imscp_layout_widget.render();
207     imscp_resize_frame();
209     imscp_panel.align('bl', 'bl');
212 function imscp_get_htmlelement_size(el, prop) {
213     var val = YAHOO.util.Dom.getStyle(el, prop);
214     if (val == 'auto') {
215         if (el.get) {
216             el = el.get('element'); // get real HTMLElement from YUI element
217         }
218         val = YAHOO.util.Dom.getComputedStyle(YAHOO.util.Dom.get(el), prop);
219     }
220     return parseInt(val);
223 function imscp_resize_frame() {
224     var obj = YAHOO.util.Dom.get('imscp_object');
225     if (obj) {
226         var content = imscp_layout_widget.getUnitByPosition('center').get('wrap');
227         obj.style.width = (content.offsetWidth - 6)+'px';
228         obj.style.height = (content.offsetHeight - 10)+'px';
229     }
233 function imscp_up(node) {
234     if (node.depth > 0) {
235         return node.parent;
236     }
237     return null;
240 function imscp_lastchild(node) {
241     if (node.children.length) {
242         return imscp_lastchild(node.children[node.children.length-1]);
243     } else {
244         return node;
245     }
248 function imscp_prev(node) {
249     if (node.previousSibling && node.previousSibling.children.length) {
250         return imscp_lastchild(node.previousSibling);
251     }
252     return imscp_skipprev(node);
255 function imscp_skipprev(node) {
256     if (node.previousSibling) {
257         return node.previousSibling;
258     } else if (node.depth > 0) {
259         return node.parent;
260     }
261     return null;
264 function imscp_next(node) {
265     if (node.children.length) {
266         return node.children[0];
267     }
268     return imscp_skipnext(node);
271 function imscp_skipnext(node) {
272     if (node.nextSibling) {
273         return node.nextSibling;
274     } else if (node.depth > 0) {
275         return imscp_skipnext(node.parent);
276     }
277     return null;