← Back to branch summary

~jstys-z/helioviewer.org/client5

« back to all changes in this revision

Viewing changes to docs/symbols/ViewportHandlers.html

Modified back-end directory structure and naming conventions. Now using PEAR's naming convention for classes. Tests should be created in mirror sub-directory within the "tests" folder.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/symbols/ViewportHandlers.html
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 - ViewportHandlers</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/Config.html">Config</a></li>
195
 
        
196
 
        <li><a href="../symbols/Date.html">Date</a></li>
197
 
        
198
 
        <li><a href="../symbols/EventLayer.html">EventLayer</a></li>
199
 
        
200
 
        <li><a href="../symbols/EventLayerAccordion.html">EventLayerAccordion</a></li>
201
 
        
202
 
        <li><a href="../symbols/EventLayerManager.html">EventLayerManager</a></li>
203
 
        
204
 
        <li><a href="../symbols/EventMarker.html">EventMarker</a></li>
205
 
        
206
 
        <li><a href="../symbols/EventTimeline.html">EventTimeline</a></li>
207
 
        
208
 
        <li><a href="../symbols/Helioviewer.html">Helioviewer</a></li>
209
 
        
210
 
        <li><a href="../symbols/IconPicker.html">IconPicker</a></li>
211
 
        
212
 
        <li><a href="../symbols/ImageSelectTool.html">ImageSelectTool</a></li>
213
 
        
214
 
        <li><a href="../symbols/KeyboardManager.html">KeyboardManager</a></li>
215
 
        
216
 
        <li><a href="../symbols/Layer.html">Layer</a></li>
217
 
        
218
 
        <li><a href="../symbols/LayerManager.html">LayerManager</a></li>
219
 
        
220
 
        <li><a href="../symbols/Math.html">Math</a></li>
221
 
        
222
 
        <li><a href="../symbols/MediaSettings.html">MediaSettings</a></li>
223
 
        
224
 
        <li><a href="../symbols/MessageConsole.html">MessageConsole</a></li>
225
 
        
226
 
        <li><a href="../symbols/MovieBuilder.html">MovieBuilder</a></li>
227
 
        
228
 
        <li><a href="../symbols/ScreenshotBuilder.html">ScreenshotBuilder</a></li>
229
 
        
230
 
        <li><a href="../symbols/String.html">String</a></li>
231
 
        
232
 
        <li><a href="../symbols/TileLayer.html">TileLayer</a></li>
233
 
        
234
 
        <li><a href="../symbols/TileLayerAccordion.html">TileLayerAccordion</a></li>
235
 
        
236
 
        <li><a href="../symbols/TileLayerManager.html">TileLayerManager</a></li>
237
 
        
238
 
        <li><a href="../symbols/Time.html">Time</a></li>
239
 
        
240
 
        <li><a href="../symbols/TimeControls.html">TimeControls</a></li>
241
 
        
242
 
        <li><a href="../symbols/TooltipHelper.html">TooltipHelper</a></li>
243
 
        
244
 
        <li><a href="../symbols/TreeSelect.html">TreeSelect</a></li>
245
 
        
246
 
        <li><a href="../symbols/UserSettings.html">UserSettings</a></li>
247
 
        
248
 
        <li><a href="../symbols/Viewport.html">Viewport</a></li>
249
 
        
250
 
        <li><a href="../symbols/ViewportHandlers.html">ViewportHandlers</a></li>
251
 
        
252
 
        <li><a href="../symbols/ZoomControls.html">ZoomControls</a></li>
253
 
        
254
 
</ul>
255
 
<hr />
256
 
                        <!-- end publish.classesIndex -->
257
 
                </div>
258
 
                
259
 
                <div id="content">
260
 
<!-- ============================== class title ============================ -->
261
 
                        <h1 class="classTitle">
262
 
                                
263
 
                                Class ViewportHandlers
264
 
                        </h1>
265
 
 
266
 
<!-- ============================== class summary ========================== -->                        
267
 
                        <p class="description">
268
 
                                
269
 
                                
270
 
                        
271
 
                                
272
 
                                
273
 
                                
274
 
                                        <br /><i>Defined in: </i> <a href="../symbols/src/lib_helioviewer_ViewportHandlers.js.html">ViewportHandlers.js</a>.
275
 
                                
276
 
                        </p>
277
 
 
278
 
<!-- ============================== constructor summary ==================== -->                        
279
 
                        
280
 
                        <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class ViewportHandlers.">
281
 
                                <caption>Class Summary</caption>
282
 
                                <thead>
283
 
                                        <tr>
284
 
                                                <th scope="col">Constructor Attributes</th>
285
 
                                                <th scope="col">Constructor Name and Description</th>
286
 
                                        </tr>
287
 
                                </thead>
288
 
                                <tbody>
289
 
                                        <tr>
290
 
                                                <td class="attributes">&nbsp;</td>
291
 
                                                <td class="nameDescription" >
292
 
                                                        <div class="fixedFont">
293
 
                                                                <b><a href="../symbols/ViewportHandlers.html#constructor">ViewportHandlers</a></b>(viewport)
294
 
                                                        </div>
295
 
                                                        <div class="description">Contains a collection of event-handlers for dealing with Viewport-related events</div>
296
 
                                                </td>
297
 
                                        </tr>
298
 
                                </tbody>
299
 
                        </table>
300
 
                        
301
 
 
302
 
<!-- ============================== properties summary ===================== -->
303
 
                        
304
 
 
305
 
<!-- ============================== methods summary ======================== -->
306
 
                        
307
 
                                
308
 
                                
309
 
                                <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class ViewportHandlers.">
310
 
                                        <caption>Method Summary</caption>
311
 
                                        <thead>
312
 
                                                <tr>
313
 
                                                        <th scope="col">Method Attributes</th>
314
 
                                                        <th scope="col">Method Name and Description</th>
315
 
                                                </tr>
316
 
                                        </thead>
317
 
                                        <tbody>
318
 
                                        
319
 
                                                <tr>
320
 
                                                        <td class="attributes">&lt;private&gt; &nbsp;</td>
321
 
                                                        <td class="nameDescription">
322
 
                                                                <div class="fixedFont"><b><a href="../symbols/ViewportHandlers.html#_initEvents">_initEvents</a></b>()
323
 
                                                                </div>
324
 
                                                                <div class="description"></div>
325
 
                                                        </td>
326
 
                                                </tr>
327
 
                                        
328
 
                                                <tr>
329
 
                                                        <td class="attributes">&nbsp;</td>
330
 
                                                        <td class="nameDescription">
331
 
                                                                <div class="fixedFont"><b><a href="../symbols/ViewportHandlers.html#computeMouseCoords">computeMouseCoords</a></b>(screenX, screenY)
332
 
                                                                </div>
333
 
                                                                <div class="description">Computes the scaled mouse coordinates relative to the size and center of the Sun.</div>
334
 
                                                        </td>
335
 
                                                </tr>
336
 
                                        
337
 
                                                <tr>
338
 
                                                        <td class="attributes">&nbsp;</td>
339
 
                                                        <td class="nameDescription">
340
 
                                                                <div class="fixedFont"><b><a href="../symbols/ViewportHandlers.html#doubleClick">doubleClick</a></b>(e)
341
 
                                                                </div>
342
 
                                                                <div class="description">Handles double-clicks</div>
343
 
                                                        </td>
344
 
                                                </tr>
345
 
                                        
346
 
                                                <tr>
347
 
                                                        <td class="attributes">&nbsp;</td>
348
 
                                                        <td class="nameDescription">
349
 
                                                                <div class="fixedFont"><b><a href="../symbols/ViewportHandlers.html#getRelativeCoords">getRelativeCoords</a></b>(screenx, screeny)
350
 
                                                                </div>
351
 
                                                                <div class="description">Get the mouse-coords relative to top-left of the viewport frame</div>
352
 
                                                        </td>
353
 
                                                </tr>
354
 
                                        
355
 
                                                <tr>
356
 
                                                        <td class="attributes">&nbsp;</td>
357
 
                                                        <td class="nameDescription">
358
 
                                                                <div class="fixedFont"><b><a href="../symbols/ViewportHandlers.html#mouseDown">mouseDown</a></b>(event)
359
 
                                                                </div>
360
 
                                                                <div class="description">Fired when a mouse is pressed</div>
361
 
                                                        </td>
362
 
                                                </tr>
363
 
                                        
364
 
                                                <tr>
365
 
                                                        <td class="attributes">&nbsp;</td>
366
 
                                                        <td class="nameDescription">
367
 
                                                                <div class="fixedFont"><b><a href="../symbols/ViewportHandlers.html#mouseMove">mouseMove</a></b>(an)
368
 
                                                                </div>
369
 
                                                                <div class="description">Handle drag events</div>
370
 
                                                        </td>
371
 
                                                </tr>
372
 
                                        
373
 
                                                <tr>
374
 
                                                        <td class="attributes">&nbsp;</td>
375
 
                                                        <td class="nameDescription">
376
 
                                                                <div class="fixedFont"><b><a href="../symbols/ViewportHandlers.html#mouseUp">mouseUp</a></b>(event)
377
 
                                                                </div>
378
 
                                                                <div class="description">Fired when a mouse button is released</div>
379
 
                                                        </td>
380
 
                                                </tr>
381
 
                                        
382
 
                                                <tr>
383
 
                                                        <td class="attributes">&nbsp;</td>
384
 
                                                        <td class="nameDescription">
385
 
                                                                <div class="fixedFont"><b><a href="../symbols/ViewportHandlers.html#mouseWheel">mouseWheel</a></b>(event, delta)
386
 
                                                                </div>
387
 
                                                                <div class="description">Handles mouse-wheel movements</div>
388
 
                                                        </td>
389
 
                                                </tr>
390
 
                                        
391
 
                                                <tr>
392
 
                                                        <td class="attributes">&nbsp;</td>
393
 
                                                        <td class="nameDescription">
394
 
                                                                <div class="fixedFont"><b><a href="../symbols/ViewportHandlers.html#toggleMouseCoords">toggleMouseCoords</a></b>()
395
 
                                                                </div>
396
 
                                                                <div class="description">Toggles mouse-coords visibility
397
 
 
398
 
TODO (2009/07/27) Disable mouse-coords display during drag & drop</div>
399
 
                                                        </td>
400
 
                                                </tr>
401
 
                                        
402
 
                                                <tr>
403
 
                                                        <td class="attributes">&nbsp;</td>
404
 
                                                        <td class="nameDescription">
405
 
                                                                <div class="fixedFont"><b><a href="../symbols/ViewportHandlers.html#updateShadows">updateShadows</a></b>()
406
 
                                                                </div>
407
 
                                                                <div class="description">Adds an animated text shadow based on the position and size of the Sun (Firefox 3.5+)
408
 
Added 2009/06/26
409
 
TODO: Apply to other text based on it's position on screen? Adjust blue based on zoom-level?
410
 
      Use viewport size to determine appropriate scales for X & Y offsets (normalize)
411
 
      Re-use computeCoordinates?</div>
412
 
                                                        </td>
413
 
                                                </tr>
414
 
                                        
415
 
                                        </tbody>
416
 
                                </table>
417
 
                                
418
 
                                
419
 
                                
420
 
                        
421
 
<!-- ============================== events summary ======================== -->
422
 
                        
423
 
 
424
 
<!-- ============================== constructor details ==================== -->                
425
 
                        
426
 
                        <div class="details"><a name="constructor"> </a>
427
 
                                <div class="sectionTitle">
428
 
                                        Class Detail
429
 
                                </div>
430
 
                                
431
 
                                <div class="fixedFont">
432
 
                                                <b>ViewportHandlers</b>(viewport)
433
 
                                </div>
434
 
                                
435
 
                                <div class="description">
436
 
                                        Contains a collection of event-handlers for dealing with Viewport-related events
437
 
                                        
438
 
                                </div>
439
 
                                
440
 
                                
441
 
                                
442
 
                                
443
 
                                        
444
 
                                                <dl class="detailList">
445
 
                                                <dt class="heading">Parameters:</dt>
446
 
                                                
447
 
                                                        <dt>
448
 
                                                                <span class="light fixedFont">{Object}</span>  <b>viewport</b>
449
 
                                                                
450
 
                                                        </dt>
451
 
                                                                <dd>A Reference to the Helioviewer application class</dd>
452
 
                                                
453
 
                                                </dl>
454
 
                                        
455
 
                                        
456
 
                                        
457
 
                                        
458
 
                                        
459
 
                                        
460
 
                                        
461
 
                                                <dl class="detailList">
462
 
                                                <dt class="heading">See:</dt>
463
 
                                                
464
 
                                                        <dd><a href="../symbols/Viewport.html">Viewport</a></dd>
465
 
                                                
466
 
                                                </dl>
467
 
                                        
468
 
 
469
 
                        </div>
470
 
                        
471
 
 
472
 
<!-- ============================== field details ========================== -->                
473
 
                        
474
 
 
475
 
<!-- ============================== method details ========================= -->                
476
 
                        
477
 
                                <div class="sectionTitle">
478
 
                                        Method Detail
479
 
                                </div>
480
 
                                
481
 
                                        <a name="_initEvents"> </a>
482
 
                                        <div class="fixedFont">&lt;private&gt; 
483
 
                                        
484
 
                                        
485
 
                                        <b>_initEvents</b>()
486
 
                                        
487
 
                                        </div>
488
 
                                        <div class="description">
489
 
                                                
490
 
                                                
491
 
                                                
492
 
                                        </div>
493
 
                                        
494
 
                                        
495
 
                                        
496
 
                                                
497
 
                                                
498
 
                                                
499
 
                                                
500
 
                                                
501
 
                                                
502
 
                                                
503
 
 
504
 
                                        <hr />
505
 
                                
506
 
                                        <a name="computeMouseCoords"> </a>
507
 
                                        <div class="fixedFont">
508
 
                                        
509
 
                                        
510
 
                                        <b>computeMouseCoords</b>(screenX, screenY)
511
 
                                        
512
 
                                        </div>
513
 
                                        <div class="description">
514
 
                                                Computes the scaled mouse coordinates relative to the size and center of the Sun.
515
 
 
516
 
 Explanation:
517
 
 
518
 
   X = location of mouse-pointer
519
 
   V = viewport top-left corner
520
 
   S = sandbox top-left corner
521
 
   M = moving container top-let corner
522
 
   
523
 
 Each of the two-letter abbreviations represents the vector <x,y> going from one
524
 
 location to the other. See wiki documentation below for more details.
525
 
                                                
526
 
                                                
527
 
                                        </div>
528
 
                                        
529
 
                                        
530
 
                                        
531
 
                                                
532
 
                                                        <dl class="detailList">
533
 
                                                        <dt class="heading">Parameters:</dt>
534
 
                                                        
535
 
                                                                <dt>
536
 
                                                                        <b>screenX</b>
537
 
                                                                        
538
 
                                                                </dt>
539
 
                                                                <dd></dd>
540
 
                                                        
541
 
                                                                <dt>
542
 
                                                                        <b>screenY</b>
543
 
                                                                        
544
 
                                                                </dt>
545
 
                                                                <dd></dd>
546
 
                                                        
547
 
                                                        </dl>
548
 
                                                
549
 
                                                
550
 
                                                
551
 
                                                
552
 
                                                
553
 
                                                
554
 
                                                
555
 
                                                        <dl class="detailList">
556
 
                                                        <dt class="heading">See:</dt>
557
 
                                                        
558
 
                                                                <dd>http://helioviewer.org/wiki/index.php?title=Co-ordinate_System_I</dd>
559
 
                                                        
560
 
                                                        </dl>
561
 
                                                
562
 
 
563
 
                                        <hr />
564
 
                                
565
 
                                        <a name="doubleClick"> </a>
566
 
                                        <div class="fixedFont">
567
 
                                        
568
 
                                        
569
 
                                        <b>doubleClick</b>(e)
570
 
                                        
571
 
                                        </div>
572
 
                                        <div class="description">
573
 
                                                Handles double-clicks
574
 
                                                
575
 
                                                
576
 
                                        </div>
577
 
                                        
578
 
                                        
579
 
                                        
580
 
                                                
581
 
                                                        <dl class="detailList">
582
 
                                                        <dt class="heading">Parameters:</dt>
583
 
                                                        
584
 
                                                                <dt>
585
 
                                                                        <span class="light fixedFont">{Event}</span> <b>e</b>
586
 
                                                                        
587
 
                                                                </dt>
588
 
                                                                <dd>Event class</dd>
589
 
                                                        
590
 
                                                        </dl>
591
 
                                                
592
 
                                                
593
 
                                                
594
 
                                                
595
 
                                                
596
 
                                                
597
 
                                                
598
 
 
599
 
                                        <hr />
600
 
                                
601
 
                                        <a name="getRelativeCoords"> </a>
602
 
                                        <div class="fixedFont">
603
 
                                        
604
 
                                        
605
 
                                        <b>getRelativeCoords</b>(screenx, screeny)
606
 
                                        
607
 
                                        </div>
608
 
                                        <div class="description">
609
 
                                                Get the mouse-coords relative to top-left of the viewport frame
610
 
                                                
611
 
                                                
612
 
                                        </div>
613
 
                                        
614
 
                                        
615
 
                                        
616
 
                                                
617
 
                                                        <dl class="detailList">
618
 
                                                        <dt class="heading">Parameters:</dt>
619
 
                                                        
620
 
                                                                <dt>
621
 
                                                                        <span class="light fixedFont">{Int}</span> <b>screenx</b>
622
 
                                                                        
623
 
                                                                </dt>
624
 
                                                                <dd>X-dimensions of the user's screen</dd>
625
 
                                                        
626
 
                                                                <dt>
627
 
                                                                        <span class="light fixedFont">{Int}</span> <b>screeny</b>
628
 
                                                                        
629
 
                                                                </dt>
630
 
                                                                <dd>Y-dimensions of the user's screen</dd>
631
 
                                                        
632
 
                                                        </dl>
633
 
                                                
634
 
                                                
635
 
                                                
636
 
                                                
637
 
                                                
638
 
                                                
639
 
                                                
640
 
 
641
 
                                        <hr />
642
 
                                
643
 
                                        <a name="mouseDown"> </a>
644
 
                                        <div class="fixedFont">
645
 
                                        
646
 
                                        
647
 
                                        <b>mouseDown</b>(event)
648
 
                                        
649
 
                                        </div>
650
 
                                        <div class="description">
651
 
                                                Fired when a mouse is pressed
652
 
                                                
653
 
                                                
654
 
                                        </div>
655
 
                                        
656
 
                                        
657
 
                                        
658
 
                                                
659
 
                                                        <dl class="detailList">
660
 
                                                        <dt class="heading">Parameters:</dt>
661
 
                                                        
662
 
                                                                <dt>
663
 
                                                                        <span class="light fixedFont">{Event}</span> <b>event</b>
664
 
                                                                        
665
 
                                                                </dt>
666
 
                                                                <dd>Prototype Event class</dd>
667
 
                                                        
668
 
                                                        </dl>
669
 
                                                
670
 
                                                
671
 
                                                
672
 
                                                
673
 
                                                
674
 
                                                
675
 
                                                
676
 
 
677
 
                                        <hr />
678
 
                                
679
 
                                        <a name="mouseMove"> </a>
680
 
                                        <div class="fixedFont">
681
 
                                        
682
 
                                        
683
 
                                        <b>mouseMove</b>(an)
684
 
                                        
685
 
                                        </div>
686
 
                                        <div class="description">
687
 
                                                Handle drag events
688
 
                                                
689
 
                                                
690
 
                                        </div>
691
 
                                        
692
 
                                        
693
 
                                        
694
 
                                                
695
 
                                                        <dl class="detailList">
696
 
                                                        <dt class="heading">Parameters:</dt>
697
 
                                                        
698
 
                                                                <dt>
699
 
                                                                        <span class="light fixedFont">{Object}</span> <b>an</b>
700
 
                                                                        
701
 
                                                                </dt>
702
 
                                                                <dd>Event object</dd>
703
 
                                                        
704
 
                                                        </dl>
705
 
                                                
706
 
                                                
707
 
                                                
708
 
                                                
709
 
                                                
710
 
                                                
711
 
                                                
712
 
 
713
 
                                        <hr />
714
 
                                
715
 
                                        <a name="mouseUp"> </a>
716
 
                                        <div class="fixedFont">
717
 
                                        
718
 
                                        
719
 
                                        <b>mouseUp</b>(event)
720
 
                                        
721
 
                                        </div>
722
 
                                        <div class="description">
723
 
                                                Fired when a mouse button is released
724
 
                                                
725
 
                                                
726
 
                                        </div>
727
 
                                        
728
 
                                        
729
 
                                        
730
 
                                                
731
 
                                                        <dl class="detailList">
732
 
                                                        <dt class="heading">Parameters:</dt>
733
 
                                                        
734
 
                                                                <dt>
735
 
                                                                        <span class="light fixedFont">{Event}</span> <b>event</b>
736
 
                                                                        
737
 
                                                                </dt>
738
 
                                                                <dd>Event object</dd>
739
 
                                                        
740
 
                                                        </dl>
741
 
                                                
742
 
                                                
743
 
                                                
744
 
                                                
745
 
                                                
746
 
                                                
747
 
                                                
748
 
 
749
 
                                        <hr />
750
 
                                
751
 
                                        <a name="mouseWheel"> </a>
752
 
                                        <div class="fixedFont">
753
 
                                        
754
 
                                        
755
 
                                        <b>mouseWheel</b>(event, delta)
756
 
                                        
757
 
                                        </div>
758
 
                                        <div class="description">
759
 
                                                Handles mouse-wheel movements
760
 
                                                
761
 
                                                
762
 
                                        </div>
763
 
                                        
764
 
                                        
765
 
                                        
766
 
                                                
767
 
                                                        <dl class="detailList">
768
 
                                                        <dt class="heading">Parameters:</dt>
769
 
                                                        
770
 
                                                                <dt>
771
 
                                                                        <span class="light fixedFont">{Event}</span> <b>event</b>
772
 
                                                                        
773
 
                                                                </dt>
774
 
                                                                <dd>Event class</dd>
775
 
                                                        
776
 
                                                                <dt>
777
 
                                                                        <b>delta</b>
778
 
                                                                        
779
 
                                                                </dt>
780
 
                                                                <dd></dd>
781
 
                                                        
782
 
                                                        </dl>
783
 
                                                
784
 
                                                
785
 
                                                
786
 
                                                
787
 
                                                
788
 
                                                
789
 
                                                
790
 
 
791
 
                                        <hr />
792
 
                                
793
 
                                        <a name="toggleMouseCoords"> </a>
794
 
                                        <div class="fixedFont">
795
 
                                        
796
 
                                        
797
 
                                        <b>toggleMouseCoords</b>()
798
 
                                        
799
 
                                        </div>
800
 
                                        <div class="description">
801
 
                                                Toggles mouse-coords visibility
802
 
 
803
 
TODO (2009/07/27) Disable mouse-coords display during drag & drop
804
 
                                                
805
 
                                                
806
 
                                        </div>
807
 
                                        
808
 
                                        
809
 
                                        
810
 
                                                
811
 
                                                
812
 
                                                
813
 
                                                
814
 
                                                
815
 
                                                
816
 
                                                
817
 
 
818
 
                                        <hr />
819
 
                                
820
 
                                        <a name="updateShadows"> </a>
821
 
                                        <div class="fixedFont">
822
 
                                        
823
 
                                        
824
 
                                        <b>updateShadows</b>()
825
 
                                        
826
 
                                        </div>
827
 
                                        <div class="description">
828
 
                                                Adds an animated text shadow based on the position and size of the Sun (Firefox 3.5+)
829
 
Added 2009/06/26
830
 
TODO: Apply to other text based on it's position on screen? Adjust blue based on zoom-level?
831
 
      Use viewport size to determine appropriate scales for X & Y offsets (normalize)
832
 
      Re-use computeCoordinates?
833
 
                                                
834
 
                                                
835
 
                                        </div>
836
 
                                        
837
 
                                        
838
 
                                        
839
 
                                                
840
 
                                                
841
 
                                                
842
 
                                                
843
 
                                                
844
 
                                                
845
 
                                                
846
 
 
847
 
                                        
848
 
                                
849
 
                        
850
 
                        
851
 
<!-- ============================== event details ========================= -->         
852
 
                        
853
 
                        
854
 
                        <hr />
855
 
                </div>
856
 
 
857
 
                
858
 
<!-- ============================== footer ================================= -->
859
 
                <div class="fineprint" style="clear:both">
860
 
                        
861
 
                        Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Sun Feb 07 2010 16:13:45 GMT-0500 (EST)
862
 
                </div>
863
 
        </body>
864
 
</html>