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 - ViewportHandlers</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/Calendar.html">Calendar</a></li>
196
<li><a href="../symbols/Date.html">Date</a></li>
198
<li><a href="../symbols/EventLayer.html">EventLayer</a></li>
200
<li><a href="../symbols/EventLayerAccordion.html">EventLayerAccordion</a></li>
202
<li><a href="../symbols/EventMarker.html">EventMarker</a></li>
204
<li><a href="../symbols/EventTimeline.html">EventTimeline</a></li>
206
<li><a href="../symbols/Helioviewer.html">Helioviewer</a></li>
208
<li><a href="../symbols/Helioviewer%23handlers.html">Helioviewer#handlers</a></li>
210
<li><a href="../symbols/IconPicker.html">IconPicker</a></li>
212
<li><a href="../symbols/Layer.html">Layer</a></li>
214
<li><a href="../symbols/LayerManager.html">LayerManager</a></li>
216
<li><a href="../symbols/LoadingIndicator.html">LoadingIndicator</a></li>
218
<li><a href="../symbols/Math.html">Math</a></li>
220
<li><a href="../symbols/MessageConsole.html">MessageConsole</a></li>
222
<li><a href="../symbols/MovieBuilder.html">MovieBuilder</a></li>
224
<li><a href="../symbols/String.html">String</a></li>
226
<li><a href="../symbols/TileLayer.html">TileLayer</a></li>
228
<li><a href="../symbols/TileLayerAccordion.html">TileLayerAccordion</a></li>
230
<li><a href="../symbols/TimeControls.html">TimeControls</a></li>
232
<li><a href="../symbols/UIElement.html">UIElement</a></li>
234
<li><a href="../symbols/UserSettings.html">UserSettings</a></li>
236
<li><a href="../symbols/Viewport.html">Viewport</a></li>
238
<li><a href="../symbols/ViewportHandlers.html">ViewportHandlers</a></li>
240
<li><a href="../symbols/ZoomControl.html">ZoomControl</a></li>
244
<!-- end publish.classesIndex -->
248
<!-- ============================== class title ============================ -->
249
<h1 class="classTitle">
251
Class ViewportHandlers
254
<!-- ============================== class summary ========================== -->
255
<p class="description">
261
<br /><i>Defined in: </i> <a href="../symbols/src/lib_helioviewer_ViewportHandlers.js.html">ViewportHandlers.js</a>.
265
<!-- ============================== constructor summary ==================== -->
267
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class ViewportHandlers.">
268
<caption>Class Summary</caption>
271
<th scope="col">Constructor Attributes</th>
272
<th scope="col">Constructor Name and Description</th>
277
<td class="attributes"> </td>
278
<td class="nameDescription" >
279
<div class="fixedFont">
280
<b><a href="../symbols/ViewportHandlers.html">ViewportHandlers</a></b>(viewport)
282
<div class="description">Contains a collection of event-handlers for dealing with Viewport-related events</div>
289
<!-- ============================== properties summary ===================== -->
292
<!-- ============================== methods summary ======================== -->
296
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class ViewportHandlers.">
297
<caption>Method Summary</caption>
300
<th scope="col">Method Attributes</th>
301
<th scope="col">Method Name and Description</th>
307
<td class="attributes"> </td>
308
<td class="nameDescription">
309
<div class="fixedFont"><b><a href="../symbols/ViewportHandlers.html#doubleClick">doubleClick</a></b>(e)
311
<div class="description">Handles double-clicks</div>
316
<td class="attributes"> </td>
317
<td class="nameDescription">
318
<div class="fixedFont"><b><a href="../symbols/ViewportHandlers.html#getRelativeCoords">getRelativeCoords</a></b>(screenx, screeny)
320
<div class="description">Get the mouse-coords relative to top-left of the viewport frame</div>
325
<td class="attributes"> </td>
326
<td class="nameDescription">
327
<div class="fixedFont"><b><a href="../symbols/ViewportHandlers.html#keyPress">keyPress</a></b>(e)
329
<div class="description">Keyboard-related event-handlers</div>
334
<td class="attributes"> </td>
335
<td class="nameDescription">
336
<div class="fixedFont"><b><a href="../symbols/ViewportHandlers.html#keyRelease">keyRelease</a></b>(event)
338
<div class="description">Fired when a keyboard key is released</div>
343
<td class="attributes"> </td>
344
<td class="nameDescription">
345
<div class="fixedFont"><b><a href="../symbols/ViewportHandlers.html#mouseDown">mouseDown</a></b>(event)
347
<div class="description">Fired when a mouse is pressed</div>
352
<td class="attributes"> </td>
353
<td class="nameDescription">
354
<div class="fixedFont"><b><a href="../symbols/ViewportHandlers.html#mouseMove">mouseMove</a></b>(event)
356
<div class="description">Handle drag events</div>
361
<td class="attributes"> </td>
362
<td class="nameDescription">
363
<div class="fixedFont"><b><a href="../symbols/ViewportHandlers.html#mouseUp">mouseUp</a></b>(event)
365
<div class="description">Fired when a mouse button is released</div>
370
<td class="attributes"> </td>
371
<td class="nameDescription">
372
<div class="fixedFont"><b><a href="../symbols/ViewportHandlers.html#mouseWheel">mouseWheel</a></b>(event)
374
<div class="description">Handles mouse-wheel movements</div>
379
<td class="attributes"> </td>
380
<td class="nameDescription">
381
<div class="fixedFont"><b><a href="../symbols/ViewportHandlers.html#toggleMouseCoords">toggleMouseCoords</a></b>()
383
<div class="description">Toggles mouse-coords visibility</div>
393
<!-- ============================== events summary ======================== -->
396
<!-- ============================== constructor details ==================== -->
398
<div class="details"><a name="constructor"> </a>
399
<div class="sectionTitle">
403
<div class="fixedFont">
404
<b>ViewportHandlers</b>(viewport)
407
<div class="description">
408
Contains a collection of event-handlers for dealing with Viewport-related events
416
<dl class="detailList">
417
<dt class="heading">Parameters:</dt>
420
<span class="light fixedFont">{Object}</span> <b>viewport</b>
423
<dd>A Reference to the Helioviewer application class</dd>
433
<dl class="detailList">
434
<dt class="heading">See:</dt>
436
<dd><a href="../symbols/Viewport.html">Viewport</a></dd>
444
<!-- ============================== field details ========================== -->
447
<!-- ============================== method details ========================= -->
449
<div class="sectionTitle">
453
<a name="doubleClick"> </a>
454
<div class="fixedFont">
457
<b>doubleClick</b>(e)
460
<div class="description">
461
Handles double-clicks
469
<dl class="detailList">
470
<dt class="heading">Parameters:</dt>
473
<span class="light fixedFont">{Event}</span> <b>e</b>
476
<dd>Prototype Event class</dd>
489
<a name="getRelativeCoords"> </a>
490
<div class="fixedFont">
493
<b>getRelativeCoords</b>(screenx, screeny)
496
<div class="description">
497
Get the mouse-coords relative to top-left of the viewport frame
505
<dl class="detailList">
506
<dt class="heading">Parameters:</dt>
509
<span class="light fixedFont">{Int}</span> <b>screenx</b>
512
<dd>X-dimensions of the user's screen</dd>
515
<span class="light fixedFont">{Int}</span> <b>screeny</b>
518
<dd>Y-dimensions of the user's screen</dd>
531
<a name="keyPress"> </a>
532
<div class="fixedFont">
538
<div class="description">
539
Keyboard-related event-handlers
547
<dl class="detailList">
548
<dt class="heading">Parameters:</dt>
567
<a name="keyRelease"> </a>
568
<div class="fixedFont">
571
<b>keyRelease</b>(event)
574
<div class="description">
575
Fired when a keyboard key is released
583
<dl class="detailList">
584
<dt class="heading">Parameters:</dt>
587
<span class="light fixedFont">{Object}</span> <b>event</b>
590
<dd>Prototype Event object</dd>
603
<a name="mouseDown"> </a>
604
<div class="fixedFont">
607
<b>mouseDown</b>(event)
610
<div class="description">
611
Fired when a mouse is pressed
619
<dl class="detailList">
620
<dt class="heading">Parameters:</dt>
623
<span class="light fixedFont">{Event}</span> <b>event</b>
626
<dd>Prototype Event class</dd>
639
<a name="mouseMove"> </a>
640
<div class="fixedFont">
643
<b>mouseMove</b>(event)
646
<div class="description">
655
<dl class="detailList">
656
<dt class="heading">Parameters:</dt>
659
<span class="light fixedFont">{Object}</span> <b>event</b>
662
<dd>Prototype Event object</dd>
675
<a name="mouseUp"> </a>
676
<div class="fixedFont">
679
<b>mouseUp</b>(event)
682
<div class="description">
683
Fired when a mouse button is released
691
<dl class="detailList">
692
<dt class="heading">Parameters:</dt>
695
<span class="light fixedFont">{Event}</span> <b>event</b>
698
<dd>Prototype Event object</dd>
711
<a name="mouseWheel"> </a>
712
<div class="fixedFont">
715
<b>mouseWheel</b>(event)
718
<div class="description">
719
Handles mouse-wheel movements
727
<dl class="detailList">
728
<dt class="heading">Parameters:</dt>
731
<span class="light fixedFont">{Event}</span> <b>event</b>
734
<dd>Prototype Event class</dd>
747
<a name="toggleMouseCoords"> </a>
748
<div class="fixedFont">
751
<b>toggleMouseCoords</b>()
754
<div class="description">
755
Toggles mouse-coords visibility
774
<!-- ============================== event details ========================= -->
781
<!-- ============================== footer ================================= -->
782
<div class="fineprint" style="clear:both">
784
Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Wed Feb 25 2009 14:47:29 GMT-0500 (EST)