Worked on image save as a file in Moodle.
[moodle/mihaisucan.git] / lib / paintweb / docs / api-ref / symbols / pwlib.guiColorInput.html
blob48a49429e3c22df58d53d6b06cf066d0eb6f8024
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" />
8 <title>JsDoc Reference - pwlib.guiColorInput</title>
10 <style type="text/css">
11 /* default.css */
12 body
14 font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
15 width: 800px;
18 .header
20 clear: both;
21 background-color: #ccc;
22 padding: 8px;
27 font-size: 150%;
28 font-weight: bold;
29 padding: 0;
30 margin: 1em 0 0 .3em;
35 border: none 0;
36 border-top: 1px solid #7F8FB1;
37 height: 1px;
40 pre.code
42 display: block;
43 padding: 8px;
44 border: 1px dashed #ccc;
47 #index
49 margin-top: 24px;
50 float: left;
51 width: 160px;
52 position: absolute;
53 left: 8px;
54 background-color: #F3F3F3;
55 padding: 8px;
58 #content
60 margin-left: 190px;
61 width: 600px;
64 .classList
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;
74 .classList li
76 padding: 0;
77 margin: 0 0 8px 0;
80 .summaryTable { width: 100%; }
82 h1.classTitle
84 font-size:170%;
85 line-height:130%;
88 h2 { font-size: 110%; }
89 caption, div.sectionTitle
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;
99 div.sectionTitle { margin-bottom: 8px; }
100 .summaryTable thead { display: none; }
102 .summaryTable td
104 vertical-align: top;
105 padding: 4px;
106 border-bottom: 1px #7F8FB1 solid;
107 border-right: 1px #7F8FB1 solid;
110 /*col#summaryAttributes {}*/
111 .summaryTable td.attributes
113 border-left: 1px #7F8FB1 solid;
114 width: 140px;
115 text-align: right;
118 td.attributes, .fixedFont
120 line-height: 15px;
121 color: #002EBE;
122 font-family: "Courier New",Courier,monospace;
123 font-size: 13px;
126 .summaryTable td.nameDescription
128 text-align: left;
129 font-size: 13px;
130 line-height: 15px;
133 .summaryTable td.nameDescription, .description
135 line-height: 15px;
136 padding: 4px;
137 padding-left: 4px;
140 .summaryTable { margin-bottom: 8px; }
142 ul.inheritsList
144 list-style: square;
145 margin-left: 20px;
146 padding-left: 0;
149 .detailList {
150 margin-left: 20px;
151 line-height: 15px;
153 .detailList dt { margin-left: 20px; }
155 .detailList .heading
157 font-weight: bold;
158 padding-bottom: 6px;
159 margin-left: 0;
162 .light, td.attributes, .light a:link, .light a:visited
164 color: #777;
165 font-style: italic;
168 .fineprint
170 text-align: right;
171 font-size: 10px;
173 </style>
174 </head>
176 <body>
177 <!-- ============================== header ================================= -->
178 <!-- begin static/header.html -->
179 <div id="header">
180 </div>
181 <!-- end static/header.html -->
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">
192 <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
194 <li><a href="../symbols/PaintWeb.html">PaintWeb</a></li>
196 <li><a href="../symbols/pwlib.html">pwlib</a></li>
198 <li><a href="../symbols/pwlib.appEvent.html">pwlib.appEvent</a></li>
200 <li><a href="../symbols/pwlib.appEvent.appDestroy.html">pwlib.appEvent.appDestroy</a></li>
202 <li><a href="../symbols/pwlib.appEvent.appInit.html">pwlib.appEvent.appInit</a></li>
204 <li><a href="../symbols/pwlib.appEvent.canvasSizeChange.html">pwlib.appEvent.canvasSizeChange</a></li>
206 <li><a href="../symbols/pwlib.appEvent.clipboardUpdate.html">pwlib.appEvent.clipboardUpdate</a></li>
208 <li><a href="../symbols/pwlib.appEvent.commandRegister.html">pwlib.appEvent.commandRegister</a></li>
210 <li><a href="../symbols/pwlib.appEvent.commandUnregister.html">pwlib.appEvent.commandUnregister</a></li>
212 <li><a href="../symbols/pwlib.appEvent.configChange.html">pwlib.appEvent.configChange</a></li>
214 <li><a href="../symbols/pwlib.appEvent.extensionRegister.html">pwlib.appEvent.extensionRegister</a></li>
216 <li><a href="../symbols/pwlib.appEvent.extensionUnregister.html">pwlib.appEvent.extensionUnregister</a></li>
218 <li><a href="../symbols/pwlib.appEvent.guiFloatingPanelStateChange.html">pwlib.appEvent.guiFloatingPanelStateChange</a></li>
220 <li><a href="../symbols/pwlib.appEvent.guiHide.html">pwlib.appEvent.guiHide</a></li>
222 <li><a href="../symbols/pwlib.appEvent.guiResizeEnd.html">pwlib.appEvent.guiResizeEnd</a></li>
224 <li><a href="../symbols/pwlib.appEvent.guiResizeStart.html">pwlib.appEvent.guiResizeStart</a></li>
226 <li><a href="../symbols/pwlib.appEvent.guiShow.html">pwlib.appEvent.guiShow</a></li>
228 <li><a href="../symbols/pwlib.appEvent.guiTabActivate.html">pwlib.appEvent.guiTabActivate</a></li>
230 <li><a href="../symbols/pwlib.appEvent.historyUpdate.html">pwlib.appEvent.historyUpdate</a></li>
232 <li><a href="../symbols/pwlib.appEvent.imageCrop.html">pwlib.appEvent.imageCrop</a></li>
234 <li><a href="../symbols/pwlib.appEvent.imageSave.html">pwlib.appEvent.imageSave</a></li>
236 <li><a href="../symbols/pwlib.appEvent.imageSaveResult.html">pwlib.appEvent.imageSaveResult</a></li>
238 <li><a href="../symbols/pwlib.appEvent.imageSizeChange.html">pwlib.appEvent.imageSizeChange</a></li>
240 <li><a href="../symbols/pwlib.appEvent.imageZoom.html">pwlib.appEvent.imageZoom</a></li>
242 <li><a href="../symbols/pwlib.appEvent.selectionChange.html">pwlib.appEvent.selectionChange</a></li>
244 <li><a href="../symbols/pwlib.appEvent.shadowAllow.html">pwlib.appEvent.shadowAllow</a></li>
246 <li><a href="../symbols/pwlib.appEvent.toolActivate.html">pwlib.appEvent.toolActivate</a></li>
248 <li><a href="../symbols/pwlib.appEvent.toolPreactivate.html">pwlib.appEvent.toolPreactivate</a></li>
250 <li><a href="../symbols/pwlib.appEvent.toolRegister.html">pwlib.appEvent.toolRegister</a></li>
252 <li><a href="../symbols/pwlib.appEvent.toolUnregister.html">pwlib.appEvent.toolUnregister</a></li>
254 <li><a href="../symbols/pwlib.appEvents.html">pwlib.appEvents</a></li>
256 <li><a href="../symbols/pwlib.browser.html">pwlib.browser</a></li>
258 <li><a href="../symbols/pwlib.dom.html">pwlib.dom</a></li>
260 <li><a href="../symbols/pwlib.dom.KeyboardEventListener.html">pwlib.dom.KeyboardEventListener</a></li>
262 <li><a href="../symbols/pwlib.dom.keyCodes.html">pwlib.dom.keyCodes</a></li>
264 <li><a href="../symbols/pwlib.dom.keyCodes_fixes.html">pwlib.dom.keyCodes_fixes</a></li>
266 <li><a href="../symbols/pwlib.dom.keyCodes_Safari2.html">pwlib.dom.keyCodes_Safari2</a></li>
268 <li><a href="../symbols/pwlib.dom.keyNames.html">pwlib.dom.keyNames</a></li>
270 <li><a href="../symbols/pwlib.extensions.html">pwlib.extensions</a></li>
272 <li><a href="../symbols/pwlib.extensions.colormixer.html">pwlib.extensions.colormixer</a></li>
274 <li><a href="../symbols/pwlib.extensions.moodle.html">pwlib.extensions.moodle</a></li>
276 <li><a href="../symbols/pwlib.extensions.mousekeys.html">pwlib.extensions.mousekeys</a></li>
278 <li><a href="../symbols/pwlib.fileCache.html">pwlib.fileCache</a></li>
280 <li><a href="../symbols/pwlib.gui.html">pwlib.gui</a></li>
282 <li><a href="../symbols/pwlib.guiColorInput.html">pwlib.guiColorInput</a></li>
284 <li><a href="../symbols/pwlib.guiFloatingPanel.html">pwlib.guiFloatingPanel</a></li>
286 <li><a href="../symbols/pwlib.guiResizer.html">pwlib.guiResizer</a></li>
288 <li><a href="../symbols/pwlib.guiTabPanel.html">pwlib.guiTabPanel</a></li>
290 <li><a href="../symbols/pwlib.tools.html">pwlib.tools</a></li>
292 <li><a href="../symbols/pwlib.tools.bcurve.html">pwlib.tools.bcurve</a></li>
294 <li><a href="../symbols/pwlib.tools.cpicker.html">pwlib.tools.cpicker</a></li>
296 <li><a href="../symbols/pwlib.tools.ellipse.html">pwlib.tools.ellipse</a></li>
298 <li><a href="../symbols/pwlib.tools.eraser.html">pwlib.tools.eraser</a></li>
300 <li><a href="../symbols/pwlib.tools.hand.html">pwlib.tools.hand</a></li>
302 <li><a href="../symbols/pwlib.tools.insertimg.html">pwlib.tools.insertimg</a></li>
304 <li><a href="../symbols/pwlib.tools.line.html">pwlib.tools.line</a></li>
306 <li><a href="../symbols/pwlib.tools.pencil.html">pwlib.tools.pencil</a></li>
308 <li><a href="../symbols/pwlib.tools.polygon.html">pwlib.tools.polygon</a></li>
310 <li><a href="../symbols/pwlib.tools.rectangle.html">pwlib.tools.rectangle</a></li>
312 <li><a href="../symbols/pwlib.tools.selection.html">pwlib.tools.selection</a></li>
314 <li><a href="../symbols/pwlib.tools.text.html">pwlib.tools.text</a></li>
316 </ul>
317 <hr />
318 <!-- end publish.classesIndex -->
319 </div>
321 <div id="content">
322 <!-- ============================== class title ============================ -->
323 <h1 class="classTitle">
325 Class pwlib.guiColorInput
326 </h1>
328 <!-- ============================== class summary ========================== -->
329 <p class="description">
332 The color input GUI component.
335 <br /><i>Defined in: </i> <a href="../symbols/src/src_interfaces_default_script.js.html">script.js</a>.
337 </p>
339 <!-- ============================== constructor summary ==================== -->
341 <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class pwlib.guiColorInput.">
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.guiColorInput.html#constructor">pwlib.guiColorInput</a></b>(gui, input)
355 </div>
356 <div class="description"></div>
357 </td>
358 </tr>
359 </tbody>
360 </table>
363 <!-- ============================== properties summary ===================== -->
367 <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class pwlib.guiColorInput.">
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>
377 <tr>
378 <td class="attributes">&nbsp;</td>
379 <td class="nameDescription">
380 <div class="fixedFont">
381 <b><a href="../symbols/pwlib.guiColorInput.html#color">color</a></b>
382 </div>
383 <div class="description">Holds the current color displayed by the input.</div>
384 </td>
385 </tr>
387 <tr>
388 <td class="attributes">&nbsp;</td>
389 <td class="nameDescription">
390 <div class="fixedFont">
391 <b><a href="../symbols/pwlib.guiColorInput.html#configGroup">configGroup</a></b>
392 </div>
393 <div class="description">The configuration group to which this color input is attached to.</div>
394 </td>
395 </tr>
397 <tr>
398 <td class="attributes">&nbsp;</td>
399 <td class="nameDescription">
400 <div class="fixedFont">
401 <b><a href="../symbols/pwlib.guiColorInput.html#configGroupRef">configGroupRef</a></b>
402 </div>
403 <div class="description">Reference to the configuration object which holds the color input value.</div>
404 </td>
405 </tr>
407 <tr>
408 <td class="attributes">&nbsp;</td>
409 <td class="nameDescription">
410 <div class="fixedFont">
411 <b><a href="../symbols/pwlib.guiColorInput.html#configProperty">configProperty</a></b>
412 </div>
413 <div class="description">The configuration property to which this color input is attached to.</div>
414 </td>
415 </tr>
417 <tr>
418 <td class="attributes">&nbsp;</td>
419 <td class="nameDescription">
420 <div class="fixedFont">
421 <b><a href="../symbols/pwlib.guiColorInput.html#id">id</a></b>
422 </div>
423 <div class="description">Color input ID.</div>
424 </td>
425 </tr>
427 <tr>
428 <td class="attributes">&nbsp;</td>
429 <td class="nameDescription">
430 <div class="fixedFont">
431 <b><a href="../symbols/pwlib.guiColorInput.html#input">input</a></b>
432 </div>
433 <div class="description">The color input element DOM reference.</div>
434 </td>
435 </tr>
437 </tbody>
438 </table>
444 <!-- ============================== methods summary ======================== -->
448 <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class pwlib.guiColorInput.">
449 <caption>Method Summary</caption>
450 <thead>
451 <tr>
452 <th scope="col">Method Attributes</th>
453 <th scope="col">Method Name and Description</th>
454 </tr>
455 </thead>
456 <tbody>
458 <tr>
459 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
460 <td class="nameDescription">
461 <div class="fixedFont"><b><a href="../symbols/pwlib.guiColorInput.html#-colormixer_hide">colormixer_hide</a></b>()
462 </div>
463 <div class="description">The color mixer <code>hide</code> event handler.</div>
464 </td>
465 </tr>
467 <tr>
468 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
469 <td class="nameDescription">
470 <div class="fixedFont"><b><a href="../symbols/pwlib.guiColorInput.html#-colormixer_show">colormixer_show</a></b>()
471 </div>
472 <div class="description">The color mixer <code>show</code> event handler.</div>
473 </td>
474 </tr>
476 <tr>
477 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
478 <td class="nameDescription">
479 <div class="fixedFont"><b><a href="../symbols/pwlib.guiColorInput.html#-ev_input_click">ev_input_click</a></b>(ev)
480 </div>
481 <div class="description">The <code>click</code> event handler for the color input element.</div>
482 </td>
483 </tr>
485 <tr>
486 <td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
487 <td class="nameDescription">
488 <div class="fixedFont"><b><a href="../symbols/pwlib.guiColorInput.html#-init">init</a></b>()
489 </div>
490 <div class="description">Initialize the color input functionality.</div>
491 </td>
492 </tr>
494 <tr>
495 <td class="attributes">&nbsp;</td>
496 <td class="nameDescription">
497 <div class="fixedFont"><b><a href="../symbols/pwlib.guiColorInput.html#updateColor">updateColor</a></b>(color)
498 </div>
499 <div class="description">Update color.</div>
500 </td>
501 </tr>
503 </tbody>
504 </table>
509 <!-- ============================== events summary ======================== -->
512 <!-- ============================== constructor details ==================== -->
514 <div class="details"><a name="constructor"> </a>
515 <div class="sectionTitle">
516 Class Detail
517 </div>
519 <div class="fixedFont">&lt;private&gt;
520 <b>pwlib.guiColorInput</b>(gui, input)
521 </div>
523 <div class="description">
526 </div>
532 <dl class="detailList">
533 <dt class="heading">Parameters:</dt>
535 <dt>
536 <span class="light fixedFont">{<a href="../symbols/pwlib.gui.html">pwlib.gui</a>}</span> <b>gui</b>
538 </dt>
539 <dd>Reference to the PaintWeb GUI object.</dd>
541 <dt>
542 <span class="light fixedFont">{Element}</span> <b>input</b>
544 </dt>
545 <dd>Reference to the DOM input element. This can be
546 a span, a div, or any other tag.</dd>
548 </dl>
557 </div>
560 <!-- ============================== field details ========================== -->
562 <div class="sectionTitle">
563 Field Detail
564 </div>
566 <a name="color"> </a>
567 <div class="fixedFont">
569 <span class="light">{Object}</span>
570 <b>color</b>
572 </div>
573 <div class="description">
574 Holds the current color displayed by the input.
577 </div>
586 <hr />
588 <a name="configGroup"> </a>
589 <div class="fixedFont">
591 <span class="light">{String}</span>
592 <b>configGroup</b>
594 </div>
595 <div class="description">
596 The configuration group to which this color input is attached to.
599 </div>
608 <hr />
610 <a name="configGroupRef"> </a>
611 <div class="fixedFont">
613 <span class="light">{String}</span>
614 <b>configGroupRef</b>
616 </div>
617 <div class="description">
618 Reference to the configuration object which holds the color input value.
621 </div>
630 <hr />
632 <a name="configProperty"> </a>
633 <div class="fixedFont">
635 <span class="light">{String}</span>
636 <b>configProperty</b>
638 </div>
639 <div class="description">
640 The configuration property to which this color input is attached to.
643 </div>
652 <hr />
654 <a name="id"> </a>
655 <div class="fixedFont">
657 <span class="light">{String.}</span>
658 <b>id</b>
660 </div>
661 <div class="description">
662 Color input ID. The ID is the same as the data-pwColorInput attribute value
663 of the DOM input element .
666 </div>
675 <hr />
677 <a name="input"> </a>
678 <div class="fixedFont">
680 <span class="light">{Element}</span>
681 <b>input</b>
683 </div>
684 <div class="description">
685 The color input element DOM reference.
688 </div>
701 <!-- ============================== method details ========================= -->
703 <div class="sectionTitle">
704 Method Detail
705 </div>
707 <a name="-colormixer_hide"> </a>
708 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
711 <b>colormixer_hide</b>()
713 </div>
714 <div class="description">
715 The color mixer <code>hide</code> event handler. This function is invoked
716 when the color mixer is hidden.
719 </div>
731 <hr />
733 <a name="-colormixer_show"> </a>
734 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
737 <b>colormixer_show</b>()
739 </div>
740 <div class="description">
741 The color mixer <code>show</code> event handler. This function is invoked
742 when the color mixer is shown.
745 </div>
757 <hr />
759 <a name="-ev_input_click"> </a>
760 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
763 <b>ev_input_click</b>(ev)
765 </div>
766 <div class="description">
767 The <code>click</code> event handler for the color input element. This
768 function shows/hides the Color Mixer panel.
771 </div>
776 <dl class="detailList">
777 <dt class="heading">Parameters:</dt>
779 <dt>
780 <span class="light fixedFont">{Event}</span> <b>ev</b>
782 </dt>
783 <dd>The DOM Event object.</dd>
785 </dl>
794 <hr />
796 <a name="-init"> </a>
797 <div class="fixedFont">&lt;private&gt; &lt;inner&gt;
800 <b>init</b>()
802 </div>
803 <div class="description">
804 Initialize the color input functionality.
807 </div>
819 <hr />
821 <a name="updateColor"> </a>
822 <div class="fixedFont">
825 <b>updateColor</b>(color)
827 </div>
828 <div class="description">
829 Update color. This method allows the change of the color values associated
830 to the current color input.
832 <p>This method is used by the color picker tool and by the global GUI
833 <code>configChange</code> application event handler.
836 </div>
841 <dl class="detailList">
842 <dt class="heading">Parameters:</dt>
844 <dt>
845 <span class="light fixedFont">{Object}</span> <b>color</b>
847 </dt>
848 <dd>The new color values. The object must have four
849 properties: <var>red</var>, <var>green</var>, <var>blue</var> and
850 <var>alpha</var>. All values must be between 0 and 1.</dd>
852 </dl>
865 <!-- ============================== event details ========================= -->
868 <hr />
869 </div>
872 <!-- ============================== footer ================================= -->
873 <div class="fineprint" style="clear:both">
875 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)
876 </div>
877 </body>
878 </html>