|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
2 <html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#"> |
|
3 <head> |
|
4 <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
|
5 <title>API: history history.js (YUI Library)</title> |
|
6 |
|
7 <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" /> |
|
8 <link rel="stylesheet" type="text/css" href="assets/api.css" /> |
|
9 |
|
10 <script type="text/javascript" src="assets/api-js"></script> |
|
11 <script type="text/javascript" src="assets/ac-js"></script> |
|
12 </head> |
|
13 |
|
14 <body id="yahoo-com"> |
|
15 |
|
16 <div id="doc3" class="yui-t2"> |
|
17 <div id="hd"> |
|
18 <h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1> |
|
19 <h3>history <span class="subtitle">3.0.0b1</span></h3> |
|
20 <a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
21 > <a href="./module_history.html" title="history">history</a> |
|
22 |
|
23 > history.js (source view) |
|
24 <form onsubmit="return false"> |
|
25 <div id="propertysearch"> |
|
26 Search: <input autocomplete="off" id="searchinput" /> |
|
27 <div id="searchresults"> |
|
28 |
|
29 </div> |
|
30 </div> |
|
31 </form> |
|
32 </div> |
|
33 |
|
34 <div id="bd"> |
|
35 <div id="yui-main"> |
|
36 <div class="yui-b"> |
|
37 <form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form"> |
|
38 <fieldset> |
|
39 <legend>Filters</legend> |
|
40 <span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span> |
|
41 <span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span> |
|
42 <span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span> |
|
43 </fieldset> |
|
44 </form> |
|
45 |
|
46 <div id="srcout"> |
|
47 <style> |
|
48 #doc3 .classopts { display:none; } |
|
49 </style> |
|
50 <div class="highlight" ><pre><span class="c">/*global YUI*/</span> |
|
51 |
|
52 <span class="c">/**</span> |
|
53 <span class="c"> * The Browser History Utility provides the ability to use the back/forward</span> |
|
54 <span class="c"> * navigation buttons in a DHTML application. It also allows a DHTML</span> |
|
55 <span class="c"> * application to be bookmarked in a specific state.</span> |
|
56 <span class="c"> *</span> |
|
57 <span class="c"> * This utility requires the following static markup:</span> |
|
58 <span class="c"> *</span> |
|
59 <span class="c"> * &lt;iframe id="yui-history-iframe" src="path-to-real-asset-in-same-domain"&gt;&lt;/iframe&gt;</span> |
|
60 <span class="c"> * &lt;input id="yui-history-field" type="hidden"&gt;</span> |
|
61 <span class="c"> *</span> |
|
62 <span class="c"> * @module history</span> |
|
63 <span class="c"> */</span> |
|
64 |
|
65 <span class="c">/**</span> |
|
66 <span class="c"> * This class represents an instance of the browser history utility.</span> |
|
67 <span class="c"> * @class History</span> |
|
68 <span class="c"> * @constructor</span> |
|
69 <span class="c"> */</span> |
|
70 |
|
71 <span class="c">// SHortcuts...</span> |
|
72 <span class="c"></span> <span class="k">var</span> <span class="nx">L</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Lang</span><span class="o">,</span> |
|
73 <span class="nx">A</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">UA</span><span class="o">,</span> |
|
74 <span class="nx">ET</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Event</span><span class="o">.</span><span class="nx">Target</span><span class="o">,</span> |
|
75 <span class="nx">C</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">config</span><span class="o">,</span> |
|
76 <span class="nx">WH</span> <span class="o">=</span> <span class="nx">C</span><span class="o">.</span><span class="nx">win</span><span class="o">.</span><span class="nx">history</span><span class="o">,</span> |
|
77 <span class="nx">WL</span> <span class="o">=</span> <span class="nx">C</span><span class="o">.</span><span class="nx">win</span><span class="o">.</span><span class="nx">location</span><span class="o">,</span> |
|
78 <span class="nx">DM</span> <span class="o">=</span> <span class="nx">C</span><span class="o">.</span><span class="nx">doc</span><span class="o">.</span><span class="nx">documentMode</span><span class="o">,</span> |
|
79 |
|
80 <span class="nx">encode</span> <span class="o">=</span> <span class="nb">encodeURIComponent</span><span class="o">,</span> |
|
81 <span class="nx">decode</span> <span class="o">=</span> <span class="nb">decodeURIComponent</span><span class="o">,</span> |
|
82 |
|
83 <span class="nx">H</span><span class="o">,</span> <span class="nx">G</span><span class="o">,</span> |
|
84 |
|
85 <span class="c">// YUI Compressor helper...</span> |
|
86 <span class="c"></span> <span class="nx">E_MISSING_OR_INVALID_ARG</span> <span class="o">=</span> <span class="s2">"Missing or invalid argument"</span><span class="o">,</span> |
|
87 |
|
88 <span class="c">// Regular expression used to parse query strings and such.</span> |
|
89 <span class="c"></span> <span class="nx">REGEXP</span> <span class="o">=</span> <span class="sr">/([^=&]+)=([^&]*)/g</span><span class="o">,</span> |
|
90 |
|
91 <span class="c">/**</span> |
|
92 <span class="c"> * @event history:ready</span> |
|
93 <span class="c"> * @description Fires when the browser history utility is ready</span> |
|
94 <span class="c"> * @type Event.Custom</span> |
|
95 <span class="c"> */</span> |
|
96 <span class="nx">EV_HISTORY_READY</span> <span class="o">=</span> <span class="s2">"history:ready"</span><span class="o">,</span> |
|
97 |
|
98 <span class="c">/**</span> |
|
99 <span class="c"> * @event history:globalStateChange</span> |
|
100 <span class="c"> * @description Fires when the global state of the page has changed (that is,</span> |
|
101 <span class="c"> * when the state of at least one browser history module has changed)</span> |
|
102 <span class="c"> * @type Event.Custom</span> |
|
103 <span class="c"> */</span> |
|
104 <span class="nx">EV_HISTORY_GLOBAL_STATE_CHANGE</span> <span class="o">=</span> <span class="s2">"history:globalStateChange"</span><span class="o">,</span> |
|
105 |
|
106 <span class="c">/**</span> |
|
107 <span class="c"> * @event history:moduleStateChange</span> |
|
108 <span class="c"> * @description Fires when the state of a history module object has changed</span> |
|
109 <span class="c"> * @type Event.Custom</span> |
|
110 <span class="c"> */</span> |
|
111 <span class="nx">EV_HISTORY_MODULE_STATE_CHANGE</span> <span class="o">=</span> <span class="s2">"history:moduleStateChange"</span><span class="o">;</span> |
|
112 |
|
113 |
|
114 <span class="k">if</span> <span class="o">(!</span><span class="nx">YUI</span><span class="o">.</span><span class="nx">Env</span><span class="o">.</span><span class="nx">history</span><span class="o">)</span> <span class="o">{</span> |
|
115 |
|
116 <span class="nx">YUI</span><span class="o">.</span><span class="nx">Env</span><span class="o">.</span><span class="nx">history</span> <span class="o">=</span> <span class="nx">G</span> <span class="o">=</span> <span class="o">{</span> |
|
117 |
|
118 <span class="c">// Flag used to tell whether the history utility is ready to be used.</span> |
|
119 <span class="c"></span> <span class="nx">ready</span><span class="o">:</span> <span class="kc">false</span><span class="o">,</span> |
|
120 |
|
121 <span class="c">// List of registered modules.</span> |
|
122 <span class="c"></span> <span class="nx">_modules</span><span class="o">:</span> <span class="o">[],</span> |
|
123 |
|
124 <span class="c">// List of fully qualified states. This is used only by Safari.</span> |
|
125 <span class="c"></span> <span class="nx">_fqstates</span><span class="o">:</span> <span class="o">[],</span> |
|
126 |
|
127 <span class="c">// INPUT field (with type="hidden" or type="text") or TEXTAREA.</span> |
|
128 <span class="c"></span> <span class="c">// This field keeps the value of the initial state, current state</span> |
|
129 <span class="c"></span> <span class="c">// the list of all states across pages within a single browser session.</span> |
|
130 <span class="c"></span> <span class="nx">_stateField</span><span class="o">:</span> <span class="kc">null</span><span class="o">,</span> |
|
131 |
|
132 <span class="c">// Hidden IFrame used to store the browsing history on IE6/7.</span> |
|
133 <span class="c"></span> <span class="nx">_historyIFrame</span><span class="o">:</span> <span class="kc">null</span> |
|
134 <span class="o">};</span> |
|
135 |
|
136 <span class="o">}</span> |
|
137 |
|
138 <span class="c">/**</span> |
|
139 <span class="c"> * Returns the portion of the hash after the '#' symbol.</span> |
|
140 <span class="c"> * @method _getHash</span> |
|
141 <span class="c"> * @return {string} The hash portion of the document's location</span> |
|
142 <span class="c"> * @private</span> |
|
143 <span class="c"> */</span> |
|
144 <span class="k">function</span> <span class="nx">_getHash</span><span class="o">()</span> <span class="o">{</span> |
|
145 <span class="k">return</span> <span class="nx">WL</span><span class="o">.</span><span class="nx">hash</span><span class="o">.</span><span class="nx">substr</span><span class="o">(</span><span class="m">1</span><span class="o">);</span> |
|
146 <span class="o">}</span> |
|
147 |
|
148 <span class="c">/**</span> |
|
149 <span class="c"> * Stores the initial state and current state for all registered modules.</span> |
|
150 <span class="c"> * On Safari, we also store all the fully qualified states visited by</span> |
|
151 <span class="c"> * the application within a single browser session. The storage takes</span> |
|
152 <span class="c"> * place in the form field specified during initialization.</span> |
|
153 <span class="c"> * @method _storeStates</span> |
|
154 <span class="c"> * @private</span> |
|
155 <span class="c"> */</span> |
|
156 <span class="k">function</span> <span class="nx">_storeStates</span><span class="o">()</span> <span class="o">{</span> |
|
157 |
|
158 <span class="k">var</span> <span class="nx">initialStates</span> <span class="o">=</span> <span class="o">[],</span> <span class="nx">currentStates</span> <span class="o">=</span> <span class="o">[],</span> <span class="nx">s</span><span class="o">;</span> |
|
159 |
|
160 <span class="nx">Y</span><span class="o">.</span><span class="nb">Object</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">G</span><span class="o">.</span><span class="nx">_modules</span><span class="o">,</span> <span class="k">function</span> <span class="o">(</span><span class="nx">module</span><span class="o">,</span> <span class="nx">moduleId</span><span class="o">)</span> <span class="o">{</span> |
|
161 <span class="nx">initialStates</span><span class="o">.</span><span class="nx">push</span><span class="o">(</span><span class="nx">moduleId</span> <span class="o">+</span> <span class="s2">"="</span> <span class="o">+</span> <span class="nx">module</span><span class="o">.</span><span class="nx">initialState</span><span class="o">);</span> |
|
162 <span class="nx">currentStates</span><span class="o">.</span><span class="nx">push</span><span class="o">(</span><span class="nx">moduleId</span> <span class="o">+</span> <span class="s2">"="</span> <span class="o">+</span> <span class="nx">module</span><span class="o">.</span><span class="nx">currentState</span><span class="o">);</span> |
|
163 <span class="o">});</span> |
|
164 |
|
165 <span class="nx">s</span> <span class="o">=</span> <span class="nx">initialStates</span><span class="o">.</span><span class="nx">join</span><span class="o">(</span><span class="s2">"&"</span><span class="o">)</span> <span class="o">+</span> <span class="s2">"|"</span> <span class="o">+</span> <span class="nx">currentStates</span><span class="o">.</span><span class="nx">join</span><span class="o">(</span><span class="s2">"&"</span><span class="o">);</span> |
|
166 |
|
167 <span class="k">if</span> <span class="o">(</span><span class="nx">A</span><span class="o">.</span><span class="nx">webkit</span><span class="o">)</span> <span class="o">{</span> |
|
168 <span class="nx">s</span> <span class="o">+=</span> <span class="s2">"|"</span> <span class="o">+</span> <span class="nx">G</span><span class="o">.</span><span class="nx">_fqstates</span><span class="o">.</span><span class="nx">join</span><span class="o">(</span><span class="s2">","</span><span class="o">);</span> |
|
169 <span class="o">}</span> |
|
170 |
|
171 <span class="nx">G</span><span class="o">.</span><span class="nx">_stateField</span><span class="o">.</span><span class="nx">set</span><span class="o">(</span><span class="s2">"value"</span><span class="o">,</span> <span class="nx">s</span><span class="o">);</span> |
|
172 <span class="o">}</span> |
|
173 |
|
174 <span class="c">/**</span> |
|
175 <span class="c"> * Sets the new currentState attribute of all modules depending on the new fully</span> |
|
176 <span class="c"> * qualified state. Also notifies the modules which current state has changed.</span> |
|
177 <span class="c"> * @method _handleFQStateChange</span> |
|
178 <span class="c"> * @param {string} fqstate fully qualified state</span> |
|
179 <span class="c"> * @private</span> |
|
180 <span class="c"> */</span> |
|
181 <span class="k">function</span> <span class="nx">_handleFQStateChange</span><span class="o">(</span><span class="nx">fqstate</span><span class="o">)</span> <span class="o">{</span> |
|
182 |
|
183 <span class="k">var</span> <span class="nx">m</span><span class="o">,</span> <span class="nx">modules</span><span class="o">,</span> <span class="nx">globalStateChanged</span> <span class="o">=</span> <span class="kc">false</span><span class="o">;</span> |
|
184 |
|
185 <span class="k">if</span> <span class="o">(!</span><span class="nx">fqstate</span><span class="o">)</span> <span class="o">{</span> |
|
186 |
|
187 <span class="nx">Y</span><span class="o">.</span><span class="nb">Object</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">G</span><span class="o">.</span><span class="nx">_modules</span><span class="o">,</span> <span class="k">function</span> <span class="o">(</span><span class="nx">module</span><span class="o">,</span> <span class="nx">moduleId</span><span class="o">)</span> <span class="o">{</span> |
|
188 <span class="k">if</span> <span class="o">(</span><span class="nx">module</span><span class="o">.</span><span class="nx">currentState</span> <span class="o">!==</span> <span class="nx">module</span><span class="o">.</span><span class="nx">initialState</span><span class="o">)</span> <span class="o">{</span> |
|
189 <span class="nx">module</span><span class="o">.</span><span class="nx">currentState</span> <span class="o">=</span> <span class="nx">module</span><span class="o">.</span><span class="nx">initialState</span><span class="o">;</span> |
|
190 <span class="nx">module</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="nx">EV_HISTORY_MODULE_STATE_CHANGE</span><span class="o">,</span> <span class="nx">module</span><span class="o">.</span><span class="nx">currentState</span><span class="o">);</span> |
|
191 <span class="nx">globalStateChanged</span> <span class="o">=</span> <span class="kc">true</span><span class="o">;</span> |
|
192 <span class="o">}</span> |
|
193 <span class="o">});</span> |
|
194 |
|
195 <span class="k">if</span> <span class="o">(</span><span class="nx">globalStateChanged</span><span class="o">)</span> <span class="o">{</span> |
|
196 <span class="nx">H</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="nx">EV_HISTORY_GLOBAL_STATE_CHANGE</span><span class="o">);</span> |
|
197 <span class="o">}</span> |
|
198 |
|
199 <span class="k">return</span><span class="o">;</span> |
|
200 <span class="o">}</span> |
|
201 |
|
202 <span class="nx">modules</span> <span class="o">=</span> <span class="o">[];</span> |
|
203 <span class="nx">REGEXP</span><span class="o">.</span><span class="nx">lastIndex</span> <span class="o">=</span> <span class="m">0</span><span class="o">;</span> |
|
204 <span class="k">while</span> <span class="o">((</span><span class="nx">m</span> <span class="o">=</span> <span class="nx">REGEXP</span><span class="o">.</span><span class="nx">exec</span><span class="o">(</span><span class="nx">fqstate</span><span class="o">)))</span> <span class="o">{</span> |
|
205 <span class="nx">modules</span><span class="o">[</span><span class="nx">m</span><span class="o">[</span><span class="m">1</span><span class="o">]]</span> <span class="o">=</span> <span class="nx">m</span><span class="o">[</span><span class="m">2</span><span class="o">];</span> |
|
206 <span class="o">}</span> |
|
207 |
|
208 <span class="nx">Y</span><span class="o">.</span><span class="nb">Object</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">G</span><span class="o">.</span><span class="nx">_modules</span><span class="o">,</span> <span class="k">function</span> <span class="o">(</span><span class="nx">module</span><span class="o">,</span> <span class="nx">moduleId</span><span class="o">)</span> <span class="o">{</span> |
|
209 |
|
210 <span class="k">var</span> <span class="nx">currentState</span> <span class="o">=</span> <span class="nx">modules</span><span class="o">[</span><span class="nx">moduleId</span><span class="o">];</span> |
|
211 |
|
212 <span class="k">if</span> <span class="o">(!</span><span class="nx">currentState</span> <span class="o">||</span> <span class="nx">module</span><span class="o">.</span><span class="nx">currentState</span> <span class="o">!==</span> <span class="nx">currentState</span><span class="o">)</span> <span class="o">{</span> |
|
213 <span class="nx">module</span><span class="o">.</span><span class="nx">currentState</span> <span class="o">=</span> <span class="nx">currentState</span> <span class="o">||</span> <span class="nx">module</span><span class="o">.</span><span class="nx">initialState</span><span class="o">;</span> |
|
214 <span class="nx">module</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="nx">EV_HISTORY_MODULE_STATE_CHANGE</span><span class="o">,</span> <span class="nx">module</span><span class="o">.</span><span class="nx">currentState</span><span class="o">);</span> |
|
215 <span class="nx">globalStateChanged</span> <span class="o">=</span> <span class="kc">true</span><span class="o">;</span> |
|
216 <span class="o">}</span> |
|
217 <span class="o">});</span> |
|
218 |
|
219 <span class="k">if</span> <span class="o">(</span><span class="nx">globalStateChanged</span><span class="o">)</span> <span class="o">{</span> |
|
220 <span class="nx">H</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="nx">EV_HISTORY_GLOBAL_STATE_CHANGE</span><span class="o">);</span> |
|
221 <span class="o">}</span> |
|
222 <span class="o">}</span> |
|
223 |
|
224 <span class="c">/**</span> |
|
225 <span class="c"> * Update the IFrame with our new state.</span> |
|
226 <span class="c"> * @method _updateIFrame</span> |
|
227 <span class="c"> * @private</span> |
|
228 <span class="c"> * @return {boolean} true if successful. false otherwise.</span> |
|
229 <span class="c"> */</span> |
|
230 <span class="k">function</span> <span class="nx">_updateIFrame</span><span class="o">(</span><span class="nx">fqstate</span><span class="o">)</span> <span class="o">{</span> |
|
231 |
|
232 <span class="k">var</span> <span class="nx">html</span><span class="o">,</span> <span class="nx">doc</span><span class="o">;</span> |
|
233 |
|
234 <span class="nx">html</span> <span class="o">=</span> <span class="s1">'<html><body>'</span> <span class="o">+</span> <span class="nx">fqstate</span> <span class="o">+</span> <span class="s1">'</body></html>'</span><span class="o">;</span> |
|
235 |
|
236 <span class="k">try</span> <span class="o">{</span> |
|
237 <span class="nx">doc</span> <span class="o">=</span> <span class="nx">G</span><span class="o">.</span><span class="nx">_historyIFrame</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="s2">"contentWindow.document"</span><span class="o">);</span> |
|
238 <span class="c">// TODO: The Node API should expose these methods in the very near future...</span> |
|
239 <span class="c"></span> <span class="nx">doc</span><span class="o">.</span><span class="nx">invoke</span><span class="o">(</span><span class="s1">'open'</span><span class="o">);</span> |
|
240 <span class="nx">doc</span><span class="o">.</span><span class="nx">invoke</span><span class="o">(</span><span class="s1">'write'</span><span class="o">,</span> <span class="nx">html</span><span class="o">,</span> <span class="s1">''</span><span class="o">,</span> <span class="s1">''</span><span class="o">,</span> <span class="s1">''</span><span class="o">,</span> <span class="s1">''</span><span class="o">);</span> <span class="c">// see bug #2447937</span> |
|
241 <span class="c"></span> <span class="nx">doc</span><span class="o">.</span><span class="nx">invoke</span><span class="o">(</span><span class="s1">'close'</span><span class="o">);</span> |
|
242 <span class="k">return</span> <span class="kc">true</span><span class="o">;</span> |
|
243 <span class="o">}</span> <span class="k">catch</span> <span class="o">(</span><span class="nx">e</span><span class="o">)</span> <span class="o">{</span> |
|
244 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"Exception while storing a new browser history entry: "</span> <span class="o">+</span> <span class="nx">e</span><span class="o">,</span> <span class="s2">"info"</span><span class="o">,</span> <span class="s2">"history"</span><span class="o">);</span> |
|
245 <span class="k">return</span> <span class="kc">false</span><span class="o">;</span> |
|
246 <span class="o">}</span> |
|
247 <span class="o">}</span> |
|
248 |
|
249 <span class="c">/**</span> |
|
250 <span class="c"> * Periodically checks whether our internal IFrame is ready to be used</span> |
|
251 <span class="c"> * @method _checkIframeLoaded</span> |
|
252 <span class="c"> * @private</span> |
|
253 <span class="c"> */</span> |
|
254 <span class="k">function</span> <span class="nx">_checkIframeLoaded</span><span class="o">()</span> <span class="o">{</span> |
|
255 |
|
256 <span class="k">var</span> <span class="nx">elem</span><span class="o">,</span> <span class="nx">fqstate</span><span class="o">,</span> <span class="nx">hash</span><span class="o">;</span> |
|
257 |
|
258 <span class="k">if</span> <span class="o">(!</span><span class="nx">G</span><span class="o">.</span><span class="nx">_historyIFrame</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="s2">"contentWindow.document"</span><span class="o">))</span> <span class="o">{</span> |
|
259 <span class="c">// Check again in 10 msec...</span> |
|
260 <span class="c"></span> <span class="nx">setTimeout</span><span class="o">(</span><span class="nx">_checkIframeLoaded</span><span class="o">,</span> <span class="m">10</span><span class="o">);</span> |
|
261 <span class="k">return</span><span class="o">;</span> |
|
262 <span class="o">}</span> |
|
263 |
|
264 <span class="c">// Start the thread that will have the responsibility to</span> |
|
265 <span class="c"></span> <span class="c">// periodically check whether a navigate operation has been</span> |
|
266 <span class="c"></span> <span class="c">// requested on the main window. This will happen when</span> |
|
267 <span class="c"></span> <span class="c">// History.navigate has been called or after the user has</span> |
|
268 <span class="c"></span> <span class="c">// hit the back/forward button.</span> |
|
269 <span class="c"></span> <span class="nx">elem</span> <span class="o">=</span> <span class="nx">G</span><span class="o">.</span><span class="nx">_historyIFrame</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="s1">'contentWindow.document.body'</span><span class="o">);</span> |
|
270 <span class="c">// We must use innerText, and not innerHTML because our string contains</span> |
|
271 <span class="c"></span> <span class="c">// the "&" character (which would end up being escaped as "&amp;") and</span> |
|
272 <span class="c"></span> <span class="c">// the string comparison would fail...</span> |
|
273 <span class="c"></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="o">.</span><span class="nx">get</span><span class="o">(</span><span class="s2">"innerText"</span><span class="o">)</span> <span class="o">:</span> <span class="kc">null</span><span class="o">;</span> |
|
274 |
|
275 <span class="nx">hash</span> <span class="o">=</span> <span class="nx">_getHash</span><span class="o">();</span> |
|
276 |
|
277 <span class="nx">setInterval</span><span class="o">(</span><span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
278 |
|
279 <span class="k">var</span> <span class="nx">newfqstate</span><span class="o">,</span> <span class="nx">states</span><span class="o">,</span> <span class="nx">newHash</span><span class="o">;</span> |
|
280 |
|
281 <span class="nx">elem</span> <span class="o">=</span> <span class="nx">G</span><span class="o">.</span><span class="nx">_historyIFrame</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="s1">'contentWindow.document.body'</span><span class="o">);</span> |
|
282 <span class="c">// See my comment above about using innerText instead of innerHTML...</span> |
|
283 <span class="c"></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="o">.</span><span class="nx">get</span><span class="o">(</span><span class="s2">"innerText"</span><span class="o">)</span> <span class="o">:</span> <span class="kc">null</span><span class="o">;</span> |
|
284 |
|
285 <span class="nx">newHash</span> <span class="o">=</span> <span class="nx">_getHash</span><span class="o">();</span> |
|
286 |
|
287 <span class="k">if</span> <span class="o">(</span><span class="nx">newfqstate</span> <span class="o">!==</span> <span class="nx">fqstate</span><span class="o">)</span> <span class="o">{</span> |
|
288 |
|
289 <span class="nx">fqstate</span> <span class="o">=</span> <span class="nx">newfqstate</span><span class="o">;</span> |
|
290 <span class="nx">_handleFQStateChange</span><span class="o">(</span><span class="nx">fqstate</span><span class="o">);</span> |
|
291 |
|
292 <span class="k">if</span> <span class="o">(!</span><span class="nx">fqstate</span><span class="o">)</span> <span class="o">{</span> |
|
293 <span class="nx">states</span> <span class="o">=</span> <span class="o">[];</span> |
|
294 <span class="nx">Y</span><span class="o">.</span><span class="nb">Object</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">G</span><span class="o">.</span><span class="nx">_modules</span><span class="o">,</span> <span class="k">function</span> <span class="o">(</span><span class="nx">module</span><span class="o">,</span> <span class="nx">moduleId</span><span class="o">)</span> <span class="o">{</span> |
|
295 <span class="nx">states</span><span class="o">.</span><span class="nx">push</span><span class="o">(</span><span class="nx">moduleId</span> <span class="o">+</span> <span class="s2">"="</span> <span class="o">+</span> <span class="nx">module</span><span class="o">.</span><span class="nx">initialState</span><span class="o">);</span> |
|
296 <span class="o">});</span> |
|
297 <span class="nx">newHash</span> <span class="o">=</span> <span class="nx">states</span><span class="o">.</span><span class="nx">join</span><span class="o">(</span><span class="s2">"&"</span><span class="o">);</span> |
|
298 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
299 <span class="nx">newHash</span> <span class="o">=</span> <span class="nx">fqstate</span><span class="o">;</span> |
|
300 <span class="o">}</span> |
|
301 |
|
302 <span class="c">// Allow the state to be bookmarked by setting the top window's</span> |
|
303 <span class="c"></span> <span class="c">// URL fragment identifier. Note that here, we are on IE < 8</span> |
|
304 <span class="c"></span> <span class="c">// which does not touch the browser history when changing the</span> |
|
305 <span class="c"></span> <span class="c">// hash (unlike all the other browsers).</span> |
|
306 <span class="c"></span> <span class="nx">WL</span><span class="o">.</span><span class="nx">hash</span> <span class="o">=</span> <span class="nx">hash</span> <span class="o">=</span> <span class="nx">newHash</span><span class="o">;</span> |
|
307 |
|
308 <span class="nx">_storeStates</span><span class="o">();</span> |
|
309 |
|
310 <span class="o">}</span> <span class="k">else</span> <span class="k">if</span> <span class="o">(</span><span class="nx">newHash</span> <span class="o">!==</span> <span class="nx">hash</span><span class="o">)</span> <span class="o">{</span> |
|
311 |
|
312 <span class="c">// The hash has changed. The user might have clicked on a link,</span> |
|
313 <span class="c"></span> <span class="c">// or modified the URL directly, or opened the same application</span> |
|
314 <span class="c"></span> <span class="c">// bookmarked in a specific state using a bookmark. However, we</span> |
|
315 <span class="c"></span> <span class="c">// know the hash change was not caused by a hit on the back or</span> |
|
316 <span class="c"></span> <span class="c">// forward buttons, or by a call to navigate() (because it would</span> |
|
317 <span class="c"></span> <span class="c">// have been handled above) We must handle these cases, which is</span> |
|
318 <span class="c"></span> <span class="c">// why we also need to keep track of hash changes on IE!</span> |
|
319 <span class="c"></span> |
|
320 <span class="c">// Note that IE6 has some major issues with this kind of user</span> |
|
321 <span class="c"></span> <span class="c">// interaction (the history stack gets completely messed up)</span> |
|
322 <span class="c"></span> <span class="c">// but it seems to work fine on IE7.</span> |
|
323 <span class="c"></span> |
|
324 <span class="nx">hash</span> <span class="o">=</span> <span class="nx">newHash</span><span class="o">;</span> |
|
325 |
|
326 <span class="c">// Now, store a new history entry. The following will cause the</span> |
|
327 <span class="c"></span> <span class="c">// code above to execute, doing all the dirty work for us...</span> |
|
328 <span class="c"></span> <span class="nx">_updateIFrame</span><span class="o">(</span><span class="nx">newHash</span><span class="o">);</span> |
|
329 <span class="o">}</span> |
|
330 |
|
331 <span class="o">},</span> <span class="m">50</span><span class="o">);</span> |
|
332 |
|
333 <span class="nx">G</span><span class="o">.</span><span class="nx">ready</span> <span class="o">=</span> <span class="kc">true</span><span class="o">;</span> |
|
334 <span class="nx">H</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="nx">EV_HISTORY_READY</span><span class="o">);</span> |
|
335 <span class="o">}</span> |
|
336 |
|
337 <span class="c">/**</span> |
|
338 <span class="c"> * Finish up the initialization of the browser utility library.</span> |
|
339 <span class="c"> * @method _initialize</span> |
|
340 <span class="c"> * @private</span> |
|
341 <span class="c"> */</span> |
|
342 <span class="k">function</span> <span class="nx">_initialize</span><span class="o">()</span> <span class="o">{</span> |
|
343 |
|
344 <span class="k">var</span> <span class="nx">m</span><span class="o">,</span> <span class="nx">parts</span><span class="o">,</span> <span class="nx">moduleId</span><span class="o">,</span> <span class="nx">module</span><span class="o">,</span> <span class="nx">initialState</span><span class="o">,</span> <span class="nx">currentState</span><span class="o">,</span> <span class="nx">counter</span><span class="o">,</span> <span class="nx">hash</span><span class="o">;</span> |
|
345 |
|
346 <span class="c">// Decode the content of our storage field...</span> |
|
347 <span class="c"></span> <span class="nx">parts</span> <span class="o">=</span> <span class="nx">G</span><span class="o">.</span><span class="nx">_stateField</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="s2">"value"</span><span class="o">).</span><span class="nx">split</span><span class="o">(</span><span class="s2">"|"</span><span class="o">);</span> |
|
348 |
|
349 <span class="k">if</span> <span class="o">(</span><span class="nx">parts</span><span class="o">.</span><span class="nx">length</span> <span class="o">></span> <span class="m">1</span><span class="o">)</span> <span class="o">{</span> |
|
350 |
|
351 <span class="nx">REGEXP</span><span class="o">.</span><span class="nx">lastIndex</span> <span class="o">=</span> <span class="m">0</span><span class="o">;</span> |
|
352 <span class="k">while</span> <span class="o">((</span><span class="nx">m</span> <span class="o">=</span> <span class="nx">REGEXP</span><span class="o">.</span><span class="nx">exec</span><span class="o">(</span><span class="nx">parts</span><span class="o">[</span><span class="m">0</span><span class="o">])))</span> <span class="o">{</span> |
|
353 <span class="nx">moduleId</span> <span class="o">=</span> <span class="nx">m</span><span class="o">[</span><span class="m">1</span><span class="o">];</span> |
|
354 <span class="nx">initialState</span> <span class="o">=</span> <span class="nx">m</span><span class="o">[</span><span class="m">2</span><span class="o">];</span> |
|
355 <span class="nx">module</span> <span class="o">=</span> <span class="nx">G</span><span class="o">.</span><span class="nx">_modules</span><span class="o">[</span><span class="nx">moduleId</span><span class="o">];</span> |
|
356 <span class="k">if</span> <span class="o">(</span><span class="nx">module</span><span class="o">)</span> <span class="o">{</span> |
|
357 <span class="nx">module</span><span class="o">.</span><span class="nx">initialState</span> <span class="o">=</span> <span class="nx">initialState</span><span class="o">;</span> |
|
358 <span class="o">}</span> |
|
359 <span class="o">}</span> |
|
360 |
|
361 <span class="nx">REGEXP</span><span class="o">.</span><span class="nx">lastIndex</span> <span class="o">=</span> <span class="m">0</span><span class="o">;</span> |
|
362 <span class="k">while</span> <span class="o">((</span><span class="nx">m</span> <span class="o">=</span> <span class="nx">REGEXP</span><span class="o">.</span><span class="nx">exec</span><span class="o">(</span><span class="nx">parts</span><span class="o">[</span><span class="m">1</span><span class="o">])))</span> <span class="o">{</span> |
|
363 <span class="nx">moduleId</span> <span class="o">=</span> <span class="nx">m</span><span class="o">[</span><span class="m">1</span><span class="o">];</span> |
|
364 <span class="nx">currentState</span> <span class="o">=</span> <span class="nx">m</span><span class="o">[</span><span class="m">2</span><span class="o">];</span> |
|
365 <span class="nx">module</span> <span class="o">=</span> <span class="nx">G</span><span class="o">.</span><span class="nx">_modules</span><span class="o">[</span><span class="nx">moduleId</span><span class="o">];</span> |
|
366 <span class="k">if</span> <span class="o">(</span><span class="nx">module</span><span class="o">)</span> <span class="o">{</span> |
|
367 <span class="nx">module</span><span class="o">.</span><span class="nx">currentState</span> <span class="o">=</span> <span class="nx">currentState</span><span class="o">;</span> |
|
368 <span class="o">}</span> |
|
369 <span class="o">}</span> |
|
370 <span class="o">}</span> |
|
371 |
|
372 <span class="k">if</span> <span class="o">(</span><span class="nx">parts</span><span class="o">.</span><span class="nx">length</span> <span class="o">></span> <span class="m">2</span><span class="o">)</span> <span class="o">{</span> |
|
373 <span class="nx">G</span><span class="o">.</span><span class="nx">_fqstates</span> <span class="o">=</span> <span class="nx">parts</span><span class="o">[</span><span class="m">2</span><span class="o">].</span><span class="nx">split</span><span class="o">(</span><span class="s2">","</span><span class="o">);</span> |
|
374 <span class="o">}</span> |
|
375 |
|
376 <span class="k">if</span> <span class="o">(</span><span class="nx">A</span><span class="o">.</span><span class="nx">ie</span><span class="o">)</span> <span class="o">{</span> |
|
377 |
|
378 <span class="k">if</span> <span class="o">(</span><span class="nx">L</span><span class="o">.</span><span class="nx">isUndefined</span><span class="o">(</span><span class="nx">DM</span><span class="o">)</span> <span class="o">||</span> <span class="nx">DM</span> <span class="o"><</span> <span class="m">8</span><span class="o">)</span> <span class="o">{</span> |
|
379 |
|
380 <span class="c">// IE < 8 or IE8 in quirks mode or IE7 standards mode</span> |
|
381 <span class="c"></span> <span class="nx">_checkIframeLoaded</span><span class="o">();</span> |
|
382 |
|
383 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
384 |
|
385 <span class="c">// IE8 in IE8 standards mode</span> |
|
386 <span class="c"></span> <span class="nx">Y</span><span class="o">.</span><span class="nx">on</span><span class="o">(</span><span class="s2">"hashchange"</span><span class="o">,</span> <span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
387 <span class="k">var</span> <span class="nx">hash</span> <span class="o">=</span> <span class="nx">_getHash</span><span class="o">();</span> |
|
388 <span class="nx">_handleFQStateChange</span><span class="o">(</span><span class="nx">hash</span><span class="o">);</span> |
|
389 <span class="nx">_storeStates</span><span class="o">();</span> |
|
390 <span class="o">},</span> <span class="nb">window</span><span class="o">);</span> |
|
391 |
|
392 <span class="nx">G</span><span class="o">.</span><span class="nx">ready</span> <span class="o">=</span> <span class="kc">true</span><span class="o">;</span> |
|
393 <span class="nx">H</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="nx">EV_HISTORY_READY</span><span class="o">);</span> |
|
394 <span class="o">}</span> |
|
395 |
|
396 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
397 |
|
398 <span class="c">// Start the thread that will have the responsibility to</span> |
|
399 <span class="c"></span> <span class="c">// periodically check whether a navigate operation has been</span> |
|
400 <span class="c"></span> <span class="c">// requested on the main window. This will happen when</span> |
|
401 <span class="c"></span> <span class="c">// YAHOO.util.History.navigate has been called or after</span> |
|
402 <span class="c"></span> <span class="c">// the user has hit the back/forward button.</span> |
|
403 <span class="c"></span> |
|
404 <span class="c">// On Safari 1.x and 2.0, the only way to catch a back/forward</span> |
|
405 <span class="c"></span> <span class="c">// operation is to watch history.length... We basically exploit</span> |
|
406 <span class="c"></span> <span class="c">// what I consider to be a bug (history.length is not supposed</span> |
|
407 <span class="c"></span> <span class="c">// to change when going back/forward in the history...) This is</span> |
|
408 <span class="c"></span> <span class="c">// why, in the following thread, we first compare the hash,</span> |
|
409 <span class="c"></span> <span class="c">// because the hash thing will be fixed in the next major</span> |
|
410 <span class="c"></span> <span class="c">// version of Safari. So even if they fix the history.length</span> |
|
411 <span class="c"></span> <span class="c">// bug, all this will still work!</span> |
|
412 <span class="c"></span> <span class="nx">counter</span> <span class="o">=</span> <span class="nx">WH</span><span class="o">.</span><span class="nx">length</span><span class="o">;</span> |
|
413 |
|
414 <span class="c">// On Gecko and Opera, we just need to watch the hash...</span> |
|
415 <span class="c"></span> <span class="nx">hash</span> <span class="o">=</span> <span class="nx">_getHash</span><span class="o">();</span> |
|
416 |
|
417 <span class="nx">setInterval</span><span class="o">(</span><span class="k">function</span> <span class="o">()</span> <span class="o">{</span> |
|
418 |
|
419 <span class="k">var</span> <span class="nx">state</span><span class="o">,</span> <span class="nx">newHash</span><span class="o">,</span> <span class="nx">newCounter</span><span class="o">;</span> |
|
420 |
|
421 <span class="nx">newHash</span> <span class="o">=</span> <span class="nx">_getHash</span><span class="o">();</span> |
|
422 <span class="nx">newCounter</span> <span class="o">=</span> <span class="nx">WH</span><span class="o">.</span><span class="nx">length</span><span class="o">;</span> |
|
423 <span class="k">if</span> <span class="o">(</span><span class="nx">newHash</span> <span class="o">!==</span> <span class="nx">hash</span><span class="o">)</span> <span class="o">{</span> |
|
424 <span class="nx">hash</span> <span class="o">=</span> <span class="nx">newHash</span><span class="o">;</span> |
|
425 <span class="nx">counter</span> <span class="o">=</span> <span class="nx">newCounter</span><span class="o">;</span> |
|
426 <span class="nx">_handleFQStateChange</span><span class="o">(</span><span class="nx">hash</span><span class="o">);</span> |
|
427 <span class="nx">_storeStates</span><span class="o">();</span> |
|
428 <span class="o">}</span> <span class="k">else</span> <span class="k">if</span> <span class="o">(</span><span class="nx">newCounter</span> <span class="o">!==</span> <span class="nx">counter</span> <span class="o">&&</span> <span class="nx">A</span><span class="o">.</span><span class="nx">webkit</span><span class="o">)</span> <span class="o">{</span> |
|
429 <span class="nx">hash</span> <span class="o">=</span> <span class="nx">newHash</span><span class="o">;</span> |
|
430 <span class="nx">counter</span> <span class="o">=</span> <span class="nx">newCounter</span><span class="o">;</span> |
|
431 <span class="nx">state</span> <span class="o">=</span> <span class="nx">G</span><span class="o">.</span><span class="nx">_fqstates</span><span class="o">[</span><span class="nx">counter</span> <span class="o">-</span> <span class="m">1</span><span class="o">];</span> |
|
432 <span class="nx">_handleFQStateChange</span><span class="o">(</span><span class="nx">state</span><span class="o">);</span> |
|
433 <span class="nx">_storeStates</span><span class="o">();</span> |
|
434 <span class="o">}</span> |
|
435 |
|
436 <span class="o">},</span> <span class="m">50</span><span class="o">);</span> |
|
437 |
|
438 <span class="nx">G</span><span class="o">.</span><span class="nx">ready</span> <span class="o">=</span> <span class="kc">true</span><span class="o">;</span> |
|
439 <span class="nx">H</span><span class="o">.</span><span class="nx">fire</span><span class="o">(</span><span class="nx">EV_HISTORY_READY</span><span class="o">);</span> |
|
440 <span class="o">}</span> |
|
441 <span class="o">}</span> |
|
442 |
|
443 |
|
444 <span class="nx">H</span> <span class="o">=</span> <span class="o">{</span> |
|
445 |
|
446 <span class="c">/**</span> |
|
447 <span class="c"> * Registers a new module.</span> |
|
448 <span class="c"> * @method register</span> |
|
449 <span class="c"> * @param {string} moduleId Non-empty string uniquely identifying the</span> |
|
450 <span class="c"> * module you wish to register.</span> |
|
451 <span class="c"> * @param {string} initialState The initial state of the specified</span> |
|
452 <span class="c"> * module corresponding to its earliest history entry.</span> |
|
453 <span class="c"> * @return {History.Module} The newly registered module</span> |
|
454 <span class="c"> */</span> |
|
455 <span class="nx">register</span><span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">moduleId</span><span class="o">,</span> <span class="nx">initialState</span><span class="o">)</span> <span class="o">{</span> |
|
456 |
|
457 <span class="k">var</span> <span class="nx">module</span><span class="o">;</span> |
|
458 |
|
459 <span class="k">if</span> <span class="o">(!</span><span class="nx">L</span><span class="o">.</span><span class="nx">isString</span><span class="o">(</span><span class="nx">moduleId</span><span class="o">)</span> <span class="o">||</span> <span class="nx">L</span><span class="o">.</span><span class="nx">trim</span><span class="o">(</span><span class="nx">moduleId</span><span class="o">)</span> <span class="o">===</span> <span class="s2">""</span> <span class="o">||</span> <span class="o">!</span><span class="nx">L</span><span class="o">.</span><span class="nx">isString</span><span class="o">(</span><span class="nx">initialState</span><span class="o">))</span> <span class="o">{</span> |
|
460 <span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="o">(</span><span class="nx">E_MISSING_OR_INVALID_ARG</span><span class="o">);</span> |
|
461 <span class="o">}</span> |
|
462 |
|
463 <span class="k">if</span> <span class="o">(</span><span class="nx">G</span><span class="o">.</span><span class="nx">_modules</span><span class="o">[</span><span class="nx">moduleId</span><span class="o">])</span> <span class="o">{</span> |
|
464 <span class="c">// The module seems to have already been registered.</span> |
|
465 <span class="c"></span> <span class="k">return</span><span class="o">;</span> |
|
466 <span class="o">}</span> |
|
467 |
|
468 <span class="c">// Note: A module CANNOT be registered once the browser history</span> |
|
469 <span class="c"></span> <span class="c">// utility has been initialized. We could relax this in the future,</span> |
|
470 <span class="c"></span> <span class="c">// but that would mean that some states may be lost once the user</span> |
|
471 <span class="c"></span> <span class="c">// leaves the page and then comes back to it.</span> |
|
472 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">G</span><span class="o">.</span><span class="nx">ready</span><span class="o">)</span> <span class="o">{</span> |
|
473 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"All modules must be registered before initializing the browser history utility"</span><span class="o">,</span> <span class="s2">"info"</span><span class="o">,</span> <span class="s2">"history"</span><span class="o">);</span> |
|
474 <span class="k">return</span> <span class="kc">null</span><span class="o">;</span> |
|
475 <span class="o">}</span> |
|
476 |
|
477 <span class="c">// Make sure the strings passed in do not contain our separators "," and "|"</span> |
|
478 <span class="c"></span> <span class="nx">moduleId</span> <span class="o">=</span> <span class="nx">encode</span><span class="o">(</span><span class="nx">moduleId</span><span class="o">);</span> |
|
479 <span class="nx">initialState</span> <span class="o">=</span> <span class="nx">encode</span><span class="o">(</span><span class="nx">initialState</span><span class="o">);</span> |
|
480 |
|
481 <span class="nx">module</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">H</span><span class="o">.</span><span class="nx">Module</span><span class="o">(</span><span class="nx">moduleId</span><span class="o">,</span> <span class="nx">initialState</span><span class="o">);</span> |
|
482 <span class="nx">G</span><span class="o">.</span><span class="nx">_modules</span><span class="o">[</span><span class="nx">moduleId</span><span class="o">]</span> <span class="o">=</span> <span class="nx">module</span><span class="o">;</span> |
|
483 <span class="k">return</span> <span class="nx">module</span><span class="o">;</span> |
|
484 <span class="o">},</span> |
|
485 |
|
486 <span class="c">/**</span> |
|
487 <span class="c"> * Initializes the Browser History Manager. Call this method</span> |
|
488 <span class="c"> * from a script block located right after the opening body tag.</span> |
|
489 <span class="c"> * @method initialize</span> |
|
490 <span class="c"> * @param {string|HTML Element} stateField <input type="hidden"> used</span> |
|
491 <span class="c"> * to store application states. Must be in the static markup.</span> |
|
492 <span class="c"> * @param {string|HTML Element} historyIFrame IFrame used to store</span> |
|
493 <span class="c"> * the history (only required for IE6/7)</span> |
|
494 <span class="c"> * @public</span> |
|
495 <span class="c"> */</span> |
|
496 <span class="nx">initialize</span><span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">stateField</span><span class="o">,</span> <span class="nx">historyIFrame</span><span class="o">)</span> <span class="o">{</span> |
|
497 |
|
498 <span class="k">var</span> <span class="nx">tagName</span><span class="o">,</span> <span class="nx">type</span><span class="o">;</span> |
|
499 |
|
500 <span class="k">if</span> <span class="o">(</span><span class="nx">G</span><span class="o">.</span><span class="nx">ready</span><span class="o">)</span> <span class="o">{</span> |
|
501 <span class="c">// The browser history utility has already been initialized.</span> |
|
502 <span class="c"></span> <span class="k">return</span> <span class="kc">true</span><span class="o">;</span> |
|
503 <span class="o">}</span> |
|
504 |
|
505 <span class="nx">stateField</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">stateField</span><span class="o">);</span> |
|
506 <span class="k">if</span> <span class="o">(!</span><span class="nx">stateField</span><span class="o">)</span> <span class="o">{</span> |
|
507 <span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="o">(</span><span class="nx">E_MISSING_OR_INVALID_ARG</span><span class="o">);</span> |
|
508 <span class="o">}</span> |
|
509 |
|
510 <span class="nx">tagName</span> <span class="o">=</span> <span class="nx">stateField</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="s2">"tagName"</span><span class="o">).</span><span class="nx">toUpperCase</span><span class="o">();</span> |
|
511 <span class="nx">type</span> <span class="o">=</span> <span class="nx">stateField</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="s2">"type"</span><span class="o">);</span> |
|
512 |
|
513 <span class="k">if</span> <span class="o">(</span><span class="nx">tagName</span> <span class="o">!==</span> <span class="s2">"TEXTAREA"</span> <span class="o">&&</span> <span class="o">(</span><span class="nx">tagName</span> <span class="o">!==</span> <span class="s2">"INPUT"</span> <span class="o">||</span> <span class="nx">type</span> <span class="o">!==</span> <span class="s2">"hidden"</span> <span class="o">&&</span> <span class="nx">type</span> <span class="o">!==</span> <span class="s2">"text"</span><span class="o">))</span> <span class="o">{</span> |
|
514 <span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="o">(</span><span class="nx">E_MISSING_OR_INVALID_ARG</span><span class="o">);</span> |
|
515 <span class="o">}</span> |
|
516 |
|
517 <span class="c">// IE < 8 or IE8 in quirks mode or IE7 standards mode</span> |
|
518 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">A</span><span class="o">.</span><span class="nx">ie</span> <span class="o">&&</span> <span class="o">(</span><span class="nx">L</span><span class="o">.</span><span class="nx">isUndefined</span><span class="o">(</span><span class="nx">DM</span><span class="o">)</span> <span class="o">||</span> <span class="nx">DM</span> <span class="o"><</span> <span class="m">8</span><span class="o">))</span> <span class="o">{</span> |
|
519 |
|
520 <span class="nx">historyIFrame</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">historyIFrame</span><span class="o">);</span> |
|
521 <span class="k">if</span> <span class="o">(!</span><span class="nx">historyIFrame</span> <span class="o">||</span> <span class="nx">historyIFrame</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="s1">'tagName'</span><span class="o">).</span><span class="nx">toUpperCase</span><span class="o">()</span> <span class="o">!==</span> <span class="s2">"IFRAME"</span><span class="o">)</span> <span class="o">{</span> |
|
522 <span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="o">(</span><span class="nx">E_MISSING_OR_INVALID_ARG</span><span class="o">);</span> |
|
523 <span class="o">}</span> |
|
524 <span class="o">}</span> |
|
525 |
|
526 <span class="k">if</span> <span class="o">(</span><span class="nx">A</span><span class="o">.</span><span class="nx">opera</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">L</span><span class="o">.</span><span class="nx">isUndefined</span><span class="o">(</span><span class="nx">WH</span><span class="o">.</span><span class="nx">navigationMode</span><span class="o">))</span> <span class="o">{</span> |
|
527 |
|
528 <span class="c">// Disable Opera's fast back/forward navigation mode and puts</span> |
|
529 <span class="c"></span> <span class="c">// it in compatible mode. This makes anchor-based history</span> |
|
530 <span class="c"></span> <span class="c">// navigation work after the page has been navigated away</span> |
|
531 <span class="c"></span> <span class="c">// from and re-activated, at the cost of slowing down</span> |
|
532 <span class="c"></span> <span class="c">// back/forward navigation to and from that page.</span> |
|
533 <span class="c"></span> <span class="nx">WH</span><span class="o">.</span><span class="nx">navigationMode</span> <span class="o">=</span> <span class="s2">"compatible"</span><span class="o">;</span> |
|
534 <span class="o">}</span> |
|
535 |
|
536 <span class="nx">G</span><span class="o">.</span><span class="nx">_stateField</span> <span class="o">=</span> <span class="nx">stateField</span><span class="o">;</span> |
|
537 <span class="nx">G</span><span class="o">.</span><span class="nx">_historyIFrame</span> <span class="o">=</span> <span class="nx">historyIFrame</span><span class="o">;</span> |
|
538 |
|
539 <span class="nx">Y</span><span class="o">.</span><span class="nx">on</span><span class="o">(</span><span class="s2">"domready"</span><span class="o">,</span> <span class="nx">_initialize</span><span class="o">);</span> |
|
540 <span class="k">return</span> <span class="kc">true</span><span class="o">;</span> |
|
541 <span class="o">},</span> |
|
542 |
|
543 <span class="c">/**</span> |
|
544 <span class="c"> * Stores a new entry in the browser history by changing the state of a registered module.</span> |
|
545 <span class="c"> * @method navigate</span> |
|
546 <span class="c"> * @param {string} module Non-empty string representing your module.</span> |
|
547 <span class="c"> * @param {string} state String representing the new state of the specified module.</span> |
|
548 <span class="c"> * @return {boolean} Indicates whether the new state was successfully added to the history.</span> |
|
549 <span class="c"> * @public</span> |
|
550 <span class="c"> */</span> |
|
551 <span class="nx">navigate</span><span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">moduleId</span><span class="o">,</span> <span class="nx">state</span><span class="o">)</span> <span class="o">{</span> |
|
552 |
|
553 <span class="k">var</span> <span class="nx">states</span><span class="o">;</span> |
|
554 |
|
555 <span class="k">if</span> <span class="o">(!</span><span class="nx">L</span><span class="o">.</span><span class="nx">isString</span><span class="o">(</span><span class="nx">moduleId</span><span class="o">)</span> <span class="o">||</span> <span class="o">!</span><span class="nx">L</span><span class="o">.</span><span class="nx">isString</span><span class="o">(</span><span class="nx">state</span><span class="o">))</span> <span class="o">{</span> |
|
556 <span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="o">(</span><span class="nx">E_MISSING_OR_INVALID_ARG</span><span class="o">);</span> |
|
557 <span class="o">}</span> |
|
558 |
|
559 <span class="nx">states</span> <span class="o">=</span> <span class="o">{};</span> |
|
560 <span class="nx">states</span><span class="o">[</span><span class="nx">moduleId</span><span class="o">]</span> <span class="o">=</span> <span class="nx">state</span><span class="o">;</span> |
|
561 |
|
562 <span class="k">return</span> <span class="nx">H</span><span class="o">.</span><span class="nx">multiNavigate</span><span class="o">(</span><span class="nx">states</span><span class="o">);</span> |
|
563 <span class="o">},</span> |
|
564 |
|
565 <span class="c">/**</span> |
|
566 <span class="c"> * Stores a new entry in the browser history by changing the state</span> |
|
567 <span class="c"> * of several registered modules in one atomic operation.</span> |
|
568 <span class="c"> * @method multiNavigate</span> |
|
569 <span class="c"> * @param {object} states Associative array of module-state pairs to set simultaneously.</span> |
|
570 <span class="c"> * @return {boolean} Indicates whether the new state was successfully added to the history.</span> |
|
571 <span class="c"> * @public</span> |
|
572 <span class="c"> */</span> |
|
573 <span class="nx">multiNavigate</span><span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">states</span><span class="o">)</span> <span class="o">{</span> |
|
574 |
|
575 <span class="k">var</span> <span class="nx">newStates</span> <span class="o">=</span> <span class="o">[],</span> <span class="nx">fqstate</span><span class="o">,</span> <span class="nx">globalStateChanged</span> <span class="o">=</span> <span class="kc">false</span><span class="o">;</span> |
|
576 |
|
577 <span class="k">if</span> <span class="o">(!</span><span class="nx">G</span><span class="o">.</span><span class="nx">ready</span><span class="o">)</span> <span class="o">{</span> |
|
578 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"The browser history utility has not been initialized"</span><span class="o">,</span> <span class="s2">"info"</span><span class="o">,</span> <span class="s2">"history"</span><span class="o">);</span> |
|
579 <span class="k">return</span> <span class="kc">false</span><span class="o">;</span> |
|
580 <span class="o">}</span> |
|
581 |
|
582 <span class="nx">Y</span><span class="o">.</span><span class="nb">Object</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">G</span><span class="o">.</span><span class="nx">_modules</span><span class="o">,</span> <span class="k">function</span> <span class="o">(</span><span class="nx">module</span><span class="o">,</span> <span class="nx">moduleId</span><span class="o">)</span> <span class="o">{</span> |
|
583 |
|
584 <span class="k">var</span> <span class="nx">state</span><span class="o">,</span> <span class="nx">decodedModuleId</span> <span class="o">=</span> <span class="nx">decode</span><span class="o">(</span><span class="nx">moduleId</span><span class="o">);</span> |
|
585 |
|
586 <span class="k">if</span> <span class="o">(!</span><span class="nx">Y</span><span class="o">.</span><span class="nb">Object</span><span class="o">.</span><span class="nx">owns</span><span class="o">(</span><span class="nx">states</span><span class="o">,</span> <span class="nx">decodedModuleId</span><span class="o">))</span> <span class="o">{</span> |
|
587 <span class="c">// The caller did not wish to modify the state of this</span> |
|
588 <span class="c"></span> <span class="c">// module. We must however include it in fqstate!</span> |
|
589 <span class="c"></span> <span class="nx">state</span> <span class="o">=</span> <span class="nx">module</span><span class="o">.</span><span class="nx">currentState</span><span class="o">;</span> |
|
590 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
591 <span class="nx">state</span> <span class="o">=</span> <span class="nx">encode</span><span class="o">(</span><span class="nx">states</span><span class="o">[</span><span class="nx">decodedModuleId</span><span class="o">]);</span> |
|
592 <span class="k">if</span> <span class="o">(</span><span class="nx">state</span> <span class="o">!==</span> <span class="nx">module</span><span class="o">.</span><span class="nx">upcomingState</span><span class="o">)</span> <span class="o">{</span> |
|
593 <span class="nx">module</span><span class="o">.</span><span class="nx">upcomingState</span> <span class="o">=</span> <span class="nx">state</span><span class="o">;</span> |
|
594 <span class="nx">globalStateChanged</span> <span class="o">=</span> <span class="kc">true</span><span class="o">;</span> |
|
595 <span class="o">}</span> |
|
596 <span class="o">}</span> |
|
597 |
|
598 <span class="nx">newStates</span><span class="o">.</span><span class="nx">push</span><span class="o">(</span><span class="nx">moduleId</span> <span class="o">+</span> <span class="s2">"="</span> <span class="o">+</span> <span class="nx">state</span><span class="o">);</span> |
|
599 <span class="o">});</span> |
|
600 |
|
601 <span class="k">if</span> <span class="o">(!</span><span class="nx">globalStateChanged</span><span class="o">)</span> <span class="o">{</span> |
|
602 <span class="c">// Nothing changed, so don't do anything.</span> |
|
603 <span class="c"></span> <span class="k">return</span> <span class="kc">false</span><span class="o">;</span> |
|
604 <span class="o">}</span> |
|
605 |
|
606 <span class="nx">fqstate</span> <span class="o">=</span> <span class="nx">newStates</span><span class="o">.</span><span class="nx">join</span><span class="o">(</span><span class="s2">"&"</span><span class="o">);</span> |
|
607 |
|
608 <span class="c">// IE < 8 or IE8 in quirks mode or IE7 standards mode</span> |
|
609 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">A</span><span class="o">.</span><span class="nx">ie</span> <span class="o">&&</span> <span class="o">(</span><span class="nx">L</span><span class="o">.</span><span class="nx">isUndefined</span><span class="o">(</span><span class="nx">DM</span><span class="o">)</span> <span class="o">||</span> <span class="nx">DM</span> <span class="o"><</span> <span class="m">8</span><span class="o">))</span> <span class="o">{</span> |
|
610 |
|
611 <span class="k">return</span> <span class="nx">_updateIFrame</span><span class="o">(</span><span class="nx">fqstate</span><span class="o">);</span> |
|
612 |
|
613 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
614 |
|
615 <span class="c">// Known bug: On Safari 1.x and 2.0, if you have tab browsing</span> |
|
616 <span class="c"></span> <span class="c">// enabled, Safari will show an endless loading icon in the</span> |
|
617 <span class="c"></span> <span class="c">// tab. This has apparently been fixed in recent WebKit builds.</span> |
|
618 <span class="c"></span> <span class="c">// One work around found by Dav Glass is to submit a form that</span> |
|
619 <span class="c"></span> <span class="c">// points to the same document. This indeed works on Safari 1.x</span> |
|
620 <span class="c"></span> <span class="c">// and 2.0 but creates bigger problems on WebKit. So for now,</span> |
|
621 <span class="c"></span> <span class="c">// we'll consider this an acceptable bug, and hope that Apple</span> |
|
622 <span class="c"></span> <span class="c">// comes out with their next version of Safari very soon.</span> |
|
623 <span class="c"></span> <span class="nx">WL</span><span class="o">.</span><span class="nx">hash</span> <span class="o">=</span> <span class="nx">fqstate</span><span class="o">;</span> |
|
624 <span class="k">if</span> <span class="o">(</span><span class="nx">A</span><span class="o">.</span><span class="nx">webkit</span><span class="o">)</span> <span class="o">{</span> |
|
625 <span class="c">// The following two lines are only useful for Safari 1.x</span> |
|
626 <span class="c"></span> <span class="c">// and 2.0. Recent nightly builds of WebKit do not require</span> |
|
627 <span class="c"></span> <span class="c">// that, but unfortunately, it is not easy to differentiate</span> |
|
628 <span class="c"></span> <span class="c">// between the two. Once Safari 2.0 departs the A-grade</span> |
|
629 <span class="c"></span> <span class="c">// list, we can remove the following two lines...</span> |
|
630 <span class="c"></span> <span class="nx">G</span><span class="o">.</span><span class="nx">_fqstates</span><span class="o">[</span><span class="nx">WH</span><span class="o">.</span><span class="nx">length</span><span class="o">]</span> <span class="o">=</span> <span class="nx">fqstate</span><span class="o">;</span> |
|
631 <span class="nx">_storeStates</span><span class="o">();</span> |
|
632 <span class="o">}</span> |
|
633 |
|
634 <span class="k">return</span> <span class="kc">true</span><span class="o">;</span> |
|
635 |
|
636 <span class="o">}</span> |
|
637 <span class="o">},</span> |
|
638 |
|
639 <span class="c">/**</span> |
|
640 <span class="c"> * Returns the current state of the specified module.</span> |
|
641 <span class="c"> * @method getCurrentState</span> |
|
642 <span class="c"> * @param {string} moduleId Non-empty string representing your module.</span> |
|
643 <span class="c"> * @return {string} The current state of the specified module.</span> |
|
644 <span class="c"> * @public</span> |
|
645 <span class="c"> */</span> |
|
646 <span class="nx">getCurrentState</span><span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">moduleId</span><span class="o">)</span> <span class="o">{</span> |
|
647 |
|
648 <span class="k">var</span> <span class="nx">module</span><span class="o">;</span> |
|
649 |
|
650 <span class="k">if</span> <span class="o">(!</span><span class="nx">L</span><span class="o">.</span><span class="nx">isString</span><span class="o">(</span><span class="nx">moduleId</span><span class="o">))</span> <span class="o">{</span> |
|
651 <span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="o">(</span><span class="nx">E_MISSING_OR_INVALID_ARG</span><span class="o">);</span> |
|
652 <span class="o">}</span> |
|
653 |
|
654 <span class="k">if</span> <span class="o">(!</span><span class="nx">G</span><span class="o">.</span><span class="nx">ready</span><span class="o">)</span> <span class="o">{</span> |
|
655 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"The browser history utility has not been initialized"</span><span class="o">,</span> <span class="s2">"info"</span><span class="o">,</span> <span class="s2">"history"</span><span class="o">);</span> |
|
656 <span class="k">return</span> <span class="kc">null</span><span class="o">;</span> |
|
657 <span class="o">}</span> |
|
658 |
|
659 <span class="nx">module</span> <span class="o">=</span> <span class="nx">G</span><span class="o">.</span><span class="nx">_modules</span><span class="o">[</span><span class="nx">moduleId</span><span class="o">];</span> |
|
660 <span class="k">if</span> <span class="o">(!</span><span class="nx">module</span><span class="o">)</span> <span class="o">{</span> |
|
661 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"No such registered module: "</span> <span class="o">+</span> <span class="nx">moduleId</span><span class="o">,</span> <span class="s2">"info"</span><span class="o">,</span> <span class="s2">"history"</span><span class="o">);</span> |
|
662 <span class="k">return</span> <span class="kc">null</span><span class="o">;</span> |
|
663 <span class="o">}</span> |
|
664 |
|
665 <span class="k">return</span> <span class="nx">decode</span><span class="o">(</span><span class="nx">module</span><span class="o">.</span><span class="nx">currentState</span><span class="o">);</span> |
|
666 <span class="o">},</span> |
|
667 |
|
668 <span class="c">/**</span> |
|
669 <span class="c"> * Returns the state of a module according to the URL fragment</span> |
|
670 <span class="c"> * identifier. This method is useful to initialize your modules</span> |
|
671 <span class="c"> * if your application was bookmarked from a particular state.</span> |
|
672 <span class="c"> * @method getBookmarkedState</span> |
|
673 <span class="c"> * @param {string} moduleId Non-empty string representing your module.</span> |
|
674 <span class="c"> * @return {string} The bookmarked state of the specified module.</span> |
|
675 <span class="c"> * @public</span> |
|
676 <span class="c"> */</span> |
|
677 <span class="nx">getBookmarkedState</span><span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">moduleId</span><span class="o">)</span> <span class="o">{</span> |
|
678 |
|
679 <span class="k">var</span> <span class="nx">m</span><span class="o">,</span> <span class="nx">i</span><span class="o">,</span> <span class="nx">h</span><span class="o">;</span> |
|
680 |
|
681 <span class="k">if</span> <span class="o">(!</span><span class="nx">L</span><span class="o">.</span><span class="nx">isString</span><span class="o">(</span><span class="nx">moduleId</span><span class="o">))</span> <span class="o">{</span> |
|
682 <span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="o">(</span><span class="nx">E_MISSING_OR_INVALID_ARG</span><span class="o">);</span> |
|
683 <span class="o">}</span> |
|
684 |
|
685 <span class="c">// Use location.href instead of location.hash which is already</span> |
|
686 <span class="c"></span> <span class="c">// URL-decoded, which creates problems if the state value</span> |
|
687 <span class="c"></span> <span class="c">// contained special characters...</span> |
|
688 <span class="c"></span> <span class="nx">h</span> <span class="o">=</span> <span class="nx">WL</span><span class="o">.</span><span class="nx">href</span><span class="o">;</span> |
|
689 <span class="nx">i</span> <span class="o">=</span> <span class="nx">h</span><span class="o">.</span><span class="nx">indexOf</span><span class="o">(</span><span class="s2">"#"</span><span class="o">);</span> |
|
690 |
|
691 <span class="k">if</span> <span class="o">(</span><span class="nx">i</span> <span class="o">>=</span> <span class="m">0</span><span class="o">)</span> <span class="o">{</span> |
|
692 <span class="nx">h</span> <span class="o">=</span> <span class="nx">h</span><span class="o">.</span><span class="nx">substr</span><span class="o">(</span><span class="nx">i</span> <span class="o">+</span> <span class="m">1</span><span class="o">);</span> |
|
693 <span class="nx">REGEXP</span><span class="o">.</span><span class="nx">lastIndex</span> <span class="o">=</span> <span class="m">0</span><span class="o">;</span> |
|
694 <span class="k">while</span> <span class="o">((</span><span class="nx">m</span> <span class="o">=</span> <span class="nx">REGEXP</span><span class="o">.</span><span class="nx">exec</span><span class="o">(</span><span class="nx">h</span><span class="o">)))</span> <span class="o">{</span> |
|
695 <span class="k">if</span> <span class="o">(</span><span class="nx">m</span><span class="o">[</span><span class="m">1</span><span class="o">]</span> <span class="o">===</span> <span class="nx">moduleId</span><span class="o">)</span> <span class="o">{</span> |
|
696 <span class="k">return</span> <span class="nx">decode</span><span class="o">(</span><span class="nx">m</span><span class="o">[</span><span class="m">2</span><span class="o">]);</span> |
|
697 <span class="o">}</span> |
|
698 <span class="o">}</span> |
|
699 <span class="o">}</span> |
|
700 |
|
701 <span class="k">return</span> <span class="kc">null</span><span class="o">;</span> |
|
702 <span class="o">},</span> |
|
703 |
|
704 <span class="c">/**</span> |
|
705 <span class="c"> * Returns the value of the specified query string parameter.</span> |
|
706 <span class="c"> * This method is not used internally by the Browser History Manager.</span> |
|
707 <span class="c"> * However, it is provided here as a helper since many applications</span> |
|
708 <span class="c"> * using the Browser History Manager will want to read the value of</span> |
|
709 <span class="c"> * url parameters to initialize themselves.</span> |
|
710 <span class="c"> * @method getQueryStringParameter</span> |
|
711 <span class="c"> * @param {string} paramName Name of the parameter we want to look up.</span> |
|
712 <span class="c"> * @param {string} queryString Optional URL to look at. If not specified,</span> |
|
713 <span class="c"> * this method uses the URL in the address bar.</span> |
|
714 <span class="c"> * @return {string} The value of the specified parameter, or null.</span> |
|
715 <span class="c"> * @public</span> |
|
716 <span class="c"> */</span> |
|
717 <span class="nx">getQueryStringParameter</span><span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">paramName</span><span class="o">,</span> <span class="nx">url</span><span class="o">)</span> <span class="o">{</span> |
|
718 |
|
719 <span class="k">var</span> <span class="nx">m</span><span class="o">,</span> <span class="nx">q</span><span class="o">,</span> <span class="nx">i</span><span class="o">;</span> |
|
720 |
|
721 <span class="nx">url</span> <span class="o">=</span> <span class="nx">url</span> <span class="o">||</span> <span class="nx">WL</span><span class="o">.</span><span class="nx">href</span><span class="o">;</span> |
|
722 |
|
723 <span class="nx">i</span> <span class="o">=</span> <span class="nx">url</span><span class="o">.</span><span class="nx">indexOf</span><span class="o">(</span><span class="s2">"?"</span><span class="o">);</span> |
|
724 <span class="nx">q</span> <span class="o">=</span> <span class="nx">i</span> <span class="o">>=</span> <span class="m">0</span> <span class="o">?</span> <span class="nx">url</span><span class="o">.</span><span class="nx">substr</span><span class="o">(</span><span class="nx">i</span> <span class="o">+</span> <span class="m">1</span><span class="o">)</span> <span class="o">:</span> <span class="nx">url</span><span class="o">;</span> |
|
725 |
|
726 <span class="c">// Remove the hash if any</span> |
|
727 <span class="c"></span> <span class="nx">i</span> <span class="o">=</span> <span class="nx">q</span><span class="o">.</span><span class="nx">lastIndexOf</span><span class="o">(</span><span class="s2">"#"</span><span class="o">);</span> |
|
728 <span class="nx">q</span> <span class="o">=</span> <span class="nx">i</span> <span class="o">>=</span> <span class="m">0</span> <span class="o">?</span> <span class="nx">q</span><span class="o">.</span><span class="nx">substr</span><span class="o">(</span><span class="m">0</span><span class="o">,</span> <span class="nx">i</span><span class="o">)</span> <span class="o">:</span> <span class="nx">q</span><span class="o">;</span> |
|
729 |
|
730 <span class="nx">REGEXP</span><span class="o">.</span><span class="nx">lastIndex</span> <span class="o">=</span> <span class="m">0</span><span class="o">;</span> |
|
731 <span class="k">while</span> <span class="o">((</span><span class="nx">m</span> <span class="o">=</span> <span class="nx">REGEXP</span><span class="o">.</span><span class="nx">exec</span><span class="o">(</span><span class="nx">q</span><span class="o">)))</span> <span class="o">{</span> |
|
732 <span class="k">if</span> <span class="o">(</span><span class="nx">m</span><span class="o">[</span><span class="m">1</span><span class="o">]</span> <span class="o">===</span> <span class="nx">paramName</span><span class="o">)</span> <span class="o">{</span> |
|
733 <span class="k">return</span> <span class="nx">decode</span><span class="o">(</span><span class="nx">m</span><span class="o">[</span><span class="m">2</span><span class="o">]);</span> |
|
734 <span class="o">}</span> |
|
735 <span class="o">}</span> |
|
736 |
|
737 <span class="k">return</span> <span class="kc">null</span><span class="o">;</span> |
|
738 <span class="o">}</span> |
|
739 <span class="o">};</span> |
|
740 |
|
741 |
|
742 <span class="c">// Make Y.History an event target</span> |
|
743 <span class="c"></span> <span class="nx">Y</span><span class="o">.</span><span class="nx">mix</span><span class="o">(</span><span class="nx">H</span><span class="o">,</span> <span class="nx">ET</span><span class="o">.</span><span class="nx">prototype</span><span class="o">);</span> |
|
744 <span class="nx">ET</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">H</span><span class="o">);</span> |
|
745 |
|
746 |
|
747 <span class="c">/**</span> |
|
748 <span class="c"> * This class represents a browser history module.</span> |
|
749 <span class="c"> * @class History.Module</span> |
|
750 <span class="c"> * @constructor</span> |
|
751 <span class="c"> * @param id {String} the module identifier</span> |
|
752 <span class="c"> * @param initialState {String} the module's initial state</span> |
|
753 <span class="c"> */</span> |
|
754 <span class="nx">H</span><span class="o">.</span><span class="nx">Module</span> <span class="o">=</span> <span class="k">function</span> <span class="o">(</span><span class="nx">id</span><span class="o">,</span> <span class="nx">initialState</span><span class="o">)</span> <span class="o">{</span> |
|
755 |
|
756 <span class="nx">ET</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="k">this</span><span class="o">);</span> |
|
757 |
|
758 <span class="c">/**</span> |
|
759 <span class="c"> * The module identifier</span> |
|
760 <span class="c"> * @type String</span> |
|
761 <span class="c"> * @final</span> |
|
762 <span class="c"> */</span> |
|
763 <span class="k">this</span><span class="o">.</span><span class="nx">id</span> <span class="o">=</span> <span class="nx">id</span><span class="o">;</span> |
|
764 |
|
765 <span class="c">/**</span> |
|
766 <span class="c"> * The module's initial state</span> |
|
767 <span class="c"> * @type String</span> |
|
768 <span class="c"> * @final</span> |
|
769 <span class="c"> */</span> |
|
770 <span class="k">this</span><span class="o">.</span><span class="nx">initialState</span> <span class="o">=</span> <span class="nx">initialState</span><span class="o">;</span> |
|
771 |
|
772 <span class="c">/**</span> |
|
773 <span class="c"> * The module's current state</span> |
|
774 <span class="c"> * @type String</span> |
|
775 <span class="c"> * @final</span> |
|
776 <span class="c"> */</span> |
|
777 <span class="k">this</span><span class="o">.</span><span class="nx">currentState</span> <span class="o">=</span> <span class="nx">initialState</span><span class="o">;</span> |
|
778 |
|
779 <span class="c">/**</span> |
|
780 <span class="c"> * The module's upcoming state. There can be a slight delay between the</span> |
|
781 <span class="c"> * time a state is changed, and the time a state change is detected.</span> |
|
782 <span class="c"> * This property allows us to not fire the module state changed event</span> |
|
783 <span class="c"> * multiple times, making client code simpler.</span> |
|
784 <span class="c"> * @type String</span> |
|
785 <span class="c"> * @private</span> |
|
786 <span class="c"> * @final</span> |
|
787 <span class="c"> */</span> |
|
788 <span class="k">this</span><span class="o">.</span><span class="nx">upcomingState</span> <span class="o">=</span> <span class="nx">initialState</span><span class="o">;</span> |
|
789 <span class="o">};</span> |
|
790 |
|
791 <span class="nx">Y</span><span class="o">.</span><span class="nx">mix</span><span class="o">(</span><span class="nx">H</span><span class="o">.</span><span class="nx">Module</span><span class="o">,</span> <span class="nx">ET</span><span class="o">,</span> <span class="kc">false</span><span class="o">,</span> <span class="kc">null</span><span class="o">,</span> <span class="m">1</span><span class="o">);</span> |
|
792 |
|
793 <span class="nx">Y</span><span class="o">.</span><span class="nx">History</span> <span class="o">=</span> <span class="nx">H</span><span class="o">;</span> |
|
794 </pre></div> |
|
795 </div> |
|
796 </div> |
|
797 </div> |
|
798 <div class="yui-b"> |
|
799 <div class="nav"> |
|
800 |
|
801 <div id="moduleList" class="module"> |
|
802 <h4>Modules</h4> |
|
803 <ul class="content"> |
|
804 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
805 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
806 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
807 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
808 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
809 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
810 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
811 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
812 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
813 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
814 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
815 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
816 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
817 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
818 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
819 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
820 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
821 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
822 <li class="selected"><a href="module_history.html" title="history">history</a></li> |
|
823 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
824 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
825 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
826 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
827 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
828 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
829 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
830 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
831 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
832 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
833 <li class=""><a href="module_queue.html" title="queue">queue</a></li> |
|
834 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
835 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
836 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
837 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
838 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
839 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
840 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
841 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
842 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
843 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
844 </ul> |
|
845 </div> |
|
846 |
|
847 <div id="classList" class="module"> |
|
848 <h4>Classes</h4> |
|
849 <ul class="content"> |
|
850 <li class=""><a href="History.html" title="History">History</a></li> |
|
851 <li class=""><a href="History.Module.html" title="History.Module">History.Module</a></li> |
|
852 </ul> |
|
853 </div> |
|
854 |
|
855 <div id="fileList" class="module"> |
|
856 <h4>Files</h4> |
|
857 <ul class="content"> |
|
858 <li class="selected"><a href="history.js.html" title="history.js">history.js</a></li> |
|
859 </ul> |
|
860 </div> |
|
861 |
|
862 |
|
863 |
|
864 |
|
865 |
|
866 </div> |
|
867 </div> |
|
868 </div> |
|
869 <div id="ft"> |
|
870 <hr /> |
|
871 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
872 </div> |
|
873 </div> |
|
874 <script type="text/javascript"> |
|
875 ALL_YUI_PROPS = [{"access": "private", "host": "History", "name": "_checkIframeLoaded", "url": "History.html#method__checkIframeLoaded", "type": "method"}, {"access": "", "host": "History.Module", "name": "currentState", "url": "History.Module.html#property_currentState", "type": "property"}, {"access": "", "host": "History", "name": "getBookmarkedState", "url": "History.html#method_getBookmarkedState", "type": "method"}, {"access": "", "host": "History", "name": "getCurrentState", "url": "History.html#method_getCurrentState", "type": "method"}, {"access": "private", "host": "History", "name": "_getHash", "url": "History.html#method__getHash", "type": "method"}, {"access": "", "host": "History", "name": "getQueryStringParameter", "url": "History.html#method_getQueryStringParameter", "type": "method"}, {"access": "private", "host": "History", "name": "_handleFQStateChange", "url": "History.html#method__handleFQStateChange", "type": "method"}, {"access": "", "host": "History", "name": "history:globalStateChange", "url": "History.html#event_history:globalStateChange", "type": "event"}, {"access": "", "host": "History", "name": "history:moduleStateChange", "url": "History.html#event_history:moduleStateChange", "type": "event"}, {"access": "", "host": "History", "name": "history:ready", "url": "History.html#event_history:ready", "type": "event"}, {"access": "", "host": "History.Module", "name": "id", "url": "History.Module.html#property_id", "type": "property"}, {"access": "private", "host": "History", "name": "_initialize", "url": "History.html#method__initialize", "type": "method"}, {"access": "", "host": "History", "name": "initialize", "url": "History.html#method_initialize", "type": "method"}, {"access": "", "host": "History.Module", "name": "initialState", "url": "History.Module.html#property_initialState", "type": "property"}, {"access": "", "host": "History", "name": "multiNavigate", "url": "History.html#method_multiNavigate", "type": "method"}, {"access": "", "host": "History", "name": "navigate", "url": "History.html#method_navigate", "type": "method"}, {"access": "", "host": "History", "name": "register", "url": "History.html#method_register", "type": "method"}, {"access": "private", "host": "History", "name": "_storeStates", "url": "History.html#method__storeStates", "type": "method"}, {"access": "private", "host": "History.Module", "name": "upcomingState", "url": "History.Module.html#property_upcomingState", "type": "property"}, {"access": "private", "host": "History", "name": "_updateIFrame", "url": "History.html#method__updateIFrame", "type": "method"}]; |
|
876 </script> |
|
877 </body> |
|
878 </html> |