319 lines
22 KiB
HTML
319 lines
22 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>API: yahoo YAHOO.js (YUI Library)</title>
|
|
<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">
|
|
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
|
|
<h3>YAHOO Global <span class="subtitle">2.5.1</span></h3>
|
|
<p>
|
|
<a href="./index.html">Yahoo! UI Library</a>
|
|
> <a href="./module_yahoo.html">yahoo</a>
|
|
|
|
> YAHOO.js (source view)
|
|
</p>
|
|
|
|
</div>
|
|
|
|
<div id="bd">
|
|
<div id="yui-main">
|
|
<div class="yui-b">
|
|
<form name="yui-classopts-form">
|
|
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> Show Private</span>
|
|
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> Show Protected</span>
|
|
</form>
|
|
|
|
<div id="srcout">
|
|
<style>
|
|
#doc3 #classopts { display:none; }
|
|
</style>
|
|
<div class="highlight" ><pre><span class="c">/**</span>
|
|
<span class="c"> * The YAHOO object is the single global object used by YUI Library. It</span>
|
|
<span class="c"> * contains utility function for setting up namespaces, inheritance, and</span>
|
|
<span class="c"> * logging. YAHOO.util, YAHOO.widget, and YAHOO.example are namespaces</span>
|
|
<span class="c"> * created automatically for and used by the library.</span>
|
|
<span class="c"> * @module yahoo</span>
|
|
<span class="c"> * @title YAHOO Global</span>
|
|
<span class="c"> */</span>
|
|
|
|
<span class="c">/**</span>
|
|
<span class="c"> * YAHOO_config is not included as part of the library. Instead it is an </span>
|
|
<span class="c"> * object that can be defined by the implementer immediately before </span>
|
|
<span class="c"> * including the YUI library. The properties included in this object</span>
|
|
<span class="c"> * will be used to configure global properties needed as soon as the </span>
|
|
<span class="c"> * library begins to load.</span>
|
|
<span class="c"> * @class YAHOO_config</span>
|
|
<span class="c"> * @static</span>
|
|
<span class="c"> */</span>
|
|
|
|
<span class="c">/**</span>
|
|
<span class="c"> * A reference to a function that will be executed every time a YAHOO module</span>
|
|
<span class="c"> * is loaded. As parameter, this function will receive the version</span>
|
|
<span class="c"> * information for the module. See <a href="YAHOO.env.html#getVersion"></span>
|
|
<span class="c"> * YAHOO.env.getVersion</a> for the description of the version data structure.</span>
|
|
<span class="c"> * @property listener</span>
|
|
<span class="c"> * @type Function</span>
|
|
<span class="c"> * @static</span>
|
|
<span class="c"> * @default undefined</span>
|
|
<span class="c"> */</span>
|
|
|
|
<span class="c">/**</span>
|
|
<span class="c"> * Set to true if the library will be dynamically loaded after window.onload.</span>
|
|
<span class="c"> * Defaults to false </span>
|
|
<span class="c"> * @property injecting</span>
|
|
<span class="c"> * @type boolean</span>
|
|
<span class="c"> * @static</span>
|
|
<span class="c"> * @default undefined</span>
|
|
<span class="c"> */</span>
|
|
|
|
<span class="c">/**</span>
|
|
<span class="c"> * Instructs the yuiloader component to dynamically load yui components and</span>
|
|
<span class="c"> * their dependencies. See the yuiloader documentation for more information</span>
|
|
<span class="c"> * about dynamic loading</span>
|
|
<span class="c"> * @property load</span>
|
|
<span class="c"> * @static</span>
|
|
<span class="c"> * @default undefined</span>
|
|
<span class="c"> * @see yuiloader</span>
|
|
<span class="c"> */</span>
|
|
|
|
<span class="c">/**</span>
|
|
<span class="c"> * Forces the use of the supplied locale where applicable in the library</span>
|
|
<span class="c"> * @property locale</span>
|
|
<span class="c"> * @type string</span>
|
|
<span class="c"> * @static</span>
|
|
<span class="c"> * @default undefined</span>
|
|
<span class="c"> */</span>
|
|
|
|
<span class="k">if</span> <span class="o">(</span><span class="k">typeof</span> <span class="nx">YAHOO</span> <span class="o">==</span> <span class="s2">"undefined"</span> <span class="o">||</span> <span class="o">!</span><span class="nx">YAHOO</span><span class="o">)</span> <span class="o">{</span>
|
|
<span class="c">/**</span>
|
|
<span class="c"> * The YAHOO global namespace object. If YAHOO is already defined, the</span>
|
|
<span class="c"> * existing YAHOO object will not be overwritten so that defined</span>
|
|
<span class="c"> * namespaces are preserved.</span>
|
|
<span class="c"> * @class YAHOO</span>
|
|
<span class="c"> * @static</span>
|
|
<span class="c"> */</span>
|
|
<span class="k">var</span> <span class="nx">YAHOO</span> <span class="o">=</span> <span class="o">{};</span>
|
|
<span class="o">}</span>
|
|
|
|
<span class="c">/**</span>
|
|
<span class="c"> * Returns the namespace specified and creates it if it doesn't exist</span>
|
|
<span class="c"> * <pre></span>
|
|
<span class="c"> * YAHOO.namespace("property.package");</span>
|
|
<span class="c"> * YAHOO.namespace("YAHOO.property.package");</span>
|
|
<span class="c"> * </pre></span>
|
|
<span class="c"> * Either of the above would create YAHOO.property, then</span>
|
|
<span class="c"> * YAHOO.property.package</span>
|
|
<span class="c"> *</span>
|
|
<span class="c"> * Be careful when naming packages. Reserved words may work in some browsers</span>
|
|
<span class="c"> * and not others. For instance, the following will fail in Safari:</span>
|
|
<span class="c"> * <pre></span>
|
|
<span class="c"> * YAHOO.namespace("really.long.nested.namespace");</span>
|
|
<span class="c"> * </pre></span>
|
|
<span class="c"> * This fails because "long" is a future reserved word in ECMAScript</span>
|
|
<span class="c"> *</span>
|
|
<span class="c"> * @method namespace</span>
|
|
<span class="c"> * @static</span>
|
|
<span class="c"> * @param {String*} arguments 1-n namespaces to create </span>
|
|
<span class="c"> * @return {Object} A reference to the last namespace object created</span>
|
|
<span class="c"> */</span>
|
|
<span class="nx">YAHOO</span><span class="o">.</span><span class="nx">namespace</span> <span class="o">=</span> <span class="k">function</span><span class="o">()</span> <span class="o">{</span>
|
|
<span class="k">var</span> <span class="nx">a</span><span class="o">=</span><span class="nx">arguments</span><span class="o">,</span> <span class="nx">o</span><span class="o">=</span><span class="kc">null</span><span class="o">,</span> <span class="nx">i</span><span class="o">,</span> <span class="nx">j</span><span class="o">,</span> <span class="nx">d</span><span class="o">;</span>
|
|
<span class="k">for</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">i</span><span class="o"><</span><span class="nx">a</span><span class="o">.</span><span class="nx">length</span><span class="o">;</span> <span class="nx">i</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">d</span><span class="o">=</span><span class="nx">a</span><span class="o">[</span><span class="nx">i</span><span class="o">].</span><span class="nx">split</span><span class="o">(</span><span class="s2">"."</span><span class="o">);</span>
|
|
<span class="nx">o</span><span class="o">=</span><span class="nx">YAHOO</span><span class="o">;</span>
|
|
|
|
<span class="c">// YAHOO is implied, so it is ignored if it is included</span>
|
|
<span class="c"></span> <span class="k">for</span> <span class="o">(</span><span class="nx">j</span><span class="o">=(</span><span class="nx">d</span><span class="o">[</span><span class="m">0</span><span class="o">]</span> <span class="o">==</span> <span class="s2">"YAHOO"</span><span class="o">)</span> <span class="o">?</span> <span class="m">1</span> <span class="o">:</span> <span class="m">0</span><span class="o">;</span> <span class="nx">j</span><span class="o"><</span><span class="nx">d</span><span class="o">.</span><span class="nx">length</span><span class="o">;</span> <span class="nx">j</span><span class="o">=</span><span class="nx">j</span><span class="o">+</span><span class="m">1</span><span class="o">)</span> <span class="o">{</span>
|
|
<span class="nx">o</span><span class="o">[</span><span class="nx">d</span><span class="o">[</span><span class="nx">j</span><span class="o">]]=</span><span class="nx">o</span><span class="o">[</span><span class="nx">d</span><span class="o">[</span><span class="nx">j</span><span class="o">]]</span> <span class="o">||</span> <span class="o">{};</span>
|
|
<span class="nx">o</span><span class="o">=</span><span class="nx">o</span><span class="o">[</span><span class="nx">d</span><span class="o">[</span><span class="nx">j</span><span class="o">]];</span>
|
|
<span class="o">}</span>
|
|
<span class="o">}</span>
|
|
|
|
<span class="k">return</span> <span class="nx">o</span><span class="o">;</span>
|
|
<span class="o">};</span>
|
|
|
|
<span class="c">/**</span>
|
|
<span class="c"> * Uses YAHOO.widget.Logger to output a log message, if the widget is</span>
|
|
<span class="c"> * available.</span>
|
|
<span class="c"> *</span>
|
|
<span class="c"> * @method log</span>
|
|
<span class="c"> * @static</span>
|
|
<span class="c"> * @param {String} msg The message to log.</span>
|
|
<span class="c"> * @param {String} cat The log category for the message. Default</span>
|
|
<span class="c"> * categories are "info", "warn", "error", time".</span>
|
|
<span class="c"> * Custom categories can be used as well. (opt)</span>
|
|
<span class="c"> * @param {String} src The source of the the message (opt)</span>
|
|
<span class="c"> * @return {Boolean} True if the log operation was successful.</span>
|
|
<span class="c"> */</span>
|
|
<span class="nx">YAHOO</span><span class="o">.</span><span class="nx">log</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">msg</span><span class="o">,</span> <span class="nx">cat</span><span class="o">,</span> <span class="nx">src</span><span class="o">)</span> <span class="o">{</span>
|
|
<span class="k">var</span> <span class="nx">l</span><span class="o">=</span><span class="nx">YAHOO</span><span class="o">.</span><span class="nx">widget</span><span class="o">.</span><span class="nx">Logger</span><span class="o">;</span>
|
|
<span class="k">if</span><span class="o">(</span><span class="nx">l</span> <span class="o">&&</span> <span class="nx">l</span><span class="o">.</span><span class="nx">log</span><span class="o">)</span> <span class="o">{</span>
|
|
<span class="k">return</span> <span class="nx">l</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="nx">msg</span><span class="o">,</span> <span class="nx">cat</span><span class="o">,</span> <span class="nx">src</span><span class="o">);</span>
|
|
<span class="o">}</span> <span class="k">else</span> <span class="o">{</span>
|
|
<span class="k">return</span> <span class="kc">false</span><span class="o">;</span>
|
|
<span class="o">}</span>
|
|
<span class="o">};</span>
|
|
|
|
<span class="c">/**</span>
|
|
<span class="c"> * Registers a module with the YAHOO object</span>
|
|
<span class="c"> * @method register</span>
|
|
<span class="c"> * @static</span>
|
|
<span class="c"> * @param {String} name the name of the module (event, slider, etc)</span>
|
|
<span class="c"> * @param {Function} mainClass a reference to class in the module. This</span>
|
|
<span class="c"> * class will be tagged with the version info</span>
|
|
<span class="c"> * so that it will be possible to identify the</span>
|
|
<span class="c"> * version that is in use when multiple versions</span>
|
|
<span class="c"> * have loaded</span>
|
|
<span class="c"> * @param {Object} data metadata object for the module. Currently it</span>
|
|
<span class="c"> * is expected to contain a "version" property</span>
|
|
<span class="c"> * and a "build" property at minimum.</span>
|
|
<span class="c"> */</span>
|
|
<span class="nx">YAHOO</span><span class="o">.</span><span class="nx">register</span> <span class="o">=</span> <span class="k">function</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">mainClass</span><span class="o">,</span> <span class="nx">data</span><span class="o">)</span> <span class="o">{</span>
|
|
<span class="k">var</span> <span class="nx">mods</span> <span class="o">=</span> <span class="nx">YAHOO</span><span class="o">.</span><span class="nx">env</span><span class="o">.</span><span class="nx">modules</span><span class="o">;</span>
|
|
<span class="k">if</span> <span class="o">(!</span><span class="nx">mods</span><span class="o">[</span><span class="nx">name</span><span class="o">])</span> <span class="o">{</span>
|
|
<span class="nx">mods</span><span class="o">[</span><span class="nx">name</span><span class="o">]</span> <span class="o">=</span> <span class="o">{</span> <span class="nx">versions</span><span class="o">:[],</span> <span class="nx">builds</span><span class="o">:[]</span> <span class="o">};</span>
|
|
<span class="o">}</span>
|
|
<span class="k">var</span> <span class="nx">m</span><span class="o">=</span><span class="nx">mods</span><span class="o">[</span><span class="nx">name</span><span class="o">],</span><span class="nx">v</span><span class="o">=</span><span class="nx">data</span><span class="o">.</span><span class="nx">version</span><span class="o">,</span><span class="nx">b</span><span class="o">=</span><span class="nx">data</span><span class="o">.</span><span class="nx">build</span><span class="o">,</span><span class="nx">ls</span><span class="o">=</span><span class="nx">YAHOO</span><span class="o">.</span><span class="nx">env</span><span class="o">.</span><span class="nx">listeners</span><span class="o">;</span>
|
|
<span class="nx">m</span><span class="o">.</span><span class="nx">name</span> <span class="o">=</span> <span class="nx">name</span><span class="o">;</span>
|
|
<span class="nx">m</span><span class="o">.</span><span class="nx">version</span> <span class="o">=</span> <span class="nx">v</span><span class="o">;</span>
|
|
<span class="nx">m</span><span class="o">.</span><span class="nx">build</span> <span class="o">=</span> <span class="nx">b</span><span class="o">;</span>
|
|
<span class="nx">m</span><span class="o">.</span><span class="nx">versions</span><span class="o">.</span><span class="nx">push</span><span class="o">(</span><span class="nx">v</span><span class="o">);</span>
|
|
<span class="nx">m</span><span class="o">.</span><span class="nx">builds</span><span class="o">.</span><span class="nx">push</span><span class="o">(</span><span class="nx">b</span><span class="o">);</span>
|
|
<span class="nx">m</span><span class="o">.</span><span class="nx">mainClass</span> <span class="o">=</span> <span class="nx">mainClass</span><span class="o">;</span>
|
|
<span class="c">// fire the module load listeners</span>
|
|
<span class="c"></span> <span class="k">for</span> <span class="o">(</span><span class="k">var</span> <span class="nx">i</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="nx">ls</span><span class="o">.</span><span class="nx">length</span><span class="o">;</span><span class="nx">i</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">ls</span><span class="o">[</span><span class="nx">i</span><span class="o">](</span><span class="nx">m</span><span class="o">);</span>
|
|
<span class="o">}</span>
|
|
<span class="c">// label the main class</span>
|
|
<span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">mainClass</span><span class="o">)</span> <span class="o">{</span>
|
|
<span class="nx">mainClass</span><span class="o">.</span><span class="nx">VERSION</span> <span class="o">=</span> <span class="nx">v</span><span class="o">;</span>
|
|
<span class="nx">mainClass</span><span class="o">.</span><span class="nx">BUILD</span> <span class="o">=</span> <span class="nx">b</span><span class="o">;</span>
|
|
<span class="o">}</span> <span class="k">else</span> <span class="o">{</span>
|
|
<span class="nx">YAHOO</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"mainClass is undefined for module "</span> <span class="o">+</span> <span class="nx">name</span><span class="o">,</span> <span class="s2">"warn"</span><span class="o">);</span>
|
|
<span class="o">}</span>
|
|
<span class="o">};</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="yui-b">
|
|
<div class="nav">
|
|
|
|
<div class="module">
|
|
<h4>Modules</h4>
|
|
<ul class="content">
|
|
|
|
<li class=""><a href="module_animation.html">animation</a></li>
|
|
|
|
<li class=""><a href="module_autocomplete.html">autocomplete</a></li>
|
|
|
|
<li class=""><a href="module_button.html">button</a></li>
|
|
|
|
<li class=""><a href="module_calendar.html">calendar</a></li>
|
|
|
|
<li class=""><a href="module_charts.html">charts</a></li>
|
|
|
|
<li class=""><a href="module_colorpicker.html">colorpicker</a></li>
|
|
|
|
<li class=""><a href="module_connection.html">connection</a></li>
|
|
|
|
<li class=""><a href="module_container.html">container</a></li>
|
|
|
|
<li class=""><a href="module_cookie.html">cookie</a></li>
|
|
|
|
<li class=""><a href="module_datasource.html">datasource</a></li>
|
|
|
|
<li class=""><a href="module_datatable.html">datatable</a></li>
|
|
|
|
<li class=""><a href="module_dom.html">dom</a></li>
|
|
|
|
<li class=""><a href="module_dragdrop.html">dragdrop</a></li>
|
|
|
|
<li class=""><a href="module_editor.html">editor</a></li>
|
|
|
|
<li class=""><a href="module_element.html">element</a></li>
|
|
|
|
<li class=""><a href="module_event.html">event</a></li>
|
|
|
|
<li class=""><a href="module_get.html">get</a></li>
|
|
|
|
<li class=""><a href="module_history.html">history</a></li>
|
|
|
|
<li class=""><a href="module_imagecropper.html">imagecropper</a></li>
|
|
|
|
<li class=""><a href="module_imageloader.html">imageloader</a></li>
|
|
|
|
<li class=""><a href="module_json.html">json</a></li>
|
|
|
|
<li class=""><a href="module_layout.html">layout</a></li>
|
|
|
|
<li class=""><a href="module_logger.html">logger</a></li>
|
|
|
|
<li class=""><a href="module_menu.html">menu</a></li>
|
|
|
|
<li class=""><a href="module_profiler.html">profiler</a></li>
|
|
|
|
<li class=""><a href="module_profilerviewer.html">profilerviewer</a></li>
|
|
|
|
<li class=""><a href="module_resize.html">resize</a></li>
|
|
|
|
<li class=""><a href="module_selector.html">selector</a></li>
|
|
|
|
<li class=""><a href="module_slider.html">slider</a></li>
|
|
|
|
<li class=""><a href="module_tabview.html">tabview</a></li>
|
|
|
|
<li class=""><a href="module_treeview.html">treeview</a></li>
|
|
|
|
<li class=""><a href="module_uploader.html">uploader</a></li>
|
|
|
|
<li class="selected"><a href="module_yahoo.html">yahoo</a></li>
|
|
|
|
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
|
|
|
|
<li class=""><a href="module_yuitest.html">yuitest</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Classes</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="YAHOO.html">YAHOO</a></li>
|
|
<li class=""><a href="YAHOO.env.html">YAHOO.env</a></li>
|
|
<li class=""><a href="YAHOO.env.ua.html">YAHOO.env.ua</a></li>
|
|
<li class=""><a href="YAHOO.lang.html">YAHOO.lang</a></li>
|
|
<li class=""><a href="YAHOO_config.html">YAHOO_config</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Files</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="Env.js.html">Env.js</a></li>
|
|
<li class=""><a href="Lang.js.html">Lang.js</a></li>
|
|
<li class="selected"><a href="YAHOO.js.html">YAHOO.js</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="ft">
|
|
<hr />
|
|
Copyright © 2007 Yahoo! Inc. All rights reserved.
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|