mirror of
https://github.com/alchemy-fr/Phraseanet.git
synced 2025-10-13 21:13:26 +00:00
945 lines
99 KiB
HTML
945 lines
99 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
|
|
<head>
|
|
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
|
|
<title>API: history history.js (YUI Library)</title>
|
|
|
|
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
|
|
<link rel="stylesheet" type="text/css" href="assets/api.css" />
|
|
|
|
<script type="text/javascript" src="assets/api-js"></script>
|
|
<script type="text/javascript" src="assets/ac-js"></script>
|
|
</head>
|
|
|
|
<body id="yahoo-com">
|
|
|
|
<div id="doc3" class="yui-t2">
|
|
<div id="hd">
|
|
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1>
|
|
<h3>Browser History Manager <span class="subtitle">2.8.2r1</span></h3>
|
|
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
|
|
> <a href="./module_history.html" title="history">history</a>
|
|
|
|
> history.js (source view)
|
|
<form onsubmit="return false">
|
|
<div id="propertysearch">
|
|
Search: <input autocomplete="off" id="searchinput" />
|
|
<div id="searchresults">
|
|
|
|
</div>
|
|
</div>
|
|
</form>
|
|
</div>
|
|
|
|
<div id="bd">
|
|
<div id="yui-main">
|
|
<div class="yui-b">
|
|
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
|
|
<fieldset>
|
|
<legend>Filters</legend>
|
|
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
|
|
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
|
|
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
|
|
</fieldset>
|
|
</form>
|
|
|
|
<div id="srcout">
|
|
<style>
|
|
#doc3 .classopts { display:none; }
|
|
</style>
|
|
<div class="highlight"><pre><span class="cm">/**</span>
|
|
<span class="cm"> * The Browser History Manager provides the ability to use the back/forward</span>
|
|
<span class="cm"> * navigation buttons in a DHTML application. It also allows a DHTML</span>
|
|
<span class="cm"> * application to be bookmarked in a specific state.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * This library requires the following static markup:</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * &lt;iframe id="yui-history-iframe" src="path-to-real-asset-in-same-domain"&gt;&lt;/iframe&gt;</span>
|
|
<span class="cm"> * &lt;input id="yui-history-field" type="hidden"&gt;</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @module history</span>
|
|
<span class="cm"> * @requires yahoo,event</span>
|
|
<span class="cm"> * @namespace YAHOO.util</span>
|
|
<span class="cm"> * @title Browser History Manager</span>
|
|
<span class="cm"> */</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * The History class provides the ability to use the back/forward navigation</span>
|
|
<span class="cm"> * buttons in a DHTML application. It also allows a DHTML application to</span>
|
|
<span class="cm"> * be bookmarked in a specific state.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @class History</span>
|
|
<span class="cm"> * @constructor</span>
|
|
<span class="cm"> */</span>
|
|
<span class="nx">YAHOO</span><span class="p">.</span><span class="nx">util</span><span class="p">.</span><span class="nx">History</span> <span class="o">=</span> <span class="p">(</span><span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * Our hidden IFrame used to store the browsing history.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @property _histFrame</span>
|
|
<span class="cm"> * @type HTMLIFrameElement</span>
|
|
<span class="cm"> * @default null</span>
|
|
<span class="cm"> * @private</span>
|
|
<span class="cm"> */</span>
|
|
<span class="kd">var</span> <span class="nx">_histFrame</span> <span class="o">=</span> <span class="kc">null</span><span class="p">;</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * INPUT field (with type="hidden" or type="text") or TEXTAREA.</span>
|
|
<span class="cm"> * This field keeps the value of the initial state, current state</span>
|
|
<span class="cm"> * the list of all states across pages within a single browser session.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @property _stateField</span>
|
|
<span class="cm"> * @type HTMLInputElement|HTMLTextAreaElement</span>
|
|
<span class="cm"> * @default null</span>
|
|
<span class="cm"> * @private</span>
|
|
<span class="cm"> */</span>
|
|
<span class="kd">var</span> <span class="nx">_stateField</span> <span class="o">=</span> <span class="kc">null</span><span class="p">;</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * Flag used to tell whether YAHOO.util.History.initialize has been called.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @property _initialized</span>
|
|
<span class="cm"> * @type boolean</span>
|
|
<span class="cm"> * @default false</span>
|
|
<span class="cm"> * @private</span>
|
|
<span class="cm"> */</span>
|
|
<span class="kd">var</span> <span class="nx">_initialized</span> <span class="o">=</span> <span class="kc">false</span><span class="p">;</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * List of registered modules.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @property _modules</span>
|
|
<span class="cm"> * @type array</span>
|
|
<span class="cm"> * @default []</span>
|
|
<span class="cm"> * @private</span>
|
|
<span class="cm"> */</span>
|
|
<span class="kd">var</span> <span class="nx">_modules</span> <span class="o">=</span> <span class="p">[];</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * List of fully qualified states. This is used only by Safari.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @property _fqstates</span>
|
|
<span class="cm"> * @type array</span>
|
|
<span class="cm"> * @default []</span>
|
|
<span class="cm"> * @private</span>
|
|
<span class="cm"> */</span>
|
|
<span class="kd">var</span> <span class="nx">_fqstates</span> <span class="o">=</span> <span class="p">[];</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * location.hash is a bit buggy on Opera. I have seen instances where</span>
|
|
<span class="cm"> * navigating the history using the back/forward buttons, and hence</span>
|
|
<span class="cm"> * changing the URL, would not change location.hash. That's ok, the</span>
|
|
<span class="cm"> * implementation of an equivalent is trivial.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @method _getHash</span>
|
|
<span class="cm"> * @return {string} The hash portion of the document's location</span>
|
|
<span class="cm"> * @private</span>
|
|
<span class="cm"> */</span>
|
|
<span class="kd">function</span> <span class="nx">_getHash</span><span class="p">()</span> <span class="p">{</span>
|
|
<span class="kd">var</span> <span class="nx">i</span><span class="p">,</span> <span class="nx">href</span><span class="p">;</span>
|
|
<span class="nx">href</span> <span class="o">=</span> <span class="nx">top</span><span class="p">.</span><span class="nx">location</span><span class="p">.</span><span class="nx">href</span><span class="p">;</span>
|
|
<span class="nx">i</span> <span class="o">=</span> <span class="nx">href</span><span class="p">.</span><span class="nx">indexOf</span><span class="p">(</span><span class="s2">"#"</span><span class="p">);</span>
|
|
<span class="k">return</span> <span class="nx">i</span> <span class="o">>=</span> <span class="mi">0</span> <span class="o">?</span> <span class="nx">href</span><span class="p">.</span><span class="nx">substr</span><span class="p">(</span><span class="nx">i</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span> <span class="o">:</span> <span class="kc">null</span><span class="p">;</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * Stores all the registered modules' initial state and current state.</span>
|
|
<span class="cm"> * On Safari, we also store all the fully qualified states visited by</span>
|
|
<span class="cm"> * the application within a single browser session. The storage takes</span>
|
|
<span class="cm"> * place in the form field specified during initialization.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @method _storeStates</span>
|
|
<span class="cm"> * @private</span>
|
|
<span class="cm"> */</span>
|
|
<span class="kd">function</span> <span class="nx">_storeStates</span><span class="p">()</span> <span class="p">{</span>
|
|
|
|
<span class="kd">var</span> <span class="nx">moduleName</span><span class="p">,</span> <span class="nx">moduleObj</span><span class="p">,</span> <span class="nx">initialStates</span> <span class="o">=</span> <span class="p">[],</span> <span class="nx">currentStates</span> <span class="o">=</span> <span class="p">[];</span>
|
|
|
|
<span class="k">for</span> <span class="p">(</span><span class="nx">moduleName</span> <span class="k">in</span> <span class="nx">_modules</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">YAHOO</span><span class="p">.</span><span class="nx">lang</span><span class="p">.</span><span class="nx">hasOwnProperty</span><span class="p">(</span><span class="nx">_modules</span><span class="p">,</span> <span class="nx">moduleName</span><span class="p">))</span> <span class="p">{</span>
|
|
<span class="nx">moduleObj</span> <span class="o">=</span> <span class="nx">_modules</span><span class="p">[</span><span class="nx">moduleName</span><span class="p">];</span>
|
|
<span class="nx">initialStates</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="nx">moduleName</span> <span class="o">+</span> <span class="s2">"="</span> <span class="o">+</span> <span class="nx">moduleObj</span><span class="p">.</span><span class="nx">initialState</span><span class="p">);</span>
|
|
<span class="nx">currentStates</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="nx">moduleName</span> <span class="o">+</span> <span class="s2">"="</span> <span class="o">+</span> <span class="nx">moduleObj</span><span class="p">.</span><span class="nx">currentState</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="nx">_stateField</span><span class="p">.</span><span class="nx">value</span> <span class="o">=</span> <span class="nx">initialStates</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="s2">"&"</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"|"</span> <span class="o">+</span> <span class="nx">currentStates</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="s2">"&"</span><span class="p">);</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">YAHOO</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">ua</span><span class="p">.</span><span class="nx">webkit</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">_stateField</span><span class="p">.</span><span class="nx">value</span> <span class="o">+=</span> <span class="s2">"|"</span> <span class="o">+</span> <span class="nx">_fqstates</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="s2">","</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * Sets the new currentState attribute of all modules depending on the new</span>
|
|
<span class="cm"> * fully qualified state. Also notifies the modules which current state has</span>
|
|
<span class="cm"> * changed.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @method _handleFQStateChange</span>
|
|
<span class="cm"> * @param {string} fqstate Fully qualified state</span>
|
|
<span class="cm"> * @private</span>
|
|
<span class="cm"> */</span>
|
|
<span class="kd">function</span> <span class="nx">_handleFQStateChange</span><span class="p">(</span><span class="nx">fqstate</span><span class="p">)</span> <span class="p">{</span>
|
|
|
|
<span class="kd">var</span> <span class="nx">i</span><span class="p">,</span> <span class="nx">len</span><span class="p">,</span> <span class="nx">moduleName</span><span class="p">,</span> <span class="nx">moduleObj</span><span class="p">,</span> <span class="nx">modules</span><span class="p">,</span> <span class="nx">states</span><span class="p">,</span> <span class="nx">tokens</span><span class="p">,</span> <span class="nx">currentState</span><span class="p">;</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">fqstate</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="c1">// Notifies all modules</span>
|
|
<span class="k">for</span> <span class="p">(</span><span class="nx">moduleName</span> <span class="k">in</span> <span class="nx">_modules</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">YAHOO</span><span class="p">.</span><span class="nx">lang</span><span class="p">.</span><span class="nx">hasOwnProperty</span><span class="p">(</span><span class="nx">_modules</span><span class="p">,</span> <span class="nx">moduleName</span><span class="p">))</span> <span class="p">{</span>
|
|
<span class="nx">moduleObj</span> <span class="o">=</span> <span class="nx">_modules</span><span class="p">[</span><span class="nx">moduleName</span><span class="p">];</span>
|
|
<span class="nx">moduleObj</span><span class="p">.</span><span class="nx">currentState</span> <span class="o">=</span> <span class="nx">moduleObj</span><span class="p">.</span><span class="nx">initialState</span><span class="p">;</span>
|
|
<span class="nx">moduleObj</span><span class="p">.</span><span class="nx">onStateChange</span><span class="p">(</span><span class="nx">unescape</span><span class="p">(</span><span class="nx">moduleObj</span><span class="p">.</span><span class="nx">currentState</span><span class="p">));</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="k">return</span><span class="p">;</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="nx">modules</span> <span class="o">=</span> <span class="p">[];</span>
|
|
<span class="nx">states</span> <span class="o">=</span> <span class="nx">fqstate</span><span class="p">.</span><span class="nx">split</span><span class="p">(</span><span class="s2">"&"</span><span class="p">);</span>
|
|
<span class="k">for</span> <span class="p">(</span><span class="nx">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="nx">len</span> <span class="o">=</span> <span class="nx">states</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span> <span class="nx">i</span> <span class="o"><</span> <span class="nx">len</span><span class="p">;</span> <span class="nx">i</span><span class="o">++</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">tokens</span> <span class="o">=</span> <span class="nx">states</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">split</span><span class="p">(</span><span class="s2">"="</span><span class="p">);</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">tokens</span><span class="p">.</span><span class="nx">length</span> <span class="o">===</span> <span class="mi">2</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">moduleName</span> <span class="o">=</span> <span class="nx">tokens</span><span class="p">[</span><span class="mi">0</span><span class="p">];</span>
|
|
<span class="nx">currentState</span> <span class="o">=</span> <span class="nx">tokens</span><span class="p">[</span><span class="mi">1</span><span class="p">];</span>
|
|
<span class="nx">modules</span><span class="p">[</span><span class="nx">moduleName</span><span class="p">]</span> <span class="o">=</span> <span class="nx">currentState</span><span class="p">;</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">for</span> <span class="p">(</span><span class="nx">moduleName</span> <span class="k">in</span> <span class="nx">_modules</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">YAHOO</span><span class="p">.</span><span class="nx">lang</span><span class="p">.</span><span class="nx">hasOwnProperty</span><span class="p">(</span><span class="nx">_modules</span><span class="p">,</span> <span class="nx">moduleName</span><span class="p">))</span> <span class="p">{</span>
|
|
<span class="nx">moduleObj</span> <span class="o">=</span> <span class="nx">_modules</span><span class="p">[</span><span class="nx">moduleName</span><span class="p">];</span>
|
|
<span class="nx">currentState</span> <span class="o">=</span> <span class="nx">modules</span><span class="p">[</span><span class="nx">moduleName</span><span class="p">];</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">currentState</span> <span class="o">||</span> <span class="nx">moduleObj</span><span class="p">.</span><span class="nx">currentState</span> <span class="o">!==</span> <span class="nx">currentState</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">moduleObj</span><span class="p">.</span><span class="nx">currentState</span> <span class="o">=</span> <span class="nx">currentState</span> <span class="o">||</span> <span class="nx">moduleObj</span><span class="p">.</span><span class="nx">initialState</span><span class="p">;</span>
|
|
<span class="nx">moduleObj</span><span class="p">.</span><span class="nx">onStateChange</span><span class="p">(</span><span class="nx">unescape</span><span class="p">(</span><span class="nx">moduleObj</span><span class="p">.</span><span class="nx">currentState</span><span class="p">));</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * Update the IFrame with our new state.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @method _updateIFrame</span>
|
|
<span class="cm"> * @private</span>
|
|
<span class="cm"> * @return {boolean} true if successful. false otherwise.</span>
|
|
<span class="cm"> */</span>
|
|
<span class="kd">function</span> <span class="nx">_updateIFrame</span> <span class="p">(</span><span class="nx">fqstate</span><span class="p">)</span> <span class="p">{</span>
|
|
|
|
<span class="kd">var</span> <span class="nx">html</span><span class="p">,</span> <span class="nx">doc</span><span class="p">;</span>
|
|
|
|
<span class="nx">html</span> <span class="o">=</span> <span class="s1">'<html><body><div id="state">'</span> <span class="o">+</span>
|
|
<span class="nx">fqstate</span><span class="p">.</span><span class="nx">replace</span><span class="p">(</span><span class="sr">/&/g</span><span class="p">,</span><span class="s1">'&amp;'</span><span class="p">).</span>
|
|
<span class="nx">replace</span><span class="p">(</span><span class="sr">/</g</span><span class="p">,</span><span class="s1">'&lt;'</span><span class="p">).</span>
|
|
<span class="nx">replace</span><span class="p">(</span><span class="sr">/>/g</span><span class="p">,</span><span class="s1">'&gt;'</span><span class="p">).</span>
|
|
<span class="nx">replace</span><span class="p">(</span><span class="sr">/"/g</span><span class="p">,</span><span class="s1">'&quot;'</span><span class="p">)</span> <span class="o">+</span>
|
|
<span class="s1">'</div></body></html>'</span><span class="p">;</span>
|
|
|
|
<span class="k">try</span> <span class="p">{</span>
|
|
<span class="nx">doc</span> <span class="o">=</span> <span class="nx">_histFrame</span><span class="p">.</span><span class="nx">contentWindow</span><span class="p">.</span><span class="nb">document</span><span class="p">;</span>
|
|
<span class="nx">doc</span><span class="p">.</span><span class="nx">open</span><span class="p">();</span>
|
|
<span class="nx">doc</span><span class="p">.</span><span class="nx">write</span><span class="p">(</span><span class="nx">html</span><span class="p">);</span>
|
|
<span class="nx">doc</span><span class="p">.</span><span class="nx">close</span><span class="p">();</span>
|
|
<span class="k">return</span> <span class="kc">true</span><span class="p">;</span>
|
|
<span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">return</span> <span class="kc">false</span><span class="p">;</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * Periodically checks whether our internal IFrame is ready to be used.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @method _checkIframeLoaded</span>
|
|
<span class="cm"> * @private</span>
|
|
<span class="cm"> */</span>
|
|
<span class="kd">function</span> <span class="nx">_checkIframeLoaded</span><span class="p">()</span> <span class="p">{</span>
|
|
|
|
<span class="kd">var</span> <span class="nx">doc</span><span class="p">,</span> <span class="nx">elem</span><span class="p">,</span> <span class="nx">fqstate</span><span class="p">,</span> <span class="nx">hash</span><span class="p">;</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">_histFrame</span><span class="p">.</span><span class="nx">contentWindow</span> <span class="o">||</span> <span class="o">!</span><span class="nx">_histFrame</span><span class="p">.</span><span class="nx">contentWindow</span><span class="p">.</span><span class="nb">document</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="c1">// Check again in 10 msec...</span>
|
|
<span class="nx">setTimeout</span><span class="p">(</span><span class="nx">_checkIframeLoaded</span><span class="p">,</span> <span class="mi">10</span><span class="p">);</span>
|
|
<span class="k">return</span><span class="p">;</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="c1">// Start the thread that will have the responsibility to</span>
|
|
<span class="c1">// periodically check whether a navigate operation has been</span>
|
|
<span class="c1">// requested on the main window. This will happen when</span>
|
|
<span class="c1">// YAHOO.util.History.navigate has been called or after</span>
|
|
<span class="c1">// the user has hit the back/forward button.</span>
|
|
|
|
<span class="nx">doc</span> <span class="o">=</span> <span class="nx">_histFrame</span><span class="p">.</span><span class="nx">contentWindow</span><span class="p">.</span><span class="nb">document</span><span class="p">;</span>
|
|
<span class="nx">elem</span> <span class="o">=</span> <span class="nx">doc</span><span class="p">.</span><span class="nx">getElementById</span><span class="p">(</span><span class="s2">"state"</span><span class="p">);</span>
|
|
<span class="c1">// We must use innerText, and not innerHTML because our string contains</span>
|
|
<span class="c1">// the "&" character (which would end up being escaped as "&amp;") and</span>
|
|
<span class="c1">// the string comparison would fail...</span>
|
|
<span class="nx">fqstate</span> <span class="o">=</span> <span class="nx">elem</span> <span class="o">?</span> <span class="nx">elem</span><span class="p">.</span><span class="nx">innerText</span> <span class="o">:</span> <span class="kc">null</span><span class="p">;</span>
|
|
|
|
<span class="nx">hash</span> <span class="o">=</span> <span class="nx">_getHash</span><span class="p">();</span>
|
|
|
|
<span class="nx">setInterval</span><span class="p">(</span><span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
|
|
|
<span class="kd">var</span> <span class="nx">newfqstate</span><span class="p">,</span> <span class="nx">states</span><span class="p">,</span> <span class="nx">moduleName</span><span class="p">,</span> <span class="nx">moduleObj</span><span class="p">,</span> <span class="nx">newHash</span><span class="p">,</span> <span class="nx">historyLength</span><span class="p">;</span>
|
|
|
|
<span class="nx">doc</span> <span class="o">=</span> <span class="nx">_histFrame</span><span class="p">.</span><span class="nx">contentWindow</span><span class="p">.</span><span class="nb">document</span><span class="p">;</span>
|
|
<span class="nx">elem</span> <span class="o">=</span> <span class="nx">doc</span><span class="p">.</span><span class="nx">getElementById</span><span class="p">(</span><span class="s2">"state"</span><span class="p">);</span>
|
|
<span class="c1">// See my comment above about using innerText instead of innerHTML...</span>
|
|
<span class="nx">newfqstate</span> <span class="o">=</span> <span class="nx">elem</span> <span class="o">?</span> <span class="nx">elem</span><span class="p">.</span><span class="nx">innerText</span> <span class="o">:</span> <span class="kc">null</span><span class="p">;</span>
|
|
|
|
<span class="nx">newHash</span> <span class="o">=</span> <span class="nx">_getHash</span><span class="p">();</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">newfqstate</span> <span class="o">!==</span> <span class="nx">fqstate</span><span class="p">)</span> <span class="p">{</span>
|
|
|
|
<span class="nx">fqstate</span> <span class="o">=</span> <span class="nx">newfqstate</span><span class="p">;</span>
|
|
<span class="nx">_handleFQStateChange</span><span class="p">(</span><span class="nx">fqstate</span><span class="p">);</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">fqstate</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">states</span> <span class="o">=</span> <span class="p">[];</span>
|
|
<span class="k">for</span> <span class="p">(</span><span class="nx">moduleName</span> <span class="k">in</span> <span class="nx">_modules</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">YAHOO</span><span class="p">.</span><span class="nx">lang</span><span class="p">.</span><span class="nx">hasOwnProperty</span><span class="p">(</span><span class="nx">_modules</span><span class="p">,</span> <span class="nx">moduleName</span><span class="p">))</span> <span class="p">{</span>
|
|
<span class="nx">moduleObj</span> <span class="o">=</span> <span class="nx">_modules</span><span class="p">[</span><span class="nx">moduleName</span><span class="p">];</span>
|
|
<span class="nx">states</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="nx">moduleName</span> <span class="o">+</span> <span class="s2">"="</span> <span class="o">+</span> <span class="nx">moduleObj</span><span class="p">.</span><span class="nx">initialState</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="nx">newHash</span> <span class="o">=</span> <span class="nx">states</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="s2">"&"</span><span class="p">);</span>
|
|
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
|
|
<span class="nx">newHash</span> <span class="o">=</span> <span class="nx">fqstate</span><span class="p">;</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="c1">// Allow the state to be bookmarked by setting the top window's</span>
|
|
<span class="c1">// URL fragment identifier. Note that here, we are on IE, and</span>
|
|
<span class="c1">// IE does not touch the browser history when setting the hash</span>
|
|
<span class="c1">// (unlike all the other browsers). I used to write:</span>
|
|
<span class="c1">// top.location.replace( "#" + hash );</span>
|
|
<span class="c1">// but this had a side effect when the page was not the top frame.</span>
|
|
<span class="nx">top</span><span class="p">.</span><span class="nx">location</span><span class="p">.</span><span class="nx">hash</span> <span class="o">=</span> <span class="nx">newHash</span><span class="p">;</span>
|
|
<span class="nx">hash</span> <span class="o">=</span> <span class="nx">newHash</span><span class="p">;</span>
|
|
|
|
<span class="nx">_storeStates</span><span class="p">();</span>
|
|
|
|
<span class="p">}</span> <span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="nx">newHash</span> <span class="o">!==</span> <span class="nx">hash</span><span class="p">)</span> <span class="p">{</span>
|
|
|
|
<span class="c1">// The hash has changed. The user might have clicked on a link,</span>
|
|
<span class="c1">// or modified the URL directly, or opened the same application</span>
|
|
<span class="c1">// bookmarked in a specific state using a bookmark. However, we</span>
|
|
<span class="c1">// know the hash change was not caused by a hit on the back or</span>
|
|
<span class="c1">// forward buttons, or by a call to navigate() (because it would</span>
|
|
<span class="c1">// have been handled above) We must handle these cases, which is</span>
|
|
<span class="c1">// why we also need to keep track of hash changes on IE!</span>
|
|
|
|
<span class="c1">// Note that IE6 has some major issues with this kind of user</span>
|
|
<span class="c1">// interaction (the history stack gets completely messed up)</span>
|
|
<span class="c1">// but it seems to work fine on IE7.</span>
|
|
|
|
<span class="nx">hash</span> <span class="o">=</span> <span class="nx">newHash</span><span class="p">;</span>
|
|
|
|
<span class="c1">// Now, store a new history entry. The following will cause the</span>
|
|
<span class="c1">// code above to execute, doing all the dirty work for us...</span>
|
|
<span class="nx">_updateIFrame</span><span class="p">(</span><span class="nx">newHash</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="p">},</span> <span class="mi">50</span><span class="p">);</span>
|
|
|
|
<span class="nx">_initialized</span> <span class="o">=</span> <span class="kc">true</span><span class="p">;</span>
|
|
<span class="nx">YAHOO</span><span class="p">.</span><span class="nx">util</span><span class="p">.</span><span class="nx">History</span><span class="p">.</span><span class="nx">onLoadEvent</span><span class="p">.</span><span class="nx">fire</span><span class="p">();</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * Finish up the initialization of the Browser History Manager.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @method _initialize</span>
|
|
<span class="cm"> * @private</span>
|
|
<span class="cm"> */</span>
|
|
<span class="kd">function</span> <span class="nx">_initialize</span><span class="p">()</span> <span class="p">{</span>
|
|
|
|
<span class="kd">var</span> <span class="nx">i</span><span class="p">,</span> <span class="nx">len</span><span class="p">,</span> <span class="nx">parts</span><span class="p">,</span> <span class="nx">tokens</span><span class="p">,</span> <span class="nx">moduleName</span><span class="p">,</span> <span class="nx">moduleObj</span><span class="p">,</span> <span class="nx">initialStates</span><span class="p">,</span> <span class="nx">initialState</span><span class="p">,</span> <span class="nx">currentStates</span><span class="p">,</span> <span class="nx">currentState</span><span class="p">,</span> <span class="nx">counter</span><span class="p">,</span> <span class="nx">hash</span><span class="p">;</span>
|
|
|
|
<span class="c1">// Decode the content of our storage field...</span>
|
|
<span class="nx">parts</span> <span class="o">=</span> <span class="nx">_stateField</span><span class="p">.</span><span class="nx">value</span><span class="p">.</span><span class="nx">split</span><span class="p">(</span><span class="s2">"|"</span><span class="p">);</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">parts</span><span class="p">.</span><span class="nx">length</span> <span class="o">></span> <span class="mi">1</span><span class="p">)</span> <span class="p">{</span>
|
|
|
|
<span class="nx">initialStates</span> <span class="o">=</span> <span class="nx">parts</span><span class="p">[</span><span class="mi">0</span><span class="p">].</span><span class="nx">split</span><span class="p">(</span><span class="s2">"&"</span><span class="p">);</span>
|
|
<span class="k">for</span> <span class="p">(</span><span class="nx">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="nx">len</span> <span class="o">=</span> <span class="nx">initialStates</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span> <span class="nx">i</span> <span class="o"><</span> <span class="nx">len</span><span class="p">;</span> <span class="nx">i</span><span class="o">++</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">tokens</span> <span class="o">=</span> <span class="nx">initialStates</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">split</span><span class="p">(</span><span class="s2">"="</span><span class="p">);</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">tokens</span><span class="p">.</span><span class="nx">length</span> <span class="o">===</span> <span class="mi">2</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">moduleName</span> <span class="o">=</span> <span class="nx">tokens</span><span class="p">[</span><span class="mi">0</span><span class="p">];</span>
|
|
<span class="nx">initialState</span> <span class="o">=</span> <span class="nx">tokens</span><span class="p">[</span><span class="mi">1</span><span class="p">];</span>
|
|
<span class="nx">moduleObj</span> <span class="o">=</span> <span class="nx">_modules</span><span class="p">[</span><span class="nx">moduleName</span><span class="p">];</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">moduleObj</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">moduleObj</span><span class="p">.</span><span class="nx">initialState</span> <span class="o">=</span> <span class="nx">initialState</span><span class="p">;</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="nx">currentStates</span> <span class="o">=</span> <span class="nx">parts</span><span class="p">[</span><span class="mi">1</span><span class="p">].</span><span class="nx">split</span><span class="p">(</span><span class="s2">"&"</span><span class="p">);</span>
|
|
<span class="k">for</span> <span class="p">(</span><span class="nx">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="nx">len</span> <span class="o">=</span> <span class="nx">currentStates</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span> <span class="nx">i</span> <span class="o"><</span> <span class="nx">len</span><span class="p">;</span> <span class="nx">i</span><span class="o">++</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">tokens</span> <span class="o">=</span> <span class="nx">currentStates</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">split</span><span class="p">(</span><span class="s2">"="</span><span class="p">);</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">tokens</span><span class="p">.</span><span class="nx">length</span> <span class="o">>=</span> <span class="mi">2</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">moduleName</span> <span class="o">=</span> <span class="nx">tokens</span><span class="p">[</span><span class="mi">0</span><span class="p">];</span>
|
|
<span class="nx">currentState</span> <span class="o">=</span> <span class="nx">tokens</span><span class="p">[</span><span class="mi">1</span><span class="p">];</span>
|
|
<span class="nx">moduleObj</span> <span class="o">=</span> <span class="nx">_modules</span><span class="p">[</span><span class="nx">moduleName</span><span class="p">];</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">moduleObj</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">moduleObj</span><span class="p">.</span><span class="nx">currentState</span> <span class="o">=</span> <span class="nx">currentState</span><span class="p">;</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">parts</span><span class="p">.</span><span class="nx">length</span> <span class="o">></span> <span class="mi">2</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">_fqstates</span> <span class="o">=</span> <span class="nx">parts</span><span class="p">[</span><span class="mi">2</span><span class="p">].</span><span class="nx">split</span><span class="p">(</span><span class="s2">","</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">YAHOO</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">ua</span><span class="p">.</span><span class="nx">ie</span><span class="p">)</span> <span class="p">{</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="k">typeof</span> <span class="nb">document</span><span class="p">.</span><span class="nx">documentMode</span> <span class="o">===</span> <span class="s2">"undefined"</span> <span class="o">||</span> <span class="nb">document</span><span class="p">.</span><span class="nx">documentMode</span> <span class="o"><</span> <span class="mi">8</span><span class="p">)</span> <span class="p">{</span>
|
|
|
|
<span class="c1">// IE < 8 or IE8 in quirks mode or IE7 standards mode</span>
|
|
<span class="nx">_checkIframeLoaded</span><span class="p">();</span>
|
|
|
|
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
|
|
|
|
<span class="c1">// IE8 in IE8 standards mode</span>
|
|
<span class="nx">YAHOO</span><span class="p">.</span><span class="nx">util</span><span class="p">.</span><span class="nx">Event</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="nx">top</span><span class="p">,</span> <span class="s2">"hashchange"</span><span class="p">,</span>
|
|
<span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
|
<span class="kd">var</span> <span class="nx">hash</span> <span class="o">=</span> <span class="nx">_getHash</span><span class="p">();</span>
|
|
<span class="nx">_handleFQStateChange</span><span class="p">(</span><span class="nx">hash</span><span class="p">);</span>
|
|
<span class="nx">_storeStates</span><span class="p">();</span>
|
|
<span class="p">});</span>
|
|
|
|
<span class="nx">_initialized</span> <span class="o">=</span> <span class="kc">true</span><span class="p">;</span>
|
|
<span class="nx">YAHOO</span><span class="p">.</span><span class="nx">util</span><span class="p">.</span><span class="nx">History</span><span class="p">.</span><span class="nx">onLoadEvent</span><span class="p">.</span><span class="nx">fire</span><span class="p">();</span>
|
|
|
|
<span class="p">}</span>
|
|
|
|
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
|
|
|
|
<span class="c1">// Start the thread that will have the responsibility to</span>
|
|
<span class="c1">// periodically check whether a navigate operation has been</span>
|
|
<span class="c1">// requested on the main window. This will happen when</span>
|
|
<span class="c1">// YAHOO.util.History.navigate has been called or after</span>
|
|
<span class="c1">// the user has hit the back/forward button.</span>
|
|
|
|
<span class="c1">// On Safari 1.x and 2.0, the only way to catch a back/forward</span>
|
|
<span class="c1">// operation is to watch history.length... We basically exploit</span>
|
|
<span class="c1">// what I consider to be a bug (history.length is not supposed</span>
|
|
<span class="c1">// to change when going back/forward in the history...) This is</span>
|
|
<span class="c1">// why, in the following thread, we first compare the hash,</span>
|
|
<span class="c1">// because the hash thing will be fixed in the next major</span>
|
|
<span class="c1">// version of Safari. So even if they fix the history.length</span>
|
|
<span class="c1">// bug, all this will still work!</span>
|
|
<span class="nx">counter</span> <span class="o">=</span> <span class="nx">history</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span>
|
|
|
|
<span class="c1">// On Gecko and Opera, we just need to watch the hash...</span>
|
|
<span class="nx">hash</span> <span class="o">=</span> <span class="nx">_getHash</span><span class="p">();</span>
|
|
|
|
<span class="nx">setInterval</span><span class="p">(</span><span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
|
|
|
<span class="kd">var</span> <span class="nx">state</span><span class="p">,</span> <span class="nx">newHash</span><span class="p">,</span> <span class="nx">newCounter</span><span class="p">;</span>
|
|
|
|
<span class="nx">newHash</span> <span class="o">=</span> <span class="nx">_getHash</span><span class="p">();</span>
|
|
<span class="nx">newCounter</span> <span class="o">=</span> <span class="nx">history</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">newHash</span> <span class="o">!==</span> <span class="nx">hash</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">hash</span> <span class="o">=</span> <span class="nx">newHash</span><span class="p">;</span>
|
|
<span class="nx">counter</span> <span class="o">=</span> <span class="nx">newCounter</span><span class="p">;</span>
|
|
<span class="nx">_handleFQStateChange</span><span class="p">(</span><span class="nx">hash</span><span class="p">);</span>
|
|
<span class="nx">_storeStates</span><span class="p">();</span>
|
|
<span class="p">}</span> <span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="nx">newCounter</span> <span class="o">!==</span> <span class="nx">counter</span> <span class="o">&&</span> <span class="nx">YAHOO</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">ua</span><span class="p">.</span><span class="nx">webkit</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">hash</span> <span class="o">=</span> <span class="nx">newHash</span><span class="p">;</span>
|
|
<span class="nx">counter</span> <span class="o">=</span> <span class="nx">newCounter</span><span class="p">;</span>
|
|
<span class="nx">state</span> <span class="o">=</span> <span class="nx">_fqstates</span><span class="p">[</span><span class="nx">counter</span> <span class="o">-</span> <span class="mi">1</span><span class="p">];</span>
|
|
<span class="nx">_handleFQStateChange</span><span class="p">(</span><span class="nx">state</span><span class="p">);</span>
|
|
<span class="nx">_storeStates</span><span class="p">();</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="p">},</span> <span class="mi">50</span><span class="p">);</span>
|
|
|
|
<span class="nx">_initialized</span> <span class="o">=</span> <span class="kc">true</span><span class="p">;</span>
|
|
<span class="nx">YAHOO</span><span class="p">.</span><span class="nx">util</span><span class="p">.</span><span class="nx">History</span><span class="p">.</span><span class="nx">onLoadEvent</span><span class="p">.</span><span class="nx">fire</span><span class="p">();</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">return</span> <span class="p">{</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * Fired when the Browser History Manager is ready. If you subscribe to</span>
|
|
<span class="cm"> * this event after the Browser History Manager has been initialized,</span>
|
|
<span class="cm"> * it will not fire. Therefore, it is recommended to use the onReady</span>
|
|
<span class="cm"> * method instead.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @event onLoadEvent</span>
|
|
<span class="cm"> * @see onReady</span>
|
|
<span class="cm"> */</span>
|
|
<span class="nx">onLoadEvent</span><span class="o">:</span> <span class="k">new</span> <span class="nx">YAHOO</span><span class="p">.</span><span class="nx">util</span><span class="p">.</span><span class="nx">CustomEvent</span><span class="p">(</span><span class="s2">"onLoad"</span><span class="p">),</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * Executes the supplied callback when the Browser History Manager is</span>
|
|
<span class="cm"> * ready. This will execute immediately if called after the Browser</span>
|
|
<span class="cm"> * History Manager onLoad event has fired.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @method onReady</span>
|
|
<span class="cm"> * @param {function} fn what to execute when the Browser History Manager is ready.</span>
|
|
<span class="cm"> * @param {object} obj an optional object to be passed back as a parameter to fn.</span>
|
|
<span class="cm"> * @param {boolean|object} overrideContext If true, the obj passed in becomes fn's execution scope.</span>
|
|
<span class="cm"> * @see onLoadEvent</span>
|
|
<span class="cm"> */</span>
|
|
<span class="nx">onReady</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">fn</span><span class="p">,</span> <span class="nx">obj</span><span class="p">,</span> <span class="nx">overrideContext</span><span class="p">)</span> <span class="p">{</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">_initialized</span><span class="p">)</span> <span class="p">{</span>
|
|
|
|
<span class="nx">setTimeout</span><span class="p">(</span><span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
|
|
<span class="kd">var</span> <span class="nx">ctx</span> <span class="o">=</span> <span class="nb">window</span><span class="p">;</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">overrideContext</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">overrideContext</span> <span class="o">===</span> <span class="kc">true</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">ctx</span> <span class="o">=</span> <span class="nx">obj</span><span class="p">;</span>
|
|
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
|
|
<span class="nx">ctx</span> <span class="o">=</span> <span class="nx">overrideContext</span><span class="p">;</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="nx">fn</span><span class="p">.</span><span class="nx">call</span><span class="p">(</span><span class="nx">ctx</span><span class="p">,</span> <span class="s2">"onLoad"</span><span class="p">,</span> <span class="p">[],</span> <span class="nx">obj</span><span class="p">);</span>
|
|
<span class="p">},</span> <span class="mi">0</span><span class="p">);</span>
|
|
|
|
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
|
|
|
|
<span class="nx">YAHOO</span><span class="p">.</span><span class="nx">util</span><span class="p">.</span><span class="nx">History</span><span class="p">.</span><span class="nx">onLoadEvent</span><span class="p">.</span><span class="nx">subscribe</span><span class="p">(</span><span class="nx">fn</span><span class="p">,</span> <span class="nx">obj</span><span class="p">,</span> <span class="nx">overrideContext</span><span class="p">);</span>
|
|
|
|
<span class="p">}</span>
|
|
<span class="p">},</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * Registers a new module.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @method register</span>
|
|
<span class="cm"> * @param {string} module Non-empty string uniquely identifying the</span>
|
|
<span class="cm"> * module you wish to register.</span>
|
|
<span class="cm"> * @param {string} initialState The initial state of the specified</span>
|
|
<span class="cm"> * module corresponding to its earliest history entry.</span>
|
|
<span class="cm"> * @param {function} onStateChange Callback called when the</span>
|
|
<span class="cm"> * state of the specified module has changed.</span>
|
|
<span class="cm"> * @param {object} obj An arbitrary object that will be passed as a</span>
|
|
<span class="cm"> * parameter to the handler.</span>
|
|
<span class="cm"> * @param {boolean} overrideContext If true, the obj passed in becomes the</span>
|
|
<span class="cm"> * execution scope of the listener.</span>
|
|
<span class="cm"> */</span>
|
|
<span class="nx">register</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">module</span><span class="p">,</span> <span class="nx">initialState</span><span class="p">,</span> <span class="nx">onStateChange</span><span class="p">,</span> <span class="nx">obj</span><span class="p">,</span> <span class="nx">overrideContext</span><span class="p">)</span> <span class="p">{</span>
|
|
|
|
<span class="kd">var</span> <span class="nx">scope</span><span class="p">,</span> <span class="nx">wrappedFn</span><span class="p">;</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="k">typeof</span> <span class="nx">module</span> <span class="o">!==</span> <span class="s2">"string"</span> <span class="o">||</span> <span class="nx">YAHOO</span><span class="p">.</span><span class="nx">lang</span><span class="p">.</span><span class="nx">trim</span><span class="p">(</span><span class="nx">module</span><span class="p">)</span> <span class="o">===</span> <span class="s2">""</span> <span class="o">||</span>
|
|
<span class="k">typeof</span> <span class="nx">initialState</span> <span class="o">!==</span> <span class="s2">"string"</span> <span class="o">||</span>
|
|
<span class="k">typeof</span> <span class="nx">onStateChange</span> <span class="o">!==</span> <span class="s2">"function"</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s2">"Missing or invalid argument"</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">_modules</span><span class="p">[</span><span class="nx">module</span><span class="p">])</span> <span class="p">{</span>
|
|
<span class="c1">// Here, we used to throw an exception. However, users have</span>
|
|
<span class="c1">// complained about this behavior, so we now just return.</span>
|
|
<span class="k">return</span><span class="p">;</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="c1">// Note: A module CANNOT be registered after calling</span>
|
|
<span class="c1">// YAHOO.util.History.initialize. Indeed, we set the initial state</span>
|
|
<span class="c1">// of each registered module in YAHOO.util.History.initialize.</span>
|
|
<span class="c1">// If you could register a module after initializing the Browser</span>
|
|
<span class="c1">// History Manager, you would not read the correct state using</span>
|
|
<span class="c1">// YAHOO.util.History.getCurrentState when coming back to the</span>
|
|
<span class="c1">// page using the back button.</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">_initialized</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s2">"All modules must be registered before calling YAHOO.util.History.initialize"</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="c1">// Make sure the strings passed in do not contain our separators "," and "|"</span>
|
|
<span class="nx">module</span> <span class="o">=</span> <span class="nx">escape</span><span class="p">(</span><span class="nx">module</span><span class="p">);</span>
|
|
<span class="nx">initialState</span> <span class="o">=</span> <span class="nx">escape</span><span class="p">(</span><span class="nx">initialState</span><span class="p">);</span>
|
|
|
|
<span class="c1">// If the user chooses to override the scope, we use the</span>
|
|
<span class="c1">// custom object passed in as the execution scope.</span>
|
|
<span class="nx">scope</span> <span class="o">=</span> <span class="kc">null</span><span class="p">;</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">overrideContext</span> <span class="o">===</span> <span class="kc">true</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">scope</span> <span class="o">=</span> <span class="nx">obj</span><span class="p">;</span>
|
|
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
|
|
<span class="nx">scope</span> <span class="o">=</span> <span class="nx">overrideContext</span><span class="p">;</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="nx">wrappedFn</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">state</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">return</span> <span class="nx">onStateChange</span><span class="p">.</span><span class="nx">call</span><span class="p">(</span><span class="nx">scope</span><span class="p">,</span> <span class="nx">state</span><span class="p">,</span> <span class="nx">obj</span><span class="p">);</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="nx">_modules</span><span class="p">[</span><span class="nx">module</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="nx">name</span><span class="o">:</span> <span class="nx">module</span><span class="p">,</span>
|
|
<span class="nx">initialState</span><span class="o">:</span> <span class="nx">initialState</span><span class="p">,</span>
|
|
<span class="nx">currentState</span><span class="o">:</span> <span class="nx">initialState</span><span class="p">,</span>
|
|
<span class="nx">onStateChange</span><span class="o">:</span> <span class="nx">wrappedFn</span>
|
|
<span class="p">};</span>
|
|
<span class="p">},</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * Initializes the Browser History Manager. Call this method</span>
|
|
<span class="cm"> * from a script block located right after the opening body tag.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @method initialize</span>
|
|
<span class="cm"> * @param {string|HTML Element} stateField <input type="hidden"> used</span>
|
|
<span class="cm"> * to store application states. Must be in the static markup.</span>
|
|
<span class="cm"> * @param {string|HTML Element} histFrame IFrame used to store</span>
|
|
<span class="cm"> * the history (only required on Internet Explorer)</span>
|
|
<span class="cm"> * @public</span>
|
|
<span class="cm"> */</span>
|
|
<span class="nx">initialize</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">stateField</span><span class="p">,</span> <span class="nx">histFrame</span><span class="p">)</span> <span class="p">{</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">_initialized</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="c1">// The browser history manager has already been initialized.</span>
|
|
<span class="k">return</span><span class="p">;</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">YAHOO</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">ua</span><span class="p">.</span><span class="nx">opera</span> <span class="o">&&</span> <span class="k">typeof</span> <span class="nx">history</span><span class="p">.</span><span class="nx">navigationMode</span> <span class="o">!==</span> <span class="s2">"undefined"</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="c1">// Disable Opera's fast back/forward navigation mode and puts</span>
|
|
<span class="c1">// it in compatible mode. This makes anchor-based history</span>
|
|
<span class="c1">// navigation work after the page has been navigated away</span>
|
|
<span class="c1">// from and re-activated, at the cost of slowing down</span>
|
|
<span class="c1">// back/forward navigation to and from that page.</span>
|
|
<span class="nx">history</span><span class="p">.</span><span class="nx">navigationMode</span> <span class="o">=</span> <span class="s2">"compatible"</span><span class="p">;</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="k">typeof</span> <span class="nx">stateField</span> <span class="o">===</span> <span class="s2">"string"</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">stateField</span> <span class="o">=</span> <span class="nb">document</span><span class="p">.</span><span class="nx">getElementById</span><span class="p">(</span><span class="nx">stateField</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">stateField</span> <span class="o">||</span>
|
|
<span class="nx">stateField</span><span class="p">.</span><span class="nx">tagName</span><span class="p">.</span><span class="nx">toUpperCase</span><span class="p">()</span> <span class="o">!==</span> <span class="s2">"TEXTAREA"</span> <span class="o">&&</span>
|
|
<span class="p">(</span><span class="nx">stateField</span><span class="p">.</span><span class="nx">tagName</span><span class="p">.</span><span class="nx">toUpperCase</span><span class="p">()</span> <span class="o">!==</span> <span class="s2">"INPUT"</span> <span class="o">||</span>
|
|
<span class="nx">stateField</span><span class="p">.</span><span class="nx">type</span> <span class="o">!==</span> <span class="s2">"hidden"</span> <span class="o">&&</span>
|
|
<span class="nx">stateField</span><span class="p">.</span><span class="nx">type</span> <span class="o">!==</span> <span class="s2">"text"</span><span class="p">))</span> <span class="p">{</span>
|
|
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s2">"Missing or invalid argument"</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="nx">_stateField</span> <span class="o">=</span> <span class="nx">stateField</span><span class="p">;</span>
|
|
|
|
<span class="c1">// IE < 8 or IE8 in quirks mode or IE7 standards mode</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">YAHOO</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">ua</span><span class="p">.</span><span class="nx">ie</span> <span class="o">&&</span> <span class="p">(</span><span class="k">typeof</span> <span class="nb">document</span><span class="p">.</span><span class="nx">documentMode</span> <span class="o">===</span> <span class="s2">"undefined"</span> <span class="o">||</span> <span class="nb">document</span><span class="p">.</span><span class="nx">documentMode</span> <span class="o"><</span> <span class="mi">8</span><span class="p">))</span> <span class="p">{</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="k">typeof</span> <span class="nx">histFrame</span> <span class="o">===</span> <span class="s2">"string"</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">histFrame</span> <span class="o">=</span> <span class="nb">document</span><span class="p">.</span><span class="nx">getElementById</span><span class="p">(</span><span class="nx">histFrame</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">histFrame</span> <span class="o">||</span> <span class="nx">histFrame</span><span class="p">.</span><span class="nx">tagName</span><span class="p">.</span><span class="nx">toUpperCase</span><span class="p">()</span> <span class="o">!==</span> <span class="s2">"IFRAME"</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s2">"Missing or invalid argument"</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="nx">_histFrame</span> <span class="o">=</span> <span class="nx">histFrame</span><span class="p">;</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="c1">// Note that the event utility MUST be included inline in the page.</span>
|
|
<span class="c1">// If it gets loaded later (which you may want to do to improve the</span>
|
|
<span class="c1">// loading speed of your site), the onDOMReady event never fires,</span>
|
|
<span class="c1">// and the history library never gets fully initialized.</span>
|
|
<span class="nx">YAHOO</span><span class="p">.</span><span class="nx">util</span><span class="p">.</span><span class="nx">Event</span><span class="p">.</span><span class="nx">onDOMReady</span><span class="p">(</span><span class="nx">_initialize</span><span class="p">);</span>
|
|
<span class="p">},</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * Call this method when you want to store a new entry in the browser's history.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @method navigate</span>
|
|
<span class="cm"> * @param {string} module Non-empty string representing your module.</span>
|
|
<span class="cm"> * @param {string} state String representing the new state of the specified module.</span>
|
|
<span class="cm"> * @return {boolean} Indicates whether the new state was successfully added to the history.</span>
|
|
<span class="cm"> * @public</span>
|
|
<span class="cm"> */</span>
|
|
<span class="nx">navigate</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">module</span><span class="p">,</span> <span class="nx">state</span><span class="p">)</span> <span class="p">{</span>
|
|
|
|
<span class="kd">var</span> <span class="nx">states</span><span class="p">;</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="k">typeof</span> <span class="nx">module</span> <span class="o">!==</span> <span class="s2">"string"</span> <span class="o">||</span> <span class="k">typeof</span> <span class="nx">state</span> <span class="o">!==</span> <span class="s2">"string"</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s2">"Missing or invalid argument"</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="nx">states</span> <span class="o">=</span> <span class="p">{};</span>
|
|
<span class="nx">states</span><span class="p">[</span><span class="nx">module</span><span class="p">]</span> <span class="o">=</span> <span class="nx">state</span><span class="p">;</span>
|
|
|
|
<span class="k">return</span> <span class="nx">YAHOO</span><span class="p">.</span><span class="nx">util</span><span class="p">.</span><span class="nx">History</span><span class="p">.</span><span class="nx">multiNavigate</span><span class="p">(</span><span class="nx">states</span><span class="p">);</span>
|
|
<span class="p">},</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * Call this method when you want to store a new entry in the browser's history.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @method multiNavigate</span>
|
|
<span class="cm"> * @param {object} states Associative array of module-state pairs to set simultaneously.</span>
|
|
<span class="cm"> * @return {boolean} Indicates whether the new state was successfully added to the history.</span>
|
|
<span class="cm"> * @public</span>
|
|
<span class="cm"> */</span>
|
|
<span class="nx">multiNavigate</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">states</span><span class="p">)</span> <span class="p">{</span>
|
|
|
|
<span class="kd">var</span> <span class="nx">currentStates</span><span class="p">,</span> <span class="nx">moduleName</span><span class="p">,</span> <span class="nx">moduleObj</span><span class="p">,</span> <span class="nx">currentState</span><span class="p">,</span> <span class="nx">fqstate</span><span class="p">;</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="k">typeof</span> <span class="nx">states</span> <span class="o">!==</span> <span class="s2">"object"</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s2">"Missing or invalid argument"</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">_initialized</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s2">"The Browser History Manager is not initialized"</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">for</span> <span class="p">(</span><span class="nx">moduleName</span> <span class="k">in</span> <span class="nx">states</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">_modules</span><span class="p">[</span><span class="nx">moduleName</span><span class="p">])</span> <span class="p">{</span>
|
|
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s2">"The following module has not been registered: "</span> <span class="o">+</span> <span class="nx">moduleName</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="c1">// Generate our new full state string mod1=xxx&mod2=yyy</span>
|
|
<span class="nx">currentStates</span> <span class="o">=</span> <span class="p">[];</span>
|
|
|
|
<span class="k">for</span> <span class="p">(</span><span class="nx">moduleName</span> <span class="k">in</span> <span class="nx">_modules</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">YAHOO</span><span class="p">.</span><span class="nx">lang</span><span class="p">.</span><span class="nx">hasOwnProperty</span><span class="p">(</span><span class="nx">_modules</span><span class="p">,</span> <span class="nx">moduleName</span><span class="p">))</span> <span class="p">{</span>
|
|
<span class="nx">moduleObj</span> <span class="o">=</span> <span class="nx">_modules</span><span class="p">[</span><span class="nx">moduleName</span><span class="p">];</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">YAHOO</span><span class="p">.</span><span class="nx">lang</span><span class="p">.</span><span class="nx">hasOwnProperty</span><span class="p">(</span><span class="nx">states</span><span class="p">,</span> <span class="nx">moduleName</span><span class="p">))</span> <span class="p">{</span>
|
|
<span class="nx">currentState</span> <span class="o">=</span> <span class="nx">states</span><span class="p">[</span><span class="nx">unescape</span><span class="p">(</span><span class="nx">moduleName</span><span class="p">)];</span>
|
|
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
|
|
<span class="nx">currentState</span> <span class="o">=</span> <span class="nx">unescape</span><span class="p">(</span><span class="nx">moduleObj</span><span class="p">.</span><span class="nx">currentState</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="c1">// Make sure the strings passed in do not contain our separators "," and "|"</span>
|
|
<span class="nx">moduleName</span> <span class="o">=</span> <span class="nx">escape</span><span class="p">(</span><span class="nx">moduleName</span><span class="p">);</span>
|
|
<span class="nx">currentState</span> <span class="o">=</span> <span class="nx">escape</span><span class="p">(</span><span class="nx">currentState</span><span class="p">);</span>
|
|
|
|
<span class="nx">currentStates</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="nx">moduleName</span> <span class="o">+</span> <span class="s2">"="</span> <span class="o">+</span> <span class="nx">currentState</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="nx">fqstate</span> <span class="o">=</span> <span class="nx">currentStates</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="s2">"&"</span><span class="p">);</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">YAHOO</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">ua</span><span class="p">.</span><span class="nx">ie</span> <span class="o">&&</span> <span class="p">(</span><span class="k">typeof</span> <span class="nb">document</span><span class="p">.</span><span class="nx">documentMode</span> <span class="o">===</span> <span class="s2">"undefined"</span> <span class="o">||</span> <span class="nb">document</span><span class="p">.</span><span class="nx">documentMode</span> <span class="o"><</span> <span class="mi">8</span><span class="p">))</span> <span class="p">{</span>
|
|
|
|
<span class="k">return</span> <span class="nx">_updateIFrame</span><span class="p">(</span><span class="nx">fqstate</span><span class="p">);</span>
|
|
|
|
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
|
|
|
|
<span class="c1">// Known bug: On Safari 1.x and 2.0, if you have tab browsing</span>
|
|
<span class="c1">// enabled, Safari will show an endless loading icon in the</span>
|
|
<span class="c1">// tab. This has apparently been fixed in recent WebKit builds.</span>
|
|
<span class="c1">// One work around found by Dav Glass is to submit a form that</span>
|
|
<span class="c1">// points to the same document. This indeed works on Safari 1.x</span>
|
|
<span class="c1">// and 2.0 but creates bigger problems on WebKit. So for now,</span>
|
|
<span class="c1">// we'll consider this an acceptable bug, and hope that Apple</span>
|
|
<span class="c1">// comes out with their next version of Safari very soon.</span>
|
|
<span class="nx">top</span><span class="p">.</span><span class="nx">location</span><span class="p">.</span><span class="nx">hash</span> <span class="o">=</span> <span class="nx">fqstate</span><span class="p">;</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">YAHOO</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">ua</span><span class="p">.</span><span class="nx">webkit</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="c1">// The following two lines are only useful for Safari 1.x</span>
|
|
<span class="c1">// and 2.0. Recent nightly builds of WebKit do not require</span>
|
|
<span class="c1">// that, but unfortunately, it is not easy to differentiate</span>
|
|
<span class="c1">// between the two. Once Safari 2.0 departs the A-grade</span>
|
|
<span class="c1">// list, we can remove the following two lines...</span>
|
|
<span class="nx">_fqstates</span><span class="p">[</span><span class="nx">history</span><span class="p">.</span><span class="nx">length</span><span class="p">]</span> <span class="o">=</span> <span class="nx">fqstate</span><span class="p">;</span>
|
|
<span class="nx">_storeStates</span><span class="p">();</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">return</span> <span class="kc">true</span><span class="p">;</span>
|
|
|
|
<span class="p">}</span>
|
|
<span class="p">},</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * Returns the current state of the specified module.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @method getCurrentState</span>
|
|
<span class="cm"> * @param {string} module Non-empty string representing your module.</span>
|
|
<span class="cm"> * @return {string} The current state of the specified module.</span>
|
|
<span class="cm"> * @public</span>
|
|
<span class="cm"> */</span>
|
|
<span class="nx">getCurrentState</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">module</span><span class="p">)</span> <span class="p">{</span>
|
|
|
|
<span class="kd">var</span> <span class="nx">moduleObj</span><span class="p">;</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="k">typeof</span> <span class="nx">module</span> <span class="o">!==</span> <span class="s2">"string"</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s2">"Missing or invalid argument"</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">_initialized</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s2">"The Browser History Manager is not initialized"</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="nx">moduleObj</span> <span class="o">=</span> <span class="nx">_modules</span><span class="p">[</span><span class="nx">module</span><span class="p">];</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">moduleObj</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s2">"No such registered module: "</span> <span class="o">+</span> <span class="nx">module</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">return</span> <span class="nx">unescape</span><span class="p">(</span><span class="nx">moduleObj</span><span class="p">.</span><span class="nx">currentState</span><span class="p">);</span>
|
|
<span class="p">},</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * Returns the state of a module according to the URL fragment</span>
|
|
<span class="cm"> * identifier. This method is useful to initialize your modules</span>
|
|
<span class="cm"> * if your application was bookmarked from a particular state.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @method getBookmarkedState</span>
|
|
<span class="cm"> * @param {string} module Non-empty string representing your module.</span>
|
|
<span class="cm"> * @return {string} The bookmarked state of the specified module.</span>
|
|
<span class="cm"> * @public</span>
|
|
<span class="cm"> */</span>
|
|
<span class="nx">getBookmarkedState</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">module</span><span class="p">)</span> <span class="p">{</span>
|
|
|
|
<span class="kd">var</span> <span class="nx">i</span><span class="p">,</span> <span class="nx">len</span><span class="p">,</span> <span class="nx">idx</span><span class="p">,</span> <span class="nx">hash</span><span class="p">,</span> <span class="nx">states</span><span class="p">,</span> <span class="nx">tokens</span><span class="p">,</span> <span class="nx">moduleName</span><span class="p">;</span>
|
|
|
|
<span class="k">if</span> <span class="p">(</span><span class="k">typeof</span> <span class="nx">module</span> <span class="o">!==</span> <span class="s2">"string"</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s2">"Missing or invalid argument"</span><span class="p">);</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="c1">// Use location.href instead of location.hash which is already</span>
|
|
<span class="c1">// URL-decoded, which creates problems if the state value</span>
|
|
<span class="c1">// contained special characters...</span>
|
|
<span class="nx">idx</span> <span class="o">=</span> <span class="nx">top</span><span class="p">.</span><span class="nx">location</span><span class="p">.</span><span class="nx">href</span><span class="p">.</span><span class="nx">indexOf</span><span class="p">(</span><span class="s2">"#"</span><span class="p">);</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">idx</span> <span class="o">>=</span> <span class="mi">0</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">hash</span> <span class="o">=</span> <span class="nx">top</span><span class="p">.</span><span class="nx">location</span><span class="p">.</span><span class="nx">href</span><span class="p">.</span><span class="nx">substr</span><span class="p">(</span><span class="nx">idx</span> <span class="o">+</span> <span class="mi">1</span><span class="p">);</span>
|
|
<span class="nx">states</span> <span class="o">=</span> <span class="nx">hash</span><span class="p">.</span><span class="nx">split</span><span class="p">(</span><span class="s2">"&"</span><span class="p">);</span>
|
|
<span class="k">for</span> <span class="p">(</span><span class="nx">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="nx">len</span> <span class="o">=</span> <span class="nx">states</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span> <span class="nx">i</span> <span class="o"><</span> <span class="nx">len</span><span class="p">;</span> <span class="nx">i</span><span class="o">++</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">tokens</span> <span class="o">=</span> <span class="nx">states</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">split</span><span class="p">(</span><span class="s2">"="</span><span class="p">);</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">tokens</span><span class="p">.</span><span class="nx">length</span> <span class="o">===</span> <span class="mi">2</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">moduleName</span> <span class="o">=</span> <span class="nx">tokens</span><span class="p">[</span><span class="mi">0</span><span class="p">];</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">moduleName</span> <span class="o">===</span> <span class="nx">module</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">return</span> <span class="nx">unescape</span><span class="p">(</span><span class="nx">tokens</span><span class="p">[</span><span class="mi">1</span><span class="p">]);</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">return</span> <span class="kc">null</span><span class="p">;</span>
|
|
<span class="p">},</span>
|
|
|
|
<span class="cm">/**</span>
|
|
<span class="cm"> * Returns the value of the specified query string parameter.</span>
|
|
<span class="cm"> * This method is not used internally by the Browser History Manager.</span>
|
|
<span class="cm"> * However, it is provided here as a helper since many applications</span>
|
|
<span class="cm"> * using the Browser History Manager will want to read the value of</span>
|
|
<span class="cm"> * url parameters to initialize themselves.</span>
|
|
<span class="cm"> *</span>
|
|
<span class="cm"> * @method getQueryStringParameter</span>
|
|
<span class="cm"> * @param {string} paramName Name of the parameter we want to look up.</span>
|
|
<span class="cm"> * @param {string} queryString Optional URL to look at. If not specified,</span>
|
|
<span class="cm"> * this method uses the URL in the address bar.</span>
|
|
<span class="cm"> * @return {string} The value of the specified parameter, or null.</span>
|
|
<span class="cm"> * @public</span>
|
|
<span class="cm"> */</span>
|
|
<span class="nx">getQueryStringParameter</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">paramName</span><span class="p">,</span> <span class="nx">url</span><span class="p">)</span> <span class="p">{</span>
|
|
|
|
<span class="kd">var</span> <span class="nx">i</span><span class="p">,</span> <span class="nx">len</span><span class="p">,</span> <span class="nx">idx</span><span class="p">,</span> <span class="nx">queryString</span><span class="p">,</span> <span class="nx">params</span><span class="p">,</span> <span class="nx">tokens</span><span class="p">;</span>
|
|
|
|
<span class="nx">url</span> <span class="o">=</span> <span class="nx">url</span> <span class="o">||</span> <span class="nx">top</span><span class="p">.</span><span class="nx">location</span><span class="p">.</span><span class="nx">href</span><span class="p">;</span>
|
|
|
|
<span class="nx">idx</span> <span class="o">=</span> <span class="nx">url</span><span class="p">.</span><span class="nx">indexOf</span><span class="p">(</span><span class="s2">"?"</span><span class="p">);</span>
|
|
<span class="nx">queryString</span> <span class="o">=</span> <span class="nx">idx</span> <span class="o">>=</span> <span class="mi">0</span> <span class="o">?</span> <span class="nx">url</span><span class="p">.</span><span class="nx">substr</span><span class="p">(</span><span class="nx">idx</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span> <span class="o">:</span> <span class="nx">url</span><span class="p">;</span>
|
|
|
|
<span class="c1">// Remove the hash if any</span>
|
|
<span class="nx">idx</span> <span class="o">=</span> <span class="nx">queryString</span><span class="p">.</span><span class="nx">lastIndexOf</span><span class="p">(</span><span class="s2">"#"</span><span class="p">);</span>
|
|
<span class="nx">queryString</span> <span class="o">=</span> <span class="nx">idx</span> <span class="o">>=</span> <span class="mi">0</span> <span class="o">?</span> <span class="nx">queryString</span><span class="p">.</span><span class="nx">substr</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="nx">idx</span><span class="p">)</span> <span class="o">:</span> <span class="nx">queryString</span><span class="p">;</span>
|
|
|
|
<span class="nx">params</span> <span class="o">=</span> <span class="nx">queryString</span><span class="p">.</span><span class="nx">split</span><span class="p">(</span><span class="s2">"&"</span><span class="p">);</span>
|
|
|
|
<span class="k">for</span> <span class="p">(</span><span class="nx">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="nx">len</span> <span class="o">=</span> <span class="nx">params</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span> <span class="nx">i</span> <span class="o"><</span> <span class="nx">len</span><span class="p">;</span> <span class="nx">i</span><span class="o">++</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">tokens</span> <span class="o">=</span> <span class="nx">params</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">split</span><span class="p">(</span><span class="s2">"="</span><span class="p">);</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">tokens</span><span class="p">.</span><span class="nx">length</span> <span class="o">>=</span> <span class="mi">2</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">tokens</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">===</span> <span class="nx">paramName</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">return</span> <span class="nx">unescape</span><span class="p">(</span><span class="nx">tokens</span><span class="p">[</span><span class="mi">1</span><span class="p">]);</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">return</span> <span class="kc">null</span><span class="p">;</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="p">};</span>
|
|
|
|
<span class="p">})();</span>
|
|
</pre></div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="yui-b">
|
|
<div class="nav">
|
|
|
|
<div id="moduleList" class="module">
|
|
<h4>Modules</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="module_animation.html" title="animation">animation</a></li>
|
|
<li class=""><a href="module_autocomplete.html" title="autocomplete">autocomplete</a></li>
|
|
<li class=""><a href="module_button.html" title="button">button</a></li>
|
|
<li class=""><a href="module_calendar.html" title="calendar">calendar</a></li>
|
|
<li class=""><a href="module_carousel.html" title="carousel">carousel</a></li>
|
|
<li class=""><a href="module_charts.html" title="charts">charts</a></li>
|
|
<li class=""><a href="module_colorpicker.html" title="colorpicker">colorpicker</a></li>
|
|
<li class=""><a href="module_connection.html" title="connection">connection</a></li>
|
|
<li class=""><a href="module_container.html" title="container">container</a></li>
|
|
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
|
|
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li>
|
|
<li class=""><a href="module_datatable.html" title="datatable">datatable</a></li>
|
|
<li class=""><a href="module_datemath.html" title="datemath">datemath</a></li>
|
|
<li class=""><a href="module_dom.html" title="dom">dom</a></li>
|
|
<li class=""><a href="module_dragdrop.html" title="dragdrop">dragdrop</a></li>
|
|
<li class=""><a href="module_editor.html" title="editor">editor</a></li>
|
|
<li class=""><a href="module_element.html" title="element">element</a></li>
|
|
<li class=""><a href="module_element-delegate.html" title="element-delegate">element-delegate</a></li>
|
|
<li class=""><a href="module_event.html" title="event">event</a></li>
|
|
<li class=""><a href="module_event-delegate.html" title="event-delegate">event-delegate</a></li>
|
|
<li class=""><a href="module_event-mouseenter.html" title="event-mouseenter">event-mouseenter</a></li>
|
|
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li>
|
|
<li class=""><a href="module_get.html" title="get">get</a></li>
|
|
<li class="selected"><a href="module_history.html" title="history">history</a></li>
|
|
<li class=""><a href="module_imagecropper.html" title="imagecropper">imagecropper</a></li>
|
|
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li>
|
|
<li class=""><a href="module_json.html" title="json">json</a></li>
|
|
<li class=""><a href="module_layout.html" title="layout">layout</a></li>
|
|
<li class=""><a href="module_logger.html" title="logger">logger</a></li>
|
|
<li class=""><a href="module_menu.html" title="menu">menu</a></li>
|
|
<li class=""><a href="module_paginator.html" title="paginator">paginator</a></li>
|
|
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li>
|
|
<li class=""><a href="module_profilerviewer.html" title="profilerviewer">profilerviewer</a></li>
|
|
<li class=""><a href="module_progressbar.html" title="progressbar">progressbar</a></li>
|
|
<li class=""><a href="module_resize.html" title="resize">resize</a></li>
|
|
<li class=""><a href="module_selector.html" title="selector">selector</a></li>
|
|
<li class=""><a href="module_slider.html" title="slider">slider</a></li>
|
|
<li class=""><a href="module_storage.html" title="Storage">Storage</a></li>
|
|
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
|
|
<li class=""><a href="module_swf.html" title="swf">swf</a></li>
|
|
<li class=""><a href="module_swfdetect.html" title="swfdetect">swfdetect</a></li>
|
|
<li class=""><a href="module_swfstore.html" title="swfstore">swfstore</a></li>
|
|
<li class=""><a href="module_tabview.html" title="tabview">tabview</a></li>
|
|
<li class=""><a href="module_treeview.html" title="treeview">treeview</a></li>
|
|
<li class=""><a href="module_uploader.html" title="uploader">uploader</a></li>
|
|
<li class=""><a href="module_yahoo.html" title="yahoo">yahoo</a></li>
|
|
<li class=""><a href="module_yuiloader.html" title="yuiloader">yuiloader</a></li>
|
|
<li class=""><a href="module_yuitest.html" title="yuitest">yuitest</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="classList" class="module">
|
|
<h4>Classes</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="YAHOO.util.History.html" title="YAHOO.util.History">YAHOO.util.History</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="fileList" class="module">
|
|
<h4>Files</h4>
|
|
<ul class="content">
|
|
<li class="selected"><a href="history.js.html" title="history.js">history.js</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="ft">
|
|
<hr />
|
|
Copyright © 2010 Yahoo! Inc. All rights reserved.
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
|
|
var ALL_YUI_PROPS = [{"access": "private", "host": "YAHOO.util.History", "name": "_checkIframeLoaded", "url": "YAHOO.util.History.html#method__checkIframeLoaded", "type": "method"}, {"access": "private", "host": "YAHOO.util.History", "name": "_fqstates", "url": "YAHOO.util.History.html#property__fqstates", "type": "property"}, {"access": "", "host": "YAHOO.util.History", "name": "getBookmarkedState", "url": "YAHOO.util.History.html#method_getBookmarkedState", "type": "method"}, {"access": "", "host": "YAHOO.util.History", "name": "getCurrentState", "url": "YAHOO.util.History.html#method_getCurrentState", "type": "method"}, {"access": "private", "host": "YAHOO.util.History", "name": "_getHash", "url": "YAHOO.util.History.html#method__getHash", "type": "method"}, {"access": "", "host": "YAHOO.util.History", "name": "getQueryStringParameter", "url": "YAHOO.util.History.html#method_getQueryStringParameter", "type": "method"}, {"access": "private", "host": "YAHOO.util.History", "name": "_handleFQStateChange", "url": "YAHOO.util.History.html#method__handleFQStateChange", "type": "method"}, {"access": "private", "host": "YAHOO.util.History", "name": "_histFrame", "url": "YAHOO.util.History.html#property__histFrame", "type": "property"}, {"access": "private", "host": "YAHOO.util.History", "name": "_initialize", "url": "YAHOO.util.History.html#method__initialize", "type": "method"}, {"access": "", "host": "YAHOO.util.History", "name": "initialize", "url": "YAHOO.util.History.html#method_initialize", "type": "method"}, {"access": "private", "host": "YAHOO.util.History", "name": "_initialized", "url": "YAHOO.util.History.html#property__initialized", "type": "property"}, {"access": "private", "host": "YAHOO.util.History", "name": "_modules", "url": "YAHOO.util.History.html#property__modules", "type": "property"}, {"access": "", "host": "YAHOO.util.History", "name": "multiNavigate", "url": "YAHOO.util.History.html#method_multiNavigate", "type": "method"}, {"access": "", "host": "YAHOO.util.History", "name": "navigate", "url": "YAHOO.util.History.html#method_navigate", "type": "method"}, {"access": "", "host": "YAHOO.util.History", "name": "onLoadEvent", "url": "YAHOO.util.History.html#event_onLoadEvent", "type": "event"}, {"access": "", "host": "YAHOO.util.History", "name": "onReady", "url": "YAHOO.util.History.html#method_onReady", "type": "method"}, {"access": "", "host": "YAHOO.util.History", "name": "register", "url": "YAHOO.util.History.html#method_register", "type": "method"}, {"access": "private", "host": "YAHOO.util.History", "name": "_stateField", "url": "YAHOO.util.History.html#property__stateField", "type": "property"}, {"access": "private", "host": "YAHOO.util.History", "name": "_storeStates", "url": "YAHOO.util.History.html#method__storeStates", "type": "method"}, {"access": "private", "host": "YAHOO.util.History", "name": "_updateIFrame", "url": "YAHOO.util.History.html#method__updateIFrame", "type": "method"}];
|
|
</script>
|
|
</body>
|
|
</html>
|