webgui/www/extras/yui/docs/YAHOO_config.html
JT Smith 20f8df1291 upgrading to YUI 2.6
data tables are going to need some work yet, but the other stuff seems to be working 100%
2008-10-22 23:53:29 +00:00

293 lines
12 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_config (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&nbsp; <span class="subtitle">2.6.0</span></h3>
<p>
<a href="./index.html">Yahoo! UI Library</a>
&gt; <a href="./module_yahoo.html">yahoo</a>
&gt; YAHOO_config
</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" /> <label for="showprivate">Show Private</label></span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> <label for="showprotected">Show Protected</label></span>
<span id="classopts"><input type="checkbox" name="showdeprecated" id="showdeprecated" /> <label for="showdeprecated">Show Deprecated</label></span>
</form>
<h2>
<code>static</code>
Class <b>YAHOO_config</b>
<span class="extends">
</span>
<span class="extends">
</span>
</code>
</h2>
<!-- class tree goes here -->
<div class="summary description">
YAHOO_config is not included as part of the library. Instead it is an
object that can be defined by the implementer immediately before
including the YUI library. The properties included in this object
will be used to configure global properties needed as soon as the
library begins to load.
</div>
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="">
<h4><a name="property_injecting">injecting</a>
<code>- static boolean</code>
</h4>
<div class="detail">
<div class="description">
Set to true if the library will be dynamically loaded after window.onload.
Defaults to false
</div>
</div>
<div class="default">
Default Value: undefined
</div>
<hr />
</div>
<div class="">
<h4><a name="property_listener">listener</a>
<code>- static Function</code>
</h4>
<div class="detail">
<div class="description">
A reference to a function that will be executed every time a YAHOO module
is loaded. As parameter, this function will receive the version
information for the module. See <a href="YAHOO.env.html#getVersion">
YAHOO.env.getVersion</a> for the description of the version data structure.
</div>
</div>
<div class="default">
Default Value: undefined
</div>
<hr />
</div>
<div class="">
<h4><a name="property_load">load</a>
<code>- static object</code>
</h4>
<div class="detail">
<div class="description">
Instructs the yuiloader component to dynamically load yui components and
their dependencies. See the yuiloader documentation for more information
about dynamic loading
</div>
</div>
<div class="default">
Default Value: undefined
</div>
<hr />
</div>
<div class="">
<h4><a name="property_locale">locale</a>
<code>- static string</code>
</h4>
<div class="detail">
<div class="description">
Forces the use of the supplied locale where applicable in the library
</div>
</div>
<div class="default">
Default Value: undefined
</div>
<hr />
</div>
</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_carousel.html">carousel</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_paginator.html">paginator</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="selected"><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=""><a href="YAHOO.js.html">YAHOO.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li class=""><a href="#property_injecting">injecting</a>
<!--<code>&lt;string&gt;</code>-->
</li>
<li class=""><a href="#property_listener">listener</a>
<!--<code>&lt;string&gt;</code>-->
</li>
<li class=""><a href="#property_load">load</a>
<!--<code>&lt;string&gt;</code>-->
</li>
<li class=""><a href="#property_locale">locale</a>
<!--<code>&lt;string&gt;</code>-->
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2008 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>