mirror of
https://github.com/alchemy-fr/Phraseanet.git
synced 2025-10-13 21:13:26 +00:00
1076 lines
62 KiB
HTML
1076 lines
62 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
|
|
<head>
|
|
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
|
|
<title>API: history YAHOO.util.History (YUI Library)</title>
|
|
|
|
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
|
|
<link rel="stylesheet" type="text/css" href="assets/api.css" />
|
|
|
|
<script type="text/javascript" src="assets/api-js"></script>
|
|
<script type="text/javascript" src="assets/ac-js"></script>
|
|
</head>
|
|
|
|
<body id="yahoo-com">
|
|
|
|
<div id="doc3" class="yui-t2">
|
|
<div id="hd">
|
|
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1>
|
|
<h3>Browser History Manager <span class="subtitle">2.8.2r1</span></h3>
|
|
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
|
|
> <a href="./module_history.html" title="history">history</a>
|
|
> YAHOO.util.History
|
|
|
|
<form onsubmit="return false">
|
|
<div id="propertysearch">
|
|
Search: <input autocomplete="off" id="searchinput" />
|
|
<div id="searchresults">
|
|
|
|
</div>
|
|
</div>
|
|
</form>
|
|
</div>
|
|
|
|
<div id="bd">
|
|
<div id="yui-main">
|
|
<div class="yui-b">
|
|
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
|
|
<fieldset>
|
|
<legend>Filters</legend>
|
|
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
|
|
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
|
|
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
|
|
</fieldset>
|
|
</form>
|
|
|
|
<h2>
|
|
|
|
|
|
|
|
|
|
Class <b property="yui:name">YAHOO.util.History</b>
|
|
<span class="extends">
|
|
</span>
|
|
|
|
</h2>
|
|
<!-- class tree goes here -->
|
|
|
|
|
|
|
|
|
|
<div class="summary description" property="yui:description">
|
|
The History class provides the ability to use the back/forward navigation
|
|
buttons in a DHTML application. It also allows a DHTML application to
|
|
be bookmarked in a specific state.
|
|
</div>
|
|
|
|
<div class="section constructor details" rel="yui:constructor" resource="#constructor">
|
|
<h3 id="constructor">Constructor</h3>
|
|
<div class="content">
|
|
<div class="detail">
|
|
<strong property="yui:name">YAHOO.util.History</strong>
|
|
<code>
|
|
(
|
|
)
|
|
</code>
|
|
<div class="description">
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div rel="yui:properties" resource="#properties">
|
|
<div class="section field details">
|
|
<h3 id="properties">Properties</h3>
|
|
<div class="content">
|
|
<div class="private" rel="yui:property" resource="#property__fqstates">
|
|
<h4><a name="property__fqstates" property="yui:name">_fqstates</a>
|
|
- <code>private <span property="yui:type">array</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
List of fully qualified states. This is used only by Safari.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default" property="yui:defaultValue">
|
|
Default Value: []
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__histFrame">
|
|
<h4><a name="property__histFrame" property="yui:name">_histFrame</a>
|
|
- <code>private <span property="yui:type">HTMLIFrameElement</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Our hidden IFrame used to store the browsing history.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default" property="yui:defaultValue">
|
|
Default Value: null
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__initialized">
|
|
<h4><a name="property__initialized" property="yui:name">_initialized</a>
|
|
- <code>private <span property="yui:type">boolean</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
Flag used to tell whether YAHOO.util.History.initialize has been called.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default" property="yui:defaultValue">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__modules">
|
|
<h4><a name="property__modules" property="yui:name">_modules</a>
|
|
- <code>private <span property="yui:type">array</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
List of registered modules.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default" property="yui:defaultValue">
|
|
Default Value: []
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:property" resource="#property__stateField">
|
|
<h4><a name="property__stateField" property="yui:name">_stateField</a>
|
|
- <code>private <span property="yui:type">HTMLInputElement|HTMLTextAreaElement</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
INPUT field (with type="hidden" or type="text") or TEXTAREA.
|
|
This field keeps the value of the initial state, current state
|
|
the list of all states across pages within a single browser session.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default" property="yui:defaultValue">
|
|
Default Value: null
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div rel="yui:methods" resource="#methods">
|
|
<div class="section method details">
|
|
<h3 id="methods">Methods</h3>
|
|
<div class="content">
|
|
<div class="private" rel="yui:method" resource="#method__checkIframeLoaded">
|
|
<h4>
|
|
<a name="method__checkIframeLoaded">_checkIframeLoaded</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_checkIframeLoaded</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Periodically checks whether our internal IFrame is ready to be used.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__getHash">
|
|
<h4>
|
|
<a name="method__getHash">_getHash</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
string
|
|
<strong property="yui:name">_getHash</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
location.hash is a bit buggy on Opera. I have seen instances where
|
|
navigating the history using the back/forward buttons, and hence
|
|
changing the URL, would not change location.hash. That's ok, the
|
|
implementation of an equivalent is trivial.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
string
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">The hash portion of the document's location</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__handleFQStateChange">
|
|
<h4>
|
|
<a name="method__handleFQStateChange">_handleFQStateChange</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_handleFQStateChange</strong>
|
|
(
|
|
|
|
|
|
fqstate
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Sets the new currentState attribute of all modules depending on the new
|
|
fully qualified state. Also notifies the modules which current state has
|
|
changed.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">fqstate</span>
|
|
<<span property="yui:type">string</span>>
|
|
</code>
|
|
<span property="yui:description"> Fully qualified state</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__initialize">
|
|
<h4>
|
|
<a name="method__initialize">_initialize</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_initialize</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Finish up the initialization of the Browser History Manager.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__storeStates">
|
|
<h4>
|
|
<a name="method__storeStates">_storeStates</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong property="yui:name">_storeStates</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Stores all the registered modules' initial state and current state.
|
|
On Safari, we also store all the fully qualified states visited by
|
|
the application within a single browser session. The storage takes
|
|
place in the form field specified during initialization.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private" rel="yui:method" resource="#method__updateIFrame">
|
|
<h4>
|
|
<a name="method__updateIFrame">_updateIFrame</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
private
|
|
|
|
|
|
boolean
|
|
<strong property="yui:name">_updateIFrame</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Update the IFrame with our new state.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
boolean
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">true if successful. false otherwise.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_getBookmarkedState">
|
|
<h4>
|
|
<a name="method_getBookmarkedState">getBookmarkedState</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
string
|
|
<strong property="yui:name">getBookmarkedState</strong>
|
|
(
|
|
|
|
|
|
module
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Returns the state of a module according to the URL fragment
|
|
identifier. This method is useful to initialize your modules
|
|
if your application was bookmarked from a particular state.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">module</span>
|
|
<<span property="yui:type">string</span>>
|
|
</code>
|
|
<span property="yui:description"> Non-empty string representing your module.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
string
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">The bookmarked state of the specified module.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_getCurrentState">
|
|
<h4>
|
|
<a name="method_getCurrentState">getCurrentState</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
string
|
|
<strong property="yui:name">getCurrentState</strong>
|
|
(
|
|
|
|
|
|
module
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Returns the current state of the specified module.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">module</span>
|
|
<<span property="yui:type">string</span>>
|
|
</code>
|
|
<span property="yui:description"> Non-empty string representing your module.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
string
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">The current state of the specified module.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_getQueryStringParameter">
|
|
<h4>
|
|
<a name="method_getQueryStringParameter">getQueryStringParameter</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
string
|
|
<strong property="yui:name">getQueryStringParameter</strong>
|
|
(
|
|
|
|
|
|
paramName
|
|
|
|
|
|
,
|
|
queryString
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Returns the value of the specified query string parameter.
|
|
This method is not used internally by the Browser History Manager.
|
|
However, it is provided here as a helper since many applications
|
|
using the Browser History Manager will want to read the value of
|
|
url parameters to initialize themselves.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">paramName</span>
|
|
<<span property="yui:type">string</span>>
|
|
</code>
|
|
<span property="yui:description"> Name of the parameter we want to look up.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">queryString</span>
|
|
<<span property="yui:type">string</span>>
|
|
</code>
|
|
<span property="yui:description"> Optional URL to look at. If not specified,
|
|
this method uses the URL in the address bar.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
string
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">The value of the specified parameter, or null.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_initialize">
|
|
<h4>
|
|
<a name="method_initialize">initialize</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong property="yui:name">initialize</strong>
|
|
(
|
|
|
|
|
|
stateField
|
|
|
|
|
|
,
|
|
histFrame
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Initializes the Browser History Manager. Call this method
|
|
from a script block located right after the opening body tag.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">stateField</span>
|
|
<<span property="yui:type">string|HTML Element</span>>
|
|
</code>
|
|
<span property="yui:description"> <input type="hidden"> used
|
|
to store application states. Must be in the static markup.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">histFrame</span>
|
|
<<span property="yui:type">string|HTML Element</span>>
|
|
</code>
|
|
<span property="yui:description"> IFrame used to store
|
|
the history (only required on Internet Explorer)</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_multiNavigate">
|
|
<h4>
|
|
<a name="method_multiNavigate">multiNavigate</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
boolean
|
|
<strong property="yui:name">multiNavigate</strong>
|
|
(
|
|
|
|
|
|
states
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Call this method when you want to store a new entry in the browser's history.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">states</span>
|
|
<<span property="yui:type">object</span>>
|
|
</code>
|
|
<span property="yui:description"> Associative array of module-state pairs to set simultaneously.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
boolean
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">Indicates whether the new state was successfully added to the history.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_navigate">
|
|
<h4>
|
|
<a name="method_navigate">navigate</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
boolean
|
|
<strong property="yui:name">navigate</strong>
|
|
(
|
|
|
|
|
|
module
|
|
|
|
|
|
,
|
|
state
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Call this method when you want to store a new entry in the browser's history.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">module</span>
|
|
<<span property="yui:type">string</span>>
|
|
</code>
|
|
<span property="yui:description"> Non-empty string representing your module.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">state</span>
|
|
<<span property="yui:type">string</span>>
|
|
</code>
|
|
<span property="yui:description"> String representing the new state of the specified module.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
boolean
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">Indicates whether the new state was successfully added to the history.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_onReady">
|
|
<h4>
|
|
<a name="method_onReady">onReady</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong property="yui:name">onReady</strong>
|
|
(
|
|
|
|
|
|
fn
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
,
|
|
overrideContext
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Executes the supplied callback when the Browser History Manager is
|
|
ready. This will execute immediately if called after the Browser
|
|
History Manager onLoad event has fired.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">fn</span>
|
|
<<span property="yui:type">function</span>>
|
|
</code>
|
|
<span property="yui:description"> what to execute when the Browser History Manager is ready.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">obj</span>
|
|
<<span property="yui:type">object</span>>
|
|
</code>
|
|
<span property="yui:description"> an optional object to be passed back as a parameter to fn.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">overrideContext</span>
|
|
<<span property="yui:type">boolean|object</span>>
|
|
</code>
|
|
<span property="yui:description"> If true, the obj passed in becomes fn's execution scope.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_register">
|
|
<h4>
|
|
<a name="method_register">register</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong property="yui:name">register</strong>
|
|
(
|
|
|
|
|
|
module
|
|
|
|
|
|
,
|
|
initialState
|
|
|
|
|
|
,
|
|
onStateChange
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
,
|
|
overrideContext
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Registers a new module.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">module</span>
|
|
<<span property="yui:type">string</span>>
|
|
</code>
|
|
<span property="yui:description"> Non-empty string uniquely identifying the
|
|
module you wish to register.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">initialState</span>
|
|
<<span property="yui:type">string</span>>
|
|
</code>
|
|
<span property="yui:description"> The initial state of the specified
|
|
module corresponding to its earliest history entry.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">onStateChange</span>
|
|
<<span property="yui:type">function</span>>
|
|
</code>
|
|
<span property="yui:description"> Callback called when the
|
|
state of the specified module has changed.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">obj</span>
|
|
<<span property="yui:type">object</span>>
|
|
</code>
|
|
<span property="yui:description"> An arbitrary object that will be passed as a
|
|
parameter to the handler.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">overrideContext</span>
|
|
<<span property="yui:type">boolean</span>>
|
|
</code>
|
|
<span property="yui:description"> If true, the obj passed in becomes the
|
|
execution scope of the listener.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div rel="yui:events" resource="#events">
|
|
<div class="section method details">
|
|
<h3 id="events">Events</h3>
|
|
<div class="content">
|
|
<div class="" rel="yui:event" resource="#event_onLoadEvent">
|
|
<h4>
|
|
<a name="event_onLoadEvent">onLoadEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong property="yui:name">onLoadEvent</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Fired when the Browser History Manager is ready. If you subscribe to
|
|
this event after the Browser History Manager has been initialized,
|
|
it will not fire. Therefore, it is recommended to use the onReady
|
|
method instead.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div rel="yui:attributes" resource="#configattributes">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="yui-b">
|
|
<div class="nav">
|
|
|
|
<div id="moduleList" class="module">
|
|
<h4>Modules</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="module_animation.html" title="animation">animation</a></li>
|
|
<li class=""><a href="module_autocomplete.html" title="autocomplete">autocomplete</a></li>
|
|
<li class=""><a href="module_button.html" title="button">button</a></li>
|
|
<li class=""><a href="module_calendar.html" title="calendar">calendar</a></li>
|
|
<li class=""><a href="module_carousel.html" title="carousel">carousel</a></li>
|
|
<li class=""><a href="module_charts.html" title="charts">charts</a></li>
|
|
<li class=""><a href="module_colorpicker.html" title="colorpicker">colorpicker</a></li>
|
|
<li class=""><a href="module_connection.html" title="connection">connection</a></li>
|
|
<li class=""><a href="module_container.html" title="container">container</a></li>
|
|
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
|
|
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li>
|
|
<li class=""><a href="module_datatable.html" title="datatable">datatable</a></li>
|
|
<li class=""><a href="module_datemath.html" title="datemath">datemath</a></li>
|
|
<li class=""><a href="module_dom.html" title="dom">dom</a></li>
|
|
<li class=""><a href="module_dragdrop.html" title="dragdrop">dragdrop</a></li>
|
|
<li class=""><a href="module_editor.html" title="editor">editor</a></li>
|
|
<li class=""><a href="module_element.html" title="element">element</a></li>
|
|
<li class=""><a href="module_element-delegate.html" title="element-delegate">element-delegate</a></li>
|
|
<li class=""><a href="module_event.html" title="event">event</a></li>
|
|
<li class=""><a href="module_event-delegate.html" title="event-delegate">event-delegate</a></li>
|
|
<li class=""><a href="module_event-mouseenter.html" title="event-mouseenter">event-mouseenter</a></li>
|
|
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li>
|
|
<li class=""><a href="module_get.html" title="get">get</a></li>
|
|
<li class="selected"><a href="module_history.html" title="history">history</a></li>
|
|
<li class=""><a href="module_imagecropper.html" title="imagecropper">imagecropper</a></li>
|
|
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li>
|
|
<li class=""><a href="module_json.html" title="json">json</a></li>
|
|
<li class=""><a href="module_layout.html" title="layout">layout</a></li>
|
|
<li class=""><a href="module_logger.html" title="logger">logger</a></li>
|
|
<li class=""><a href="module_menu.html" title="menu">menu</a></li>
|
|
<li class=""><a href="module_paginator.html" title="paginator">paginator</a></li>
|
|
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li>
|
|
<li class=""><a href="module_profilerviewer.html" title="profilerviewer">profilerviewer</a></li>
|
|
<li class=""><a href="module_progressbar.html" title="progressbar">progressbar</a></li>
|
|
<li class=""><a href="module_resize.html" title="resize">resize</a></li>
|
|
<li class=""><a href="module_selector.html" title="selector">selector</a></li>
|
|
<li class=""><a href="module_slider.html" title="slider">slider</a></li>
|
|
<li class=""><a href="module_storage.html" title="Storage">Storage</a></li>
|
|
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
|
|
<li class=""><a href="module_swf.html" title="swf">swf</a></li>
|
|
<li class=""><a href="module_swfdetect.html" title="swfdetect">swfdetect</a></li>
|
|
<li class=""><a href="module_swfstore.html" title="swfstore">swfstore</a></li>
|
|
<li class=""><a href="module_tabview.html" title="tabview">tabview</a></li>
|
|
<li class=""><a href="module_treeview.html" title="treeview">treeview</a></li>
|
|
<li class=""><a href="module_uploader.html" title="uploader">uploader</a></li>
|
|
<li class=""><a href="module_yahoo.html" title="yahoo">yahoo</a></li>
|
|
<li class=""><a href="module_yuiloader.html" title="yuiloader">yuiloader</a></li>
|
|
<li class=""><a href="module_yuitest.html" title="yuitest">yuitest</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="classList" class="module">
|
|
<h4>Classes</h4>
|
|
<ul class="content">
|
|
<li class="selected"><a href="YAHOO.util.History.html" title="YAHOO.util.History">YAHOO.util.History</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="fileList" class="module">
|
|
<h4>Files</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="history.js.html" title="history.js">history.js</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="propertyList" class="module">
|
|
<h4>Properties</h4>
|
|
<ul class="content">
|
|
<li class="private"><a href="#property__fqstates" title="_fqstates">_fqstates</a></li>
|
|
<li class="private"><a href="#property__histFrame" title="_histFrame">_histFrame</a></li>
|
|
<li class="private"><a href="#property__initialized" title="_initialized">_initialized</a></li>
|
|
<li class="private"><a href="#property__modules" title="_modules">_modules</a></li>
|
|
<li class="private"><a href="#property__stateField" title="_stateField">_stateField</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="methodsList" class="module">
|
|
<h4>Methods</h4>
|
|
<ul class="content">
|
|
<li class="private"><a href="#method__checkIframeLoaded" title="_checkIframeLoaded">_checkIframeLoaded</a></li>
|
|
<li class="private"><a href="#method__getHash" title="_getHash">_getHash</a></li>
|
|
<li class="private"><a href="#method__handleFQStateChange" title="_handleFQStateChange">_handleFQStateChange</a></li>
|
|
<li class="private"><a href="#method__initialize" title="_initialize">_initialize</a></li>
|
|
<li class="private"><a href="#method__storeStates" title="_storeStates">_storeStates</a></li>
|
|
<li class="private"><a href="#method__updateIFrame" title="_updateIFrame">_updateIFrame</a></li>
|
|
<li class=""><a href="#method_getBookmarkedState" title="getBookmarkedState">getBookmarkedState</a></li>
|
|
<li class=""><a href="#method_getCurrentState" title="getCurrentState">getCurrentState</a></li>
|
|
<li class=""><a href="#method_getQueryStringParameter" title="getQueryStringParameter">getQueryStringParameter</a></li>
|
|
<li class=""><a href="#method_initialize" title="initialize">initialize</a></li>
|
|
<li class=""><a href="#method_multiNavigate" title="multiNavigate">multiNavigate</a></li>
|
|
<li class=""><a href="#method_navigate" title="navigate">navigate</a></li>
|
|
<li class=""><a href="#method_onReady" title="onReady">onReady</a></li>
|
|
<li class=""><a href="#method_register" title="register">register</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="eventsList" class="module">
|
|
<h4>Events</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="#event_onLoadEvent" title="onLoadEvent">onLoadEvent</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="ft">
|
|
<hr />
|
|
Copyright © 2010 Yahoo! Inc. All rights reserved.
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
|
|
var ALL_YUI_PROPS = [{"access": "private", "host": "YAHOO.util.History", "name": "_checkIframeLoaded", "url": "YAHOO.util.History.html#method__checkIframeLoaded", "type": "method"}, {"access": "private", "host": "YAHOO.util.History", "name": "_fqstates", "url": "YAHOO.util.History.html#property__fqstates", "type": "property"}, {"access": "", "host": "YAHOO.util.History", "name": "getBookmarkedState", "url": "YAHOO.util.History.html#method_getBookmarkedState", "type": "method"}, {"access": "", "host": "YAHOO.util.History", "name": "getCurrentState", "url": "YAHOO.util.History.html#method_getCurrentState", "type": "method"}, {"access": "private", "host": "YAHOO.util.History", "name": "_getHash", "url": "YAHOO.util.History.html#method__getHash", "type": "method"}, {"access": "", "host": "YAHOO.util.History", "name": "getQueryStringParameter", "url": "YAHOO.util.History.html#method_getQueryStringParameter", "type": "method"}, {"access": "private", "host": "YAHOO.util.History", "name": "_handleFQStateChange", "url": "YAHOO.util.History.html#method__handleFQStateChange", "type": "method"}, {"access": "private", "host": "YAHOO.util.History", "name": "_histFrame", "url": "YAHOO.util.History.html#property__histFrame", "type": "property"}, {"access": "private", "host": "YAHOO.util.History", "name": "_initialize", "url": "YAHOO.util.History.html#method__initialize", "type": "method"}, {"access": "", "host": "YAHOO.util.History", "name": "initialize", "url": "YAHOO.util.History.html#method_initialize", "type": "method"}, {"access": "private", "host": "YAHOO.util.History", "name": "_initialized", "url": "YAHOO.util.History.html#property__initialized", "type": "property"}, {"access": "private", "host": "YAHOO.util.History", "name": "_modules", "url": "YAHOO.util.History.html#property__modules", "type": "property"}, {"access": "", "host": "YAHOO.util.History", "name": "multiNavigate", "url": "YAHOO.util.History.html#method_multiNavigate", "type": "method"}, {"access": "", "host": "YAHOO.util.History", "name": "navigate", "url": "YAHOO.util.History.html#method_navigate", "type": "method"}, {"access": "", "host": "YAHOO.util.History", "name": "onLoadEvent", "url": "YAHOO.util.History.html#event_onLoadEvent", "type": "event"}, {"access": "", "host": "YAHOO.util.History", "name": "onReady", "url": "YAHOO.util.History.html#method_onReady", "type": "method"}, {"access": "", "host": "YAHOO.util.History", "name": "register", "url": "YAHOO.util.History.html#method_register", "type": "method"}, {"access": "private", "host": "YAHOO.util.History", "name": "_stateField", "url": "YAHOO.util.History.html#property__stateField", "type": "property"}, {"access": "private", "host": "YAHOO.util.History", "name": "_storeStates", "url": "YAHOO.util.History.html#method__storeStates", "type": "method"}, {"access": "private", "host": "YAHOO.util.History", "name": "_updateIFrame", "url": "YAHOO.util.History.html#method__updateIFrame", "type": "method"}];
|
|
</script>
|
|
</body>
|
|
</html>
|