|
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.Module (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.Module |
|
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.Module</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 a browser history module. |
|
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.Module</strong> |
|
70 <code> |
|
71 ( |
|
72 |
|
73 |
|
74 |
|
75 id |
|
76 |
|
77 , |
|
78 initialState |
|
79 ) |
|
80 </code> |
|
81 <div class="description"> |
|
82 <dl rel="yui:parameters"> |
|
83 <dt>Parameters:</dt> |
|
84 <dd rel="yui:parameter"> |
|
85 <code><span property="yui:name">id</span> |
|
86 <<span property="yui:type">String</span>> |
|
87 </code> |
|
88 <span property="yui:description"> the module identifier</span> |
|
89 </dd> |
|
90 <dd rel="yui:parameter"> |
|
91 <code><span property="yui:name">initialState</span> |
|
92 <<span property="yui:type">String</span>> |
|
93 </code> |
|
94 <span property="yui:description"> the module's initial state</span> |
|
95 </dd> |
|
96 </dl> |
|
97 |
|
98 |
|
99 </div> |
|
100 </div> |
|
101 </div> |
|
102 </div> |
|
103 |
|
104 <div rel="yui:properties" resource="#properties"> |
|
105 <div class="section field details"> |
|
106 <h3 id="properties">Properties</h3> |
|
107 <div class="content"> |
|
108 <div class="" rel="yui:property" resource="#property_currentState"> |
|
109 <h4><a name="property_currentState" property="yui:name">currentState</a> |
|
110 - <code>final <span property="yui:type">String</span></code> |
|
111 </h4> |
|
112 <div class="detail"> |
|
113 <div class="description" property="yui:description"> |
|
114 The module's current state |
|
115 </div> |
|
116 </div> |
|
117 |
|
118 |
|
119 |
|
120 |
|
121 <hr /> |
|
122 </div> |
|
123 <div class="" rel="yui:property" resource="#property_id"> |
|
124 <h4><a name="property_id" property="yui:name">id</a> |
|
125 - <code>final <span property="yui:type">String</span></code> |
|
126 </h4> |
|
127 <div class="detail"> |
|
128 <div class="description" property="yui:description"> |
|
129 The module identifier |
|
130 </div> |
|
131 </div> |
|
132 |
|
133 |
|
134 |
|
135 |
|
136 <hr /> |
|
137 </div> |
|
138 <div class="" rel="yui:property" resource="#property_initialState"> |
|
139 <h4><a name="property_initialState" property="yui:name">initialState</a> |
|
140 - <code>final <span property="yui:type">String</span></code> |
|
141 </h4> |
|
142 <div class="detail"> |
|
143 <div class="description" property="yui:description"> |
|
144 The module's initial state |
|
145 </div> |
|
146 </div> |
|
147 |
|
148 |
|
149 |
|
150 |
|
151 <hr /> |
|
152 </div> |
|
153 <div class="private" rel="yui:property" resource="#property_upcomingState"> |
|
154 <h4><a name="property_upcomingState" property="yui:name">upcomingState</a> |
|
155 - <code>private final <span property="yui:type">String</span></code> |
|
156 </h4> |
|
157 <div class="detail"> |
|
158 <div class="description" property="yui:description"> |
|
159 The module's upcoming state. There can be a slight delay between the |
|
160 time a state is changed, and the time a state change is detected. |
|
161 This property allows us to not fire the module state changed event |
|
162 multiple times, making client code simpler. |
|
163 </div> |
|
164 </div> |
|
165 |
|
166 |
|
167 |
|
168 |
|
169 <hr /> |
|
170 </div> |
|
171 </div> |
|
172 </div> |
|
173 |
|
174 </div> |
|
175 |
|
176 <div rel="yui:methods" resource="#methods"> |
|
177 |
|
178 </div> |
|
179 |
|
180 <div rel="yui:events" resource="#events"> |
|
181 |
|
182 |
|
183 </div> |
|
184 |
|
185 <div rel="yui:attributes" resource="#configattributes"> |
|
186 |
|
187 </div> |
|
188 |
|
189 </div> |
|
190 </div> |
|
191 <div class="yui-b"> |
|
192 <div class="nav"> |
|
193 |
|
194 <div id="moduleList" class="module"> |
|
195 <h4>Modules</h4> |
|
196 <ul class="content"> |
|
197 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
198 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
199 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
200 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
201 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
202 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
203 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
204 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
205 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
206 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
207 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
208 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
209 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
210 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
211 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
212 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
213 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
214 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
215 <li class="selected"><a href="module_history.html" title="history">history</a></li> |
|
216 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
217 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
218 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
219 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
220 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
221 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
222 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
223 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
224 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
225 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
226 <li class=""><a href="module_queue.html" title="queue">queue</a></li> |
|
227 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
228 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
229 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
230 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
231 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
232 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
233 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
234 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
235 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
236 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
237 </ul> |
|
238 </div> |
|
239 |
|
240 <div id="classList" class="module"> |
|
241 <h4>Classes</h4> |
|
242 <ul class="content"> |
|
243 <li class=""><a href="History.html" title="History">History</a></li> |
|
244 <li class="selected"><a href="History.Module.html" title="History.Module">History.Module</a></li> |
|
245 </ul> |
|
246 </div> |
|
247 |
|
248 <div id="fileList" class="module"> |
|
249 <h4>Files</h4> |
|
250 <ul class="content"> |
|
251 <li class=""><a href="history.js.html" title="history.js">history.js</a></li> |
|
252 </ul> |
|
253 </div> |
|
254 |
|
255 <div id="propertyList" class="module"> |
|
256 <h4>Properties</h4> |
|
257 <ul class="content"> |
|
258 <li class=""><a href="#property_currentState" title="currentState">currentState</a></li> |
|
259 <li class=""><a href="#property_id" title="id">id</a></li> |
|
260 <li class=""><a href="#property_initialState" title="initialState">initialState</a></li> |
|
261 <li class="private"><a href="#property_upcomingState" title="upcomingState">upcomingState</a></li> |
|
262 </ul> |
|
263 </div> |
|
264 |
|
265 |
|
266 |
|
267 |
|
268 </div> |
|
269 </div> |
|
270 </div> |
|
271 <div id="ft"> |
|
272 <hr /> |
|
273 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
274 </div> |
|
275 </div> |
|
276 <script type="text/javascript"> |
|
277 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"}]; |
|
278 </script> |
|
279 </body> |
|
280 </html> |