?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Updated PaintWeb to the latest snapshot.
[moodle/mihaisucan.git] / lib / paintweb / docs / api-ref / symbols / pwlib.tools.cpicker.html
blob0ae7457f75c514cb0c6f54dcaddaebb28bbc5c4c
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.tools.cpicker</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.tools.cpicker
326 </h1>
327
328 <!-- ============================== class summary ========================== -->
329 <p class="description">
330
331
332 The color picker tool.
333
334
335 <br /><i>Defined in: </i> <a href="../symbols/src/src_tools_cpicker.js.html">cpicker.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.tools.cpicker.">
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">&nbsp;</td>
352 <td class="nameDescription" >
353 <div class="fixedFont">
354 <b><a href="../symbols/pwlib.tools.cpicker.html#constructor">pwlib.tools.cpicker</a></b>(app)
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.tools.cpicker.">
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">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
379 <td class="nameDescription">
380 <div class="fixedFont">
381 <b><a href="../symbols/pwlib.tools.cpicker.html#-colorAccepted">colorAccepted</a></b>
382 </div>
383 <div class="description">Tells if the current color values are accepted by the user.</div>
384 </td>
385 </tr>
386
387 <tr>
388 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
389 <td class="nameDescription">
390 <div class="fixedFont">
391 <b><a href="../symbols/pwlib.tools.cpicker.html#-colormixerActive">colormixerActive</a></b>
392 </div>
393 <div class="description">Tells if the color mixer is active for the current target input.</div>
394 </td>
395 </tr>
396
397 <tr>
398 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
399 <td class="nameDescription">
400 <div class="fixedFont">
401 <b><a href="../symbols/pwlib.tools.cpicker.html#-prevColor">prevColor</a></b>
402 </div>
403 <div class="description">Holds the previous color values - before the user started picking
404 a different color.</div>
405 </td>
406 </tr>
407
408 <tr>
409 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
410 <td class="nameDescription">
411 <div class="fixedFont">
412 <b><a href="../symbols/pwlib.tools.cpicker.html#-prevTool">prevTool</a></b>
413 </div>
414 <div class="description">Holds the ID of the previously active tool.</div>
415 </td>
416 </tr>
417
418 <tr>
419 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
420 <td class="nameDescription">
421 <div class="fixedFont">
422 <b><a href="../symbols/pwlib.tools.cpicker.html#-targetInput">targetInput</a></b>
423 </div>
424 <div class="description">Holds a reference to the target color input.</div>
425 </td>
426 </tr>
427
428 </tbody>
429 </table>
430
431
432
433
434
435 <!-- ============================== methods summary ======================== -->
436
437
438
439 <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class pwlib.tools.cpicker.">
440 <caption>Method Summary</caption>
441 <thead>
442 <tr>
443 <th scope="col">Method Attributes</th>
444 <th scope="col">Method Name and Description</th>
445 </tr>
446 </thead>
447 <tbody>
448
449 <tr>
450 <td class="attributes">&nbsp;</td>
451 <td class="nameDescription">
452 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.cpicker.html#activate">activate</a></b>()
453 </div>
454 <div class="description">The <code>activate</code> event handler.</div>
455 </td>
456 </tr>
457
458 <tr>
459 <td class="attributes">&nbsp;</td>
460 <td class="nameDescription">
461 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.cpicker.html#contextmenu">contextmenu</a></b>()
462 </div>
463 <div class="description">The <code>contextmenu</code> event handler.</div>
464 </td>
465 </tr>
466
467 <tr>
468 <td class="attributes">&nbsp;</td>
469 <td class="nameDescription">
470 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.cpicker.html#deactivate">deactivate</a></b>()
471 </div>
472 <div class="description">The <code>deactivate</code> event handler.</div>
473 </td>
474 </tr>
475
476 <tr>
477 <td class="attributes">&nbsp;</td>
478 <td class="nameDescription">
479 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.cpicker.html#keydown">keydown</a></b>(ev)
480 </div>
481 <div class="description">The <code>keydown</code> event handler.</div>
482 </td>
483 </tr>
484
485 <tr>
486 <td class="attributes">&nbsp;</td>
487 <td class="nameDescription">
488 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.cpicker.html#mousedown">mousedown</a></b>(ev)
489 </div>
490 <div class="description">The <code>mousedown</code> event handler.</div>
491 </td>
492 </tr>
493
494 <tr>
495 <td class="attributes">&nbsp;</td>
496 <td class="nameDescription">
497 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.cpicker.html#mouseup">mouseup</a></b>(ev)
498 </div>
499 <div class="description">The <code>mouseup</code> event handler.</div>
500 </td>
501 </tr>
502
503 <tr>
504 <td class="attributes">&nbsp;</td>
505 <td class="nameDescription">
506 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.cpicker.html#preActivate">preActivate</a></b>()
507 </div>
508 <div class="description">The <code>preActivate</code> event handler.</div>
509 </td>
510 </tr>
511
512 <tr>
513 <td class="attributes">&lt;inner&gt; &nbsp;</td>
514 <td class="nameDescription">
515 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.cpicker.html#-updateColor">updateColor</a></b>(ev, usePrevColor)
516 </div>
517 <div class="description">Perform color update.</div>
518 </td>
519 </tr>
520
521 <tr>
522 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
523 <td class="nameDescription">
524 <div class="fixedFont"><b><a href="../symbols/pwlib.tools.cpicker.html#-updatePrevColor">updatePrevColor</a></b>()
525 </div>
526 <div class="description">Store the color values from the target color input, before this tool
527 changes the colors.</div>
528 </td>
529 </tr>
530
531 </tbody>
532 </table>
533
534
535
536
537 <!-- ============================== events summary ======================== -->
538
539
540 <!-- ============================== constructor details ==================== -->
541
542 <div class="details"><a name="constructor"> </a>
543 <div class="sectionTitle">
544 Class Detail
545 </div>
546
547 <div class="fixedFont">
548 <b>pwlib.tools.cpicker</b>(app)
549 </div>
550
551 <div class="description">
552
553
554 </div>
555
556
557
558
559
560 <dl class="detailList">
561 <dt class="heading">Parameters:</dt>
562
563 <dt>
564 <span class="light fixedFont">{<a href="../symbols/PaintWeb.html">PaintWeb</a>}</span> <b>app</b>
565
566 </dt>
567 <dd>Reference to the main paint application object.</dd>
568
569 </dl>
570
571
572
573
574
575
576
577
578 </div>
579
580
581 <!-- ============================== field details ========================== -->
582
583 <div class="sectionTitle">
584 Field Detail
585 </div>
586
587 <a name="-colorAccepted"> </a>
588 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
589
590 <span class="light">{Boolean}</span>
591 <b>colorAccepted</b>
592
593 </div>
594 <div class="description">
595 Tells if the current color values are accepted by the user. This value is
596 used by the tool deactivation code.
597
598
599 </div>
600
601
602
603
604
605
606
607
608 <hr />
609
610 <a name="-colormixerActive"> </a>
611 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
612
613 <span class="light">{Boolean}</span>
614 <b>colormixerActive</b>
615
616 </div>
617 <div class="description">
618 Tells if the color mixer is active for the current target input.
619
620
621 </div>
622
623
624
625
626
627
628
629
630 <hr />
631
632 <a name="-prevColor"> </a>
633 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
634
635 <span class="light">{Object}</span>
636 <b>prevColor</b>
637
638 </div>
639 <div class="description">
640 Holds the previous color values - before the user started picking
641 a different color.
642
643
644 </div>
645
646
647
648
649
650
651
652
653 <hr />
654
655 <a name="-prevTool"> </a>
656 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
657
658 <span class="light">{String}</span>
659 <b>prevTool</b>
660
661 </div>
662 <div class="description">
663 Holds the ID of the previously active tool. Once the user completes the
664 color picking operation, the previous tool is activated.
665
666
667 </div>
668
669
670
671
672
673
674
675
676 <hr />
677
678 <a name="-targetInput"> </a>
679 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
680
681 <span class="light">{<a href="../symbols/pwlib.guiColorInput.html">pwlib.guiColorInput</a>}</span>
682 <b>targetInput</b>
683
684 </div>
685 <div class="description">
686 Holds a reference to the target color input. This is a GUI color input
687 component.
688
689
690 </div>
691
692
693
694
695
696
697
698
699
700
701
702
703 <!-- ============================== method details ========================= -->
704
705 <div class="sectionTitle">
706 Method Detail
707 </div>
708
709 <a name="activate"> </a>
710 <div class="fixedFont">
711
712
713 <b>activate</b>()
714
715 </div>
716 <div class="description">
717 The <code>activate</code> event handler. This method determines the current
718 target input in the Color Mixer, if any. Canvas shadow rendering is
719 disallowed.
720
721
722 </div>
723
724
725
726
727
728
729
730
731
732
733
734 <hr />
735
736 <a name="contextmenu"> </a>
737 <div class="fixedFont">
738
739
740 <b>contextmenu</b>()
741
742 </div>
743 <div class="description">
744 The <code>contextmenu</code> event handler. This method only cancels the
745 context menu.
746
747
748 </div>
749
750
751
752
753
754
755
756
757
758
759
760 <hr />
761
762 <a name="deactivate"> </a>
763 <div class="fixedFont">
764
765
766 <b>deactivate</b>()
767
768 </div>
769 <div class="description">
770 The <code>deactivate</code> event handler. This method allows shadow
771 rendering again, and resets the color input values if the user did not
772 accept the new color.
773
774
775 </div>
776
777
778
779
780
781
782
783
784
785
786
787 <hr />
788
789 <a name="keydown"> </a>
790 <div class="fixedFont">
791
792 <span class="light">{Boolean}</span>
793 <b>keydown</b>(ev)
794
795 </div>
796 <div class="description">
797 The <code>keydown</code> event handler. This method allows the user to
798 press the <kbd>Escape</kbd> key to cancel the color picking operation. By
799 doing so, the original color values are restored.
800
801
802 </div>
803
804
805
806
807 <dl class="detailList">
808 <dt class="heading">Parameters:</dt>
809
810 <dt>
811 <span class="light fixedFont">{Event}</span> <b>ev</b>
812
813 </dt>
814 <dd>The DOM Event object.</dd>
815
816 </dl>
817
818
819
820
821
822 <dl class="detailList">
823 <dt class="heading">Returns:</dt>
824
825 <dd><span class="light fixedFont">{Boolean}</span> True if the keyboard shortcut was recognized, or false
826 if not.</dd>
827
828 </dl>
829
830
831
832
833 <hr />
834
835 <a name="mousedown"> </a>
836 <div class="fixedFont">
837
838
839 <b>mousedown</b>(ev)
840
841 </div>
842 <div class="description">
843 The <code>mousedown</code> event handler. This method starts the color
844 picking operation.
845
846
847 </div>
848
849
850
851
852 <dl class="detailList">
853 <dt class="heading">Parameters:</dt>
854
855 <dt>
856 <span class="light fixedFont">{Event}</span> <b>ev</b>
857
858 </dt>
859 <dd>The DOM Event object.</dd>
860
861 </dl>
862
863
864
865
866
867
868
869
870 <hr />
871
872 <a name="mouseup"> </a>
873 <div class="fixedFont">
874
875
876 <b>mouseup</b>(ev)
877
878 </div>
879 <div class="description">
880 The <code>mouseup</code> event handler. This method completes the color
881 picking operation, and activates the previous tool.
882
883 <p>The <a href="../symbols/pwlib.appEvent.configChange.html">pwlib.appEvent.configChange</a> application event is also
884 dispatched for the configuration property associated to the target input.
885
886
887 </div>
888
889
890
891
892 <dl class="detailList">
893 <dt class="heading">Parameters:</dt>
894
895 <dt>
896 <span class="light fixedFont">{Event}</span> <b>ev</b>
897
898 </dt>
899 <dd>The DOM Event object.</dd>
900
901 </dl>
902
903
904
905
906
907
908
909
910 <hr />
911
912 <a name="preActivate"> </a>
913 <div class="fixedFont">
914
915
916 <b>preActivate</b>()
917
918 </div>
919 <div class="description">
920 The <code>preActivate</code> event handler. This method checks if the
921 browser implements the <code>getImageData()</code> context method. If not,
922 the color picker tool cannot be used.
923
924
925 </div>
926
927
928
929
930
931
932
933
934
935
936
937 <hr />
938
939 <a name="-updateColor"> </a>
940 <div class="fixedFont">&lt;inner&gt;
941
942
943 <b>updateColor</b>(ev, usePrevColor)
944
945 </div>
946 <div class="description">
947 Perform color update. This function updates the target input or the Color
948 Mixer to hold the color value under the mouse - it actually performs the
949 color picking operation.
950
951 <p>This function is also the <code>mousemove</code> event handler for this
952 tool.
953
954
955 </div>
956
957
958
959
960 <dl class="detailList">
961 <dt class="heading">Parameters:</dt>
962
963 <dt>
964 <span class="light fixedFont">{Event}</span> <b>ev</b>
965
966 </dt>
967 <dd>The DOM Event object.</dd>
968
969 <dt>
970 <span class="light fixedFont">{Boolean}</span> <b>usePrevColor</b>
971 <i>Optional, Default: false</i>
972 </dt>
973 <dd>Tells the function to use the
974 previous color values we have stored. This is used when the user cancels
975 the color picking operation.</dd>
976
977 </dl>
978
979
980
981
982
983
984
985
986 <hr />
987
988 <a name="-updatePrevColor"> </a>
989 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
990
991
992 <b>updatePrevColor</b>()
993
994 </div>
995 <div class="description">
996 Store the color values from the target color input, before this tool
997 changes the colors. The previous color values are used when the user
998 decides to cancel the color picking operation.
999
1000
1001 </div>
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017 <!-- ============================== event details ========================= -->
1018
1019
1020 <hr />
1021 </div>
1022
1023
1024 <!-- ============================== footer ================================= -->
1025 <div class="fineprint" style="clear:both">
1026
1027 Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.0 on Fri Jul 31 2009 20:23:23 GMT+0300 (EEST)
1028 </div>
1029 </body>
1030 </html>
Mihai Sucan's work on Moodle