1 /* ***************************************************************************
2 * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20 * DEALINGS IN THE SOFTWARE.
21 * ***************************************************************************
23 * Author: Jinhyuk Jun <jinhyuk.jun@samsung.com>
26 (function ( $, undefined ) {
28 $.widget( "mobile.pagelayout", $.mobile.widget, {
30 visibleOnPageShow: true,
31 disablePageZoom: true,
32 transition: "slide", //can be none, fade, slide (slide maps to slideup or slidedown)
35 tapToggleBlacklist: "a, input, select, textarea, .ui-header-fixed, .ui-footer-fixed",
36 hideDuringFocus: "input, textarea, select",
37 updatePagePadding: true,
38 trackPersistentToolbars: true,
39 // Browser detection! Weeee, here we go...
40 // Unfortunately, position:fixed is costly, not to mention probably impossible, to feature-detect accurately.
41 // Some tests exist, but they currently return false results in critical devices and browsers, which could lead to a broken experience.
42 // Testing fixed positioning is also pretty obtrusive to page load, requiring injected elements and scrolling the window
43 // The following function serves to rule out some popular browsers with known fixed-positioning issues
44 // This is a plugin option like any other, so feel free to improve or overwrite it
45 supportBlacklist: function () {
47 ua = navigator.userAgent,
48 platform = navigator.platform,
49 // Rendering engine is Webkit, and capture major version
50 wkmatch = ua.match( /AppleWebKit\/([0-9]+)/ ),
51 wkversion = !!wkmatch && wkmatch[ 1 ],
52 ffmatch = ua.match( /Fennec\/([0-9]+)/ ),
53 ffversion = !!ffmatch && ffmatch[ 1 ],
54 operammobilematch = ua.match( /Opera Mobi\/([0-9]+)/ ),
55 omversion = !!operammobilematch && operammobilematch[ 1 ];
58 // iOS 4.3 and older : Platform is iPhone/Pad/Touch and Webkit version is less than 534 (ios5)
59 ( ( platform.indexOf( "iPhone" ) > -1 || platform.indexOf( "iPad" ) > -1 || platform.indexOf( "iPod" ) > -1 ) && wkversion && wkversion < 534 )
62 ( w.operamini && ({}).toString.call( w.operamini ) === "[object OperaMini]" )
64 ( operammobilematch && omversion < 7458 )
66 //Android lte 2.1: Platform is Android and Webkit version is less than 533 (Android 2.2)
67 ( ua.indexOf( "Android" ) > -1 && wkversion && wkversion < 533 )
69 // Firefox Mobile before 6.0 -
70 ( ffversion && ffversion < 6 )
73 ( "palmGetResource" in window && wkversion && wkversion < 534 )
76 ( ua.indexOf( "MeeGo" ) > -1 && ua.indexOf( "NokiaBrowser/8.5.0" ) > -1 )
83 initSelector: ":jqmData(role='content')"
86 _create: function () {
92 // Feature detecting support for
93 if ( o.supportBlacklist() ) {
98 self._addFixedClass();
99 self._addTransitionClass();
100 self._bindPageEvents();
103 self._bindContentControlEvents();
106 /* add minimum fixed css style to bar(header/footer) and content
107 * it need to update when core source modified(jquery.mobile.page.section.js)
108 * modified from core source cuz initSelector different */
109 _addFixedClass: function () {
113 $elHeader = $el.siblings( ":jqmData(role='header')" ),
114 $elFooter = $el.siblings( ":jqmData(role='footer')" ),
115 $elPage = $el.closest(".ui-page");
117 $elHeader.addClass( "ui-header-fixed" );
118 $elFooter.addClass( "ui-footer-fixed" );
120 // "fullscreen" overlay positioning
121 if ( o.fullscreen ) {
122 $elHeader.addClass( "ui-header-fullscreen" );
123 $elFooter.addClass( "ui-footer-fullscreen" );
125 .addClass( "ui-page-header-fullscreen" )
126 .addClass( "ui-page-footer-fullscreen" );
128 // If not fullscreen, add class to page to set top or bottom padding
129 $elPage.addClass( "ui-page-header-fixed" )
130 .addClass( "ui-page-footer-fixed" );
134 /* original core source(jquery.mobile.fixedToolbar.js)
136 _addTransitionClass: function () {
137 var tclass = this.options.transition;
139 if ( tclass && tclass !== "none" ) {
140 // use appropriate slide for header or footer
141 if ( tclass === "slide" ) {
142 tclass = this.element.is( ".ui-header" ) ? "slidedown" : "slideup";
145 this.element.addClass( tclass );
150 /* Set default page positon
151 * 1. add title style to header
152 * 2. Set default header/footer position */
153 setHeaderFooter: function ( event ) {
154 var $elPage = $( event.target ),
155 $elHeader = $elPage.find( ":jqmData(role='header')" ).length ? $elPage.find( ":jqmData(role='header')") : $elPage.siblings( ":jqmData(role='header')"),
156 $elContent = $elPage.find( ".ui-content" ),
157 $elFooter = $( document ).find( ":jqmData(role='footer')" ),
158 $elFooterGroup = $elFooter.find( ":jqmData(role='fieldcontain')" );
160 // divide content mode scrollview and non-scrollview
161 if ( !$elPage.is( ".ui-dialog" ) ) {
162 if ( $elHeader.jqmData("position") == "fixed" || ( $.support.scrollview && $.tizen.frameworkData.theme.match(/tizen/) ) ) {
164 .css( "position", "fixed" )
165 .css( "top", "0px" );
166 } else if ( !$.support.scrollview && $elHeader.jqmData("position") != "fixed" ) {
167 $elHeader.css( "position", "relative" );
171 /* set Title style */
172 if ( $elHeader.find("span.ui-title-text-sub").length ) {
173 $elHeader.addClass( "ui-title-multiline");
176 if ( $elFooterGroup.find( "div" ).is( ".ui-controlgroup-label" ) ) {
177 $elFooterGroup.find( "div.ui-controlgroup-label" ).remove();
181 _bindPageEvents: function () {
187 //page event bindings
188 // Fixed toolbars require page zoom to be disabled, otherwise usability issues crop up
189 // This method is meant to disable zoom while a fixed-positioned toolbar page is visible
190 $el.closest( ".ui-page" )
191 .bind( "pagebeforeshow", function ( event ) {
192 if ( o.disablePageZoom ) {
193 $.mobile.zoom.disable( true );
195 if ( !o.visibleOnPageShow ) {
198 self.setHeaderFooter( event );
199 self._setContentMinHeight( event );
201 .bind( "webkitAnimationStart animationstart updatelayout", function ( e, data ) {
203 if ( o.updatePagePadding ) {
204 self.updatePagePadding(thisPage);
205 self.updatePageLayout(data);
209 .bind( "pageshow", function ( event ) {
211 self._setContentMinHeight( event );
212 self.updatePagePadding(thisPage);
213 self._updateHeaderArea();
214 if ( o.updatePagePadding ) {
215 $( window ).bind( "throttledresize." + self.widgetName, function () {
216 self.updatePagePadding(thisPage);
218 self.updatePageLayout();
219 self._updateHeaderArea();
220 self._setContentMinHeight( event );
225 .bind( "pagebeforehide", function ( e, ui ) {
226 if ( o.disablePageZoom ) {
227 $.mobile.zoom.enable( true );
229 if ( o.updatePagePadding ) {
230 $( window ).unbind( "throttledresize." + self.widgetName );
233 if ( o.trackPersistentToolbars ) {
234 var thisFooter = $( ".ui-footer-fixed:jqmData(id)", this ),
235 thisHeader = $( ".ui-header-fixed:jqmData(id)", this ),
236 nextFooter = thisFooter.length && ui.nextPage && $( ".ui-footer-fixed:jqmData(id='" + thisFooter.jqmData( "id" ) + "')", ui.nextPage ),
237 nextHeader = thisHeader.length && ui.nextPage && $( ".ui-header-fixed:jqmData(id='" + thisHeader.jqmData( "id" ) + "')", ui.nextPage );
239 nextFooter = nextFooter || $();
241 if ( nextFooter.length || nextHeader.length ) {
243 nextFooter.add( nextHeader ).appendTo( $.mobile.pageContainer );
245 ui.nextPage.one( "pageshow", function () {
246 nextFooter.add( nextHeader ).appendTo( this );
252 window.addEventListener( "softkeyboardchange", function( e ) {
255 if ( e.state == "on" ) {
256 $elCurrentFooter = $( ".ui-page-active .ui-footer" );
257 $elCurrentFooter.hide();
258 } else if (e.state == "off") {
259 $elCurrentFooter.show();
261 self.updatePagePadding( thisPage, e.state );
265 _bindContentControlEvents: function () {
270 $el.closest( ".ui-page" )
271 .bind( "pagebeforeshow", function ( event ) {
276 _setContentMinHeight : function ( event ) {
277 var $elPage = $( event.target ),
278 $elHeader = $elPage.find( ":jqmData(role='header')" ),
279 $elFooter = $elPage.find( ":jqmData(role='footer')" ),
280 $elContent = $elPage.find( ":jqmData(role='content')" ),
283 resultMinHeight = window.innerHeight - $elHeader.height() - $elFooter.height();
285 $elContent.css( "min-height", resultMinHeight - parseFloat( $elContent.css("padding-top") ) - parseFloat( $elContent.css("padding-bottom") ) + "px" );
288 _updateHeaderArea : function () {
289 var $elPage = $( ".ui-page-active" ),
290 $elHeader = $elPage.find( ":jqmData(role='header')" ).length ? $elPage.find( ":jqmData(role='header')") : $elPage.siblings( ":jqmData(role='header')"),
291 headerBtnNum = $elHeader.children("a").length,
292 headerSrcNum = $elHeader.children("img").length;
294 if ( !$elPage.is( ".ui-dialog" ) ) {
295 $elHeader.find( "h1" ).css( "width", window.innerWidth - $elHeader.children( "a" ).width() * headerBtnNum - $elHeader.children( "a" ).width() / 4 - $elHeader.children( "img" ).width() * headerSrcNum * 4 );
297 /* add half width for default space between text and button, and img tag area is too narrow, so multiply three for img width*/
302 // This will set the content element's top or bottom padding equal to the toolbar's height
303 updatePagePadding: function ( tbPage, imestatus ) {
304 var $el = this.element,
305 header = $el.siblings( ".ui-header" ).length,
306 footer = $el.siblings( ".ui-footer" ).length;
308 // This behavior only applies to "fixed", not "fullscreen"
309 if ( this.options.fullscreen && imestatus ) { return; }
311 tbPage = tbPage || $el.closest( ".ui-page" );
312 if ( imestatus == "on" ) {
313 $el.height( window.innerHeight - $el.siblings( ".ui-header" ).height() -
314 parseFloat( $el.css("padding-top") ) -
315 parseFloat( $el.css("padding-bottom") ) );
317 if ( $el.siblings( ".ui-header" ).jqmData("position") == "fixed" || $.support.scrollview ) {
318 $( tbPage ).css( "padding-top", ( header ? $el.siblings( ".ui-header" ).outerHeight() : 0 ) );
320 $( tbPage ).css( "padding-bottom", ( footer ? $el.siblings( ".ui-footer" ).outerHeight() : 0 ) );
324 /* 1. Calculate and update content height */
325 updatePageLayout: function ( receiveType ) {
327 $elPage = $( document ).find( ".ui-page-active" ),
328 $elHeader = $elPage.find( ":jqmData(role='header')" ),
329 $elContent = $elPage.find( ":jqmData(role='content')" ),
330 resultContentHeight = 0,
331 resultFooterHeight = 0,
332 resultHeaderHeight = 0;
334 if ( $elPage.length ) {
335 $elFooter = $( document ).find( ".ui-page-active" ).find( ":jqmData(role='footer')" );
337 $elFooter = $( document ).find( ":jqmData(role='footer')" ).eq( 0 );
340 // calculate footer height
341 resultFooterHeight = ( $elFooter.css( "display" ) == "none" ) ? 0 : $elFooter.height();
342 resultHeaderHeight = ( $elHeader.css( "display" ) == "none" ) ? 0 : $elHeader.height();
344 if (resultFooterHeight != 0 ) {
345 $elFooter.css( "bottom", 0 );
348 resultContentHeight = window.innerHeight - resultFooterHeight - resultHeaderHeight;
350 if ( $.support.scrollview ) {
351 $elContent.height( resultContentHeight -
352 parseFloat( $elContent.css("padding-top") ) -
353 parseFloat( $elContent.css("padding-bottom") ) );
356 // External call page( "refresh") - in case title changed
359 .css( "min-height", resultContentHeight )
360 .css( "padding-top", resultHeaderHeight )
361 .css( "padding-bottom", resultFooterHeight );
365 _useTransition: function ( notransition ) {
366 var $win = $( window ),
368 scroll = $win.scrollTop(),
369 elHeight = $el.height(),
370 pHeight = $el.closest( ".ui-page" ).height(),
371 viewportHeight = $.mobile.getScreenHeight(),
372 tbtype = $el.is( ":jqmData(role='header')" ) ? "header" : "footer";
374 return !notransition &&
375 ( this.options.transition && this.options.transition !== "none" &&
377 ( tbtype === "header" && !this.options.fullscreen && scroll > elHeight ) ||
378 ( tbtype === "footer" && !this.options.fullscreen && scroll + viewportHeight < pHeight - elHeight )
379 ) || this.options.fullscreen
383 show: function ( notransition ) {
384 /* var hideClass = "ui-fixed-hidden",
387 if ( this._useTransition( notransition ) ){
389 .removeClass( "out " + hideClass )
393 $el.removeClass( hideClass );
395 this._visible = true;*/
398 hide: function ( notransition ) {
399 /* var hideClass = "ui-fixed-hidden",
401 // if it's a slide transition, our new transitions need the reverse class as well to slide outward
402 outclass = "out" + ( this.options.transition === "slide" ? " reverse" : "" );
404 if ( this._useTransition( notransition ) ){
406 .addClass( outclass )
408 .animationComplete( function () {
409 $el.addClass( hideClass ).removeClass( outclass );
413 $el.addClass( hideClass ).removeClass( outclass );
415 this._visible = false;*/
418 toggle: function () {
419 this[ this._visible ? "hide" : "show" ]();
422 destroy: function () {
423 this.element.removeClass( "ui-header-fixed ui-footer-fixed ui-header-fullscreen ui-footer-fullscreen in out fade slidedown slideup ui-fixed-hidden" );
424 this.element.closest( ".ui-page" ).removeClass( "ui-page-header-fixed ui-page-footer-fixed ui-page-header-fullscreen ui-page-footer-fullscreen" );
428 //auto self-init widgets
430 .bind( "pagecreate create", function ( e ) {
431 // DEPRECATED in 1.1: support for data-fullscreen=true|false on the page element.
432 // This line ensures it still works, but we recommend moving the attribute to the toolbars themselves.
433 if ( $( e.target ).jqmData( "fullscreen" ) ) {
434 $( $.mobile.pagelayout.prototype.options.initSelector, e.target ).not( ":jqmData(fullscreen)" ).jqmData( "fullscreen", true );
436 $.mobile.pagelayout.prototype.enhanceWithin( e.target );