|
0
|
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 (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 |
> History |
|
|
23 |
|
|
|
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 |
<h2> |
|
|
47 |
|
|
|
48 |
|
|
|
49 |
|
|
|
50 |
|
|
|
51 |
Class <b property="yui:name">History</b> |
|
|
52 |
<span class="extends"> |
|
|
53 |
</span> |
|
|
54 |
|
|
|
55 |
</h2> |
|
|
56 |
<!-- class tree goes here --> |
|
|
57 |
|
|
|
58 |
|
|
|
59 |
|
|
|
60 |
|
|
|
61 |
<div class="summary description" property="yui:description"> |
|
|
62 |
This class represents an instance of the browser history utility. |
|
|
63 |
</div> |
|
|
64 |
|
|
|
65 |
<div class="section constructor details" rel="yui:constructor" resource="#constructor"> |
|
|
66 |
<h3 id="constructor">Constructor</h3> |
|
|
67 |
<div class="content"> |
|
|
68 |
<div class="detail"> |
|
|
69 |
<strong property="yui:name">History</strong> |
|
|
70 |
<code> |
|
|
71 |
( |
|
|
72 |
) |
|
|
73 |
</code> |
|
|
74 |
<div class="description"> |
|
|
75 |
|
|
|
76 |
|
|
|
77 |
</div> |
|
|
78 |
</div> |
|
|
79 |
</div> |
|
|
80 |
</div> |
|
|
81 |
|
|
|
82 |
<div rel="yui:properties" resource="#properties"> |
|
|
83 |
|
|
|
84 |
</div> |
|
|
85 |
|
|
|
86 |
<div rel="yui:methods" resource="#methods"> |
|
|
87 |
<div class="section method details"> |
|
|
88 |
<h3 id="methods">Methods</h3> |
|
|
89 |
<div class="content"> |
|
|
90 |
<div class="private" rel="yui:method" resource="#method__checkIframeLoaded"> |
|
|
91 |
<h4> |
|
|
92 |
<a name="method__checkIframeLoaded">_checkIframeLoaded</a></h4> |
|
|
93 |
<div class="detail" > |
|
|
94 |
<code> |
|
|
95 |
private |
|
|
96 |
|
|
|
97 |
|
|
|
98 |
void |
|
|
99 |
<strong property="yui:name">_checkIframeLoaded</strong> |
|
|
100 |
( |
|
|
101 |
) |
|
|
102 |
</code> |
|
|
103 |
|
|
|
104 |
<div class="description" property="yui:description"> |
|
|
105 |
Periodically checks whether our internal IFrame is ready to be used |
|
|
106 |
</div> |
|
|
107 |
|
|
|
108 |
<div class="description"> |
|
|
109 |
|
|
|
110 |
|
|
|
111 |
<dl> |
|
|
112 |
<dt>Returns: |
|
|
113 |
<code property="yui:return"> |
|
|
114 |
void |
|
|
115 |
</code></dt> |
|
|
116 |
<dd property="yui:returnInfo"></dd> |
|
|
117 |
</dl> |
|
|
118 |
|
|
|
119 |
|
|
|
120 |
|
|
|
121 |
|
|
|
122 |
</div> |
|
|
123 |
|
|
|
124 |
</div> |
|
|
125 |
<hr /> |
|
|
126 |
</div> |
|
|
127 |
<div class="private" rel="yui:method" resource="#method__getHash"> |
|
|
128 |
<h4> |
|
|
129 |
<a name="method__getHash">_getHash</a></h4> |
|
|
130 |
<div class="detail" > |
|
|
131 |
<code> |
|
|
132 |
private |
|
|
133 |
|
|
|
134 |
|
|
|
135 |
string |
|
|
136 |
<strong property="yui:name">_getHash</strong> |
|
|
137 |
( |
|
|
138 |
) |
|
|
139 |
</code> |
|
|
140 |
|
|
|
141 |
<div class="description" property="yui:description"> |
|
|
142 |
Returns the portion of the hash after the '#' symbol. |
|
|
143 |
</div> |
|
|
144 |
|
|
|
145 |
<div class="description"> |
|
|
146 |
|
|
|
147 |
|
|
|
148 |
<dl> |
|
|
149 |
<dt>Returns: |
|
|
150 |
<code property="yui:return"> |
|
|
151 |
string |
|
|
152 |
</code></dt> |
|
|
153 |
<dd property="yui:returnInfo">The hash portion of the document's location</dd> |
|
|
154 |
</dl> |
|
|
155 |
|
|
|
156 |
|
|
|
157 |
|
|
|
158 |
|
|
|
159 |
</div> |
|
|
160 |
|
|
|
161 |
</div> |
|
|
162 |
<hr /> |
|
|
163 |
</div> |
|
|
164 |
<div class="private" rel="yui:method" resource="#method__handleFQStateChange"> |
|
|
165 |
<h4> |
|
|
166 |
<a name="method__handleFQStateChange">_handleFQStateChange</a></h4> |
|
|
167 |
<div class="detail" > |
|
|
168 |
<code> |
|
|
169 |
private |
|
|
170 |
|
|
|
171 |
|
|
|
172 |
void |
|
|
173 |
<strong property="yui:name">_handleFQStateChange</strong> |
|
|
174 |
( |
|
|
175 |
|
|
|
176 |
|
|
|
177 |
fqstate |
|
|
178 |
|
|
|
179 |
|
|
|
180 |
) |
|
|
181 |
</code> |
|
|
182 |
|
|
|
183 |
<div class="description" property="yui:description"> |
|
|
184 |
Sets the new currentState attribute of all modules depending on the new fully |
|
|
185 |
qualified state. Also notifies the modules which current state has changed. |
|
|
186 |
</div> |
|
|
187 |
|
|
|
188 |
<div class="description"> |
|
|
189 |
|
|
|
190 |
<dl rel="yui:parameters"> |
|
|
191 |
<dt>Parameters:</dt> |
|
|
192 |
<dd rel="yui:parameter"> |
|
|
193 |
<code><span property="yui:name">fqstate</span> |
|
|
194 |
<<span property="yui:type">string</span>> |
|
|
195 |
</code> |
|
|
196 |
<span property="yui:description"> fully qualified state</span> |
|
|
197 |
</dd> |
|
|
198 |
</dl> |
|
|
199 |
|
|
|
200 |
<dl> |
|
|
201 |
<dt>Returns: |
|
|
202 |
<code property="yui:return"> |
|
|
203 |
void |
|
|
204 |
</code></dt> |
|
|
205 |
<dd property="yui:returnInfo"></dd> |
|
|
206 |
</dl> |
|
|
207 |
|
|
|
208 |
|
|
|
209 |
|
|
|
210 |
|
|
|
211 |
</div> |
|
|
212 |
|
|
|
213 |
</div> |
|
|
214 |
<hr /> |
|
|
215 |
</div> |
|
|
216 |
<div class="private" rel="yui:method" resource="#method__initialize"> |
|
|
217 |
<h4> |
|
|
218 |
<a name="method__initialize">_initialize</a></h4> |
|
|
219 |
<div class="detail" > |
|
|
220 |
<code> |
|
|
221 |
private |
|
|
222 |
|
|
|
223 |
|
|
|
224 |
void |
|
|
225 |
<strong property="yui:name">_initialize</strong> |
|
|
226 |
( |
|
|
227 |
) |
|
|
228 |
</code> |
|
|
229 |
|
|
|
230 |
<div class="description" property="yui:description"> |
|
|
231 |
Finish up the initialization of the browser utility library. |
|
|
232 |
</div> |
|
|
233 |
|
|
|
234 |
<div class="description"> |
|
|
235 |
|
|
|
236 |
|
|
|
237 |
<dl> |
|
|
238 |
<dt>Returns: |
|
|
239 |
<code property="yui:return"> |
|
|
240 |
void |
|
|
241 |
</code></dt> |
|
|
242 |
<dd property="yui:returnInfo"></dd> |
|
|
243 |
</dl> |
|
|
244 |
|
|
|
245 |
|
|
|
246 |
|
|
|
247 |
|
|
|
248 |
</div> |
|
|
249 |
|
|
|
250 |
</div> |
|
|
251 |
<hr /> |
|
|
252 |
</div> |
|
|
253 |
<div class="private" rel="yui:method" resource="#method__storeStates"> |
|
|
254 |
<h4> |
|
|
255 |
<a name="method__storeStates">_storeStates</a></h4> |
|
|
256 |
<div class="detail" > |
|
|
257 |
<code> |
|
|
258 |
private |
|
|
259 |
|
|
|
260 |
|
|
|
261 |
void |
|
|
262 |
<strong property="yui:name">_storeStates</strong> |
|
|
263 |
( |
|
|
264 |
) |
|
|
265 |
</code> |
|
|
266 |
|
|
|
267 |
<div class="description" property="yui:description"> |
|
|
268 |
Stores the initial state and current state for all registered modules. |
|
|
269 |
On Safari, we also store all the fully qualified states visited by |
|
|
270 |
the application within a single browser session. The storage takes |
|
|
271 |
place in the form field specified during initialization. |
|
|
272 |
</div> |
|
|
273 |
|
|
|
274 |
<div class="description"> |
|
|
275 |
|
|
|
276 |
|
|
|
277 |
<dl> |
|
|
278 |
<dt>Returns: |
|
|
279 |
<code property="yui:return"> |
|
|
280 |
void |
|
|
281 |
</code></dt> |
|
|
282 |
<dd property="yui:returnInfo"></dd> |
|
|
283 |
</dl> |
|
|
284 |
|
|
|
285 |
|
|
|
286 |
|
|
|
287 |
|
|
|
288 |
</div> |
|
|
289 |
|
|
|
290 |
</div> |
|
|
291 |
<hr /> |
|
|
292 |
</div> |
|
|
293 |
<div class="private" rel="yui:method" resource="#method__updateIFrame"> |
|
|
294 |
<h4> |
|
|
295 |
<a name="method__updateIFrame">_updateIFrame</a></h4> |
|
|
296 |
<div class="detail" > |
|
|
297 |
<code> |
|
|
298 |
private |
|
|
299 |
|
|
|
300 |
|
|
|
301 |
boolean |
|
|
302 |
<strong property="yui:name">_updateIFrame</strong> |
|
|
303 |
( |
|
|
304 |
) |
|
|
305 |
</code> |
|
|
306 |
|
|
|
307 |
<div class="description" property="yui:description"> |
|
|
308 |
Update the IFrame with our new state. |
|
|
309 |
</div> |
|
|
310 |
|
|
|
311 |
<div class="description"> |
|
|
312 |
|
|
|
313 |
|
|
|
314 |
<dl> |
|
|
315 |
<dt>Returns: |
|
|
316 |
<code property="yui:return"> |
|
|
317 |
boolean |
|
|
318 |
</code></dt> |
|
|
319 |
<dd property="yui:returnInfo">true if successful. false otherwise.</dd> |
|
|
320 |
</dl> |
|
|
321 |
|
|
|
322 |
|
|
|
323 |
|
|
|
324 |
|
|
|
325 |
</div> |
|
|
326 |
|
|
|
327 |
</div> |
|
|
328 |
<hr /> |
|
|
329 |
</div> |
|
|
330 |
<div class="" rel="yui:method" resource="#method_getBookmarkedState"> |
|
|
331 |
<h4> |
|
|
332 |
<a name="method_getBookmarkedState">getBookmarkedState</a></h4> |
|
|
333 |
<div class="detail" > |
|
|
334 |
<code> |
|
|
335 |
|
|
|
336 |
|
|
|
337 |
|
|
|
338 |
string |
|
|
339 |
<strong property="yui:name">getBookmarkedState</strong> |
|
|
340 |
( |
|
|
341 |
|
|
|
342 |
|
|
|
343 |
moduleId |
|
|
344 |
|
|
|
345 |
|
|
|
346 |
) |
|
|
347 |
</code> |
|
|
348 |
|
|
|
349 |
<div class="description" property="yui:description"> |
|
|
350 |
Returns the state of a module according to the URL fragment |
|
|
351 |
identifier. This method is useful to initialize your modules |
|
|
352 |
if your application was bookmarked from a particular state. |
|
|
353 |
</div> |
|
|
354 |
|
|
|
355 |
<div class="description"> |
|
|
356 |
|
|
|
357 |
<dl rel="yui:parameters"> |
|
|
358 |
<dt>Parameters:</dt> |
|
|
359 |
<dd rel="yui:parameter"> |
|
|
360 |
<code><span property="yui:name">moduleId</span> |
|
|
361 |
<<span property="yui:type">string</span>> |
|
|
362 |
</code> |
|
|
363 |
<span property="yui:description"> Non-empty string representing your module.</span> |
|
|
364 |
</dd> |
|
|
365 |
</dl> |
|
|
366 |
|
|
|
367 |
<dl> |
|
|
368 |
<dt>Returns: |
|
|
369 |
<code property="yui:return"> |
|
|
370 |
string |
|
|
371 |
</code></dt> |
|
|
372 |
<dd property="yui:returnInfo">The bookmarked state of the specified module.</dd> |
|
|
373 |
</dl> |
|
|
374 |
|
|
|
375 |
|
|
|
376 |
|
|
|
377 |
|
|
|
378 |
</div> |
|
|
379 |
|
|
|
380 |
</div> |
|
|
381 |
<hr /> |
|
|
382 |
</div> |
|
|
383 |
<div class="" rel="yui:method" resource="#method_getCurrentState"> |
|
|
384 |
<h4> |
|
|
385 |
<a name="method_getCurrentState">getCurrentState</a></h4> |
|
|
386 |
<div class="detail" > |
|
|
387 |
<code> |
|
|
388 |
|
|
|
389 |
|
|
|
390 |
|
|
|
391 |
string |
|
|
392 |
<strong property="yui:name">getCurrentState</strong> |
|
|
393 |
( |
|
|
394 |
|
|
|
395 |
|
|
|
396 |
moduleId |
|
|
397 |
|
|
|
398 |
|
|
|
399 |
) |
|
|
400 |
</code> |
|
|
401 |
|
|
|
402 |
<div class="description" property="yui:description"> |
|
|
403 |
Returns the current state of the specified module. |
|
|
404 |
</div> |
|
|
405 |
|
|
|
406 |
<div class="description"> |
|
|
407 |
|
|
|
408 |
<dl rel="yui:parameters"> |
|
|
409 |
<dt>Parameters:</dt> |
|
|
410 |
<dd rel="yui:parameter"> |
|
|
411 |
<code><span property="yui:name">moduleId</span> |
|
|
412 |
<<span property="yui:type">string</span>> |
|
|
413 |
</code> |
|
|
414 |
<span property="yui:description"> Non-empty string representing your module.</span> |
|
|
415 |
</dd> |
|
|
416 |
</dl> |
|
|
417 |
|
|
|
418 |
<dl> |
|
|
419 |
<dt>Returns: |
|
|
420 |
<code property="yui:return"> |
|
|
421 |
string |
|
|
422 |
</code></dt> |
|
|
423 |
<dd property="yui:returnInfo">The current state of the specified module.</dd> |
|
|
424 |
</dl> |
|
|
425 |
|
|
|
426 |
|
|
|
427 |
|
|
|
428 |
|
|
|
429 |
</div> |
|
|
430 |
|
|
|
431 |
</div> |
|
|
432 |
<hr /> |
|
|
433 |
</div> |
|
|
434 |
<div class="" rel="yui:method" resource="#method_getQueryStringParameter"> |
|
|
435 |
<h4> |
|
|
436 |
<a name="method_getQueryStringParameter">getQueryStringParameter</a></h4> |
|
|
437 |
<div class="detail" > |
|
|
438 |
<code> |
|
|
439 |
|
|
|
440 |
|
|
|
441 |
|
|
|
442 |
string |
|
|
443 |
<strong property="yui:name">getQueryStringParameter</strong> |
|
|
444 |
( |
|
|
445 |
|
|
|
446 |
|
|
|
447 |
paramName |
|
|
448 |
|
|
|
449 |
|
|
|
450 |
, |
|
|
451 |
queryString |
|
|
452 |
|
|
|
453 |
|
|
|
454 |
) |
|
|
455 |
</code> |
|
|
456 |
|
|
|
457 |
<div class="description" property="yui:description"> |
|
|
458 |
Returns the value of the specified query string parameter. |
|
|
459 |
This method is not used internally by the Browser History Manager. |
|
|
460 |
However, it is provided here as a helper since many applications |
|
|
461 |
using the Browser History Manager will want to read the value of |
|
|
462 |
url parameters to initialize themselves. |
|
|
463 |
</div> |
|
|
464 |
|
|
|
465 |
<div class="description"> |
|
|
466 |
|
|
|
467 |
<dl rel="yui:parameters"> |
|
|
468 |
<dt>Parameters:</dt> |
|
|
469 |
<dd rel="yui:parameter"> |
|
|
470 |
<code><span property="yui:name">paramName</span> |
|
|
471 |
<<span property="yui:type">string</span>> |
|
|
472 |
</code> |
|
|
473 |
<span property="yui:description"> Name of the parameter we want to look up.</span> |
|
|
474 |
</dd> |
|
|
475 |
<dd rel="yui:parameter"> |
|
|
476 |
<code><span property="yui:name">queryString</span> |
|
|
477 |
<<span property="yui:type">string</span>> |
|
|
478 |
</code> |
|
|
479 |
<span property="yui:description"> Optional URL to look at. If not specified, |
|
|
480 |
this method uses the URL in the address bar.</span> |
|
|
481 |
</dd> |
|
|
482 |
</dl> |
|
|
483 |
|
|
|
484 |
<dl> |
|
|
485 |
<dt>Returns: |
|
|
486 |
<code property="yui:return"> |
|
|
487 |
string |
|
|
488 |
</code></dt> |
|
|
489 |
<dd property="yui:returnInfo">The value of the specified parameter, or null.</dd> |
|
|
490 |
</dl> |
|
|
491 |
|
|
|
492 |
|
|
|
493 |
|
|
|
494 |
|
|
|
495 |
</div> |
|
|
496 |
|
|
|
497 |
</div> |
|
|
498 |
<hr /> |
|
|
499 |
</div> |
|
|
500 |
<div class="" rel="yui:method" resource="#method_initialize"> |
|
|
501 |
<h4> |
|
|
502 |
<a name="method_initialize">initialize</a></h4> |
|
|
503 |
<div class="detail" > |
|
|
504 |
<code> |
|
|
505 |
|
|
|
506 |
|
|
|
507 |
|
|
|
508 |
void |
|
|
509 |
<strong property="yui:name">initialize</strong> |
|
|
510 |
( |
|
|
511 |
|
|
|
512 |
|
|
|
513 |
stateField |
|
|
514 |
|
|
|
515 |
|
|
|
516 |
, |
|
|
517 |
historyIFrame |
|
|
518 |
|
|
|
519 |
|
|
|
520 |
) |
|
|
521 |
</code> |
|
|
522 |
|
|
|
523 |
<div class="description" property="yui:description"> |
|
|
524 |
Initializes the Browser History Manager. Call this method |
|
|
525 |
from a script block located right after the opening body tag. |
|
|
526 |
</div> |
|
|
527 |
|
|
|
528 |
<div class="description"> |
|
|
529 |
|
|
|
530 |
<dl rel="yui:parameters"> |
|
|
531 |
<dt>Parameters:</dt> |
|
|
532 |
<dd rel="yui:parameter"> |
|
|
533 |
<code><span property="yui:name">stateField</span> |
|
|
534 |
<<span property="yui:type">string|HTML Element</span>> |
|
|
535 |
</code> |
|
|
536 |
<span property="yui:description"> <input type="hidden"> used |
|
|
537 |
to store application states. Must be in the static markup.</span> |
|
|
538 |
</dd> |
|
|
539 |
<dd rel="yui:parameter"> |
|
|
540 |
<code><span property="yui:name">historyIFrame</span> |
|
|
541 |
<<span property="yui:type">string|HTML Element</span>> |
|
|
542 |
</code> |
|
|
543 |
<span property="yui:description"> IFrame used to store |
|
|
544 |
the history (only required for IE6/7)</span> |
|
|
545 |
</dd> |
|
|
546 |
</dl> |
|
|
547 |
|
|
|
548 |
<dl> |
|
|
549 |
<dt>Returns: |
|
|
550 |
<code property="yui:return"> |
|
|
551 |
void |
|
|
552 |
</code></dt> |
|
|
553 |
<dd property="yui:returnInfo"></dd> |
|
|
554 |
</dl> |
|
|
555 |
|
|
|
556 |
|
|
|
557 |
|
|
|
558 |
|
|
|
559 |
</div> |
|
|
560 |
|
|
|
561 |
</div> |
|
|
562 |
<hr /> |
|
|
563 |
</div> |
|
|
564 |
<div class="" rel="yui:method" resource="#method_multiNavigate"> |
|
|
565 |
<h4> |
|
|
566 |
<a name="method_multiNavigate">multiNavigate</a></h4> |
|
|
567 |
<div class="detail" > |
|
|
568 |
<code> |
|
|
569 |
|
|
|
570 |
|
|
|
571 |
|
|
|
572 |
boolean |
|
|
573 |
<strong property="yui:name">multiNavigate</strong> |
|
|
574 |
( |
|
|
575 |
|
|
|
576 |
|
|
|
577 |
states |
|
|
578 |
|
|
|
579 |
|
|
|
580 |
) |
|
|
581 |
</code> |
|
|
582 |
|
|
|
583 |
<div class="description" property="yui:description"> |
|
|
584 |
Stores a new entry in the browser history by changing the state |
|
|
585 |
of several registered modules in one atomic operation. |
|
|
586 |
</div> |
|
|
587 |
|
|
|
588 |
<div class="description"> |
|
|
589 |
|
|
|
590 |
<dl rel="yui:parameters"> |
|
|
591 |
<dt>Parameters:</dt> |
|
|
592 |
<dd rel="yui:parameter"> |
|
|
593 |
<code><span property="yui:name">states</span> |
|
|
594 |
<<span property="yui:type">object</span>> |
|
|
595 |
</code> |
|
|
596 |
<span property="yui:description"> Associative array of module-state pairs to set simultaneously.</span> |
|
|
597 |
</dd> |
|
|
598 |
</dl> |
|
|
599 |
|
|
|
600 |
<dl> |
|
|
601 |
<dt>Returns: |
|
|
602 |
<code property="yui:return"> |
|
|
603 |
boolean |
|
|
604 |
</code></dt> |
|
|
605 |
<dd property="yui:returnInfo">Indicates whether the new state was successfully added to the history.</dd> |
|
|
606 |
</dl> |
|
|
607 |
|
|
|
608 |
|
|
|
609 |
|
|
|
610 |
|
|
|
611 |
</div> |
|
|
612 |
|
|
|
613 |
</div> |
|
|
614 |
<hr /> |
|
|
615 |
</div> |
|
|
616 |
<div class="" rel="yui:method" resource="#method_navigate"> |
|
|
617 |
<h4> |
|
|
618 |
<a name="method_navigate">navigate</a></h4> |
|
|
619 |
<div class="detail" > |
|
|
620 |
<code> |
|
|
621 |
|
|
|
622 |
|
|
|
623 |
|
|
|
624 |
boolean |
|
|
625 |
<strong property="yui:name">navigate</strong> |
|
|
626 |
( |
|
|
627 |
|
|
|
628 |
|
|
|
629 |
module |
|
|
630 |
|
|
|
631 |
|
|
|
632 |
, |
|
|
633 |
state |
|
|
634 |
|
|
|
635 |
|
|
|
636 |
) |
|
|
637 |
</code> |
|
|
638 |
|
|
|
639 |
<div class="description" property="yui:description"> |
|
|
640 |
Stores a new entry in the browser history by changing the state of a registered module. |
|
|
641 |
</div> |
|
|
642 |
|
|
|
643 |
<div class="description"> |
|
|
644 |
|
|
|
645 |
<dl rel="yui:parameters"> |
|
|
646 |
<dt>Parameters:</dt> |
|
|
647 |
<dd rel="yui:parameter"> |
|
|
648 |
<code><span property="yui:name">module</span> |
|
|
649 |
<<span property="yui:type">string</span>> |
|
|
650 |
</code> |
|
|
651 |
<span property="yui:description"> Non-empty string representing your module.</span> |
|
|
652 |
</dd> |
|
|
653 |
<dd rel="yui:parameter"> |
|
|
654 |
<code><span property="yui:name">state</span> |
|
|
655 |
<<span property="yui:type">string</span>> |
|
|
656 |
</code> |
|
|
657 |
<span property="yui:description"> String representing the new state of the specified module.</span> |
|
|
658 |
</dd> |
|
|
659 |
</dl> |
|
|
660 |
|
|
|
661 |
<dl> |
|
|
662 |
<dt>Returns: |
|
|
663 |
<code property="yui:return"> |
|
|
664 |
boolean |
|
|
665 |
</code></dt> |
|
|
666 |
<dd property="yui:returnInfo">Indicates whether the new state was successfully added to the history.</dd> |
|
|
667 |
</dl> |
|
|
668 |
|
|
|
669 |
|
|
|
670 |
|
|
|
671 |
|
|
|
672 |
</div> |
|
|
673 |
|
|
|
674 |
</div> |
|
|
675 |
<hr /> |
|
|
676 |
</div> |
|
|
677 |
<div class="" rel="yui:method" resource="#method_register"> |
|
|
678 |
<h4> |
|
|
679 |
<a name="method_register">register</a></h4> |
|
|
680 |
<div class="detail" > |
|
|
681 |
<code> |
|
|
682 |
|
|
|
683 |
|
|
|
684 |
|
|
|
685 |
History.Module |
|
|
686 |
<strong property="yui:name">register</strong> |
|
|
687 |
( |
|
|
688 |
|
|
|
689 |
|
|
|
690 |
moduleId |
|
|
691 |
|
|
|
692 |
|
|
|
693 |
, |
|
|
694 |
initialState |
|
|
695 |
|
|
|
696 |
|
|
|
697 |
) |
|
|
698 |
</code> |
|
|
699 |
|
|
|
700 |
<div class="description" property="yui:description"> |
|
|
701 |
Registers a new module. |
|
|
702 |
</div> |
|
|
703 |
|
|
|
704 |
<div class="description"> |
|
|
705 |
|
|
|
706 |
<dl rel="yui:parameters"> |
|
|
707 |
<dt>Parameters:</dt> |
|
|
708 |
<dd rel="yui:parameter"> |
|
|
709 |
<code><span property="yui:name">moduleId</span> |
|
|
710 |
<<span property="yui:type">string</span>> |
|
|
711 |
</code> |
|
|
712 |
<span property="yui:description"> Non-empty string uniquely identifying the |
|
|
713 |
module you wish to register.</span> |
|
|
714 |
</dd> |
|
|
715 |
<dd rel="yui:parameter"> |
|
|
716 |
<code><span property="yui:name">initialState</span> |
|
|
717 |
<<span property="yui:type">string</span>> |
|
|
718 |
</code> |
|
|
719 |
<span property="yui:description"> The initial state of the specified |
|
|
720 |
module corresponding to its earliest history entry.</span> |
|
|
721 |
</dd> |
|
|
722 |
</dl> |
|
|
723 |
|
|
|
724 |
<dl> |
|
|
725 |
<dt>Returns: |
|
|
726 |
<code property="yui:return"> |
|
|
727 |
History.Module |
|
|
728 |
</code></dt> |
|
|
729 |
<dd property="yui:returnInfo">The newly registered module</dd> |
|
|
730 |
</dl> |
|
|
731 |
|
|
|
732 |
|
|
|
733 |
|
|
|
734 |
|
|
|
735 |
</div> |
|
|
736 |
|
|
|
737 |
</div> |
|
|
738 |
<hr /> |
|
|
739 |
</div> |
|
|
740 |
</div> |
|
|
741 |
</div> |
|
|
742 |
|
|
|
743 |
</div> |
|
|
744 |
|
|
|
745 |
<div rel="yui:events" resource="#events"> |
|
|
746 |
<div class="section method details"> |
|
|
747 |
<h3 id="events">Events</h3> |
|
|
748 |
<div class="content"> |
|
|
749 |
<div class="" rel="yui:event" resource="#event_history:globalStateChange"> |
|
|
750 |
<h4> |
|
|
751 |
<a name="event_history:globalStateChange">history:globalStateChange</a></h4> |
|
|
752 |
<div class="detail"> |
|
|
753 |
<code> |
|
|
754 |
|
|
|
755 |
|
|
|
756 |
|
|
|
757 |
<strong property="yui:name">history:globalStateChange</strong> |
|
|
758 |
|
|
|
759 |
( |
|
|
760 |
) |
|
|
761 |
|
|
|
762 |
</code> |
|
|
763 |
|
|
|
764 |
<div class="description" property="yui:description"> |
|
|
765 |
Fires when the global state of the page has changed (that is, |
|
|
766 |
when the state of at least one browser history module has changed) |
|
|
767 |
</div> |
|
|
768 |
|
|
|
769 |
<div class="description"> |
|
|
770 |
|
|
|
771 |
|
|
|
772 |
|
|
|
773 |
|
|
|
774 |
</div> |
|
|
775 |
|
|
|
776 |
</div> |
|
|
777 |
<hr /> |
|
|
778 |
</div> |
|
|
779 |
<div class="" rel="yui:event" resource="#event_history:moduleStateChange"> |
|
|
780 |
<h4> |
|
|
781 |
<a name="event_history:moduleStateChange">history:moduleStateChange</a></h4> |
|
|
782 |
<div class="detail"> |
|
|
783 |
<code> |
|
|
784 |
|
|
|
785 |
|
|
|
786 |
|
|
|
787 |
<strong property="yui:name">history:moduleStateChange</strong> |
|
|
788 |
|
|
|
789 |
( |
|
|
790 |
) |
|
|
791 |
|
|
|
792 |
</code> |
|
|
793 |
|
|
|
794 |
<div class="description" property="yui:description"> |
|
|
795 |
Fires when the state of a history module object has changed |
|
|
796 |
</div> |
|
|
797 |
|
|
|
798 |
<div class="description"> |
|
|
799 |
|
|
|
800 |
|
|
|
801 |
|
|
|
802 |
|
|
|
803 |
</div> |
|
|
804 |
|
|
|
805 |
</div> |
|
|
806 |
<hr /> |
|
|
807 |
</div> |
|
|
808 |
<div class="" rel="yui:event" resource="#event_history:ready"> |
|
|
809 |
<h4> |
|
|
810 |
<a name="event_history:ready">history:ready</a></h4> |
|
|
811 |
<div class="detail"> |
|
|
812 |
<code> |
|
|
813 |
|
|
|
814 |
|
|
|
815 |
|
|
|
816 |
<strong property="yui:name">history:ready</strong> |
|
|
817 |
|
|
|
818 |
( |
|
|
819 |
) |
|
|
820 |
|
|
|
821 |
</code> |
|
|
822 |
|
|
|
823 |
<div class="description" property="yui:description"> |
|
|
824 |
Fires when the browser history utility is ready |
|
|
825 |
</div> |
|
|
826 |
|
|
|
827 |
<div class="description"> |
|
|
828 |
|
|
|
829 |
|
|
|
830 |
|
|
|
831 |
|
|
|
832 |
</div> |
|
|
833 |
|
|
|
834 |
</div> |
|
|
835 |
<hr /> |
|
|
836 |
</div> |
|
|
837 |
</div> |
|
|
838 |
</div> |
|
|
839 |
|
|
|
840 |
|
|
|
841 |
</div> |
|
|
842 |
|
|
|
843 |
<div rel="yui:attributes" resource="#configattributes"> |
|
|
844 |
|
|
|
845 |
</div> |
|
|
846 |
|
|
|
847 |
</div> |
|
|
848 |
</div> |
|
|
849 |
<div class="yui-b"> |
|
|
850 |
<div class="nav"> |
|
|
851 |
|
|
|
852 |
<div id="moduleList" class="module"> |
|
|
853 |
<h4>Modules</h4> |
|
|
854 |
<ul class="content"> |
|
|
855 |
<li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
|
856 |
<li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
|
857 |
<li class=""><a href="module_base.html" title="base">base</a></li> |
|
|
858 |
<li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
|
859 |
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
|
860 |
<li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
|
861 |
<li class=""><a href="module_console.html" title="console">console</a></li> |
|
|
862 |
<li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
|
863 |
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
|
864 |
<li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
|
865 |
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
|
866 |
<li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
|
867 |
<li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
|
868 |
<li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
|
869 |
<li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
|
870 |
<li class=""><a href="module_event.html" title="event">event</a></li> |
|
|
871 |
<li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
|
872 |
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
|
873 |
<li class="selected"><a href="module_history.html" title="history">history</a></li> |
|
|
874 |
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
|
875 |
<li class=""><a href="module_io.html" title="io">io</a></li> |
|
|
876 |
<li class=""><a href="module_json.html" title="json">json</a></li> |
|
|
877 |
<li class=""><a href="module_node.html" title="node">node</a></li> |
|
|
878 |
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
|
879 |
<li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
|
880 |
<li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
|
881 |
<li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
|
882 |
<li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
|
883 |
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
|
884 |
<li class=""><a href="module_queue.html" title="queue">queue</a></li> |
|
|
885 |
<li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
|
886 |
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
|
887 |
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
|
888 |
<li class=""><a href="module_test.html" title="test">test</a></li> |
|
|
889 |
<li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
|
890 |
<li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
|
891 |
<li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
|
892 |
<li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
|
893 |
<li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
|
894 |
<li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
|
895 |
</ul> |
|
|
896 |
</div> |
|
|
897 |
|
|
|
898 |
<div id="classList" class="module"> |
|
|
899 |
<h4>Classes</h4> |
|
|
900 |
<ul class="content"> |
|
|
901 |
<li class="selected"><a href="History.html" title="History">History</a></li> |
|
|
902 |
<li class=""><a href="History.Module.html" title="History.Module">History.Module</a></li> |
|
|
903 |
</ul> |
|
|
904 |
</div> |
|
|
905 |
|
|
|
906 |
<div id="fileList" class="module"> |
|
|
907 |
<h4>Files</h4> |
|
|
908 |
<ul class="content"> |
|
|
909 |
<li class=""><a href="history.js.html" title="history.js">history.js</a></li> |
|
|
910 |
</ul> |
|
|
911 |
</div> |
|
|
912 |
|
|
|
913 |
|
|
|
914 |
<div id="methodsList" class="module"> |
|
|
915 |
<h4>Methods</h4> |
|
|
916 |
<ul class="content"> |
|
|
917 |
<li class="private"><a href="#method__checkIframeLoaded" title="_checkIframeLoaded">_checkIframeLoaded</a></li> |
|
|
918 |
<li class="private"><a href="#method__getHash" title="_getHash">_getHash</a></li> |
|
|
919 |
<li class="private"><a href="#method__handleFQStateChange" title="_handleFQStateChange">_handleFQStateChange</a></li> |
|
|
920 |
<li class="private"><a href="#method__initialize" title="_initialize">_initialize</a></li> |
|
|
921 |
<li class="private"><a href="#method__storeStates" title="_storeStates">_storeStates</a></li> |
|
|
922 |
<li class="private"><a href="#method__updateIFrame" title="_updateIFrame">_updateIFrame</a></li> |
|
|
923 |
<li class=""><a href="#method_getBookmarkedState" title="getBookmarkedState">getBookmarkedState</a></li> |
|
|
924 |
<li class=""><a href="#method_getCurrentState" title="getCurrentState">getCurrentState</a></li> |
|
|
925 |
<li class=""><a href="#method_getQueryStringParameter" title="getQueryStringParameter">getQueryStringParameter</a></li> |
|
|
926 |
<li class=""><a href="#method_initialize" title="initialize">initialize</a></li> |
|
|
927 |
<li class=""><a href="#method_multiNavigate" title="multiNavigate">multiNavigate</a></li> |
|
|
928 |
<li class=""><a href="#method_navigate" title="navigate">navigate</a></li> |
|
|
929 |
<li class=""><a href="#method_register" title="register">register</a></li> |
|
|
930 |
</ul> |
|
|
931 |
</div> |
|
|
932 |
|
|
|
933 |
<div id="eventsList" class="module"> |
|
|
934 |
<h4>Events</h4> |
|
|
935 |
<ul class="content"> |
|
|
936 |
<li class=""><a href="#event_history:globalStateChange" title="history:globalStateChange">history:globalStateChange</a></li> |
|
|
937 |
<li class=""><a href="#event_history:moduleStateChange" title="history:moduleStateChange">history:moduleStateChange</a></li> |
|
|
938 |
<li class=""><a href="#event_history:ready" title="history:ready">history:ready</a></li> |
|
|
939 |
</ul> |
|
|
940 |
</div> |
|
|
941 |
|
|
|
942 |
|
|
|
943 |
</div> |
|
|
944 |
</div> |
|
|
945 |
</div> |
|
|
946 |
<div id="ft"> |
|
|
947 |
<hr /> |
|
|
948 |
Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
|
949 |
</div> |
|
|
950 |
</div> |
|
|
951 |
<script type="text/javascript"> |
|
|
952 |
ALL_YUI_PROPS = [{"access": "private", "host": "History", "name": "_checkIframeLoaded", "url": "History.html#method__checkIframeLoaded", "type": "method"}, {"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": "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", "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", "name": "_updateIFrame", "url": "History.html#method__updateIFrame", "type": "method"}]; |
|
|
953 |
</script> |
|
|
954 |
</body> |
|
|
955 |
</html> |