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">
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">
14 font: 12px "Lucida Grande", Tahoma
, Arial
, Helvetica
, sans-serif
;
21 background-color: #ccc;
36 border-top: 1px solid
#7F8FB1;
44 border: 1px dashed
#ccc;
54 background-color: #F3F3F3;
66 list-style-type: none
;
69 font-family: arial
, sans-serif
;
80 .summaryTable { width: 100%; }
88 h2
{ font-size: 110%; }
89 caption
, div
.sectionTitle
91 background-color: #7F8FB1;
95 padding: 2px 6px 2px 6px;
96 border: 1px #7F8FB1 solid
;
99 div
.sectionTitle
{ margin-bottom: 8px; }
100 .summaryTable thead { display: none
; }
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
;
118 td
.attributes
, .fixedFont
122 font-family: "Courier New",Courier
,monospace
;
126 .summaryTable td
.nameDescription
133 .summaryTable td
.nameDescription
, .description
140 .summaryTable { margin-bottom: 8px; }
153 .detailList dt { margin-left: 20px; }
162 .light
, td
.attributes
, .light
a:link
, .light
a:visited
177 <!-- ============================== header ================================= -->
178 <!-- begin static/header.html -->
181 <!-- end static/header.html -->
183 <!-- ============================== classes 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>
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>
318 <!-- end publish.classesIndex -->
322 <!-- ============================== class title ============================ -->
323 <h1 class=
"classTitle">
325 Class pwlib.guiColorInput
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>.
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>
345 <th scope=
"col">Constructor Attributes
</th>
346 <th scope=
"col">Constructor Name and Description
</th>
351 <td class=
"attributes"><private
> </td>
352 <td class=
"nameDescription" >
353 <div class=
"fixedFont">
354 <b><a href=
"../symbols/pwlib.guiColorInput.html#constructor">pwlib.guiColorInput
</a></b>(gui, input)
356 <div class=
"description"></div>
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>
371 <th scope=
"col">Field Attributes
</th>
372 <th scope=
"col">Field Name and Description
</th>
378 <td class=
"attributes"> </td>
379 <td class=
"nameDescription">
380 <div class=
"fixedFont">
381 <b><a href=
"../symbols/pwlib.guiColorInput.html#color">color
</a></b>
383 <div class=
"description">Holds the current color displayed by the input.
</div>
388 <td class=
"attributes"> </td>
389 <td class=
"nameDescription">
390 <div class=
"fixedFont">
391 <b><a href=
"../symbols/pwlib.guiColorInput.html#configGroup">configGroup
</a></b>
393 <div class=
"description">The configuration group to which this color input is attached to.
</div>
398 <td class=
"attributes"> </td>
399 <td class=
"nameDescription">
400 <div class=
"fixedFont">
401 <b><a href=
"../symbols/pwlib.guiColorInput.html#configGroupRef">configGroupRef
</a></b>
403 <div class=
"description">Reference to the configuration object which holds the color input value.
</div>
408 <td class=
"attributes"> </td>
409 <td class=
"nameDescription">
410 <div class=
"fixedFont">
411 <b><a href=
"../symbols/pwlib.guiColorInput.html#configProperty">configProperty
</a></b>
413 <div class=
"description">The configuration property to which this color input is attached to.
</div>
418 <td class=
"attributes"> </td>
419 <td class=
"nameDescription">
420 <div class=
"fixedFont">
421 <b><a href=
"../symbols/pwlib.guiColorInput.html#id">id
</a></b>
423 <div class=
"description">Color input ID.
</div>
428 <td class=
"attributes"> </td>
429 <td class=
"nameDescription">
430 <div class=
"fixedFont">
431 <b><a href=
"../symbols/pwlib.guiColorInput.html#input">input
</a></b>
433 <div class=
"description">The color input element DOM reference.
</div>
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>
452 <th scope=
"col">Method Attributes
</th>
453 <th scope=
"col">Method Name and Description
</th>
459 <td class=
"attributes"><private
> <inner
> </td>
460 <td class=
"nameDescription">
461 <div class=
"fixedFont"><b><a href=
"../symbols/pwlib.guiColorInput.html#-colormixer_hide">colormixer_hide
</a></b>()
463 <div class=
"description">The color mixer
<code>hide
</code> event handler.
</div>
468 <td class=
"attributes"><private
> <inner
> </td>
469 <td class=
"nameDescription">
470 <div class=
"fixedFont"><b><a href=
"../symbols/pwlib.guiColorInput.html#-colormixer_show">colormixer_show
</a></b>()
472 <div class=
"description">The color mixer
<code>show
</code> event handler.
</div>
477 <td class=
"attributes"><private
> <inner
> </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)
481 <div class=
"description">The
<code>click
</code> event handler for the color input element.
</div>
486 <td class=
"attributes"><private
> <inner
> </td>
487 <td class=
"nameDescription">
488 <div class=
"fixedFont"><b><a href=
"../symbols/pwlib.guiColorInput.html#-init">init
</a></b>()
490 <div class=
"description">Initialize the color input functionality.
</div>
495 <td class=
"attributes"> </td>
496 <td class=
"nameDescription">
497 <div class=
"fixedFont"><b><a href=
"../symbols/pwlib.guiColorInput.html#updateColor">updateColor
</a></b>(color)
499 <div class=
"description">Update color.
</div>
509 <!-- ============================== events summary ======================== -->
512 <!-- ============================== constructor details ==================== -->
514 <div class=
"details"><a name=
"constructor"> </a>
515 <div class=
"sectionTitle">
519 <div class=
"fixedFont"><private
>
520 <b>pwlib.guiColorInput
</b>(gui, input)
523 <div class=
"description">
532 <dl class=
"detailList">
533 <dt class=
"heading">Parameters:
</dt>
536 <span class=
"light fixedFont">{
<a href=
"../symbols/pwlib.gui.html">pwlib.gui
</a>}
</span> <b>gui
</b>
539 <dd>Reference to the PaintWeb GUI object.
</dd>
542 <span class=
"light fixedFont">{Element}
</span> <b>input
</b>
545 <dd>Reference to the DOM input element. This can be
546 a span, a div, or any other tag.
</dd>
560 <!-- ============================== field details ========================== -->
562 <div class=
"sectionTitle">
566 <a name=
"color"> </a>
567 <div class=
"fixedFont">
569 <span class=
"light">{Object}
</span>
573 <div class=
"description">
574 Holds the current color displayed by the input.
588 <a name=
"configGroup"> </a>
589 <div class=
"fixedFont">
591 <span class=
"light">{String}
</span>
595 <div class=
"description">
596 The configuration group to which this color input is attached to.
610 <a name=
"configGroupRef"> </a>
611 <div class=
"fixedFont">
613 <span class=
"light">{String}
</span>
614 <b>configGroupRef
</b>
617 <div class=
"description">
618 Reference to the configuration object which holds the color input value.
632 <a name=
"configProperty"> </a>
633 <div class=
"fixedFont">
635 <span class=
"light">{String}
</span>
636 <b>configProperty
</b>
639 <div class=
"description">
640 The configuration property to which this color input is attached to.
655 <div class=
"fixedFont">
657 <span class=
"light">{String.}
</span>
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 .
677 <a name=
"input"> </a>
678 <div class=
"fixedFont">
680 <span class=
"light">{Element}
</span>
684 <div class=
"description">
685 The color input element DOM reference.
701 <!-- ============================== method details ========================= -->
703 <div class=
"sectionTitle">
707 <a name=
"-colormixer_hide"> </a>
708 <div class=
"fixedFont"><private
> <inner
>
711 <b>colormixer_hide
</b>()
714 <div class=
"description">
715 The color mixer
<code>hide
</code> event handler. This function is invoked
716 when the color mixer is hidden.
733 <a name=
"-colormixer_show"> </a>
734 <div class=
"fixedFont"><private
> <inner
>
737 <b>colormixer_show
</b>()
740 <div class=
"description">
741 The color mixer
<code>show
</code> event handler. This function is invoked
742 when the color mixer is shown.
759 <a name=
"-ev_input_click"> </a>
760 <div class=
"fixedFont"><private
> <inner
>
763 <b>ev_input_click
</b>(ev)
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.
776 <dl class=
"detailList">
777 <dt class=
"heading">Parameters:
</dt>
780 <span class=
"light fixedFont">{Event}
</span> <b>ev
</b>
783 <dd>The DOM Event object.
</dd>
796 <a name=
"-init"> </a>
797 <div class=
"fixedFont"><private
> <inner
>
803 <div class=
"description">
804 Initialize the color input functionality.
821 <a name=
"updateColor"> </a>
822 <div class=
"fixedFont">
825 <b>updateColor
</b>(color)
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.
841 <dl class=
"detailList">
842 <dt class=
"heading">Parameters:
</dt>
845 <span class=
"light fixedFont">{Object}
</span> <b>color
</b>
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>
865 <!-- ============================== event details ========================= -->
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)