?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Worked on image save as a file in Moodle.
[moodle/mihaisucan.git] / lib / paintweb / docs / api-ref / symbols / pwlib.guiFloatingPanel.html
blob2a93e35e25a9349e1f4419ab3cc731b7fd8e2f28
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 <head>
5 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
6 <meta name="generator" content="JsDoc Toolkit" />
7
8 <title>JsDoc Reference - pwlib.guiFloatingPanel</title>
9
10 <style type="text/css">
11 /* default.css */
12 body
13 {
14 font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
15 width: 800px;
16 }
17
18 .header
19 {
20 clear: both;
21 background-color: #ccc;
22 padding: 8px;
23 }
24
25 h1
26 {
27 font-size: 150%;
28 font-weight: bold;
29 padding: 0;
30 margin: 1em 0 0 .3em;
31 }
32
33 hr
34 {
35 border: none 0;
36 border-top: 1px solid #7F8FB1;
37 height: 1px;
38 }
39
40 pre.code
41 {
42 display: block;
43 padding: 8px;
44 border: 1px dashed #ccc;
45 }
46
47 #index
48 {
49 margin-top: 24px;
50 float: left;
51 width: 160px;
52 position: absolute;
53 left: 8px;
54 background-color: #F3F3F3;
55 padding: 8px;
56 }
57
58 #content
59 {
60 margin-left: 190px;
61 width: 600px;
62 }
63
64 .classList
65 {
66 list-style-type: none;
67 padding: 0;
68 margin: 0 0 0 8px;
69 font-family: arial, sans-serif;
70 font-size: 1em;
71 overflow: auto;
72 }
73
74 .classList li
75 {
76 padding: 0;
77 margin: 0 0 8px 0;
78 }
79
80 .summaryTable { width: 100%; }
81
82 h1.classTitle
83 {
84 font-size:170%;
85 line-height:130%;
86 }
87
88 h2 { font-size: 110%; }
89 caption, div.sectionTitle
90 {
91 background-color: #7F8FB1;
92 color: #fff;
93 font-size:130%;
94 text-align: left;
95 padding: 2px 6px 2px 6px;
96 border: 1px #7F8FB1 solid;
97 }
98
99 div.sectionTitle { margin-bottom: 8px; }
100 .summaryTable thead { display: none; }
101
102 .summaryTable td
103 {
104 vertical-align: top;
105 padding: 4px;
106 border-bottom: 1px #7F8FB1 solid;
107 border-right: 1px #7F8FB1 solid;
108 }
109
110 /*col#summaryAttributes {}*/
111 .summaryTable td.attributes
112 {
113 border-left: 1px #7F8FB1 solid;
114 width: 140px;
115 text-align: right;
116 }
117
118 td.attributes, .fixedFont
119 {
120 line-height: 15px;
121 color: #002EBE;
122 font-family: "Courier New",Courier,monospace;
123 font-size: 13px;
124 }
125
126 .summaryTable td.nameDescription
127 {
128 text-align: left;
129 font-size: 13px;
130 line-height: 15px;
131 }
132
133 .summaryTable td.nameDescription, .description
134 {
135 line-height: 15px;
136 padding: 4px;
137 padding-left: 4px;
138 }
139
140 .summaryTable { margin-bottom: 8px; }
141
142 ul.inheritsList
143 {
144 list-style: square;
145 margin-left: 20px;
146 padding-left: 0;
147 }
148
149 .detailList {
150 margin-left: 20px;
151 line-height: 15px;
152 }
153 .detailList dt { margin-left: 20px; }
154
155 .detailList .heading
156 {
157 font-weight: bold;
158 padding-bottom: 6px;
159 margin-left: 0;
160 }
161
162 .light, td.attributes, .light a:link, .light a:visited
163 {
164 color: #777;
165 font-style: italic;
166 }
167
168 .fineprint
169 {
170 text-align: right;
171 font-size: 10px;
172 }
173 </style>
174 </head>
175
176 <body>
177 <!-- ============================== header ================================= -->
178 <!-- begin static/header.html -->
179 <div id="header">
180 </div>
181 <!-- end static/header.html -->
182
183 <!-- ============================== classes index ============================ -->
184 <div id="index">
185 <!-- begin publish.classesIndex -->
186 <div align="center"><a href="../index.html">Class Index</a>
187 | <a href="../files.html">File Index</a></div>
188 <hr />
189 <h2>Classes</h2>
190 <ul class="classList">
191
192 <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
193
194 <li><a href="../symbols/PaintWeb.html">PaintWeb</a></li>
195
196 <li><a href="../symbols/pwlib.html">pwlib</a></li>
197
198 <li><a href="../symbols/pwlib.appEvent.html">pwlib.appEvent</a></li>
199
200 <li><a href="../symbols/pwlib.appEvent.appDestroy.html">pwlib.appEvent.appDestroy</a></li>
201
202 <li><a href="../symbols/pwlib.appEvent.appInit.html">pwlib.appEvent.appInit</a></li>
203
204 <li><a href="../symbols/pwlib.appEvent.canvasSizeChange.html">pwlib.appEvent.canvasSizeChange</a></li>
205
206 <li><a href="../symbols/pwlib.appEvent.clipboardUpdate.html">pwlib.appEvent.clipboardUpdate</a></li>
207
208 <li><a href="../symbols/pwlib.appEvent.commandRegister.html">pwlib.appEvent.commandRegister</a></li>
209
210 <li><a href="../symbols/pwlib.appEvent.commandUnregister.html">pwlib.appEvent.commandUnregister</a></li>
211
212 <li><a href="../symbols/pwlib.appEvent.configChange.html">pwlib.appEvent.configChange</a></li>
213
214 <li><a href="../symbols/pwlib.appEvent.extensionRegister.html">pwlib.appEvent.extensionRegister</a></li>
215
216 <li><a href="../symbols/pwlib.appEvent.extensionUnregister.html">pwlib.appEvent.extensionUnregister</a></li>
217
218 <li><a href="../symbols/pwlib.appEvent.guiFloatingPanelStateChange.html">pwlib.appEvent.guiFloatingPanelStateChange</a></li>
219
220 <li><a href="../symbols/pwlib.appEvent.guiHide.html">pwlib.appEvent.guiHide</a></li>
221
222 <li><a href="../symbols/pwlib.appEvent.guiResizeEnd.html">pwlib.appEvent.guiResizeEnd</a></li>
223
224 <li><a href="../symbols/pwlib.appEvent.guiResizeStart.html">pwlib.appEvent.guiResizeStart</a></li>
225
226 <li><a href="../symbols/pwlib.appEvent.guiShow.html">pwlib.appEvent.guiShow</a></li>
227
228 <li><a href="../symbols/pwlib.appEvent.guiTabActivate.html">pwlib.appEvent.guiTabActivate</a></li>
229
230 <li><a href="../symbols/pwlib.appEvent.historyUpdate.html">pwlib.appEvent.historyUpdate</a></li>
231
232 <li><a href="../symbols/pwlib.appEvent.imageCrop.html">pwlib.appEvent.imageCrop</a></li>
233
234 <li><a href="../symbols/pwlib.appEvent.imageSave.html">pwlib.appEvent.imageSave</a></li>
235
236 <li><a href="../symbols/pwlib.appEvent.imageSaveResult.html">pwlib.appEvent.imageSaveResult</a></li>
237
238 <li><a href="../symbols/pwlib.appEvent.imageSizeChange.html">pwlib.appEvent.imageSizeChange</a></li>
239
240 <li><a href="../symbols/pwlib.appEvent.imageZoom.html">pwlib.appEvent.imageZoom</a></li>
241
242 <li><a href="../symbols/pwlib.appEvent.selectionChange.html">pwlib.appEvent.selectionChange</a></li>
243
244 <li><a href="../symbols/pwlib.appEvent.shadowAllow.html">pwlib.appEvent.shadowAllow</a></li>
245
246 <li><a href="../symbols/pwlib.appEvent.toolActivate.html">pwlib.appEvent.toolActivate</a></li>
247
248 <li><a href="../symbols/pwlib.appEvent.toolPreactivate.html">pwlib.appEvent.toolPreactivate</a></li>
249
250 <li><a href="../symbols/pwlib.appEvent.toolRegister.html">pwlib.appEvent.toolRegister</a></li>
251
252 <li><a href="../symbols/pwlib.appEvent.toolUnregister.html">pwlib.appEvent.toolUnregister</a></li>
253
254 <li><a href="../symbols/pwlib.appEvents.html">pwlib.appEvents</a></li>
255
256 <li><a href="../symbols/pwlib.browser.html">pwlib.browser</a></li>
257
258 <li><a href="../symbols/pwlib.dom.html">pwlib.dom</a></li>
259
260 <li><a href="../symbols/pwlib.dom.KeyboardEventListener.html">pwlib.dom.KeyboardEventListener</a></li>
261
262 <li><a href="../symbols/pwlib.dom.keyCodes.html">pwlib.dom.keyCodes</a></li>
263
264 <li><a href="../symbols/pwlib.dom.keyCodes_fixes.html">pwlib.dom.keyCodes_fixes</a></li>
265
266 <li><a href="../symbols/pwlib.dom.keyCodes_Safari2.html">pwlib.dom.keyCodes_Safari2</a></li>
267
268 <li><a href="../symbols/pwlib.dom.keyNames.html">pwlib.dom.keyNames</a></li>
269
270 <li><a href="../symbols/pwlib.extensions.html">pwlib.extensions</a></li>
271
272 <li><a href="../symbols/pwlib.extensions.colormixer.html">pwlib.extensions.colormixer</a></li>
273
274 <li><a href="../symbols/pwlib.extensions.moodle.html">pwlib.extensions.moodle</a></li>
275
276 <li><a href="../symbols/pwlib.extensions.mousekeys.html">pwlib.extensions.mousekeys</a></li>
277
278 <li><a href="../symbols/pwlib.fileCache.html">pwlib.fileCache</a></li>
279
280 <li><a href="../symbols/pwlib.gui.html">pwlib.gui</a></li>
281
282 <li><a href="../symbols/pwlib.guiColorInput.html">pwlib.guiColorInput</a></li>
283
284 <li><a href="../symbols/pwlib.guiFloatingPanel.html">pwlib.guiFloatingPanel</a></li>
285
286 <li><a href="../symbols/pwlib.guiResizer.html">pwlib.guiResizer</a></li>
287
288 <li><a href="../symbols/pwlib.guiTabPanel.html">pwlib.guiTabPanel</a></li>
289
290 <li><a href="../symbols/pwlib.tools.html">pwlib.tools</a></li>
291
292 <li><a href="../symbols/pwlib.tools.bcurve.html">pwlib.tools.bcurve</a></li>
293
294 <li><a href="../symbols/pwlib.tools.cpicker.html">pwlib.tools.cpicker</a></li>
295
296 <li><a href="../symbols/pwlib.tools.ellipse.html">pwlib.tools.ellipse</a></li>
297
298 <li><a href="../symbols/pwlib.tools.eraser.html">pwlib.tools.eraser</a></li>
299
300 <li><a href="../symbols/pwlib.tools.hand.html">pwlib.tools.hand</a></li>
301
302 <li><a href="../symbols/pwlib.tools.insertimg.html">pwlib.tools.insertimg</a></li>
303
304 <li><a href="../symbols/pwlib.tools.line.html">pwlib.tools.line</a></li>
305
306 <li><a href="../symbols/pwlib.tools.pencil.html">pwlib.tools.pencil</a></li>
307
308 <li><a href="../symbols/pwlib.tools.polygon.html">pwlib.tools.polygon</a></li>
309
310 <li><a href="../symbols/pwlib.tools.rectangle.html">pwlib.tools.rectangle</a></li>
311
312 <li><a href="../symbols/pwlib.tools.selection.html">pwlib.tools.selection</a></li>
313
314 <li><a href="../symbols/pwlib.tools.text.html">pwlib.tools.text</a></li>
315
316 </ul>
317 <hr />
318 <!-- end publish.classesIndex -->
319 </div>
320
321 <div id="content">
322 <!-- ============================== class title ============================ -->
323 <h1 class="classTitle">
324
325 Class pwlib.guiFloatingPanel
326 </h1>
327
328 <!-- ============================== class summary ========================== -->
329 <p class="description">
330
331
332 A floating panel GUI element.
333
334
335 <br /><i>Defined in: </i> <a href="../symbols/src/src_interfaces_default_script.js.html">script.js</a>.
336
337 </p>
338
339 <!-- ============================== constructor summary ==================== -->
340
341 <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class pwlib.guiFloatingPanel.">
342 <caption>Class Summary</caption>
343 <thead>
344 <tr>
345 <th scope="col">Constructor Attributes</th>
346 <th scope="col">Constructor Name and Description</th>
347 </tr>
348 </thead>
349 <tbody>
350 <tr>
351 <td class="attributes">&lt;private&gt; &nbsp;</td>
352 <td class="nameDescription" >
353 <div class="fixedFont">
354 <b><a href="../symbols/pwlib.guiFloatingPanel.html#constructor">pwlib.guiFloatingPanel</a></b>(gui, container)
355 </div>
356 <div class="description"></div>
357 </td>
358 </tr>
359 </tbody>
360 </table>
361
362
363 <!-- ============================== properties summary ===================== -->
364
365
366
367 <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class pwlib.guiFloatingPanel.">
368 <caption>Field Summary</caption>
369 <thead>
370 <tr>
371 <th scope="col">Field Attributes</th>
372 <th scope="col">Field Name and Description</th>
373 </tr>
374 </thead>
375 <tbody>
376
377 <tr>
378 <td class="attributes">&nbsp;</td>
379 <td class="nameDescription">
380 <div class="fixedFont">
381 <b><a href="../symbols/pwlib.guiFloatingPanel.html#container">container</a></b>
382 </div>
383 <div class="description">Reference to the floating panel element.</div>
384 </td>
385 </tr>
386
387 <tr>
388 <td class="attributes">&nbsp;</td>
389 <td class="nameDescription">
390 <div class="fixedFont">
391 <b><a href="../symbols/pwlib.guiFloatingPanel.html#content">content</a></b>
392 </div>
393 <div class="description">The panel content element.</div>
394 </td>
395 </tr>
396
397 <tr>
398 <td class="attributes">&nbsp;</td>
399 <td class="nameDescription">
400 <div class="fixedFont">
401 <b><a href="../symbols/pwlib.guiFloatingPanel.html#events">events</a></b>
402 </div>
403 <div class="description">Custom application events interface.</div>
404 </td>
405 </tr>
406
407 <tr>
408 <td class="attributes">&nbsp;</td>
409 <td class="nameDescription">
410 <div class="fixedFont">
411 <b><a href="../symbols/pwlib.guiFloatingPanel.html#id">id</a></b>
412 </div>
413 <div class="description">Floating panel ID.</div>
414 </td>
415 </tr>
416
417 <tr>
418 <td class="attributes">&nbsp;</td>
419 <td class="nameDescription">
420 <div class="fixedFont">
421 <b><a href="../symbols/pwlib.guiFloatingPanel.html#state">state</a></b>
422 </div>
423 <div class="description">Tells the state of the floating panel: hidden/minimized/visible or if it's
424 being dragged.</div>
425 </td>
426 </tr>
427
428 <tr>
429 <td class="attributes">&lt;constant&gt; &nbsp;</td>
430 <td class="nameDescription">
431 <div class="fixedFont">
432 <b><a href="../symbols/pwlib.guiFloatingPanel.html#STATE_DRAGGING">STATE_DRAGGING</a></b>
433 </div>
434 <div class="description">Panel state: the user is dragging the floating panel.</div>
435 </td>
436 </tr>
437
438 <tr>
439 <td class="attributes">&lt;constant&gt; &nbsp;</td>
440 <td class="nameDescription">
441 <div class="fixedFont">
442 <b><a href="../symbols/pwlib.guiFloatingPanel.html#STATE_HIDDEN">STATE_HIDDEN</a></b>
443 </div>
444 <div class="description">Panel state: hidden.</div>
445 </td>
446 </tr>
447
448 <tr>
449 <td class="attributes">&lt;constant&gt; &nbsp;</td>
450 <td class="nameDescription">
451 <div class="fixedFont">
452 <b><a href="../symbols/pwlib.guiFloatingPanel.html#STATE_MINIMIZED">STATE_MINIMIZED</a></b>
453 </div>
454 <div class="description">Panel state: minimized.</div>
455 </td>
456 </tr>
457
458 <tr>
459 <td class="attributes">&lt;constant&gt; &nbsp;</td>
460 <td class="nameDescription">
461 <div class="fixedFont">
462 <b><a href="../symbols/pwlib.guiFloatingPanel.html#STATE_VISIBLE">STATE_VISIBLE</a></b>
463 </div>
464 <div class="description">Panel state: visible.</div>
465 </td>
466 </tr>
467
468 <tr>
469 <td class="attributes">&nbsp;</td>
470 <td class="nameDescription">
471 <div class="fixedFont">
472 <b><a href="../symbols/pwlib.guiFloatingPanel.html#viewport">viewport</a></b>
473 </div>
474 <div class="description">The viewport element.</div>
475 </td>
476 </tr>
477
478 </tbody>
479 </table>
480
481
482
483
484
485 <!-- ============================== methods summary ======================== -->
486
487
488
489 <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class pwlib.guiFloatingPanel.">
490 <caption>Method Summary</caption>
491 <thead>
492 <tr>
493 <th scope="col">Method Attributes</th>
494 <th scope="col">Method Name and Description</th>
495 </tr>
496 </thead>
497 <tbody>
498
499 <tr>
500 <td class="attributes">&nbsp;</td>
501 <td class="nameDescription">
502 <div class="fixedFont"><b><a href="../symbols/pwlib.guiFloatingPanel.html#bringOnTop">bringOnTop</a></b>()
503 </div>
504 <div class="description">Bring the panel to the top.</div>
505 </td>
506 </tr>
507
508 <tr>
509 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
510 <td class="nameDescription">
511 <div class="fixedFont"><b><a href="../symbols/pwlib.guiFloatingPanel.html#-ev_close">ev_close</a></b>(ev)
512 </div>
513 <div class="description">The <code>click</code> event handler for the panel Close button element.</div>
514 </td>
515 </tr>
516
517 <tr>
518 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
519 <td class="nameDescription">
520 <div class="fixedFont"><b><a href="../symbols/pwlib.guiFloatingPanel.html#-ev_minimize">ev_minimize</a></b>(ev)
521 </div>
522 <div class="description">The <code>click</code> event handler for the panel Minimize button element.</div>
523 </td>
524 </tr>
525
526 <tr>
527 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
528 <td class="nameDescription">
529 <div class="fixedFont"><b><a href="../symbols/pwlib.guiFloatingPanel.html#-ev_mousedown">ev_mousedown</a></b>(ev)
530 </div>
531 <div class="description">The <code>mousedown</code> event handler.</div>
532 </td>
533 </tr>
534
535 <tr>
536 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
537 <td class="nameDescription">
538 <div class="fixedFont"><b><a href="../symbols/pwlib.guiFloatingPanel.html#-ev_mousemove">ev_mousemove</a></b>(ev)
539 </div>
540 <div class="description">The <code>mousemove</code> event handler.</div>
541 </td>
542 </tr>
543
544 <tr>
545 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
546 <td class="nameDescription">
547 <div class="fixedFont"><b><a href="../symbols/pwlib.guiFloatingPanel.html#-ev_mouseup">ev_mouseup</a></b>(ev)
548 </div>
549 <div class="description">The <code>mouseup</code> event handler.</div>
550 </td>
551 </tr>
552
553 <tr>
554 <td class="attributes">&nbsp;</td>
555 <td class="nameDescription">
556 <div class="fixedFont"><b><a href="../symbols/pwlib.guiFloatingPanel.html#hide">hide</a></b>()
557 </div>
558 <div class="description">Hide the panel.</div>
559 </td>
560 </tr>
561
562 <tr>
563 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
564 <td class="nameDescription">
565 <div class="fixedFont"><b><a href="../symbols/pwlib.guiFloatingPanel.html#-init">init</a></b>()
566 </div>
567 <div class="description">Initialize the floating panel.</div>
568 </td>
569 </tr>
570
571 <tr>
572 <td class="attributes">&nbsp;</td>
573 <td class="nameDescription">
574 <div class="fixedFont"><b><a href="../symbols/pwlib.guiFloatingPanel.html#show">show</a></b>()
575 </div>
576 <div class="description">Show the panel.</div>
577 </td>
578 </tr>
579
580 <tr>
581 <td class="attributes">&nbsp;</td>
582 <td class="nameDescription">
583 <div class="fixedFont"><b><a href="../symbols/pwlib.guiFloatingPanel.html#toggle">toggle</a></b>()
584 </div>
585 <div class="description">Toggle the panel visibility.</div>
586 </td>
587 </tr>
588
589 </tbody>
590 </table>
591
592
593
594
595 <!-- ============================== events summary ======================== -->
596
597
598 <!-- ============================== constructor details ==================== -->
599
600 <div class="details"><a name="constructor"> </a>
601 <div class="sectionTitle">
602 Class Detail
603 </div>
604
605 <div class="fixedFont">&lt;private&gt;
606 <b>pwlib.guiFloatingPanel</b>(gui, container)
607 </div>
608
609 <div class="description">
610
611
612 </div>
613
614
615
616
617
618 <dl class="detailList">
619 <dt class="heading">Parameters:</dt>
620
621 <dt>
622 <span class="light fixedFont">{<a href="../symbols/pwlib.gui.html">pwlib.gui</a>}</span> <b>gui</b>
623
624 </dt>
625 <dd>Reference to the PaintWeb GUI object.</dd>
626
627 <dt>
628 <span class="light fixedFont">{Element}</span> <b>container</b>
629
630 </dt>
631 <dd>Reference to the DOM element you want to transform
632 into a floating panel.</dd>
633
634 </dl>
635
636
637
638
639
640
641
642
643 </div>
644
645
646 <!-- ============================== field details ========================== -->
647
648 <div class="sectionTitle">
649 Field Detail
650 </div>
651
652 <a name="container"> </a>
653 <div class="fixedFont">
654
655 <span class="light">{Element}</span>
656 <b>container</b>
657
658 </div>
659 <div class="description">
660 Reference to the floating panel element.
661
662
663 </div>
664
665
666
667
668
669
670
671
672 <hr />
673
674 <a name="content"> </a>
675 <div class="fixedFont">
676
677 <span class="light">{Element}</span>
678 <b>content</b>
679
680 </div>
681 <div class="description">
682 The panel content element.
683
684
685 </div>
686
687
688
689
690
691
692
693
694 <hr />
695
696 <a name="events"> </a>
697 <div class="fixedFont">
698
699 <span class="light">{<a href="../symbols/pwlib.appEvents.html">pwlib.appEvents</a>}</span>
700 <b>events</b>
701
702 </div>
703 <div class="description">
704 Custom application events interface.
705
706
707 </div>
708
709
710
711
712
713
714
715
716 <hr />
717
718 <a name="id"> </a>
719 <div class="fixedFont">
720
721 <span class="light">{String}</span>
722 <b>id</b>
723
724 </div>
725 <div class="description">
726 Floating panel ID. This is the ID used in the
727 <var>data-pwFloatingPanel</var> element attribute.
728
729
730 </div>
731
732
733
734
735
736
737
738
739 <hr />
740
741 <a name="state"> </a>
742 <div class="fixedFont">
743
744 <span class="light">{Number}</span>
745 <b>state</b>
746
747 </div>
748 <div class="description">
749 Tells the state of the floating panel: hidden/minimized/visible or if it's
750 being dragged.
751
752
753 </div>
754
755
756
757
758
759
760
761
762 <hr />
763
764 <a name="STATE_DRAGGING"> </a>
765 <div class="fixedFont">&lt;constant&gt;
766
767
768 <b>STATE_DRAGGING</b>
769
770 </div>
771 <div class="description">
772 Panel state: the user is dragging the floating panel.
773
774
775 </div>
776
777
778
779
780
781
782
783
784 <hr />
785
786 <a name="STATE_HIDDEN"> </a>
787 <div class="fixedFont">&lt;constant&gt;
788
789
790 <b>STATE_HIDDEN</b>
791
792 </div>
793 <div class="description">
794 Panel state: hidden.
795
796
797 </div>
798
799
800
801
802
803
804
805
806 <hr />
807
808 <a name="STATE_MINIMIZED"> </a>
809 <div class="fixedFont">&lt;constant&gt;
810
811
812 <b>STATE_MINIMIZED</b>
813
814 </div>
815 <div class="description">
816 Panel state: minimized.
817
818
819 </div>
820
821
822
823
824
825
826
827
828 <hr />
829
830 <a name="STATE_VISIBLE"> </a>
831 <div class="fixedFont">&lt;constant&gt;
832
833
834 <b>STATE_VISIBLE</b>
835
836 </div>
837 <div class="description">
838 Panel state: visible.
839
840
841 </div>
842
843
844
845
846
847
848
849
850 <hr />
851
852 <a name="viewport"> </a>
853 <div class="fixedFont">
854
855 <span class="light">{Element}</span>
856 <b>viewport</b>
857
858 </div>
859 <div class="description">
860 The viewport element. This element is the first parent element which has
861 the style.overflow set to "auto" or "scroll".
862
863
864 </div>
865
866
867
868
869
870
871
872
873
874
875
876
877 <!-- ============================== method details ========================= -->
878
879 <div class="sectionTitle">
880 Method Detail
881 </div>
882
883 <a name="bringOnTop"> </a>
884 <div class="fixedFont">
885
886
887 <b>bringOnTop</b>()
888
889 </div>
890 <div class="description">
891 Bring the panel to the top. This method makes sure the current floating
892 panel is visible.
893
894
895 </div>
896
897
898
899
900
901
902
903
904
905
906
907 <hr />
908
909 <a name="-ev_close"> </a>
910 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
911
912
913 <b>ev_close</b>(ev)
914
915 </div>
916 <div class="description">
917 The <code>click</code> event handler for the panel Close button element.
918 This hides the floating panel.
919
920 <p>This method dispatches the
921 <a href="../symbols/pwlib.appEvent.guiFloatingPanelStateChange.html">pwlib.appEvent.guiFloatingPanelStateChange</a> application event.
922
923
924 </div>
925
926
927
928
929 <dl class="detailList">
930 <dt class="heading">Parameters:</dt>
931
932 <dt>
933 <span class="light fixedFont">{Event}</span> <b>ev</b>
934
935 </dt>
936 <dd>The DOM Event object.</dd>
937
938 </dl>
939
940
941
942
943
944
945
946
947 <hr />
948
949 <a name="-ev_minimize"> </a>
950 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
951
952
953 <b>ev_minimize</b>(ev)
954
955 </div>
956 <div class="description">
957 The <code>click</code> event handler for the panel Minimize button element.
958
959 <p>This method dispatches the
960 <a href="../symbols/pwlib.appEvent.guiFloatingPanelStateChange.html">pwlib.appEvent.guiFloatingPanelStateChange</a> application event.
961
962
963 </div>
964
965
966
967
968 <dl class="detailList">
969 <dt class="heading">Parameters:</dt>
970
971 <dt>
972 <span class="light fixedFont">{Event}</span> <b>ev</b>
973
974 </dt>
975 <dd>The DOM Event object.</dd>
976
977 </dl>
978
979
980
981
982
983
984
985
986 <hr />
987
988 <a name="-ev_mousedown"> </a>
989 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
990
991
992 <b>ev_mousedown</b>(ev)
993
994 </div>
995 <div class="description">
996 The <code>mousedown</code> event handler. This is invoked when you start
997 dragging the floating panel.
998
999 <p>This method dispatches the
1000 <a href="../symbols/pwlib.appEvent.guiFloatingPanelStateChange.html">pwlib.appEvent.guiFloatingPanelStateChange</a> application event.
1001
1002
1003 </div>
1004
1005
1006
1007
1008 <dl class="detailList">
1009 <dt class="heading">Parameters:</dt>
1010
1011 <dt>
1012 <span class="light fixedFont">{Event}</span> <b>ev</b>
1013
1014 </dt>
1015 <dd>The DOM Event object.</dd>
1016
1017 </dl>
1018
1019
1020
1021
1022
1023
1024
1025
1026 <hr />
1027
1028 <a name="-ev_mousemove"> </a>
1029 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
1030
1031
1032 <b>ev_mousemove</b>(ev)
1033
1034 </div>
1035 <div class="description">
1036 The <code>mousemove</code> event handler. This performs the actual move of
1037 the floating panel.
1038
1039
1040 </div>
1041
1042
1043
1044
1045 <dl class="detailList">
1046 <dt class="heading">Parameters:</dt>
1047
1048 <dt>
1049 <span class="light fixedFont">{Event}</span> <b>ev</b>
1050
1051 </dt>
1052 <dd>The DOM Event object.</dd>
1053
1054 </dl>
1055
1056
1057
1058
1059
1060
1061
1062
1063 <hr />
1064
1065 <a name="-ev_mouseup"> </a>
1066 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
1067
1068
1069 <b>ev_mouseup</b>(ev)
1070
1071 </div>
1072 <div class="description">
1073 The <code>mouseup</code> event handler. This ends the panel drag operation.
1074
1075 <p>This method dispatches the
1076 <a href="../symbols/pwlib.appEvent.guiFloatingPanelStateChange.html">pwlib.appEvent.guiFloatingPanelStateChange</a> application event.
1077
1078
1079 </div>
1080
1081
1082
1083
1084 <dl class="detailList">
1085 <dt class="heading">Parameters:</dt>
1086
1087 <dt>
1088 <span class="light fixedFont">{Event}</span> <b>ev</b>
1089
1090 </dt>
1091 <dd>The DOM Event object.</dd>
1092
1093 </dl>
1094
1095
1096
1097
1098
1099
1100
1101
1102 <hr />
1103
1104 <a name="hide"> </a>
1105 <div class="fixedFont">
1106
1107
1108 <b>hide</b>()
1109
1110 </div>
1111 <div class="description">
1112 Hide the panel.
1113
1114 <p>This method dispatches the
1115 <a href="../symbols/pwlib.appEvent.guiFloatingPanelStateChange.html">pwlib.appEvent.guiFloatingPanelStateChange</a> application event.
1116
1117
1118 </div>
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130 <hr />
1131
1132 <a name="-init"> </a>
1133 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
1134
1135
1136 <b>init</b>()
1137
1138 </div>
1139 <div class="description">
1140 Initialize the floating panel.
1141
1142
1143 </div>
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155 <hr />
1156
1157 <a name="show"> </a>
1158 <div class="fixedFont">
1159
1160
1161 <b>show</b>()
1162
1163 </div>
1164 <div class="description">
1165 Show the panel.
1166
1167 <p>This method dispatches the
1168 <a href="../symbols/pwlib.appEvent.guiFloatingPanelStateChange.html">pwlib.appEvent.guiFloatingPanelStateChange</a> application event.
1169
1170
1171 </div>
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183 <hr />
1184
1185 <a name="toggle"> </a>
1186 <div class="fixedFont">
1187
1188
1189 <b>toggle</b>()
1190
1191 </div>
1192 <div class="description">
1193 Toggle the panel visibility.
1194
1195 <p>This method dispatches the
1196 <a href="../symbols/pwlib.appEvent.guiFloatingPanelStateChange.html">pwlib.appEvent.guiFloatingPanelStateChange</a> application event.
1197
1198
1199 </div>
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215 <!-- ============================== event details ========================= -->
1216
1217
1218 <hr />
1219 </div>
1220
1221
1222 <!-- ============================== footer ================================= -->
1223 <div class="fineprint" style="clear:both">
1224
1225 Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.0 on Mon Jul 27 2009 14:56:58 GMT+0300 (EEST)
1226 </div>
1227 </body>
1228 </html>
Mihai Sucan's work on Moodle