diff options
Diffstat (limited to 'lib/dojo/back.js')
| -rw-r--r-- | lib/dojo/back.js | 395 |
1 files changed, 2 insertions, 393 deletions
diff --git a/lib/dojo/back.js b/lib/dojo/back.js index 0bb4817b4..c012e7db1 100644 --- a/lib/dojo/back.js +++ b/lib/dojo/back.js @@ -4,396 +4,5 @@ see: http://dojotoolkit.org/license for details */ - -if(!dojo._hasResource["dojo.back"]){ //_hasResource checks added by build. Do not use _hasResource directly in your code. -dojo._hasResource["dojo.back"] = true; -dojo.provide("dojo.back"); - -dojo.getObject("back", true, dojo); - -/*===== -dojo.back = { - // summary: Browser history management resources -} -=====*/ - - -(function(){ - var back = dojo.back, - - // everyone deals with encoding the hash slightly differently - - getHash= back.getHash= function(){ - var h = window.location.hash; - if(h.charAt(0) == "#"){ h = h.substring(1); } - return dojo.isMozilla ? h : decodeURIComponent(h); - }, - - setHash= back.setHash= function(h){ - if(!h){ h = ""; } - window.location.hash = encodeURIComponent(h); - historyCounter = history.length; - }; - - var initialHref = (typeof(window) !== "undefined") ? window.location.href : ""; - var initialHash = (typeof(window) !== "undefined") ? getHash() : ""; - var initialState = null; - - var locationTimer = null; - var bookmarkAnchor = null; - var historyIframe = null; - var forwardStack = []; - var historyStack = []; - var moveForward = false; - var changingUrl = false; - var historyCounter; - - function handleBackButton(){ - //summary: private method. Do not call this directly. - - //The "current" page is always at the top of the history stack. - var current = historyStack.pop(); - if(!current){ return; } - var last = historyStack[historyStack.length-1]; - if(!last && historyStack.length == 0){ - last = initialState; - } - if(last){ - if(last.kwArgs["back"]){ - last.kwArgs["back"](); - }else if(last.kwArgs["backButton"]){ - last.kwArgs["backButton"](); - }else if(last.kwArgs["handle"]){ - last.kwArgs.handle("back"); - } - } - forwardStack.push(current); - } - - back.goBack = handleBackButton; - - function handleForwardButton(){ - //summary: private method. Do not call this directly. - var last = forwardStack.pop(); - if(!last){ return; } - if(last.kwArgs["forward"]){ - last.kwArgs.forward(); - }else if(last.kwArgs["forwardButton"]){ - last.kwArgs.forwardButton(); - }else if(last.kwArgs["handle"]){ - last.kwArgs.handle("forward"); - } - historyStack.push(last); - } - - back.goForward = handleForwardButton; - - function createState(url, args, hash){ - //summary: private method. Do not call this directly. - return {"url": url, "kwArgs": args, "urlHash": hash}; //Object - } - - function getUrlQuery(url){ - //summary: private method. Do not call this directly. - var segments = url.split("?"); - if(segments.length < 2){ - return null; //null - } - else{ - return segments[1]; //String - } - } - - function loadIframeHistory(){ - //summary: private method. Do not call this directly. - var url = (dojo.config["dojoIframeHistoryUrl"] || dojo.moduleUrl("dojo", "resources/iframe_history.html")) + "?" + (new Date()).getTime(); - moveForward = true; - if(historyIframe){ - dojo.isWebKit ? historyIframe.location = url : window.frames[historyIframe.name].location = url; - }else{ - //console.warn("dojo.back: Not initialised. You need to call dojo.back.init() from a <script> block that lives inside the <body> tag."); - } - return url; //String - } - - function checkLocation(){ - if(!changingUrl){ - var hsl = historyStack.length; - - var hash = getHash(); - - if((hash === initialHash||window.location.href == initialHref)&&(hsl == 1)){ - // FIXME: could this ever be a forward button? - // we can't clear it because we still need to check for forwards. Ugg. - // clearInterval(this.locationTimer); - handleBackButton(); - return; - } - - // first check to see if we could have gone forward. We always halt on - // a no-hash item. - if(forwardStack.length > 0){ - if(forwardStack[forwardStack.length-1].urlHash === hash){ - handleForwardButton(); - return; - } - } - - // ok, that didn't work, try someplace back in the history stack - if((hsl >= 2)&&(historyStack[hsl-2])){ - if(historyStack[hsl-2].urlHash === hash){ - handleBackButton(); - return; - } - } - } - }; - - back.init = function(){ - //summary: Initializes the undo stack. This must be called from a <script> - // block that lives inside the <body> tag to prevent bugs on IE. - // description: - // Only call this method before the page's DOM is finished loading. Otherwise - // it will not work. Be careful with xdomain loading or djConfig.debugAtAllCosts scenarios, - // in order for this method to work, dojo.back will need to be part of a build layer. - if(dojo.byId("dj_history")){ return; } // prevent reinit - var src = dojo.config["dojoIframeHistoryUrl"] || dojo.moduleUrl("dojo", "resources/iframe_history.html"); - if (dojo._postLoad) { - console.error("dojo.back.init() must be called before the DOM has loaded. " - + "If using xdomain loading or djConfig.debugAtAllCosts, include dojo.back " - + "in a build layer."); - } else { - document.write('<iframe style="border:0;width:1px;height:1px;position:absolute;visibility:hidden;bottom:0;right:0;" name="dj_history" id="dj_history" src="' + src + '"></iframe>'); - } - }; - - back.setInitialState = function(/*Object*/args){ - //summary: - // Sets the state object and back callback for the very first page - // that is loaded. - //description: - // It is recommended that you call this method as part of an event - // listener that is registered via dojo.addOnLoad(). - //args: Object - // See the addToHistory() function for the list of valid args properties. - initialState = createState(initialHref, args, initialHash); - }; - - //FIXME: Make these doc comments not be awful. At least they're not wrong. - //FIXME: Would like to support arbitrary back/forward jumps. Have to rework iframeLoaded among other things. - //FIXME: is there a slight race condition in moz using change URL with the timer check and when - // the hash gets set? I think I have seen a back/forward call in quick succession, but not consistent. - - - /*===== - dojo.__backArgs = function(kwArgs){ - // back: Function? - // A function to be called when this state is reached via the user - // clicking the back button. - // forward: Function? - // Upon return to this state from the "back, forward" combination - // of navigation steps, this function will be called. Somewhat - // analgous to the semantic of an "onRedo" event handler. - // changeUrl: Boolean?|String? - // Boolean indicating whether or not to create a unique hash for - // this state. If a string is passed instead, it is used as the - // hash. - } - =====*/ - - back.addToHistory = function(/*dojo.__backArgs*/ args){ - // summary: - // adds a state object (args) to the history list. - // description: - // To support getting back button notifications, the object - // argument should implement a function called either "back", - // "backButton", or "handle". The string "back" will be passed as - // the first and only argument to this callback. - // - // To support getting forward button notifications, the object - // argument should implement a function called either "forward", - // "forwardButton", or "handle". The string "forward" will be - // passed as the first and only argument to this callback. - // - // If you want the browser location string to change, define "changeUrl" on the object. If the - // value of "changeUrl" is true, then a unique number will be appended to the URL as a fragment - // identifier (http://some.domain.com/path#uniquenumber). If it is any other value that does - // not evaluate to false, that value will be used as the fragment identifier. For example, - // if changeUrl: 'page1', then the URL will look like: http://some.domain.com/path#page1 - // - // There are problems with using dojo.back with semantically-named fragment identifiers - // ("hash values" on an URL). In most browsers it will be hard for dojo.back to know - // distinguish a back from a forward event in those cases. For back/forward support to - // work best, the fragment ID should always be a unique value (something using new Date().getTime() - // for example). If you want to detect hash changes using semantic fragment IDs, then - // consider using dojo.hash instead (in Dojo 1.4+). - // - // example: - // | dojo.back.addToHistory({ - // | back: function(){ console.log('back pressed'); }, - // | forward: function(){ console.log('forward pressed'); }, - // | changeUrl: true - // | }); - - // BROWSER NOTES: - // Safari 1.2: - // back button "works" fine, however it's not possible to actually - // DETECT that you've moved backwards by inspecting window.location. - // Unless there is some other means of locating. - // FIXME: perhaps we can poll on history.length? - // Safari 2.0.3+ (and probably 1.3.2+): - // works fine, except when changeUrl is used. When changeUrl is used, - // Safari jumps all the way back to whatever page was shown before - // the page that uses dojo.undo.browser support. - // IE 5.5 SP2: - // back button behavior is macro. It does not move back to the - // previous hash value, but to the last full page load. This suggests - // that the iframe is the correct way to capture the back button in - // these cases. - // Don't test this page using local disk for MSIE. MSIE will not create - // a history list for iframe_history.html if served from a file: URL. - // The XML served back from the XHR tests will also not be properly - // created if served from local disk. Serve the test pages from a web - // server to test in that browser. - // IE 6.0: - // same behavior as IE 5.5 SP2 - // Firefox 1.0+: - // the back button will return us to the previous hash on the same - // page, thereby not requiring an iframe hack, although we do then - // need to run a timer to detect inter-page movement. - - //If addToHistory is called, then that means we prune the - //forward stack -- the user went back, then wanted to - //start a new forward path. - forwardStack = []; - - var hash = null; - var url = null; - if(!historyIframe){ - if(dojo.config["useXDomain"] && !dojo.config["dojoIframeHistoryUrl"]){ - console.warn("dojo.back: When using cross-domain Dojo builds," - + " please save iframe_history.html to your domain and set djConfig.dojoIframeHistoryUrl" - + " to the path on your domain to iframe_history.html"); - } - historyIframe = window.frames["dj_history"]; - } - if(!bookmarkAnchor){ - bookmarkAnchor = dojo.create("a", {style: {display: "none"}}, dojo.body()); - } - if(args["changeUrl"]){ - hash = ""+ ((args["changeUrl"]!==true) ? args["changeUrl"] : (new Date()).getTime()); - - //If the current hash matches the new one, just replace the history object with - //this new one. It doesn't make sense to track different state objects for the same - //logical URL. This matches the browser behavior of only putting in one history - //item no matter how many times you click on the same #hash link, at least in Firefox - //and Safari, and there is no reliable way in those browsers to know if a #hash link - //has been clicked on multiple times. So making this the standard behavior in all browsers - //so that dojo.back's behavior is the same in all browsers. - if(historyStack.length == 0 && initialState.urlHash == hash){ - initialState = createState(url, args, hash); - return; - }else if(historyStack.length > 0 && historyStack[historyStack.length - 1].urlHash == hash){ - historyStack[historyStack.length - 1] = createState(url, args, hash); - return; - } - - changingUrl = true; - setTimeout(function() { - setHash(hash); - changingUrl = false; - }, 1); - bookmarkAnchor.href = hash; - - if(dojo.isIE){ - url = loadIframeHistory(); - - var oldCB = args["back"]||args["backButton"]||args["handle"]; - - //The function takes handleName as a parameter, in case the - //callback we are overriding was "handle". In that case, - //we will need to pass the handle name to handle. - var tcb = function(handleName){ - if(getHash() != ""){ - setTimeout(function() { setHash(hash); }, 1); - } - //Use apply to set "this" to args, and to try to avoid memory leaks. - oldCB.apply(this, [handleName]); - }; - - //Set interceptor function in the right place. - if(args["back"]){ - args.back = tcb; - }else if(args["backButton"]){ - args.backButton = tcb; - }else if(args["handle"]){ - args.handle = tcb; - } - - var oldFW = args["forward"]||args["forwardButton"]||args["handle"]; - - //The function takes handleName as a parameter, in case the - //callback we are overriding was "handle". In that case, - //we will need to pass the handle name to handle. - var tfw = function(handleName){ - if(getHash() != ""){ - setHash(hash); - } - if(oldFW){ // we might not actually have one - //Use apply to set "this" to args, and to try to avoid memory leaks. - oldFW.apply(this, [handleName]); - } - }; - - //Set interceptor function in the right place. - if(args["forward"]){ - args.forward = tfw; - }else if(args["forwardButton"]){ - args.forwardButton = tfw; - }else if(args["handle"]){ - args.handle = tfw; - } - - }else if(!dojo.isIE){ - // start the timer - if(!locationTimer){ - locationTimer = setInterval(checkLocation, 200); - } - - } - }else{ - url = loadIframeHistory(); - } - - historyStack.push(createState(url, args, hash)); - }; - - back._iframeLoaded = function(evt, ifrLoc){ - //summary: - // private method. Do not call this directly. - var query = getUrlQuery(ifrLoc.href); - if(query == null){ - // alert("iframeLoaded"); - // we hit the end of the history, so we should go back - if(historyStack.length == 1){ - handleBackButton(); - } - return; - } - if(moveForward){ - // we were expecting it, so it's not either a forward or backward movement - moveForward = false; - return; - } - - //Check the back stack first, since it is more likely. - //Note that only one step back or forward is supported. - if(historyStack.length >= 2 && query == getUrlQuery(historyStack[historyStack.length-2].url)){ - handleBackButton(); - }else if(forwardStack.length > 0 && query == getUrlQuery(forwardStack[forwardStack.length-1].url)){ - handleForwardButton(); - } - }; - })(); - -} +//>>built +define("dojo/back",["./_base/kernel","./_base/lang","./_base/sniff","./dom","./dom-construct","./_base/window","require"],function(_1,_2,_3,_4,_5,_6,_7){_2.getObject("back",true,_1);var _8=_1.back,_9=_8.getHash=function(){var h=window.location.hash;if(h.charAt(0)=="#"){h=h.substring(1);}return _3("mozilla")?h:decodeURIComponent(h);},_a=_8.setHash=function(h){if(!h){h="";}window.location.hash=encodeURIComponent(h);_b=history.length;};var _c=(typeof (window)!=="undefined")?window.location.href:"";var _d=(typeof (window)!=="undefined")?_9():"";var _e=null;var _f=null;var _10=null;var _11=null;var _12=[];var _13=[];var _14=false;var _15=false;var _b;function _16(){var _17=_13.pop();if(!_17){return;}var _18=_13[_13.length-1];if(!_18&&_13.length==0){_18=_e;}if(_18){if(_18.kwArgs["back"]){_18.kwArgs["back"]();}else{if(_18.kwArgs["backButton"]){_18.kwArgs["backButton"]();}else{if(_18.kwArgs["handle"]){_18.kwArgs.handle("back");}}}}_12.push(_17);};_8.goBack=_16;function _19(){var _1a=_12.pop();if(!_1a){return;}if(_1a.kwArgs["forward"]){_1a.kwArgs.forward();}else{if(_1a.kwArgs["forwardButton"]){_1a.kwArgs.forwardButton();}else{if(_1a.kwArgs["handle"]){_1a.kwArgs.handle("forward");}}}_13.push(_1a);};_8.goForward=_19;function _1b(url,_1c,_1d){return {"url":url,"kwArgs":_1c,"urlHash":_1d};};function _1e(url){var _1f=url.split("?");if(_1f.length<2){return null;}else{return _1f[1];}};function _20(){var url=(_1.config["dojoIframeHistoryUrl"]||_7.toUrl("./resources/iframe_history.html"))+"?"+(new Date()).getTime();_14=true;if(_11){_3("webkit")?_11.location=url:window.frames[_11.name].location=url;}else{}return url;};function _21(){if(!_15){var hsl=_13.length;var _22=_9();if((_22===_d||window.location.href==_c)&&(hsl==1)){_16();return;}if(_12.length>0){if(_12[_12.length-1].urlHash===_22){_19();return;}}if((hsl>=2)&&(_13[hsl-2])){if(_13[hsl-2].urlHash===_22){_16();}}}};_8.init=function(){if(_4.byId("dj_history")){return;}var src=_1.config["dojoIframeHistoryUrl"]||_7.toUrl("./resources/iframe_history.html");if(_1._postLoad){console.error("dojo.back.init() must be called before the DOM has loaded. "+"If using xdomain loading or djConfig.debugAtAllCosts, include dojo.back "+"in a build layer.");}else{document.write("<iframe style=\"border:0;width:1px;height:1px;position:absolute;visibility:hidden;bottom:0;right:0;\" name=\"dj_history\" id=\"dj_history\" src=\""+src+"\"></iframe>");}};_8.setInitialState=function(_23){_e=_1b(_c,_23,_d);};_8.addToHistory=function(_24){_12=[];var _25=null;var url=null;if(!_11){if(_1.config["useXDomain"]&&!_1.config["dojoIframeHistoryUrl"]){console.warn("dojo.back: When using cross-domain Dojo builds,"+" please save iframe_history.html to your domain and set djConfig.dojoIframeHistoryUrl"+" to the path on your domain to iframe_history.html");}_11=window.frames["dj_history"];}if(!_10){_10=_5.create("a",{style:{display:"none"}},_6.body());}if(_24["changeUrl"]){_25=""+((_24["changeUrl"]!==true)?_24["changeUrl"]:(new Date()).getTime());if(_13.length==0&&_e.urlHash==_25){_e=_1b(url,_24,_25);return;}else{if(_13.length>0&&_13[_13.length-1].urlHash==_25){_13[_13.length-1]=_1b(url,_24,_25);return;}}_15=true;setTimeout(function(){_a(_25);_15=false;},1);_10.href=_25;if(_3("ie")){url=_20();var _26=_24["back"]||_24["backButton"]||_24["handle"];var tcb=function(_27){if(_9()!=""){setTimeout(function(){_a(_25);},1);}_26.apply(this,[_27]);};if(_24["back"]){_24.back=tcb;}else{if(_24["backButton"]){_24.backButton=tcb;}else{if(_24["handle"]){_24.handle=tcb;}}}var _28=_24["forward"]||_24["forwardButton"]||_24["handle"];var tfw=function(_29){if(_9()!=""){_a(_25);}if(_28){_28.apply(this,[_29]);}};if(_24["forward"]){_24.forward=tfw;}else{if(_24["forwardButton"]){_24.forwardButton=tfw;}else{if(_24["handle"]){_24.handle=tfw;}}}}else{if(!_3("ie")){if(!_f){_f=setInterval(_21,200);}}}}else{url=_20();}_13.push(_1b(url,_24,_25));};_8._iframeLoaded=function(evt,_2a){var _2b=_1e(_2a.href);if(_2b==null){if(_13.length==1){_16();}return;}if(_14){_14=false;return;}if(_13.length>=2&&_2b==_1e(_13[_13.length-2].url)){_16();}else{if(_12.length>0&&_2b==_1e(_12[_12.length-1].url)){_19();}}};return _1.back;});
\ No newline at end of file |