mirror of
https://github.com/alchemy-fr/Phraseanet.git
synced 2025-10-13 21:13:26 +00:00
1419 lines
83 KiB
HTML
1419 lines
83 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: yahoo YAHOO.lang (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>YAHOO Global <span class="subtitle">2.8.2r1</span></h3>
|
|
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
|
|
> <a href="./module_yahoo.html" title="yahoo">yahoo</a>
|
|
> YAHOO.lang
|
|
|
|
<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.lang</b>
|
|
<span class="extends">
|
|
</span>
|
|
|
|
</h2>
|
|
<!-- class tree goes here -->
|
|
|
|
|
|
|
|
|
|
<div class="summary description" property="yui:description">
|
|
Provides the language utilites and extensions used by the library
|
|
</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__IEEnumFix">
|
|
<h4><a name="property__IEEnumFix" property="yui:name">_IEEnumFix</a>
|
|
- <code>private static <span property="yui:type">object</span></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description" property="yui:description">
|
|
IE will not enumerate native functions in a derived object even if the
|
|
function was overridden. This is a workaround for specific functions
|
|
we care about on the Object prototype.
|
|
</div>
|
|
</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="" rel="yui:method" resource="#method_augment">
|
|
<h4>
|
|
<a name="method_augment">augment</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
void
|
|
<strong property="yui:name">augment</strong>
|
|
(
|
|
|
|
|
|
r
|
|
|
|
|
|
,
|
|
s
|
|
|
|
|
|
,
|
|
arguments
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Same as YAHOO.lang.augmentObject, except it only applies prototype
|
|
properties. This is an alias for augmentProto.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">r</span>
|
|
<<span property="yui:type">Function</span>>
|
|
</code>
|
|
<span property="yui:description"> the object to receive the augmentation</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">s</span>
|
|
<<span property="yui:type">Function</span>>
|
|
</code>
|
|
<span property="yui:description"> the object that supplies the properties to augment</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">arguments</span>
|
|
<<span property="yui:type">String*|boolean</span>>
|
|
</code>
|
|
<span property="yui:description"> zero or more properties methods to
|
|
augment the receiver with. If none specified, everything
|
|
in the supplier will be used unless it would
|
|
overwrite an existing property in the receiver. if true
|
|
is specified as the third parameter, all properties will
|
|
be applied and will overwrite an existing property in
|
|
the receiver</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_augmentObject">
|
|
<h4>
|
|
<a name="method_augmentObject">augmentObject</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
void
|
|
<strong property="yui:name">augmentObject</strong>
|
|
(
|
|
|
|
|
|
r
|
|
|
|
|
|
,
|
|
s
|
|
|
|
|
|
,
|
|
arguments
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Applies all properties in the supplier to the receiver if the
|
|
receiver does not have these properties yet. Optionally, one or
|
|
more methods/properties can be specified (as additional
|
|
parameters). This option will overwrite the property if receiver
|
|
has it already. If true is passed as the third parameter, all
|
|
properties will be applied and _will_ overwrite properties in
|
|
the receiver.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">r</span>
|
|
<<span property="yui:type">Function</span>>
|
|
</code>
|
|
<span property="yui:description"> the object to receive the augmentation</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">s</span>
|
|
<<span property="yui:type">Function</span>>
|
|
</code>
|
|
<span property="yui:description"> the object that supplies the properties to augment</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">arguments</span>
|
|
<<span property="yui:type">String*|boolean</span>>
|
|
</code>
|
|
<span property="yui:description"> zero or more properties methods
|
|
to augment the receiver with. If none specified, everything
|
|
in the supplier will be used unless it would
|
|
overwrite an existing property in the receiver. If true
|
|
is specified as the third parameter, all properties will
|
|
be applied and will overwrite an existing property in
|
|
the receiver</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_augmentProto">
|
|
<h4>
|
|
<a name="method_augmentProto">augmentProto</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
void
|
|
<strong property="yui:name">augmentProto</strong>
|
|
(
|
|
|
|
|
|
r
|
|
|
|
|
|
,
|
|
s
|
|
|
|
|
|
,
|
|
arguments
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Same as YAHOO.lang.augmentObject, except it only applies prototype properties
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">r</span>
|
|
<<span property="yui:type">Function</span>>
|
|
</code>
|
|
<span property="yui:description"> the object to receive the augmentation</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">s</span>
|
|
<<span property="yui:type">Function</span>>
|
|
</code>
|
|
<span property="yui:description"> the object that supplies the properties to augment</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">arguments</span>
|
|
<<span property="yui:type">String*|boolean</span>>
|
|
</code>
|
|
<span property="yui:description"> zero or more properties methods
|
|
to augment the receiver with. If none specified, everything
|
|
in the supplier will be used unless it would overwrite an existing
|
|
property in the receiver. if true is specified as the third
|
|
parameter, all properties will be applied and will overwrite an
|
|
existing property in the receiver</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_dump">
|
|
<h4>
|
|
<a name="method_dump">dump</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
String
|
|
<strong property="yui:name">dump</strong>
|
|
(
|
|
|
|
|
|
o
|
|
|
|
|
|
,
|
|
d
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Returns a simple string representation of the object or array.
|
|
Other types of objects will be returned unprocessed. Arrays
|
|
are expected to be indexed. Use object notation for
|
|
associative arrays.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">o</span>
|
|
<<span property="yui:type">Object</span>>
|
|
</code>
|
|
<span property="yui:description"> The object to dump</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">d</span>
|
|
<<span property="yui:type">int</span>>
|
|
</code>
|
|
<span property="yui:description"> How deep to recurse child objects, default 3</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
String
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">the dump result</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_extend">
|
|
<h4>
|
|
<a name="method_extend">extend</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
static
|
|
|
|
void
|
|
<strong property="yui:name">extend</strong>
|
|
(
|
|
|
|
|
|
subc
|
|
|
|
|
|
,
|
|
superc
|
|
|
|
|
|
,
|
|
overrides
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Utility to set up the prototype, constructor and superclass properties to
|
|
support an inheritance strategy that can chain constructors and methods.
|
|
Static members will not be inherited.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">subc</span>
|
|
<<span property="yui:type">Function</span>>
|
|
</code>
|
|
<span property="yui:description"> the object to modify</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">superc</span>
|
|
<<span property="yui:type">Function</span>>
|
|
</code>
|
|
<span property="yui:description"> the object to inherit</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">overrides</span>
|
|
<<span property="yui:type">Object</span>>
|
|
</code>
|
|
<span property="yui:description"> additional properties/methods to add to the
|
|
subclass prototype. These will override the
|
|
matching items obtained from the superclass
|
|
if present.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_hasOwnProperty">
|
|
<h4>
|
|
<a name="method_hasOwnProperty">hasOwnProperty</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
boolean
|
|
<strong property="yui:name">hasOwnProperty</strong>
|
|
(
|
|
|
|
|
|
o
|
|
|
|
|
|
,
|
|
prop
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Determines whether or not the property was added
|
|
to the object instance. Returns false if the property is not present
|
|
in the object, or was inherited from the prototype.
|
|
This abstraction is provided to enable hasOwnProperty for Safari 1.3.x.
|
|
There is a discrepancy between YAHOO.lang.hasOwnProperty and
|
|
Object.prototype.hasOwnProperty when the property is a primitive added to
|
|
both the instance AND prototype with the same value:
|
|
<pre>
|
|
var A = function() {};
|
|
A.prototype.foo = 'foo';
|
|
var a = new A();
|
|
a.foo = 'foo';
|
|
alert(a.hasOwnProperty('foo')); // true
|
|
alert(YAHOO.lang.hasOwnProperty(a, 'foo')); // false when using fallback
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">o</span>
|
|
<<span property="yui:type">any</span>>
|
|
</code>
|
|
<span property="yui:description"> The object being testing</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">prop</span>
|
|
<<span property="yui:type">string</span>>
|
|
</code>
|
|
<span property="yui:description"> the name of the property to test</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
boolean
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">the result</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_isArray">
|
|
<h4>
|
|
<a name="method_isArray">isArray</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
boolean
|
|
<strong property="yui:name">isArray</strong>
|
|
(
|
|
|
|
|
|
o
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Determines wheather or not the provided object is an array.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">o</span>
|
|
<<span property="yui:type">any</span>>
|
|
</code>
|
|
<span property="yui:description"> The object being testing</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
boolean
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">the result</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_isBoolean">
|
|
<h4>
|
|
<a name="method_isBoolean">isBoolean</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
boolean
|
|
<strong property="yui:name">isBoolean</strong>
|
|
(
|
|
|
|
|
|
o
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Determines whether or not the provided object is a boolean
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">o</span>
|
|
<<span property="yui:type">any</span>>
|
|
</code>
|
|
<span property="yui:description"> The object being testing</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
boolean
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">the result</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_isFunction">
|
|
<h4>
|
|
<a name="method_isFunction">isFunction</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
boolean
|
|
<strong property="yui:name">isFunction</strong>
|
|
(
|
|
|
|
|
|
o
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Determines whether or not the provided object is a function.
|
|
Note: Internet Explorer thinks certain functions are objects:
|
|
var obj = document.createElement("object");
|
|
YAHOO.lang.isFunction(obj.getAttribute) // reports false in IE
|
|
var input = document.createElement("input"); // append to body
|
|
YAHOO.lang.isFunction(input.focus) // reports false in IE
|
|
You will have to implement additional tests if these functions
|
|
matter to you.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">o</span>
|
|
<<span property="yui:type">any</span>>
|
|
</code>
|
|
<span property="yui:description"> The object being testing</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
boolean
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">the result</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_isNull">
|
|
<h4>
|
|
<a name="method_isNull">isNull</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
boolean
|
|
<strong property="yui:name">isNull</strong>
|
|
(
|
|
|
|
|
|
o
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Determines whether or not the provided object is null
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">o</span>
|
|
<<span property="yui:type">any</span>>
|
|
</code>
|
|
<span property="yui:description"> The object being testing</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
boolean
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">the result</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_isNumber">
|
|
<h4>
|
|
<a name="method_isNumber">isNumber</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
boolean
|
|
<strong property="yui:name">isNumber</strong>
|
|
(
|
|
|
|
|
|
o
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Determines whether or not the provided object is a legal number
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">o</span>
|
|
<<span property="yui:type">any</span>>
|
|
</code>
|
|
<span property="yui:description"> The object being testing</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
boolean
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">the result</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_isObject">
|
|
<h4>
|
|
<a name="method_isObject">isObject</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
boolean
|
|
<strong property="yui:name">isObject</strong>
|
|
(
|
|
|
|
|
|
o
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Determines whether or not the provided object is of type object
|
|
or function
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">o</span>
|
|
<<span property="yui:type">any</span>>
|
|
</code>
|
|
<span property="yui:description"> The object being testing</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
boolean
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">the result</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_isString">
|
|
<h4>
|
|
<a name="method_isString">isString</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
boolean
|
|
<strong property="yui:name">isString</strong>
|
|
(
|
|
|
|
|
|
o
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Determines whether or not the provided object is a string
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">o</span>
|
|
<<span property="yui:type">any</span>>
|
|
</code>
|
|
<span property="yui:description"> The object being testing</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
boolean
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">the result</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_isUndefined">
|
|
<h4>
|
|
<a name="method_isUndefined">isUndefined</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
boolean
|
|
<strong property="yui:name">isUndefined</strong>
|
|
(
|
|
|
|
|
|
o
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Determines whether or not the provided object is undefined
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">o</span>
|
|
<<span property="yui:type">any</span>>
|
|
</code>
|
|
<span property="yui:description"> The object being testing</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
boolean
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">the result</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_isValue">
|
|
<h4>
|
|
<a name="method_isValue">isValue</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
boolean
|
|
<strong property="yui:name">isValue</strong>
|
|
(
|
|
|
|
|
|
o
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
A convenience method for detecting a legitimate non-null value.
|
|
Returns false for null/undefined/NaN, true for other values,
|
|
including 0/false/''
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">o</span>
|
|
<<span property="yui:type">any</span>>
|
|
</code>
|
|
<span property="yui:description"> the item to test</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
boolean
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">true if it is not null/undefined/NaN || false</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_later">
|
|
<h4>
|
|
<a name="method_later">later</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
|
|
<strong property="yui:name">later</strong>
|
|
(
|
|
|
|
|
|
when
|
|
|
|
|
|
,
|
|
o
|
|
|
|
|
|
,
|
|
fn
|
|
|
|
|
|
,
|
|
data
|
|
|
|
|
|
,
|
|
periodic
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Executes the supplied function in the context of the supplied
|
|
object 'when' milliseconds later. Executes the function a
|
|
single time unless periodic is set to true.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">when</span>
|
|
<<span property="yui:type">int</span>>
|
|
</code>
|
|
<span property="yui:description"> the number of milliseconds to wait until the fn
|
|
is executed</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">o</span>
|
|
<<span property="yui:type">object</span>>
|
|
</code>
|
|
<span property="yui:description"> the context object</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">fn</span>
|
|
<<span property="yui:type">Function|String</span>>
|
|
</code>
|
|
<span property="yui:description"> the function to execute or the name of
|
|
the method in the 'o' object to execute</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">data</span>
|
|
<<span property="yui:type">object</span>>
|
|
</code>
|
|
<span property="yui:description"> [Array] data that is provided to the function. This accepts
|
|
either a single item or an array. If an array is provided, the
|
|
function is executed with one parameter for each array item. If
|
|
you need to pass a single array parameter, it needs to be wrapped in
|
|
an array [myarray]</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">periodic</span>
|
|
<<span property="yui:type">boolean</span>>
|
|
</code>
|
|
<span property="yui:description"> if true, executes continuously at supplied
|
|
interval until canceled</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">a timer object. Call the cancel() method on this object to
|
|
stop the timer.</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_merge">
|
|
<h4>
|
|
<a name="method_merge">merge</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
|
|
<strong property="yui:name">merge</strong>
|
|
(
|
|
|
|
|
|
arguments
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Returns a new object containing all of the properties of
|
|
all the supplied objects. The properties from later objects
|
|
will overwrite those in earlier objects.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">arguments</span>
|
|
<<span property="yui:type">Object*</span>>
|
|
</code>
|
|
<span property="yui:description"> the objects to merge</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">the new merged object</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_substitute">
|
|
<h4>
|
|
<a name="method_substitute">substitute</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
String
|
|
<strong property="yui:name">substitute</strong>
|
|
(
|
|
|
|
|
|
s
|
|
|
|
|
|
,
|
|
o
|
|
|
|
|
|
,
|
|
f
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Does variable substitution on a string. It scans through the string
|
|
looking for expressions enclosed in { } braces. If an expression
|
|
is found, it is used a key on the object. If there is a space in
|
|
the key, the first word is used for the key and the rest is provided
|
|
to an optional function to be used to programatically determine the
|
|
value (the extra information might be used for this decision). If
|
|
the value for the key in the object, or what is returned from the
|
|
function has a string value, number value, or object value, it is
|
|
substituted for the bracket expression and it repeats. If this
|
|
value is an object, it uses the Object's toString() if this has
|
|
been overridden, otherwise it does a shallow dump of the key/value
|
|
pairs.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">s</span>
|
|
<<span property="yui:type">String</span>>
|
|
</code>
|
|
<span property="yui:description"> The string that will be modified.</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">o</span>
|
|
<<span property="yui:type">Object</span>>
|
|
</code>
|
|
<span property="yui:description"> An object containing the replacement values</span>
|
|
</dd>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">f</span>
|
|
<<span property="yui:type">Function</span>>
|
|
</code>
|
|
<span property="yui:description"> An optional function that can be used to
|
|
process each match. It receives the key,
|
|
value, and any extra metadata included with
|
|
the key inside of the braces.</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
String
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">the substituted string</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="" rel="yui:method" resource="#method_trim">
|
|
<h4>
|
|
<a name="method_trim">trim</a></h4>
|
|
<div class="detail" >
|
|
<code>
|
|
|
|
|
|
|
|
string
|
|
<strong property="yui:name">trim</strong>
|
|
(
|
|
|
|
|
|
s
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description" property="yui:description">
|
|
Returns a string without any leading or trailing whitespace. If
|
|
the input is not a string, the input will be returned untouched.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl rel="yui:parameters">
|
|
<dt>Parameters:</dt>
|
|
<dd rel="yui:parameter">
|
|
<code><span property="yui:name">s</span>
|
|
<<span property="yui:type">string</span>>
|
|
</code>
|
|
<span property="yui:description"> the string to trim</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code property="yui:return">
|
|
string
|
|
</code></dt>
|
|
<dd property="yui:returnInfo">the trimmed string</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div rel="yui:events" resource="#events">
|
|
|
|
|
|
</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=""><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="selected"><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=""><a href="YAHOO.html" title="YAHOO">YAHOO</a></li>
|
|
<li class=""><a href="YAHOO.env.html" title="YAHOO.env">YAHOO.env</a></li>
|
|
<li class=""><a href="YAHOO.env.ua.html" title="YAHOO.env.ua">YAHOO.env.ua</a></li>
|
|
<li class="selected"><a href="YAHOO.lang.html" title="YAHOO.lang">YAHOO.lang</a></li>
|
|
<li class=""><a href="YAHOO_config.html" title="YAHOO_config">YAHOO_config</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="fileList" class="module">
|
|
<h4>Files</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="Env.js.html" title="Env.js">Env.js</a></li>
|
|
<li class=""><a href="Lang.js.html" title="Lang.js">Lang.js</a></li>
|
|
<li class=""><a href="YAHOO.js.html" title="YAHOO.js">YAHOO.js</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="propertyList" class="module">
|
|
<h4>Properties</h4>
|
|
<ul class="content">
|
|
<li class="private"><a href="#property__IEEnumFix" title="_IEEnumFix">_IEEnumFix</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="methodsList" class="module">
|
|
<h4>Methods</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="#method_augment" title="augment">augment</a></li>
|
|
<li class=""><a href="#method_augmentObject" title="augmentObject">augmentObject</a></li>
|
|
<li class=""><a href="#method_augmentProto" title="augmentProto">augmentProto</a></li>
|
|
<li class=""><a href="#method_dump" title="dump">dump</a></li>
|
|
<li class=""><a href="#method_extend" title="extend">extend</a></li>
|
|
<li class=""><a href="#method_hasOwnProperty" title="hasOwnProperty">hasOwnProperty</a></li>
|
|
<li class=""><a href="#method_isArray" title="isArray">isArray</a></li>
|
|
<li class=""><a href="#method_isBoolean" title="isBoolean">isBoolean</a></li>
|
|
<li class=""><a href="#method_isFunction" title="isFunction">isFunction</a></li>
|
|
<li class=""><a href="#method_isNull" title="isNull">isNull</a></li>
|
|
<li class=""><a href="#method_isNumber" title="isNumber">isNumber</a></li>
|
|
<li class=""><a href="#method_isObject" title="isObject">isObject</a></li>
|
|
<li class=""><a href="#method_isString" title="isString">isString</a></li>
|
|
<li class=""><a href="#method_isUndefined" title="isUndefined">isUndefined</a></li>
|
|
<li class=""><a href="#method_isValue" title="isValue">isValue</a></li>
|
|
<li class=""><a href="#method_later" title="later">later</a></li>
|
|
<li class=""><a href="#method_merge" title="merge">merge</a></li>
|
|
<li class=""><a href="#method_substitute" title="substitute">substitute</a></li>
|
|
<li class=""><a href="#method_trim" title="trim">trim</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": "", "host": "YAHOO.env.ua", "name": "air", "url": "YAHOO.env.ua.html#property_air", "type": "property"}, {"access": "", "host": "YAHOO.lang", "name": "augment", "url": "YAHOO.lang.html#method_augment", "type": "method"}, {"access": "", "host": "YAHOO.lang", "name": "augmentObject", "url": "YAHOO.lang.html#method_augmentObject", "type": "method"}, {"access": "", "host": "YAHOO.lang", "name": "augmentProto", "url": "YAHOO.lang.html#method_augmentProto", "type": "method"}, {"access": "", "host": "YAHOO.env.ua", "name": "caja", "url": "YAHOO.env.ua.html#property_caja", "type": "property"}, {"access": "", "host": "YAHOO.lang", "name": "dump", "url": "YAHOO.lang.html#method_dump", "type": "method"}, {"access": "", "host": "YAHOO.lang", "name": "extend", "url": "YAHOO.lang.html#method_extend", "type": "method"}, {"access": "", "host": "YAHOO.env.ua", "name": "gecko", "url": "YAHOO.env.ua.html#property_gecko", "type": "property"}, {"access": "", "host": "YAHOO.env", "name": "getVersion", "url": "YAHOO.env.html#method_getVersion", "type": "method"}, {"access": "", "host": "YAHOO.lang", "name": "hasOwnProperty", "url": "YAHOO.lang.html#method_hasOwnProperty", "type": "method"}, {"access": "", "host": "YAHOO.env.ua", "name": "ie", "url": "YAHOO.env.ua.html#property_ie", "type": "property"}, {"access": "private", "host": "YAHOO.lang", "name": "_IEEnumFix", "url": "YAHOO.lang.html#property__IEEnumFix", "type": "property"}, {"access": "", "host": "YAHOO.lang", "name": "isArray", "url": "YAHOO.lang.html#method_isArray", "type": "method"}, {"access": "", "host": "YAHOO.lang", "name": "isBoolean", "url": "YAHOO.lang.html#method_isBoolean", "type": "method"}, {"access": "", "host": "YAHOO.lang", "name": "isFunction", "url": "YAHOO.lang.html#method_isFunction", "type": "method"}, {"access": "", "host": "YAHOO.lang", "name": "isNull", "url": "YAHOO.lang.html#method_isNull", "type": "method"}, {"access": "", "host": "YAHOO.lang", "name": "isNumber", "url": "YAHOO.lang.html#method_isNumber", "type": "method"}, {"access": "", "host": "YAHOO.lang", "name": "isObject", "url": "YAHOO.lang.html#method_isObject", "type": "method"}, {"access": "", "host": "YAHOO.lang", "name": "isString", "url": "YAHOO.lang.html#method_isString", "type": "method"}, {"access": "", "host": "YAHOO.lang", "name": "isUndefined", "url": "YAHOO.lang.html#method_isUndefined", "type": "method"}, {"access": "", "host": "YAHOO.lang", "name": "isValue", "url": "YAHOO.lang.html#method_isValue", "type": "method"}, {"access": "", "host": "YAHOO.lang", "name": "later", "url": "YAHOO.lang.html#method_later", "type": "method"}, {"access": "", "host": "YAHOO.env", "name": "listeners", "url": "YAHOO.env.html#property_listeners", "type": "property"}, {"access": "", "host": "YAHOO.lang", "name": "merge", "url": "YAHOO.lang.html#method_merge", "type": "method"}, {"access": "", "host": "YAHOO.env.ua", "name": "mobile", "url": "YAHOO.env.ua.html#property_mobile", "type": "property"}, {"access": "", "host": "YAHOO.env", "name": "modules", "url": "YAHOO.env.html#property_modules", "type": "property"}, {"access": "", "host": "YAHOO.env.ua", "name": "opera", "url": "YAHOO.env.ua.html#property_opera", "type": "property"}, {"access": "", "host": "YAHOO.env.ua", "name": "os", "url": "YAHOO.env.ua.html#property_os", "type": "property"}, {"access": "", "host": "YAHOO.env.ua", "name": "secure", "url": "YAHOO.env.ua.html#property_secure", "type": "property"}, {"access": "", "host": "YAHOO.lang", "name": "substitute", "url": "YAHOO.lang.html#method_substitute", "type": "method"}, {"access": "", "host": "YAHOO.lang", "name": "trim", "url": "YAHOO.lang.html#method_trim", "type": "method"}, {"access": "", "host": "YAHOO.env.ua", "name": "webkit", "url": "YAHOO.env.ua.html#property_webkit", "type": "property"}];
|
|
</script>
|
|
</body>
|
|
</html>
|