This repository has been archived by the owner on Oct 8, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
methods.html
645 lines (500 loc) · 25.9 KB
/
methods.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
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
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
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
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>jQuery Mobile Docs - Methods</title>
<link rel="stylesheet" href="../../css/themes/default/jquery.mobile.css" />
<link rel="stylesheet" href="../_assets/css/jqm-docs.css"/>
<script src="../../js/jquery.js"></script>
<script src="../../docs/_assets/js/jqm-docs.js"></script>
<script src="../../js/"></script>
</head>
<body>
<div data-role="page" class="type-interior">
<div data-role="header" data-theme="f">
<h1>Methods</h1>
<a href="../../" data-icon="home" data-iconpos="notext" data-direction="reverse">Home</a>
<a href="../nav.html" data-icon="search" data-iconpos="notext" data-rel="dialog" data-transition="fade">Search</a>
</div><!-- /header -->
<div data-role="content">
<div class="content-primary">
<p>jQuery Mobile exposes several methods and properties on the $.mobile object for use in your applications.</p>
<dl>
<dt><code>$.mobile.changePage</code> (<em>method</em>)</dt>
<dd>Programmatically change from one page to another. This method is used internally for the page loading and transitioning that occurs as a result of clicking a link or submitting a form, when those features are enabled.</dd>
<dd>
<dl>
<dt><code>·</code> Arguments</dt>
<dd><code>to</code> (<em>string or object</em>, required)
<ul>
<li>String: Absolute or relative URL. ("about/us.html")</li>
<li>Object: jQuery collection object. (<code>$("#about")</code>)</li>
</ul>
</dd>
<dd><code>options</code> (<em>object</em>, optional)
<ul>
<li>Properties:
<ul>
<li><code>allowSamePageTransition</code> (<em>boolean</em>, default: false) By default, changePage() ignores requests to change to the current active page. Setting this option to true, allows the request to execute. Developers should note that some of the page transitions assume that the fromPage and toPage of a changePage request are different, so they may not animate as expected. Developers are responsible for either providing a proper transition, or turning it off for this specific case.</li>
<li><code>changeHash</code> (<em>boolean</em>, default: true) Decides if the hash in the location bar should be updated. </li>
<li><code>data</code> (<em>object</em> or string, default: undefined) The data to send with an Ajax page request.
<ul>
<li>Used only when the 'to' argument of changePage() is a URL.</li>
</ul>
</li>
<li><code>dataUrl</code> (string, default: undefined) The URL to use when updating the browser location upon changePage completion.
If not specified, the value of the data-url attribute of the page element is used.</li>
<li><code>pageContainer</code> (jQuery collection, default: $.mobile.pageContainer) Specifies the element that should contain the page. </li>
<li><code>reloadPage</code> (<em>boolean</em>, default: false) Forces a reload of a page, even if it is already in the DOM of the page container.
<ul>
<li>Used only when the 'to' argument of changePage() is a URL.</li>
</ul>
</li>
<li><code>reverse</code> (<em>boolean</em>, default: false) Decides what direction the transition will run when showing the page. </li>
<li><code>role</code> (<em>string</em>, default: undefined) The data-role value to be used when displaying the page. By default this is undefined which means rely on the value of the @data-role attribute defined on the element.</li>
<li><code>showLoadMsg</code> (<em>boolean</em>, default: true) Decides whether or not to show the loading message when loading external pages.</li>
<li><code>transition</code> (<em>string</em>, default: $.mobile.defaultPageTransition) The transition to use when showing the page. </li>
<li><code>type</code> (<em>string</em>, default: "get") Specifies the method ("get" or "post") to use when making a page request.
<ul>
<li>Used only when the 'to' argument of changePage() is a URL.</li>
</ul>
</li>
</ul>
</li>
</ul>
</dd>
</dl>
</dd>
<dd>Examples:
<pre>
<code>
<strong>//transition to the "about us" page with a slideup transition</strong>
$.mobile.changePage( "about/us.html", { transition: "slideup"} );
<strong>//transition to the "search results" page, using data from a form with an id of "search"</strong>
$.mobile.changePage( "searchresults.php", {
type: "post",
data: $("form#search").serialize()
});
<strong>//transition to the "confirm" page with a "pop" transition without tracking it in history </strong>
$.mobile.changePage( "../alerts/confirm.html", {
transition: "pop",
reverse: false,
changeHash: false
});
</code>
</pre>
</dd>
<dt><code>$.mobile.loadPage</code> (<em>method</em>)</dt>
<dd>Load an external page, enhance its content, and insert it into the DOM. This method is called internally by the changePage() function when its first argument is a URL. This function does not affect the current active page so it can be used to load pages in the background. The function returns a deferred promise object that gets resolved after the page has been enhanced and inserted into the document.</dd>
<dd>
<dl>
<dt><code>·</code> Arguments</dt>
<dd><code>url</code> (<em>string or object</em>, required) A relative or absolute URL.</dd>
<dd><code>options</code> (<em>object</em>, optional)
<ul>
<li>Properties:
<ul>
<li><code>data</code> (<em>object</em> or string, default: undefined) The data to send with an Ajax page request. </li>
<li><code>loadMsgDelay</code> (<em>number (in ms)</em>, default: 50) Forced delay before the loading message is shown. This is meant to allow time for a page that has already been visited to be fetched from cache without a loading message.</li>
<li><code>pageContainer</code> (jQuery collection, default: $.mobile.pageContainer) Specifies the element that should contain the page after it is loaded. </li>
<li><code>reloadPage</code> (<em>boolean</em>, default: false) Forces a reload of a page, even if it is already in the DOM of the page container. </li>
<li><code>role</code> (<em>string</em>, default: undefined) The data-role value to be used when displaying the page. By default this is undefined which means rely on the value of the @data-role attribute defined on the element.</li>
<li><code>type</code> (<em>string</em>, default: "get") Specifies the method ("get" or "post") to use when making a page request.
</li>
</ul>
</li>
</ul>
</dd>
</dl>
</dd>
<dd>Examples:
<pre>
<code>
<strong>//load the "about us" page into the DOM</strong>
$.mobile.loadPage( "about/us.html" );
<strong>//load a "search results" page, using data from a form with an id of "search"</strong>
$.mobile.loadPage( "searchresults.php", {
type: "post",
data: $("form#search").serialize()
});
</code>
</pre>
</dd>
<dt><code>$.fn.jqmData(), $.fn.jqmRemoveData()</code> (<em>method</em>)</dt>
<dd>When working with jQuery Mobile, <code>jqmData</code> and <code>jqmRemoveData</code> should be used in place of jQuery core's <code>data</code> and <code>removeData</code> methods (note that this includes $.fn.data, $.fn.removeData, and the $.data, $.removeData, and $.hasData utilities), as they automatically incorporate getting and setting of namespaced data attributes (even if no namespace is currently in use).</dd>
<dd>
<dl>
<dt><code>·</code> Arguments:</dt>
<dd>See jQuery's <a href="http://api.jquery.com/jQuery.data/">data</a> and <a href="http://api.jquery.com/jQuery.removeData/">removeData</a> methods</dd>
<strong>Note: </strong>Calling jqmData() with no argument will return <code>undefined</code>. This behavior is subject to change in future versions.
<dt><code>·</code> Also:</dt>
<dd>When finding elements by their jQuery Mobile data attribute, please use the custom selector <code>:jqmData()</code>, as it automatically incorporates namespaced data attributes into the lookup when they are in use. For example, instead of calling <code>$("div[data-role='page']")</code>, you should use <code>$("div:jqmData(role='page')")</code>, which internally maps to <code>$("div[data-"+ $.mobile.ns +"role='page']")</code> without forcing you to concatenate a namespace into your selectors manually.</dd>
</dl>
</dd>
<dt><code>$.fn.jqmEnhanceable()</code> (<em>method</em>)</dt>
<dd>For users that wish to respect <code>data-enhance=false</code> parent elements during manual enhancement or custom plugin authoring jQuery Mobile provides the <code>$.fn.jqmEnhanceable</code> filter method.</dd>
<dd>
<dl>
<dt><code>·</code> Settings:</dt>
<dd>If, and only if, <code>$.mobile.ignoreContentEnabled</code> is set to true, this method will traverse the parent nodes for each DOM element in the jQuery object and where it finds a <code>data-enhance=false</code> parent the child will be removed from the set.</dd>
<dt><code>·</code> Warning:</dt>
<dd>The operation of traversing all parent elements can be expensive for even small jQuery object sets.</dd>
</dl>
</dd>
<dt><code>$.fn.jqmHijackable()</code> (<em>method</em>)</dt>
<dd>For users that wish to respect <code>data-ajax=false</code> parent elements during custom form and link binding jQuery Mobile provides the <code>$.fn.jqmHijackable</code> filter method.</dd>
<dd>
<dl>
<dt><code>·</code> Settings:</dt>
<dd>If, and only if, <code>$.mobile.ignoreContentEnabled</code> is set to true, this method will traverse the parent nodes for each DOM element in the jQuery object and where it finds a <code>data-ajax=false</code> parent the child form or link will be removed from the set.</dd>
<dt><code>·</code> Warning:</dt>
<dd>The operation of traversing all parent elements can be expensive for even small jQuery object sets.</dd>
</dl>
</dd>
<dt><code>$.mobile.showPageLoadingMsg</code> (<em>method</em>)</dt>
<dd>Show the page loading message, which is configurable via $.mobile.loadingMessage.</dd>
<dd>
<dl>
<dt><code>·</code> Arguments</dt>
<dd><code>theme</code> (<em>string</em>, default: "a") The theme swatch for the message.</dd>
<dd><code>msgText</code> (<em>string</em>, default: "loading") The text of the message.</dd>
<dd><code>textonly</code> (<em>boolean</em>, default: false) If true, the "spinner" image will be hidden when the message is shown.</dd>
</dl>
</dd>
<dd>Examples:
<pre>
<code>
<strong>//cue the page loader</strong>
$.mobile.showPageLoadingMsg();
<strong>//use theme swatch "b", a custom message, and no spinner</strong>
$.mobile.showPageLoadingMsg("b", "This is only a test", true);
</code>
</pre>
</dd>
<dt><code>$.mobile.hidePageLoadingMsg</code> (<em>method</em>)</dt>
<dd>Hide the page loading message, which is configurable via $.mobile.loadingMessage.</dd>
<dd>Example:
<pre>
<code>
<strong>//hide the page loader</strong>
$.mobile.hidePageLoadingMsg();
</code>
</pre>
</dd>
<dt><code>$.mobile.fixedToolbars.show</code> (<em>method</em>)</dt>
<dd>Utility method for displaying the fixed header and/or footer of the current active page within the viewport. Note that fixed headers/footers are never really hidden. Toggling the show/hide state of a toolbar is really toggling whether or not they are inline within the page content, or displayed within the viewport as if they were fixed.</dd>
<dd>
<dl>
<dt><code>·</code> Arguments</dt>
<dd><code>immediately</code> (<em>boolean</em>, optional) If true, any fixed header or footer for the current active page is displayed immediately within the viewport. If false or unspecified, the fixed header/footer will fade-in after a 100 millisecond delay. Note that other events such as a document resize or scroll event can result in an additional delay before the start of the header/footer display animation.</dd>
</dl>
</dd>
<dd>Example:
<pre>
<code>
<strong>// Show fixed header/footer with a fade animation.</strong>
$.mobile.fixedToolbars.show();
<strong>// Show fixed header/footer immediately.</strong>
$.mobile.fixedToolbars.show(true);
</code>
</pre>
</dd>
<dt><code>$.mobile.fixedToolbars.hide</code> (<em>method</em>)</dt>
<dd>Utility method for hiding the fixed header and/or footer of the current active page.</dd>
<dd>
<dl>
<dt><code>·</code> Arguments</dt>
<dd><code>immediately</code> (<em>boolean</em>, optional) If true, any fixed header or footer for the current active page is immediately placed inline (back in flow) with the page content, which means it will scroll along with the content and will only be visible when viewing the top or bottom of the page within the viewport. If false or unspecified, the fixed header/footer will fade-out after a 100 millisecond delay. Note that other events such as a document resize or scroll event can result in the header/footer being immediately hidden.</dd>
</dl>
</dd>
<dd>Example:
<pre>
<code>
<strong>// Hide fixed header/footer with a fade animation.</strong>
$.mobile.fixedToolbars.hide();
<strong>// Hide fixed header/footer immediately.</strong>
$.mobile.fixedToolbars.hide(true);
</code>
</pre>
</dd>
<dt><code>$.mobile.path.parseUrl</code> (<em>method</em>)</dt>
<dd>Utility method for parsing a URL and its relative variants into an object that makes accessing the components of the URL easy. When parsing relative variants, the resulting object will contain empty string values for missing components (like protocol, host, etc). Also, when parsing URLs that have no authority, such as tel: urls, the pathname property of the object will contain the data after the protocol/scheme colon.</dd>
<dd>
<dl>
<dt><code>·</code> Arguments</dt>
<dd><code>url</code> (<em>string</em>, required) A relative or absolute URL.</dd>
<dt><code>·</code> Return Value</dt>
<dd>
<p>This function returns an object that contains the various components of the URL as strings. The properties on the object mimic the browser's location object:</p>
<dl>
<dt><code>hash</code></dt>
<dd>The fragment component of the URL, including the leading '#' character.</dd>
<dt><code>host</code></dt>
<dd>The host and port number of the URL.</dd>
<dt><code>hostname</code></dt>
<dd>The name of the host within the URL.</dd>
<dt><code>href</code></dt>
<dd>The original URL that was parsed.</dd>
<dt><code>pathname</code></dt>
<dd>The path of the file or directory referenced by the URL.</dd>
<dt><code>port</code></dt>
<dd>The port specified within the URL. Most URLs rely on the default port for the protocol used, so this may be an empty string most of the time.</dd>
<dt><code>protocol</code></dt>
<dd>The protocol for the URL including the trailing ':' character.</dd>
<dt><code>search</code></dt>
<dd>The query component of the URL including the leading '?' character.</dd>
</dl>
<p>But it also contains additional properties that provide access to additional components as well as some common forms of the URL developers access:</p>
<dl>
<dt><code>authority</code></dt>
<dd>The username, password, and host components of the URL</dd>
<dt><code>directory</code></dt>
<dd>The directory component of the pathname, minus any filename.</dd>
<dt><code>domain</code></dt>
<dd>The protocol and authority components of the URL.</dd>
<dt><code>filename</code></dt>
<dd>The filename within the pathname component, minus the directory.</dd>
<dt><code>hrefNoHash</code></dt>
<dd>The original URL minus the fragment (hash) components.</dd>
<dt><code>hrefNoSearch</code></dt>
<dd>The original URL minus the query (search) and fragment (hash) components.</dd>
<dt><code>password</code></dt>
<dd>The password contained within the authority component.</dd>
<dt><code>username</code></dt>
<dd>The username contained within the authority component.</dd>
</dl>
</dd>
</dl>
</dd>
<dd>Examples:
<pre>
<code>
<strong>// Parsing the Url below results an object that is returned with the
// following properties:
//
// obj.href: http://jblas:password@mycompany.com:8080/mail/inbox?msg=1234&type=unread#msg-content
// obj.hrefNoHash: http://jblas:password@mycompany.com:8080/mail/inbox?msg=1234&type=unread
// obj.hrefNoSearch: http://jblas:password@mycompany.com:8080/mail/inbox
// obj.domain: http://jblas:password@mycompany.com:8080
// obj.protocol: http:
// obj.authority: jblas:password@mycompany.com:8080
// obj.username: jblas
// obj.password: password
// obj.host: mycompany.com:8080
// obj.hostname: mycompany.com
// obj.port: 8080
// obj.pathname: /mail/inbox
// obj.directory: /mail/
// obj.filename: inbox
// obj.search: ?msg=1234&type=unread
// obj.hash: #msg-content</strong>
var obj = $.mobile.path.parseUrl("http://jblas:password@mycompany.com:8080/mail/inbox?msg=1234");
</code>
</pre>
</dd>
<dt><code>$.mobile.path.makePathAbsolute</code> (<em>method</em>)</dt>
<dd>Utility method for converting a relative file or directory path into an absolute path.</dd>
<dd>
<dl>
<dt><code>·</code> Arguments</dt>
<dd><code>relPath</code> (<em>string</em>, required) A relative file or directory path.</dd>
<dd><code>absPath</code> (<em>string</em>, required) An absolute file or relative path to resolve against.</dd>
<dt><code>·</code> Return Value</dt>
<dd>This function returns a string that is an absolute version of the relative path passed in.</dd>
</dl>
</dd>
<dd>Examples:
<pre>
<code>
<strong>// Returns: /a/b/c/file.html</strong>
var absPath = $.mobile.path.makePathAbsolute("file.html", "/a/b/c/bar.html");
<strong>// Returns: /a/foo/file.html</strong>
var absPath = $.mobile.path.makePathAbsolute("../../foo/file.html", "/a/b/c/bar.html");
</code>
</pre>
</dd>
<dt><code>$.mobile.path.makeUrlAbsolute</code> (<em>method</em>)</dt>
<dd>Utility method for converting a relative URL to an absolute URL.</dd>
<dd>
<dl>
<dt>Arguments</dt>
<dd><code>relUrl</code> (<em>string</em>, required) A relative URL.</dd>
<dd><code>absUrl</code> (<em>string</em>, required) An absolute URL to resolve against.</dd>
<dt>Return Value</dt>
<dd>This function returns a string that is an absolute version of the relative URL passed in.</dd>
</dl>
</dd>
<dd>Examples:
<pre>
<code>
<strong>// Returns: http://foo.com/a/b/c/file.html</strong>
var absUrl = $.mobile.path.makeUrlAbsolute("file.html", "http://foo.com/a/b/c/test.html");
<strong>// Returns: http://foo.com/a/foo/file.html</strong>
var absUrl = $.mobile.path.makeUrlAbsolute("../../foo/file.html", "http://foo.com/a/b/c/test.html");
<strong>// Returns: http://foo.com/bar/file.html</strong>
var absUrl = $.mobile.path.makeUrlAbsolute("//foo.com/bar/file.html", "http://foo.com/a/b/c/test.html");
<strong>// Returns: http://foo.com/a/b/c/test.html?a=1&b=2</strong>
var absUrl = $.mobile.path.makeUrlAbsolute("?a=1&b=2", "http://foo.com/a/b/c/test.html");
<strong>// Returns: http://foo.com/a/b/c/test.html#bar</strong>
var absUrl = $.mobile.path.makeUrlAbsolute("#bar", "http://foo.com/a/b/c/test.html");
</code>
</pre>
</dd>
<dt><code>$.mobile.path.isSameDomain</code> (<em>method</em>)</dt>
<dd>Utility method for comparing the domain of 2 URLs.</dd>
<dd>
<dl>
<dt><code>·</code> Arguments</dt>
<dd><code>url1</code> (<em>string</em>, required) A relative URL.</dd>
<dd><code>url2</code> (<em>string</em>, required) An absolute URL to resolve against.</dd>
<dt>Return Value</dt>
<dd>This function returns a boolean true if the domains match, false if they don't.</dd>
</dl>
</dd>
<dd>Examples:
<pre>
<code>
<strong>// Returns: true</strong>
var same = $.mobile.path.isSameDomain("http://foo.com/a/file.html", "http://foo.com/a/b/c/test.html");
<strong>// Returns: false</strong>
var same = $.mobile.path.isSameDomain("file://foo.com/a/file.html", "http://foo.com/a/b/c/test.html");
<strong>// Returns: false</strong>
var same = $.mobile.path.isSameDomain("https://foo.com/a/file.html", "http://foo.com/a/b/c/test.html");
<strong>// Returns: false</strong>
var same = $.mobile.path.isSameDomain("http://foo.com/a/file.html", "http://bar.com/a/b/c/test.html");
</code>
</pre>
</dd>
<dt><code>$.mobile.path.isRelativeUrl</code> (<em>method</em>)</dt>
<dd>Utility method for determining if a URL is a relative variant.</dd>
<dd>
<dl>
<dt><code>·</code> Arguments</dt>
<dd><code>url</code> (<em>string</em>, required) A relative or absolute URL.</dd>
<dt><code>·</code> Return Value</dt>
<dd>This function returns a boolean true if the URL is relative, false if it is absolute.</dd>
</dl>
</dd>
<dd>Examples:
<pre>
<code>
<strong>// Returns: false</strong>
var isRel = $.mobile.path.isRelativeUrl("http://foo.com/a/file.html");
<strong>// Returns: true</strong>
var isRel = $.mobile.path.isRelativeUrl("//foo.com/a/file.html");
<strong>// Returns: true</strong>
var isRel = $.mobile.path.isRelativeUrl("/a/file.html");
<strong>// Returns: true</strong>
var isRel = $.mobile.path.isRelativeUrl("file.html");
<strong>// Returns: true</strong>
var isRel = $.mobile.path.isRelativeUrl("?a=1&b=2");
<strong>// Returns: true</strong>
var isRel = $.mobile.path.isRelativeUrl("#foo");
</code>
</pre>
</dd>
<dt><code>$.mobile.path.isAbsoluteUrl</code> (<em>method</em>)</dt>
<dd>Utility method for determining if a URL is absolute.</dd>
<dd>
<dl>
<dt><code>·</code> Arguments</dt>
<dd><code>url</code> (<em>string</em>, required) A relative or absolute URL.</dd>
<dt><code>·</code> Return Value</dt>
<dd>This function returns a boolean true if the URL is absolute, false if not.</dd>
</dl>
</dd>
<dd>Examples:
<pre>
<code>
<strong>// Returns: true</strong>
var isAbs = $.mobile.path.isAbsoluteUrl("http://foo.com/a/file.html");
<strong>// Returns: false</strong>
var isAbs = $.mobile.path.isAbsoluteUrl("//foo.com/a/file.html");
<strong>// Returns: false</strong>
var isAbs = $.mobile.path.isAbsoluteUrl("/a/file.html");
<strong>// Returns: false</strong>
var isAbs = $.mobile.path.isAbsoluteUrl("file.html");
<strong>// Returns: false</strong>
var isAbs = $.mobile.path.isAbsoluteUrl("?a=1&b=2");
<strong>// Returns: false</strong>
var isAbs = $.mobile.path.isAbsoluteUrl("#foo");
</code>
</pre>
</dd>
<dt><code>$.mobile.path.get</code> (<em>method</em>)</dt>
<dd>Utility method for determining the directory portion of an URL. If the URL has no trailing slash, the last component of the URL is considered to be a file.</dd>
<dd>
<dl>
<dt><code>·</code> Arguments</dt>
<dd><code>url</code> (<em>string</em>, required) A relative or absolute URL.</dd>
<dt><code>·</code> Return Value</dt>
<dd>This function returns the directory portion of a given URL.</dd>
</dl>
</dd>
<dd>Examples:
<pre>
<code>
<strong>// Returns: http://foo.com/a/</strong>
var dirName = $.mobile.path.get("http://foo.com/a/file.html");
<strong>// Returns: http://foo.com/a/</strong>
var dirName = $.mobile.path.get("http://foo.com/a/");
<strong>// Returns: http://foo.com/a</strong>
var dirName = $.mobile.path.get("http://foo.com/a");
<strong>// Returns: //foo.com/a/</strong>
var dirName = $.mobile.path.get("//foo.com/a/file.html");
<strong>// Returns: /a/</strong>
var dirName = $.mobile.path.get("/a/file.html");
<strong>// Returns: ""</strong>
var dirName = $.mobile.path.get("file.html");
<strong>// Returns: /</strong>
var dirName = $.mobile.path.get("/file.html");
<strong>// Returns: ?a=1&b=2</strong>
var dirName = $.mobile.path.get("?a=1&b=2");
<strong>// Returns: foo</strong>
var dirName = $.mobile.path.isAbsoluteUrl("#foo");
</code>
</pre>
</dd>
<dt><code>$.mobile.base</code> (<em>methods, properties</em>)</dt>
<dd>Utilities for working with generated base element. TODO: document as public API is finalized.</dd>
<dt><code>$.mobile.silentScroll</code> (<em>method</em>)</dt>
<dd>Scroll to a particular Y position without triggering scroll event listeners.</dd>
<dd>
<dl>
<dt><code>·</code> Arguments:</dt>
<dd><code>yPos</code> (<em>number</em>, defaults to 0). Pass any number to scroll to that Y location.</dd>
</dl>
</dd>
<dd>Examples:
<pre>
<code>
<strong>//scroll to Y 100px</strong>
$.mobile.silentScroll(100);
</code>
</pre>
</dd>
<dt><code>$.mobile.activePage</code> (<em>property</em>)</dt>
<dd>Reference to the page currently in view.</dd>
</dl>
</div><!--/content-secondary -->
<div class="content-secondary">
<div data-role="collapsible" data-collapsed="true" data-theme="b" data-content-theme="d">
<h3>More in this section</h3>
<ul data-role="listview" data-theme="c" data-dividertheme="d">
<li data-role="list-divider">API</li>
<li><a href="../../docs/api/globalconfig.html">Configuring defaults</a></li>
<li><a href="../../docs/api/events.html">Events</a></li>
<li data-theme="a"><a href="../../docs/api/methods.html">Methods & Utilities</a></li>
<li><a href="../../docs/api/data-attributes.html">Data attribute reference</a></li>
<li><a href="../../docs/api/themes.html">Theme framework</a></li>
</ul>
</div>
</div>
</div><!-- /content -->
<div data-role="footer" class="footer-docs" data-theme="c">
<p>© 2012 jQuery Foundation and other contributors</p>
</div>
</div><!-- /page -->
</body>
</html>