UNPKG

92.2 kBHTMLView Raw
1<!DOCTYPE html>
2
3<html lang="en">
4<head>
5 <meta charset="utf-8">
6 <meta name="viewport" content="width=device-width">
7 <title>CrossBrowdy API documentation Namespace: CB_Touch</title>
8
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
13
14 <link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
15
16</head>
17
18<body style="min-width:800px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
19
20<div class="navbar navbar-default navbar-fixed-top ">
21<div class="container">
22 <div class="navbar-header">
23 <a class="navbar-brand" href="index.html">CrossBrowdy API documentation</a>
24 <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
25 <span class="icon-bar"></span>
26 <span class="icon-bar"></span>
27 <span class="icon-bar"></span>
28 </button>
29 </div>
30 <div class="navbar-collapse collapse" id="topNavigation">
31 <ul class="nav navbar-nav">
32
33 <li class="dropdown">
34 <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
35 <ul class="dropdown-menu inline">
36 <li><a href="CB_Arrays.html">CB_Arrays</a></li><li><a href="CB_AudioDetector.html">CB_AudioDetector</a></li><li><a href="CB_Client.html">CB_Client</a></li><li><a href="CB_Collisions.html">CB_Collisions</a></li><li><a href="CB_Configuration.html">CB_Configuration</a></li><li><a href="CB_Configuration.CrossBase.html">CB_Configuration.CrossBase</a></li><li><a href="CB_Configuration.CrossBrowdy.html">CB_Configuration.CrossBrowdy</a></li><li><a href="CB_Controllers.html">CB_Controllers</a></li><li><a href="CB_Controllers_Proprietary.html">CB_Controllers_Proprietary</a></li><li><a href="CB_Controllers_Proprietary.WII.html">CB_Controllers_Proprietary.WII</a></li><li><a href="CB_Controllers_Proprietary.WII_U.html">CB_Controllers_Proprietary.WII_U</a></li><li><a href="CB_Device.html">CB_Device</a></li><li><a href="CB_Device.AmbientLight.html">CB_Device.AmbientLight</a></li><li><a href="CB_Device.Battery.html">CB_Device.Battery</a></li><li><a href="CB_Device.Location.html">CB_Device.Location</a></li><li><a href="CB_Device.Motion.html">CB_Device.Motion</a></li><li><a href="CB_Device.Orientation.html">CB_Device.Orientation</a></li><li><a href="CB_Device.Proximity.html">CB_Device.Proximity</a></li><li><a href="CB_Device.Vibration.html">CB_Device.Vibration</a></li><li><a href="CB_Elements.html">CB_Elements</a></li><li><a href="CB_Events.html">CB_Events</a></li><li><a href="CB_Keyboard.html">CB_Keyboard</a></li><li><a href="CB_Keyboard.chars.html">CB_Keyboard.chars</a></li><li><a href="CB_Keyboard.extended.html">CB_Keyboard.extended</a></li><li><a href="CB_Keyboard.keys.html">CB_Keyboard.keys</a></li><li><a href="CB_Modules.html">CB_Modules</a></li><li><a href="CB_Mouse.html">CB_Mouse</a></li><li><a href="CB_Mouse.CursorImage.html">CB_Mouse.CursorImage</a></li><li><a href="CB_Net.html">CB_Net</a></li><li><a href="CB_Net.Fetch.html">CB_Net.Fetch</a></li><li><a href="CB_Net.REST.html">CB_Net.REST</a></li><li><a href="CB_Net.Sockets.html">CB_Net.Sockets</a></li><li><a href="CB_Net.Sockets.SockJS.html">CB_Net.Sockets.SockJS</a></li><li><a href="CB_Net.XHR.html">CB_Net.XHR</a></li><li><a href="CB_Pointer.html">CB_Pointer</a></li><li><a href="CB_Screen.html">CB_Screen</a></li><li><a href="CB_Speaker.html">CB_Speaker</a></li><li><a href="CB_Touch.html">CB_Touch</a></li><li><a href="CB_baseSymbols.html">CB_baseSymbols</a></li>
37 </ul>
38 </li>
39
40 <li class="dropdown">
41 <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
42 <ul class="dropdown-menu inline">
43 <li><a href="CB_AudioFile.html">CB_AudioFile</a></li><li><a href="CB_AudioFileCache.html">CB_AudioFileCache</a></li><li><a href="CB_AudioFileSprites.html">CB_AudioFileSprites</a></li><li><a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a></li><li><a href="CB_AudioFile_API.AAPI.html">CB_AudioFile_API.AAPI</a></li><li><a href="CB_AudioFile_API.ACMP.html">CB_AudioFile_API.ACMP</a></li><li><a href="CB_AudioFile_API.SM2.html">CB_AudioFile_API.SM2</a></li><li><a href="CB_AudioFile_API.WAAPI.html">CB_AudioFile_API.WAAPI</a></li><li><a href="CB_Canvas.html">CB_Canvas</a></li><li><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></li><li><a href="CB_GraphicSpritesScene.html">CB_GraphicSpritesScene</a></li>
44 </ul>
45 </li>
46
47 <li class="dropdown">
48 <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
49 <ul class="dropdown-menu inline">
50 <li><a href="global.html#CB_BASE_NAME">CB_BASE_NAME</a></li><li><a href="global.html#CB_CREDITS_DEFAULT">CB_CREDITS_DEFAULT</a></li><li><a href="global.html#CB_NAME">CB_NAME</a></li><li><a href="global.html#CB_OPTIONS">CB_OPTIONS</a></li><li><a href="global.html#CB_VERSION">CB_VERSION</a></li><li><a href="global.html#CB_addCredits">CB_addCredits</a></li><li><a href="global.html#CB_baseToBase">CB_baseToBase</a></li><li><a href="global.html#CB_baseToInt">CB_baseToInt</a></li><li><a href="global.html#CB_br2nl">CB_br2nl</a></li><li><a href="global.html#CB_brToNl">CB_brToNl</a></li><li><a href="global.html#CB_combineArraysOrObjects">CB_combineArraysOrObjects</a></li><li><a href="global.html#CB_combineAutomatically">CB_combineAutomatically</a></li><li><a href="global.html#CB_combineJSON">CB_combineJSON</a></li><li><a href="global.html#CB_combineURIParameters">CB_combineURIParameters</a></li><li><a href="global.html#CB_combineURLParameters">CB_combineURLParameters</a></li><li><a href="global.html#CB_console">CB_console</a></li><li><a href="global.html#CB_copyObject">CB_copyObject</a></li><li><a href="global.html#CB_countDecimalDigits">CB_countDecimalDigits</a></li><li><a href="global.html#CB_countDecimalPart">CB_countDecimalPart</a></li><li><a href="global.html#CB_countDecimals">CB_countDecimals</a></li><li><a href="global.html#CB_countIntegerDigits">CB_countIntegerDigits</a></li><li><a href="global.html#CB_countIntegerPart">CB_countIntegerPart</a></li><li><a href="global.html#CB_credits">CB_credits</a></li><li><a href="global.html#CB_forEach">CB_forEach</a></li><li><a href="global.html#CB_forceString">CB_forceString</a></li><li><a href="global.html#CB_getBase64StringObject">CB_getBase64StringObject</a></li><li><a href="global.html#CB_getCookie">CB_getCookie</a></li><li><a href="global.html#CB_getDatum">CB_getDatum</a></li><li><a href="global.html#CB_getJSONPropertyValue">CB_getJSONPropertyValue</a></li><li><a href="global.html#CB_getLZStringObject">CB_getLZStringObject</a></li><li><a href="global.html#CB_getValueIndex">CB_getValueIndex</a></li><li><a href="global.html#CB_getValuePath">CB_getValuePath</a></li><li><a href="global.html#CB_includeJSFile">CB_includeJSFile</a></li><li><a href="global.html#CB_indexOf">CB_indexOf</a></li><li><a href="global.html#CB_init">CB_init</a></li><li><a href="global.html#CB_intToBase">CB_intToBase</a></li><li><a href="global.html#CB_isArray">CB_isArray</a></li><li><a href="global.html#CB_isEmail">CB_isEmail</a></li><li><a href="global.html#CB_isFileLocal">CB_isFileLocal</a></li><li><a href="global.html#CB_isString">CB_isString</a></li><li><a href="global.html#CB_lastIndexOf">CB_lastIndexOf</a></li><li><a href="global.html#CB_ltrim">CB_ltrim</a></li><li><a href="global.html#CB_nl2br">CB_nl2br</a></li><li><a href="global.html#CB_nlToBr">CB_nlToBr</a></li><li><a href="global.html#CB_numberFormat">CB_numberFormat</a></li><li><a href="global.html#CB_numberOfDecimalDigits">CB_numberOfDecimalDigits</a></li><li><a href="global.html#CB_numberOfDecimals">CB_numberOfDecimals</a></li><li><a href="global.html#CB_numberOfIntegerDigits">CB_numberOfIntegerDigits</a></li><li><a href="global.html#CB_parseJSON">CB_parseJSON</a></li><li><a href="global.html#CB_parseString">CB_parseString</a></li><li><a href="global.html#CB_regularExpressionString">CB_regularExpressionString</a></li><li><a href="global.html#CB_renderString">CB_renderString</a></li><li><a href="global.html#CB_replaceAll">CB_replaceAll</a></li><li><a href="global.html#CB_rtrim">CB_rtrim</a></li><li><a href="global.html#CB_scriptPath">CB_scriptPath</a></li><li><a href="global.html#CB_scriptPathCalculate">CB_scriptPathCalculate</a></li><li><a href="global.html#CB_setCookie">CB_setCookie</a></li><li><a href="global.html#CB_setDatum">CB_setDatum</a></li><li><a href="global.html#CB_sizeOf">CB_sizeOf</a></li><li><a href="global.html#CB_sizeof">CB_sizeof</a></li><li><a href="global.html#CB_stringifyJSON">CB_stringifyJSON</a></li><li><a href="global.html#CB_symmetricCall">CB_symmetricCall</a></li><li><a href="global.html#CB_symmetricCallClear">CB_symmetricCallClear</a></li><li><a href="global.html#CB_this">CB_this</a></li><li><a href="global.html#CB_trim">CB_trim</a></li>
51 </ul>
52 </li>
53
54 </ul>
55
56 <div class="col-sm-3 col-md-3">
57 <form class="navbar-form" role="search">
58 <div class="input-group">
59 <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
60 <div class="input-group-btn">
61 <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
62 </div>
63 </div>
64 </form>
65 </div>
66
67 </div>
68
69</div>
70</div>
71
72
73<div class="container" id="toc-content" style="width:100%;">
74<div class="row" style="width:100%;">
75
76
77 <div class="col-md-8" style="width:85%;">
78
79 <div id="main">
80
81
82
83 <h1 class="page-title">Namespace: CB_Touch</h1>
84
85<section>
86
87<header>
88
89 <h2>
90 CB_Touch
91 </h2>
92
93
94</header>
95
96
97<article>
98 <div class="container-overview">
99
100
101 <div class="description"><p>Static class to manage the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Touch_events">touch events</a>. It will return itself if it is tried to be instantiated. It can also use <a href="https://pressurejs.com/">Pressure.js</a> and <a href="https://hammerjs.github.io/">Hammer.js</a>.</p></div>
102
103
104
105<dl class="details">
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
136 <dd class="tag-source">
137 <ul class="dummy">
138 <li>
139 <a href="CrossBase_input_CB_Touch.js.html">CrossBase/input/CB_Touch.js</a>,
140 <a href="CrossBase_input_CB_Touch.js.html#sunlight-1-line-12">line 12</a>
141 </li>
142 </ul>
143 </dd>
144
145
146
147
148
149
150
151</dl>
152
153
154
155
156 </div>
157
158
159
160
161
162
163
164
165
166
167
168
169 <h3 class="subsection-title">Members</h3>
170
171 <dl>
172
173<hr>
174<dt class="name" id=".DEFAULT_FORCE">
175 <h4 id=".DEFAULT_FORCE"><span class="type-signature">&lt;static, readonly> </span>DEFAULT_FORCE<span class="type-signature"> :number</span></h4>
176
177
178</dt>
179<dd>
180
181 <div class="description">
182 <p>Default value for the force attribute if no one is detected.</p>
183 </div>
184
185
186
187 <h5>Type:</h5>
188 <ul>
189 <li>
190
191<span class="param-type">number</span>
192
193
194
195 </li>
196 </ul>
197
198
199
200<dl class="details">
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226 <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
227 <dd class="tag-default">
228 <ul class="dummy">
229 <li>1</li>
230 </ul>
231 </dd>
232
233
234
235
236
237 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
238 <dd class="tag-source">
239 <ul class="dummy">
240 <li>
241 <a href="CrossBase_input_CB_Touch.js.html">CrossBase/input/CB_Touch.js</a>,
242 <a href="CrossBase_input_CB_Touch.js.html#sunlight-1-line-24">line 24</a>
243 </li>
244 </ul>
245 </dd>
246
247
248
249
250
251
252
253</dl>
254
255
256
257</dd>
258
259 </dl>
260
261
262
263 <h3 class="subsection-title">Methods</h3>
264
265 <dl>
266
267<hr>
268<dt>
269 <h4 class="name" id=".delay"><span class="type-signature">&lt;static> </span>delay<span class="signature">( [delayMs] [, index])</span><span class="type-signature"> &rarr; {boolean}</span></h4>
270
271
272</dt>
273<dd>
274
275
276 <div class="description">
277 <p>First time, this function will return true. Next calls, with same index, returns false during the previously-defined time set in the previous call and true after that delay. After the first call, next calls of this function with same index will be ignored (returning always false) until the delay provided expires. If it is called after a previous call with the same index and the delay of the previous call already expired, it will act as it was the first call again. Useful, for example, to prevent the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/touchstart_event">onTouchStart</a> event to fire twice or more when a layer (container) is closed and behind there is another one with also the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/touchstart_event">onTouchStart</a> event.</p>
278 </div>
279
280
281
282
283
284
285
286
287 <h5>Parameters:</h5>
288
289
290<table class="params table table-striped">
291 <thead>
292 <tr>
293
294 <th style="width:12%; min-width:110px;">Name</th>
295
296
297 <th style="width:12%; min-width:110px;">Type</th>
298
299
300 <th style="width:12%; min-width:110px;">Argument</th>
301
302
303
304 <th style="width:12%; min-width:110px;">Default</th>
305
306
307 <th class="last" style="min-width:310px;">Description</th>
308 </tr>
309 </thead>
310
311 <tbody>
312
313
314 <tr>
315
316 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>delayMs</code></td>
317
318
319 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
320
321
322<span class="param-type">integer</span>
323
324
325
326
327 </td>
328
329
330 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
331
332 &lt;optional><br>
333
334
335
336
337
338 </td>
339
340
341
342 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
343
344 CB_Touch._delayMsDefault
345
346 </td>
347
348
349 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Delay desired in milliseconds. For same indexes, this parameter will be ignored if there was a previous call to this function whose delay did not expire yet.</p></td>
350 </tr>
351
352
353
354 <tr>
355
356 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>index</code></td>
357
358
359 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
360
361
362<span class="param-type">integer</span>
363|
364
365<span class="param-type">string</span>
366
367
368
369
370 </td>
371
372
373 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
374
375 &lt;optional><br>
376
377
378
379
380
381 </td>
382
383
384
385 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
386
387 0
388
389 </td>
390
391
392 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Desired index to identify the process.</p></td>
393 </tr>
394
395
396 </tbody>
397</table>
398
399
400
401
402<dl class="details">
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
433 <dd class="tag-source">
434 <ul class="dummy">
435 <li>
436 <a href="CrossBase_input_CB_Touch.js.html">CrossBase/input/CB_Touch.js</a>,
437 <a href="CrossBase_input_CB_Touch.js.html#sunlight-1-line-344">line 344</a>
438 </li>
439 </ul>
440 </dd>
441
442
443
444
445
446
447
448</dl>
449
450
451
452
453
454
455
456
457
458
459
460
461
462 <h5>Returns:</h5>
463
464
465<div class="param-desc">
466 <p>First time, this function will return true. Next calls with the same index, returns false during the given time and true after that delay. After the first call, next calls with same index of this function will be ignored (returning always false) until the delay provided expires. If it is called after a previous call with the same index and the delay of the previous call already expired, it will act as it was the first call again.</p>
467</div>
468
469
470
471<dl>
472 <dt>
473 Type
474 </dt>
475 <dd>
476
477<span class="param-type">boolean</span>
478
479
480
481 </dd>
482</dl>
483
484
485
486
487
488</dd>
489
490
491
492<hr>
493<dt>
494 <h4 class="name" id=".getData"><span class="type-signature">&lt;static> </span>getData<span class="signature">()</span><span class="type-signature"> &rarr; {Event|null}</span></h4>
495
496
497</dt>
498<dd>
499
500
501 <div class="description">
502 <p>Returns the last <a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent">touch event</a> object (if any), processed by <a href="CB_Touch.html#.normalizeEvent"><code>CB_Touch.normalizeEvent</code></a> internally, which was used in the last touch event fired, if that touch event was <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/touchstart_event">touchstart</a>, <a href="https://w3.org/TR/2011/WD-touch-events-20110505/#the-touchenter-event">touchenter</a> or <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/touchmove_event">touchmove</a>. The <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/touchend_event">touchend</a> and <a href="https://w3.org/TR/2011/WD-touch-events-20110505/#the-touchleave-event">touchleave</a> events set it to &quot;null&quot;.</p>
503 </div>
504
505
506
507
508
509
510
511
512
513
514<dl class="details">
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
545 <dd class="tag-source">
546 <ul class="dummy">
547 <li>
548 <a href="CrossBase_input_CB_Touch.js.html">CrossBase/input/CB_Touch.js</a>,
549 <a href="CrossBase_input_CB_Touch.js.html#sunlight-1-line-169">line 169</a>
550 </li>
551 </ul>
552 </dd>
553
554
555
556
557
558
559
560</dl>
561
562
563
564
565
566
567
568
569
570
571
572
573
574 <h5>Returns:</h5>
575
576
577<div class="param-desc">
578 <p>Returns the last <a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent">touch event</a> affected, if any.</p>
579</div>
580
581
582
583<dl>
584 <dt>
585 Type
586 </dt>
587 <dd>
588
589<span class="param-type">Event</span>
590|
591
592<span class="param-type">null</span>
593
594
595
596 </dd>
597</dl>
598
599
600
601
602
603</dd>
604
605
606
607<hr>
608<dt>
609 <h4 class="name" id=".getHammerJSObject"><span class="type-signature">&lt;static> </span>getHammerJSObject<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
610
611
612</dt>
613<dd>
614
615
616 <div class="description">
617 <p>Returns the <a href="https://hammerjs.github.io/">Hammer.js</a> object (if any). Useful for managing touch gestures.</p>
618 </div>
619
620
621
622
623
624
625
626
627
628
629<dl class="details">
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
660 <dd class="tag-source">
661 <ul class="dummy">
662 <li>
663 <a href="CrossBase_input_CB_Touch.js.html">CrossBase/input/CB_Touch.js</a>,
664 <a href="CrossBase_input_CB_Touch.js.html#sunlight-1-line-317">line 317</a>
665 </li>
666 </ul>
667 </dd>
668
669
670
671
672
673
674
675</dl>
676
677
678
679
680
681
682
683
684
685
686
687
688
689 <h5>Returns:</h5>
690
691
692<div class="param-desc">
693 <p>Returns the <a href="https://hammerjs.github.io/">Hammer.js</a> object (if any).</p>
694</div>
695
696
697
698<dl>
699 <dt>
700 Type
701 </dt>
702 <dd>
703
704<span class="param-type">Object</span>
705
706
707
708 </dd>
709</dl>
710
711
712
713
714
715</dd>
716
717
718
719<hr>
720<dt>
721 <h4 class="name" id=".getMaxTouchPoints"><span class="type-signature">&lt;static> </span>getMaxTouchPoints<span class="signature">()</span><span class="type-signature"> &rarr; {integer|null}</span></h4>
722
723
724</dt>
725<dd>
726
727
728 <div class="description">
729 <p>Returns the maximum of touch points supported by the device (if possible).</p>
730 </div>
731
732
733
734
735
736
737
738
739
740
741<dl class="details">
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
772 <dd class="tag-source">
773 <ul class="dummy">
774 <li>
775 <a href="CrossBase_input_CB_Touch.js.html">CrossBase/input/CB_Touch.js</a>,
776 <a href="CrossBase_input_CB_Touch.js.html#sunlight-1-line-180">line 180</a>
777 </li>
778 </ul>
779 </dd>
780
781
782
783
784
785
786
787</dl>
788
789
790
791
792
793
794
795
796
797
798
799
800
801 <h5>Returns:</h5>
802
803
804<div class="param-desc">
805 <p>Maximum touch points supported by the device (if possible). If it cannot be detected, returns null.</p>
806</div>
807
808
809
810<dl>
811 <dt>
812 Type
813 </dt>
814 <dd>
815
816<span class="param-type">integer</span>
817|
818
819<span class="param-type">null</span>
820
821
822
823 </dd>
824</dl>
825
826
827
828
829
830</dd>
831
832
833
834<hr>
835<dt>
836 <h4 class="name" id=".getPressureJSObject"><span class="type-signature">&lt;static> </span>getPressureJSObject<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
837
838
839</dt>
840<dd>
841
842
843 <div class="description">
844 <p>Returns the <a href="https://pressurejs.com/">Pressure.js</a> object (if any). Useful for managing <a href="https://en.wikipedia.org/wiki/Force_Touch">Force Touch/3D Touch</a> and <a href="https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/pressure">Pointer Pressure</a> features.</p>
845 </div>
846
847
848
849
850
851
852
853
854
855
856<dl class="details">
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
887 <dd class="tag-source">
888 <ul class="dummy">
889 <li>
890 <a href="CrossBase_input_CB_Touch.js.html">CrossBase/input/CB_Touch.js</a>,
891 <a href="CrossBase_input_CB_Touch.js.html#sunlight-1-line-328">line 328</a>
892 </li>
893 </ul>
894 </dd>
895
896
897
898
899
900
901
902</dl>
903
904
905
906
907
908
909
910
911
912
913
914
915
916 <h5>Returns:</h5>
917
918
919<div class="param-desc">
920 <p>Returns the <a href="https://pressurejs.com/">Pressure.js</a> object (if any).</p>
921</div>
922
923
924
925<dl>
926 <dt>
927 Type
928 </dt>
929 <dd>
930
931<span class="param-type">Object</span>
932
933
934
935 </dd>
936</dl>
937
938
939
940
941
942</dd>
943
944
945
946<hr>
947<dt>
948 <h4 class="name" id=".normalizeEvent"><span class="type-signature">&lt;static> </span>normalizeEvent<span class="signature">(e)</span><span class="type-signature"> &rarr; {Event}</span></h4>
949
950
951</dt>
952<dd>
953
954
955 <div class="description">
956 <p>Tries to return the <a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent">touch event</a> object with some properties normalized (since different clients can use different values), when possible. It also calls the <a href="CB_Events.html#.normalize"><code>CB_Events.normalize</code></a> and <a href="CB_Touch.html#.normalizePoints"><code>CB_Touch.normalizePoints</code></a> functions internally. Some properties affected could be <a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent/targetTouches">targetTouches</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent/touches">touches</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent/changedTouches">changedTouches</a>, etc.</p>
957 </div>
958
959
960
961
962
963
964
965
966 <h5>Parameters:</h5>
967
968
969<table class="params table table-striped">
970 <thead>
971 <tr>
972
973 <th style="width:12%; min-width:110px;">Name</th>
974
975
976 <th style="width:12%; min-width:110px;">Type</th>
977
978
979
980
981
982 <th class="last" style="min-width:310px;">Description</th>
983 </tr>
984 </thead>
985
986 <tbody>
987
988
989 <tr>
990
991 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>e</code></td>
992
993
994 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
995
996
997<span class="param-type">Event</span>
998
999
1000
1001
1002 </td>
1003
1004
1005
1006
1007
1008 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p><a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent">Touch event</a> object. If not provided, it will use the value of &quot;event&quot;, &quot;window.event&quot;, &quot;Event&quot; or an empty object (&quot;{}&quot;).</p></td>
1009 </tr>
1010
1011
1012 </tbody>
1013</table>
1014
1015
1016
1017
1018<dl class="details">
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1049 <dd class="tag-source">
1050 <ul class="dummy">
1051 <li>
1052 <a href="CrossBase_input_CB_Touch.js.html">CrossBase/input/CB_Touch.js</a>,
1053 <a href="CrossBase_input_CB_Touch.js.html#sunlight-1-line-110">line 110</a>
1054 </li>
1055 </ul>
1056 </dd>
1057
1058
1059
1060
1061
1062
1063
1064 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
1065 <dd class="tag-todo">
1066 <ul>
1067 <li>Add more properties and methods to normalize (if needed)</li>
1068 </ul>
1069 </dd>
1070
1071</dl>
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085 <h5>Returns:</h5>
1086
1087
1088<div class="param-desc">
1089 <p>Returns the <a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent">touch event</a> object normalized.</p>
1090</div>
1091
1092
1093
1094<dl>
1095 <dt>
1096 Type
1097 </dt>
1098 <dd>
1099
1100<span class="param-type">Event</span>
1101
1102
1103
1104 </dd>
1105</dl>
1106
1107
1108
1109
1110
1111</dd>
1112
1113
1114
1115<hr>
1116<dt>
1117 <h4 class="name" id=".normalizeForce"><span class="type-signature">&lt;static> </span>normalizeForce<span class="signature">(force)</span><span class="type-signature"> &rarr; {Event}</span></h4>
1118
1119
1120</dt>
1121<dd>
1122
1123
1124 <div class="description">
1125 <p>Normalizes the given &quot;force&quot; property value across different clients. The new attached methods and properties may include polyfills, etc. This function is called by <a href="CB_Touch.html#.normalizePoint"><code>CB_Touch.normalizePoint</code></a> automatically.</p>
1126 </div>
1127
1128
1129
1130
1131
1132
1133
1134
1135 <h5>Parameters:</h5>
1136
1137
1138<table class="params table table-striped">
1139 <thead>
1140 <tr>
1141
1142 <th style="width:12%; min-width:110px;">Name</th>
1143
1144
1145 <th style="width:12%; min-width:110px;">Type</th>
1146
1147
1148
1149
1150
1151 <th class="last" style="min-width:310px;">Description</th>
1152 </tr>
1153 </thead>
1154
1155 <tbody>
1156
1157
1158 <tr>
1159
1160 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>force</code></td>
1161
1162
1163 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1164
1165
1166<span class="param-type">number</span>
1167
1168
1169
1170
1171 </td>
1172
1173
1174
1175
1176
1177 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Force value to be normalized.</p></td>
1178 </tr>
1179
1180
1181 </tbody>
1182</table>
1183
1184
1185
1186
1187<dl class="details">
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1218 <dd class="tag-source">
1219 <ul class="dummy">
1220 <li>
1221 <a href="CrossBase_input_CB_Touch.js.html">CrossBase/input/CB_Touch.js</a>,
1222 <a href="CrossBase_input_CB_Touch.js.html#sunlight-1-line-92">line 92</a>
1223 </li>
1224 </ul>
1225 </dd>
1226
1227
1228
1229
1230
1231
1232
1233 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
1234 <dd class="tag-todo">
1235 <ul>
1236 <li>Not all web clients are the same, so not all should be normalized.</li>
1237 </ul>
1238 </dd>
1239
1240</dl>
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254 <h5>Returns:</h5>
1255
1256
1257<div class="param-desc">
1258 <p>Returns the force value normalized.</p>
1259</div>
1260
1261
1262
1263<dl>
1264 <dt>
1265 Type
1266 </dt>
1267 <dd>
1268
1269<span class="param-type">Event</span>
1270
1271
1272
1273 </dd>
1274</dl>
1275
1276
1277
1278
1279
1280</dd>
1281
1282
1283
1284<hr>
1285<dt>
1286 <h4 class="name" id=".normalizePoint"><span class="type-signature">&lt;static> </span>normalizePoint<span class="signature">(point)</span><span class="type-signature"> &rarr; {Touch}</span></h4>
1287
1288
1289</dt>
1290<dd>
1291
1292
1293 <div class="description">
1294 <p>Normalizes a given point. Calls <a href="CB_Touch.html#.normalizeForce"><code>CB_Touch.normalizeForce</code></a> internally. This function is called by <a href="CB_Touch.html#.normalizePoints"><code>CB_Touch.normalizePoints</code></a> automatically.</p>
1295 </div>
1296
1297
1298
1299
1300
1301
1302
1303
1304 <h5>Parameters:</h5>
1305
1306
1307<table class="params table table-striped">
1308 <thead>
1309 <tr>
1310
1311 <th style="width:12%; min-width:110px;">Name</th>
1312
1313
1314 <th style="width:12%; min-width:110px;">Type</th>
1315
1316
1317
1318
1319
1320 <th class="last" style="min-width:310px;">Description</th>
1321 </tr>
1322 </thead>
1323
1324 <tbody>
1325
1326
1327 <tr>
1328
1329 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>point</code></td>
1330
1331
1332 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1333
1334
1335<span class="param-type">Touch</span>
1336
1337
1338
1339
1340 </td>
1341
1342
1343
1344
1345
1346 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p><a href="https://developer.mozilla.org/en-US/docs/Web/API/Touch">Touch object</a> to be normalized.</p></td>
1347 </tr>
1348
1349
1350 </tbody>
1351</table>
1352
1353
1354
1355
1356<dl class="details">
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1387 <dd class="tag-source">
1388 <ul class="dummy">
1389 <li>
1390 <a href="CrossBase_input_CB_Touch.js.html">CrossBase/input/CB_Touch.js</a>,
1391 <a href="CrossBase_input_CB_Touch.js.html#sunlight-1-line-148">line 148</a>
1392 </li>
1393 </ul>
1394 </dd>
1395
1396
1397
1398
1399
1400
1401
1402</dl>
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416 <h5>Returns:</h5>
1417
1418
1419<div class="param-desc">
1420 <p>Returns the given point normalized.</p>
1421</div>
1422
1423
1424
1425<dl>
1426 <dt>
1427 Type
1428 </dt>
1429 <dd>
1430
1431<span class="param-type">Touch</span>
1432
1433
1434
1435 </dd>
1436</dl>
1437
1438
1439
1440
1441
1442</dd>
1443
1444
1445
1446<hr>
1447<dt>
1448 <h4 class="name" id=".normalizePoints"><span class="type-signature">&lt;static> </span>normalizePoints<span class="signature">(points)</span><span class="type-signature"> &rarr; {TouchList|array}</span></h4>
1449
1450
1451</dt>
1452<dd>
1453
1454
1455 <div class="description">
1456 <p>Normalizes a given list of points. Calls <a href="CB_Touch.html#.normalizePoint"><code>CB_Touch.normalizePoint</code></a> internally. This function is called by <a href="CB_Touch.html#.normalizeEvent"><code>CB_Touch.normalizeEvent</code></a> automatically.</p>
1457 </div>
1458
1459
1460
1461
1462
1463
1464
1465
1466 <h5>Parameters:</h5>
1467
1468
1469<table class="params table table-striped">
1470 <thead>
1471 <tr>
1472
1473 <th style="width:12%; min-width:110px;">Name</th>
1474
1475
1476 <th style="width:12%; min-width:110px;">Type</th>
1477
1478
1479
1480
1481
1482 <th class="last" style="min-width:310px;">Description</th>
1483 </tr>
1484 </thead>
1485
1486 <tbody>
1487
1488
1489 <tr>
1490
1491 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>points</code></td>
1492
1493
1494 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1495
1496
1497<span class="param-type">TouchList</span>
1498|
1499
1500<span class="param-type">array</span>
1501
1502
1503
1504
1505 </td>
1506
1507
1508
1509
1510
1511 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p><a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchList">TouchList</a> or array with the points (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Touch">Touch objects</a>) to be normalized.</p></td>
1512 </tr>
1513
1514
1515 </tbody>
1516</table>
1517
1518
1519
1520
1521<dl class="details">
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1552 <dd class="tag-source">
1553 <ul class="dummy">
1554 <li>
1555 <a href="CrossBase_input_CB_Touch.js.html">CrossBase/input/CB_Touch.js</a>,
1556 <a href="CrossBase_input_CB_Touch.js.html#sunlight-1-line-131">line 131</a>
1557 </li>
1558 </ul>
1559 </dd>
1560
1561
1562
1563
1564
1565
1566
1567</dl>
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581 <h5>Returns:</h5>
1582
1583
1584<div class="param-desc">
1585 <p>Returns the given points normalized.</p>
1586</div>
1587
1588
1589
1590<dl>
1591 <dt>
1592 Type
1593 </dt>
1594 <dd>
1595
1596<span class="param-type">TouchList</span>
1597|
1598
1599<span class="param-type">array</span>
1600
1601
1602
1603 </dd>
1604</dl>
1605
1606
1607
1608
1609
1610</dd>
1611
1612
1613
1614<hr>
1615<dt>
1616 <h4 class="name" id=".onCancel"><span class="type-signature">&lt;static> </span>onCancel<span class="signature">(callbackFunction [, keepOldFunction] [, useCapture] [, target])</span><span class="type-signature"></span></h4>
1617
1618
1619</dt>
1620<dd>
1621
1622
1623 <div class="description">
1624 <p>Sets a function to execute when the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/touchcancel_event">onTouchCancel</a> event is fired or removes it. More information: <a href="https://developer.mozilla.org/en-US/docs/DOM/Touch_events">Touch events</a>.</p>
1625 </div>
1626
1627
1628
1629
1630
1631
1632
1633
1634 <h5>Parameters:</h5>
1635
1636
1637<table class="params table table-striped">
1638 <thead>
1639 <tr>
1640
1641 <th style="width:12%; min-width:110px;">Name</th>
1642
1643
1644 <th style="width:12%; min-width:110px;">Type</th>
1645
1646
1647 <th style="width:12%; min-width:110px;">Argument</th>
1648
1649
1650
1651 <th style="width:12%; min-width:110px;">Default</th>
1652
1653
1654 <th class="last" style="min-width:310px;">Description</th>
1655 </tr>
1656 </thead>
1657
1658 <tbody>
1659
1660
1661 <tr>
1662
1663 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackFunction</code></td>
1664
1665
1666 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1667
1668
1669<span class="param-type">function</span>
1670|
1671
1672<span class="param-type">null</span>
1673
1674
1675
1676
1677 </td>
1678
1679
1680 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1681
1682
1683
1684
1685
1686 </td>
1687
1688
1689
1690 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1691
1692 </td>
1693
1694
1695 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The function (event listener) that we want to execute when the event is fired. The first and unique parameter received for this function will be the event object (already normalized by the <a href="CB_Touch.html#.normalizeEvent"><code>CB_Touch.normalizeEvent</code></a> function). If a null value is used, the event will be removed.</p></td>
1696 </tr>
1697
1698
1699
1700 <tr>
1701
1702 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldFunction</code></td>
1703
1704
1705 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1706
1707
1708<span class="param-type">boolean</span>
1709
1710
1711
1712
1713 </td>
1714
1715
1716 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1717
1718 &lt;optional><br>
1719
1720
1721
1722
1723
1724 </td>
1725
1726
1727
1728 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1729
1730 true
1731
1732 </td>
1733
1734
1735 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to keep any possible previous event listener for the same target and event name or not.</p></td>
1736 </tr>
1737
1738
1739
1740 <tr>
1741
1742 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>useCapture</code></td>
1743
1744
1745 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1746
1747
1748<span class="param-type">boolean</span>
1749
1750
1751
1752
1753 </td>
1754
1755
1756 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1757
1758 &lt;optional><br>
1759
1760
1761
1762
1763
1764 </td>
1765
1766
1767
1768 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1769
1770 false
1771
1772 </td>
1773
1774
1775 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether the event we want to add will use capture or not. This parameter will be effective only if the current client supports the <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener">addEventListener</a> method and will be used as its third parameter.</p></td>
1776 </tr>
1777
1778
1779
1780 <tr>
1781
1782 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>target</code></td>
1783
1784
1785 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1786
1787
1788<span class="param-type">Object</span>
1789
1790
1791
1792
1793 </td>
1794
1795
1796 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1797
1798 &lt;optional><br>
1799
1800
1801
1802
1803
1804 </td>
1805
1806
1807
1808 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1809
1810 document
1811
1812 </td>
1813
1814
1815 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The target where we want to attach the event listener.</p></td>
1816 </tr>
1817
1818
1819 </tbody>
1820</table>
1821
1822
1823
1824
1825<dl class="details">
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1856 <dd class="tag-source">
1857 <ul class="dummy">
1858 <li>
1859 <a href="CrossBase_input_CB_Touch.js.html">CrossBase/input/CB_Touch.js</a>,
1860 <a href="CrossBase_input_CB_Touch.js.html#sunlight-1-line-227">line 227</a>
1861 </li>
1862 </ul>
1863 </dd>
1864
1865
1866
1867
1868
1869
1870
1871</dl>
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887</dd>
1888
1889
1890
1891<hr>
1892<dt>
1893 <h4 class="name" id=".onEnd"><span class="type-signature">&lt;static> </span>onEnd<span class="signature">(callbackFunction [, keepOldFunction] [, useCapture] [, target])</span><span class="type-signature"></span></h4>
1894
1895
1896</dt>
1897<dd>
1898
1899
1900 <div class="description">
1901 <p>Sets a function to execute when the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/touchend_event">onTouchEnd</a> event is fired or removes it. More information: <a href="https://developer.mozilla.org/en-US/docs/DOM/Touch_events">Touch events</a>.</p>
1902 </div>
1903
1904
1905
1906
1907
1908
1909
1910
1911 <h5>Parameters:</h5>
1912
1913
1914<table class="params table table-striped">
1915 <thead>
1916 <tr>
1917
1918 <th style="width:12%; min-width:110px;">Name</th>
1919
1920
1921 <th style="width:12%; min-width:110px;">Type</th>
1922
1923
1924 <th style="width:12%; min-width:110px;">Argument</th>
1925
1926
1927
1928 <th style="width:12%; min-width:110px;">Default</th>
1929
1930
1931 <th class="last" style="min-width:310px;">Description</th>
1932 </tr>
1933 </thead>
1934
1935 <tbody>
1936
1937
1938 <tr>
1939
1940 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackFunction</code></td>
1941
1942
1943 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1944
1945
1946<span class="param-type">function</span>
1947|
1948
1949<span class="param-type">null</span>
1950
1951
1952
1953
1954 </td>
1955
1956
1957 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1958
1959
1960
1961
1962
1963 </td>
1964
1965
1966
1967 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1968
1969 </td>
1970
1971
1972 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The function (event listener) that we want to execute when the event is fired. The first and unique parameter received for this function will be the event object (already normalized by the <a href="CB_Touch.html#.normalizeEvent"><code>CB_Touch.normalizeEvent</code></a> function). If a null value is used, the event will be removed.</p></td>
1973 </tr>
1974
1975
1976
1977 <tr>
1978
1979 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldFunction</code></td>
1980
1981
1982 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1983
1984
1985<span class="param-type">boolean</span>
1986
1987
1988
1989
1990 </td>
1991
1992
1993 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
1994
1995 &lt;optional><br>
1996
1997
1998
1999
2000
2001 </td>
2002
2003
2004
2005 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2006
2007 true
2008
2009 </td>
2010
2011
2012 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to keep any possible previous event listener for the same target and event name or not.</p></td>
2013 </tr>
2014
2015
2016
2017 <tr>
2018
2019 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>useCapture</code></td>
2020
2021
2022 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2023
2024
2025<span class="param-type">boolean</span>
2026
2027
2028
2029
2030 </td>
2031
2032
2033 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2034
2035 &lt;optional><br>
2036
2037
2038
2039
2040
2041 </td>
2042
2043
2044
2045 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2046
2047 false
2048
2049 </td>
2050
2051
2052 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether the event we want to add will use capture or not. This parameter will be effective only if the current client supports the <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener">addEventListener</a> method and will be used as its third parameter.</p></td>
2053 </tr>
2054
2055
2056
2057 <tr>
2058
2059 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>target</code></td>
2060
2061
2062 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2063
2064
2065<span class="param-type">Object</span>
2066
2067
2068
2069
2070 </td>
2071
2072
2073 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2074
2075 &lt;optional><br>
2076
2077
2078
2079
2080
2081 </td>
2082
2083
2084
2085 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2086
2087 document
2088
2089 </td>
2090
2091
2092 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The target where we want to attach the event listener.</p></td>
2093 </tr>
2094
2095
2096 </tbody>
2097</table>
2098
2099
2100
2101
2102<dl class="details">
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2133 <dd class="tag-source">
2134 <ul class="dummy">
2135 <li>
2136 <a href="CrossBase_input_CB_Touch.js.html">CrossBase/input/CB_Touch.js</a>,
2137 <a href="CrossBase_input_CB_Touch.js.html#sunlight-1-line-213">line 213</a>
2138 </li>
2139 </ul>
2140 </dd>
2141
2142
2143
2144
2145
2146
2147
2148</dl>
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164</dd>
2165
2166
2167
2168<hr>
2169<dt>
2170 <h4 class="name" id=".onEnter"><span class="type-signature">&lt;static> </span>onEnter<span class="signature">(callbackFunction [, keepOldFunction] [, useCapture] [, target])</span><span class="type-signature"></span></h4>
2171
2172
2173</dt>
2174<dd>
2175
2176
2177 <div class="description">
2178 <p>Sets a function to execute when the <a href="https://w3.org/TR/2011/WD-touch-events-20110505/#the-touchenter-event">onTouchEnter</a> event is fired or removes it. More information: <a href="https://developer.mozilla.org/en-US/docs/DOM/Touch_events">Touch events</a>.</p>
2179 </div>
2180
2181
2182
2183
2184
2185
2186
2187
2188 <h5>Parameters:</h5>
2189
2190
2191<table class="params table table-striped">
2192 <thead>
2193 <tr>
2194
2195 <th style="width:12%; min-width:110px;">Name</th>
2196
2197
2198 <th style="width:12%; min-width:110px;">Type</th>
2199
2200
2201 <th style="width:12%; min-width:110px;">Argument</th>
2202
2203
2204
2205 <th style="width:12%; min-width:110px;">Default</th>
2206
2207
2208 <th class="last" style="min-width:310px;">Description</th>
2209 </tr>
2210 </thead>
2211
2212 <tbody>
2213
2214
2215 <tr>
2216
2217 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackFunction</code></td>
2218
2219
2220 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2221
2222
2223<span class="param-type">function</span>
2224|
2225
2226<span class="param-type">null</span>
2227
2228
2229
2230
2231 </td>
2232
2233
2234 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2235
2236
2237
2238
2239
2240 </td>
2241
2242
2243
2244 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2245
2246 </td>
2247
2248
2249 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The function (event listener) that we want to execute when the event is fired. The first and unique parameter received for this function will be the event object (already normalized by the <a href="CB_Touch.html#.normalizeEvent"><code>CB_Touch.normalizeEvent</code></a> function). If a null value is used, the event will be removed.</p></td>
2250 </tr>
2251
2252
2253
2254 <tr>
2255
2256 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldFunction</code></td>
2257
2258
2259 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2260
2261
2262<span class="param-type">boolean</span>
2263
2264
2265
2266
2267 </td>
2268
2269
2270 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2271
2272 &lt;optional><br>
2273
2274
2275
2276
2277
2278 </td>
2279
2280
2281
2282 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2283
2284 true
2285
2286 </td>
2287
2288
2289 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to keep any possible previous event listener for the same target and event name or not.</p></td>
2290 </tr>
2291
2292
2293
2294 <tr>
2295
2296 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>useCapture</code></td>
2297
2298
2299 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2300
2301
2302<span class="param-type">boolean</span>
2303
2304
2305
2306
2307 </td>
2308
2309
2310 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2311
2312 &lt;optional><br>
2313
2314
2315
2316
2317
2318 </td>
2319
2320
2321
2322 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2323
2324 false
2325
2326 </td>
2327
2328
2329 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether the event we want to add will use capture or not. This parameter will be effective only if the current client supports the <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener">addEventListener</a> method and will be used as its third parameter.</p></td>
2330 </tr>
2331
2332
2333
2334 <tr>
2335
2336 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>target</code></td>
2337
2338
2339 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2340
2341
2342<span class="param-type">Object</span>
2343
2344
2345
2346
2347 </td>
2348
2349
2350 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2351
2352 &lt;optional><br>
2353
2354
2355
2356
2357
2358 </td>
2359
2360
2361
2362 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2363
2364 document
2365
2366 </td>
2367
2368
2369 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The target where we want to attach the event listener.</p></td>
2370 </tr>
2371
2372
2373 </tbody>
2374</table>
2375
2376
2377
2378
2379<dl class="details">
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2410 <dd class="tag-source">
2411 <ul class="dummy">
2412 <li>
2413 <a href="CrossBase_input_CB_Touch.js.html">CrossBase/input/CB_Touch.js</a>,
2414 <a href="CrossBase_input_CB_Touch.js.html#sunlight-1-line-241">line 241</a>
2415 </li>
2416 </ul>
2417 </dd>
2418
2419
2420
2421
2422
2423
2424
2425</dl>
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441</dd>
2442
2443
2444
2445<hr>
2446<dt>
2447 <h4 class="name" id=".onLeave"><span class="type-signature">&lt;static> </span>onLeave<span class="signature">(callbackFunction [, keepOldFunction] [, useCapture] [, target])</span><span class="type-signature"></span></h4>
2448
2449
2450</dt>
2451<dd>
2452
2453
2454 <div class="description">
2455 <p>Sets a function to execute when the <a href="https://w3.org/TR/2011/WD-touch-events-20110505/#the-touchleave-event">onTouchLeave</a> event is fired or removes it. More information: <a href="https://developer.mozilla.org/en-US/docs/DOM/Touch_events">Touch events</a>.</p>
2456 </div>
2457
2458
2459
2460
2461
2462
2463
2464
2465 <h5>Parameters:</h5>
2466
2467
2468<table class="params table table-striped">
2469 <thead>
2470 <tr>
2471
2472 <th style="width:12%; min-width:110px;">Name</th>
2473
2474
2475 <th style="width:12%; min-width:110px;">Type</th>
2476
2477
2478 <th style="width:12%; min-width:110px;">Argument</th>
2479
2480
2481
2482 <th style="width:12%; min-width:110px;">Default</th>
2483
2484
2485 <th class="last" style="min-width:310px;">Description</th>
2486 </tr>
2487 </thead>
2488
2489 <tbody>
2490
2491
2492 <tr>
2493
2494 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackFunction</code></td>
2495
2496
2497 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2498
2499
2500<span class="param-type">function</span>
2501|
2502
2503<span class="param-type">null</span>
2504
2505
2506
2507
2508 </td>
2509
2510
2511 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2512
2513
2514
2515
2516
2517 </td>
2518
2519
2520
2521 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2522
2523 </td>
2524
2525
2526 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The function (event listener) that we want to execute when the event is fired. The first and unique parameter received for this function will be the event object (already normalized by the <a href="CB_Touch.html#.normalizeEvent"><code>CB_Touch.normalizeEvent</code></a> function). If a null value is used, the event will be removed.</p></td>
2527 </tr>
2528
2529
2530
2531 <tr>
2532
2533 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldFunction</code></td>
2534
2535
2536 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2537
2538
2539<span class="param-type">boolean</span>
2540
2541
2542
2543
2544 </td>
2545
2546
2547 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2548
2549 &lt;optional><br>
2550
2551
2552
2553
2554
2555 </td>
2556
2557
2558
2559 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2560
2561 true
2562
2563 </td>
2564
2565
2566 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to keep any possible previous event listener for the same target and event name or not.</p></td>
2567 </tr>
2568
2569
2570
2571 <tr>
2572
2573 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>useCapture</code></td>
2574
2575
2576 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2577
2578
2579<span class="param-type">boolean</span>
2580
2581
2582
2583
2584 </td>
2585
2586
2587 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2588
2589 &lt;optional><br>
2590
2591
2592
2593
2594
2595 </td>
2596
2597
2598
2599 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2600
2601 false
2602
2603 </td>
2604
2605
2606 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether the event we want to add will use capture or not. This parameter will be effective only if the current client supports the <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener">addEventListener</a> method and will be used as its third parameter.</p></td>
2607 </tr>
2608
2609
2610
2611 <tr>
2612
2613 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>target</code></td>
2614
2615
2616 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2617
2618
2619<span class="param-type">Object</span>
2620
2621
2622
2623
2624 </td>
2625
2626
2627 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2628
2629 &lt;optional><br>
2630
2631
2632
2633
2634
2635 </td>
2636
2637
2638
2639 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2640
2641 document
2642
2643 </td>
2644
2645
2646 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The target where we want to attach the event listener.</p></td>
2647 </tr>
2648
2649
2650 </tbody>
2651</table>
2652
2653
2654
2655
2656<dl class="details">
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2687 <dd class="tag-source">
2688 <ul class="dummy">
2689 <li>
2690 <a href="CrossBase_input_CB_Touch.js.html">CrossBase/input/CB_Touch.js</a>,
2691 <a href="CrossBase_input_CB_Touch.js.html#sunlight-1-line-255">line 255</a>
2692 </li>
2693 </ul>
2694 </dd>
2695
2696
2697
2698
2699
2700
2701
2702</dl>
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718</dd>
2719
2720
2721
2722<hr>
2723<dt>
2724 <h4 class="name" id=".onMove"><span class="type-signature">&lt;static> </span>onMove<span class="signature">(callbackFunction [, keepOldFunction] [, useCapture] [, target])</span><span class="type-signature"></span></h4>
2725
2726
2727</dt>
2728<dd>
2729
2730
2731 <div class="description">
2732 <p>Sets a function to execute when the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/touchmove_event">onTouchMove</a> event is fired or removes it. More information: <a href="https://developer.mozilla.org/en-US/docs/DOM/Touch_events">Touch events</a>.</p>
2733 </div>
2734
2735
2736
2737
2738
2739
2740
2741
2742 <h5>Parameters:</h5>
2743
2744
2745<table class="params table table-striped">
2746 <thead>
2747 <tr>
2748
2749 <th style="width:12%; min-width:110px;">Name</th>
2750
2751
2752 <th style="width:12%; min-width:110px;">Type</th>
2753
2754
2755 <th style="width:12%; min-width:110px;">Argument</th>
2756
2757
2758
2759 <th style="width:12%; min-width:110px;">Default</th>
2760
2761
2762 <th class="last" style="min-width:310px;">Description</th>
2763 </tr>
2764 </thead>
2765
2766 <tbody>
2767
2768
2769 <tr>
2770
2771 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackFunction</code></td>
2772
2773
2774 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2775
2776
2777<span class="param-type">function</span>
2778|
2779
2780<span class="param-type">null</span>
2781
2782
2783
2784
2785 </td>
2786
2787
2788 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2789
2790
2791
2792
2793
2794 </td>
2795
2796
2797
2798 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2799
2800 </td>
2801
2802
2803 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The function (event listener) that we want to execute when the event is fired. The first and unique parameter received for this function will be the event object (already normalized by the <a href="CB_Touch.html#.normalizeEvent"><code>CB_Touch.normalizeEvent</code></a> function). If a null value is used, the event will be removed.</p></td>
2804 </tr>
2805
2806
2807
2808 <tr>
2809
2810 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldFunction</code></td>
2811
2812
2813 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2814
2815
2816<span class="param-type">boolean</span>
2817
2818
2819
2820
2821 </td>
2822
2823
2824 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2825
2826 &lt;optional><br>
2827
2828
2829
2830
2831
2832 </td>
2833
2834
2835
2836 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2837
2838 true
2839
2840 </td>
2841
2842
2843 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to keep any possible previous event listener for the same target and event name or not.</p></td>
2844 </tr>
2845
2846
2847
2848 <tr>
2849
2850 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>useCapture</code></td>
2851
2852
2853 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2854
2855
2856<span class="param-type">boolean</span>
2857
2858
2859
2860
2861 </td>
2862
2863
2864 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2865
2866 &lt;optional><br>
2867
2868
2869
2870
2871
2872 </td>
2873
2874
2875
2876 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2877
2878 false
2879
2880 </td>
2881
2882
2883 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether the event we want to add will use capture or not. This parameter will be effective only if the current client supports the <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener">addEventListener</a> method and will be used as its third parameter.</p></td>
2884 </tr>
2885
2886
2887
2888 <tr>
2889
2890 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>target</code></td>
2891
2892
2893 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2894
2895
2896<span class="param-type">Object</span>
2897
2898
2899
2900
2901 </td>
2902
2903
2904 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2905
2906 &lt;optional><br>
2907
2908
2909
2910
2911
2912 </td>
2913
2914
2915
2916 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2917
2918 document
2919
2920 </td>
2921
2922
2923 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The target where we want to attach the event listener.</p></td>
2924 </tr>
2925
2926
2927 </tbody>
2928</table>
2929
2930
2931
2932
2933<dl class="details">
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2964 <dd class="tag-source">
2965 <ul class="dummy">
2966 <li>
2967 <a href="CrossBase_input_CB_Touch.js.html">CrossBase/input/CB_Touch.js</a>,
2968 <a href="CrossBase_input_CB_Touch.js.html#sunlight-1-line-269">line 269</a>
2969 </li>
2970 </ul>
2971 </dd>
2972
2973
2974
2975
2976
2977
2978
2979</dl>
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995</dd>
2996
2997
2998
2999<hr>
3000<dt>
3001 <h4 class="name" id=".onStart"><span class="type-signature">&lt;static> </span>onStart<span class="signature">(callbackFunction [, keepOldFunction] [, useCapture] [, target])</span><span class="type-signature"></span></h4>
3002
3003
3004</dt>
3005<dd>
3006
3007
3008 <div class="description">
3009 <p>Sets a function to execute when the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/touchstart_event">onTouchStart</a> event is fired or removes it. More information: <a href="https://developer.mozilla.org/en-US/docs/DOM/Touch_events">Touch events</a>.</p>
3010 </div>
3011
3012
3013
3014
3015
3016
3017
3018
3019 <h5>Parameters:</h5>
3020
3021
3022<table class="params table table-striped">
3023 <thead>
3024 <tr>
3025
3026 <th style="width:12%; min-width:110px;">Name</th>
3027
3028
3029 <th style="width:12%; min-width:110px;">Type</th>
3030
3031
3032 <th style="width:12%; min-width:110px;">Argument</th>
3033
3034
3035
3036 <th style="width:12%; min-width:110px;">Default</th>
3037
3038
3039 <th class="last" style="min-width:310px;">Description</th>
3040 </tr>
3041 </thead>
3042
3043 <tbody>
3044
3045
3046 <tr>
3047
3048 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackFunction</code></td>
3049
3050
3051 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3052
3053
3054<span class="param-type">function</span>
3055|
3056
3057<span class="param-type">null</span>
3058
3059
3060
3061
3062 </td>
3063
3064
3065 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3066
3067
3068
3069
3070
3071 </td>
3072
3073
3074
3075 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3076
3077 </td>
3078
3079
3080 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The function (event listener) that we want to execute when the event is fired. The first and unique parameter received for this function will be the event object (already normalized by the <a href="CB_Touch.html#.normalizeEvent"><code>CB_Touch.normalizeEvent</code></a> function). If a null value is used, the event will be removed.</p></td>
3081 </tr>
3082
3083
3084
3085 <tr>
3086
3087 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldFunction</code></td>
3088
3089
3090 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3091
3092
3093<span class="param-type">boolean</span>
3094
3095
3096
3097
3098 </td>
3099
3100
3101 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3102
3103 &lt;optional><br>
3104
3105
3106
3107
3108
3109 </td>
3110
3111
3112
3113 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3114
3115 true
3116
3117 </td>
3118
3119
3120 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to keep any possible previous event listener for the same target and event name or not.</p></td>
3121 </tr>
3122
3123
3124
3125 <tr>
3126
3127 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>useCapture</code></td>
3128
3129
3130 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3131
3132
3133<span class="param-type">boolean</span>
3134
3135
3136
3137
3138 </td>
3139
3140
3141 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3142
3143 &lt;optional><br>
3144
3145
3146
3147
3148
3149 </td>
3150
3151
3152
3153 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3154
3155 false
3156
3157 </td>
3158
3159
3160 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether the event we want to add will use capture or not. This parameter will be effective only if the current client supports the <a href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener">addEventListener</a> method and will be used as its third parameter.</p></td>
3161 </tr>
3162
3163
3164
3165 <tr>
3166
3167 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>target</code></td>
3168
3169
3170 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3171
3172
3173<span class="param-type">Object</span>
3174
3175
3176
3177
3178 </td>
3179
3180
3181 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3182
3183 &lt;optional><br>
3184
3185
3186
3187
3188
3189 </td>
3190
3191
3192
3193 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3194
3195 document
3196
3197 </td>
3198
3199
3200 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The target where we want to attach the event listener.</p></td>
3201 </tr>
3202
3203
3204 </tbody>
3205</table>
3206
3207
3208
3209
3210<dl class="details">
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3241 <dd class="tag-source">
3242 <ul class="dummy">
3243 <li>
3244 <a href="CrossBase_input_CB_Touch.js.html">CrossBase/input/CB_Touch.js</a>,
3245 <a href="CrossBase_input_CB_Touch.js.html#sunlight-1-line-199">line 199</a>
3246 </li>
3247 </ul>
3248 </dd>
3249
3250
3251
3252
3253
3254
3255
3256</dl>
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272</dd>
3273
3274 </dl>
3275
3276
3277
3278
3279
3280</article>
3281
3282</section>
3283
3284
3285
3286
3287 </div>
3288 </div>
3289
3290 <div class="clearfix"></div>
3291
3292
3293 <div class="col-md-3">
3294 <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
3295 </div>
3296
3297
3298</div>
3299</div>
3300
3301
3302 <div class="modal fade" id="searchResults">
3303 <div class="modal-dialog">
3304 <div class="modal-content">
3305 <div class="modal-header">
3306 <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
3307 <h4 class="modal-title">Search results</h4>
3308 </div>
3309 <div class="modal-body"></div>
3310 <div class="modal-footer">
3311 <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
3312 </div>
3313 </div><!-- /.modal-content -->
3314 </div><!-- /.modal-dialog -->
3315 </div>
3316
3317
3318<footer>
3319
3320
3321 <span class="copyright">
3322 <a href="printable/" target="_blank">See a more printer-friendly version</a><hr /><span style="color:#000000">© <address style="display:inline; font-style:normal;"><a href="https://crossbrowdy.com/" target="_blank">CrossBrowdy</a> API documentation</address> by <a href="https://joanalbamaldonado.com/" target="_blank">Joan Alba Maldonado</a> - <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank">Creative Commons Attribution 4.0 International</a><br />DocStrap Copyright © 2012-2015 The contributors to the JSDoc3 and DocStrap projects.</span>
3323 </span>
3324
3325<span class="jsdoc-message">
3326 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
3327
3328 on Wed Mar 22nd 2023
3329
3330 using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
3331</span>
3332</footer>
3333
3334<script src="scripts/docstrap.lib.js"></script>
3335<script src="scripts/toc.js"></script>
3336
3337 <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
3338
3339
3340<script>
3341$( function () {
3342 $( "[id*='$']" ).each( function () {
3343 var $this = $( this );
3344
3345 $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
3346 } );
3347
3348 $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
3349 var $this = $( this );
3350
3351 var example = $this.find( "code" );
3352 exampleText = example.html();
3353 var lang = /{@lang (.*?)}/.exec( exampleText );
3354 if ( lang && lang[1] ) {
3355 exampleText = exampleText.replace( lang[0], "" );
3356 example.html( exampleText );
3357 lang = lang[1];
3358 } else {
3359 var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
3360 lang = langClassMatch ? langClassMatch[1] : "javascript";
3361 }
3362
3363 if ( lang ) {
3364
3365 $this
3366 .addClass( "sunlight-highlight-" + lang )
3367 .addClass( "linenums" )
3368 .html( example.html() );
3369
3370 }
3371 } );
3372
3373 Sunlight.highlightAll( {
3374 lineNumbers : true,
3375 showMenu : true,
3376 enableDoclinks : true
3377 } );
3378
3379 $.catchAnchorLinks( {
3380 navbarOffset: 10
3381 } );
3382 $( "#toc" ).toc( {
3383 anchorName : function ( i, heading, prefix ) {
3384 return $( heading ).attr( "id" ) || ( prefix + i );
3385 },
3386 selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
3387 showAndHide : false,
3388 smoothScrolling: true
3389 } );
3390
3391 $( "#main span[id^='toc']" ).addClass( "toc-shim" );
3392 $( '.dropdown-toggle' ).dropdown();
3393
3394 $( "table" ).each( function () {
3395 var $this = $( this );
3396 $this.addClass('table');
3397 } );
3398
3399} );
3400</script>
3401
3402
3403
3404<!--Navigation and Symbol Display-->
3405
3406<script>
3407 $( function () {
3408 $( '#main' ).localScroll( {
3409 offset : { top : 60 } //offset by the height of your header (give or take a few px, see what works for you)
3410 } );
3411 $( "dt.name" ).each( function () {
3412 var $this = $( this ).find("h4");
3413 var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
3414 var dt = $(this);
3415 var children = dt.next( "dd" );
3416
3417 dt.prepend( icon ).css( {cursor : "pointer"} );
3418 dt.addClass( "member-collapsed" ).addClass( "member" );
3419
3420
3421 children.hide();
3422
3423 dt.children().on( "click", function () {
3424 children = dt.next( "dd" );
3425 children.slideToggle( "fast", function () {
3426
3427 if ( children.is( ":visible" ) ) {
3428 icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
3429 dt.addClass( "member-open" ).animate( "member-collapsed" );
3430 } else {
3431 icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
3432 dt.addClass( "member-collapsed" ).removeClass( "member-open" );
3433 }
3434 } );
3435 } );
3436
3437 } );
3438 } );
3439</script>
3440
3441
3442<!--Google Analytics-->
3443
3444
3445
3446 <script type="text/javascript">
3447 $(document).ready(function() {
3448 SearcherDisplay.init();
3449 });
3450 </script>
3451
3452
3453</body>
3454</html>
\No newline at end of file