1756 lines
89 KiB
HTML
1756 lines
89 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>API: element YAHOO.util.Element (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>element <span class="subtitle">2.5.1</span></h3>
|
|
<p>
|
|
<a href="./index.html">Yahoo! UI Library</a>
|
|
> <a href="./module_element.html">element</a>
|
|
> YAHOO.util.Element
|
|
|
|
</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>
|
|
|
|
<h2>
|
|
|
|
|
|
|
|
|
|
Class <b>YAHOO.util.Element</b>
|
|
<span class="extends">
|
|
</span>
|
|
|
|
<span class="extends">
|
|
- uses
|
|
|
|
<a href="YAHOO.util.AttributeProvider.html">YAHOO.util.AttributeProvider</a>
|
|
|
|
</span>
|
|
|
|
</code>
|
|
</h2>
|
|
<!-- class tree goes here -->
|
|
|
|
<dl class="subclasses">
|
|
<dt>Known Subclasses:</dd>
|
|
<dd>
|
|
<a href="YAHOO.widget.Toolbar.html">YAHOO.widget.Toolbar</a>
|
|
<a href="YAHOO.util.Resize.html">YAHOO.util.Resize</a>
|
|
<a href="YAHOO.widget.Layout.html">YAHOO.widget.Layout</a>
|
|
<a href="YAHOO.widget.ImageCropper.html">YAHOO.widget.ImageCropper</a>
|
|
<a href="YAHOO.widget.SimpleEditor.html">YAHOO.widget.SimpleEditor</a>
|
|
<a href="YAHOO.widget.LayoutUnit.html">YAHOO.widget.LayoutUnit</a>
|
|
<a href="YAHOO.widget.ColorPicker.html">YAHOO.widget.ColorPicker</a>
|
|
<a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a>
|
|
<a href="YAHOO.widget.ButtonGroup.html">YAHOO.widget.ButtonGroup</a>
|
|
<a href="YAHOO.widget.ProfilerViewer.html">YAHOO.widget.ProfilerViewer</a>
|
|
<a href="YAHOO.widget.Button.html">YAHOO.widget.Button</a>
|
|
<a href="YAHOO.widget.Tab.html">YAHOO.widget.Tab</a>
|
|
<a href="YAHOO.widget.TabView.html">YAHOO.widget.TabView</a>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<div class="summary description">
|
|
Element provides an wrapper object to simplify adding
|
|
event listeners, using dom methods, and managing attributes.
|
|
</div>
|
|
|
|
<div class="section constructor details">
|
|
<h3 id="constructor">Constructor</h3>
|
|
<div class="content">
|
|
<div class="detail">
|
|
<strong>YAHOO.util.Element</strong>
|
|
<code>
|
|
(
|
|
|
|
|
|
|
|
el
|
|
|
|
,
|
|
map
|
|
)
|
|
</code>
|
|
<div class="description">
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>el
|
|
<HTMLElement | String>
|
|
</code>
|
|
The html element that
|
|
represents the Element.
|
|
</dd>
|
|
<dd>
|
|
<code>map
|
|
<Object>
|
|
</code>
|
|
A key-value map of initial config names and values
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field details">
|
|
<h3 id="properties">Properties</h3>
|
|
<div class="content">
|
|
<div class="">
|
|
<h4><a name="property_DOM_EVENTS">DOM_EVENTS</a>
|
|
<code>- Object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Dom events supported by the Element instance.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field inheritance">
|
|
<h4>Properties inherited from <a href="YAHOO.util.AttributeProvider.html">YAHOO.util.AttributeProvider</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
|
|
<a class="private" href="YAHOO.util.AttributeProvider.html#property__configs">_configs</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
<div class="section field inheritance">
|
|
<h4>Properties inherited from <a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
|
|
<a class="private" href="YAHOO.util.EventProvider.html#property___yui_events">__yui_events</a><span class="private">,</span>
|
|
<a class="private" href="YAHOO.util.EventProvider.html#property___yui_subscribers">__yui_subscribers</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section method details">
|
|
<h3 id="methods">Methods</h3>
|
|
<div class="content">
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__registerHTMLAttr">_registerHTMLAttr</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_registerHTMLAttr</strong>
|
|
(
|
|
|
|
|
|
element
|
|
|
|
|
|
,
|
|
key
|
|
|
|
|
|
,
|
|
map
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Sets the value of the property and fires beforeChange and change events.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>element <YAHOO.util.Element></code>
|
|
The Element instance to
|
|
register the config to.
|
|
</dd>
|
|
<dd>
|
|
<code>key <String></code>
|
|
The name of the config to register
|
|
</dd>
|
|
<dd>
|
|
<code>map <Object></code>
|
|
A key-value map of the config's params
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_addClass">addClass</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>addClass</strong>
|
|
(
|
|
|
|
|
|
className
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Wrapper for Dom method.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>className <String></code>
|
|
The className to add
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_addListener">addListener</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>addListener</strong>
|
|
(
|
|
|
|
|
|
type
|
|
|
|
|
|
,
|
|
fn
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
,
|
|
scope
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Adds a listener for the given event. These may be DOM or
|
|
customEvent listeners. Any event that is fired via fireEvent
|
|
can be listened for. All handlers receive an event object.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>type <String></code>
|
|
The name of the event to listen for
|
|
</dd>
|
|
<dd>
|
|
<code>fn <Function></code>
|
|
The handler to call when the event fires
|
|
</dd>
|
|
<dd>
|
|
<code>obj <Any></code>
|
|
A variable to pass to the handler
|
|
</dd>
|
|
<dd>
|
|
<code>scope <Object></code>
|
|
The object to use for the scope of the handler
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_appendChild">appendChild</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>appendChild</strong>
|
|
(
|
|
|
|
|
|
child
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Wrapper for HTMLElement method.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>child <YAHOO.util.Element || HTMLElement></code>
|
|
The element to append.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_appendTo">appendTo</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>appendTo</strong>
|
|
(
|
|
|
|
|
|
parentNode
|
|
|
|
|
|
,
|
|
before
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Appends the HTMLElement into either the supplied parentNode.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>parentNode <HTMLElement | Element></code>
|
|
The node to append to
|
|
</dd>
|
|
<dd>
|
|
<code>before <HTMLElement | Element></code>
|
|
An optional node to insert before
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_fireQueue">fireQueue</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>fireQueue</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Apply any queued set calls.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getElementsByClassName">getElementsByClassName</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Array
|
|
<strong>getElementsByClassName</strong>
|
|
(
|
|
|
|
|
|
className
|
|
|
|
|
|
,
|
|
tag
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Wrapper for Dom method.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>className <String></code>
|
|
The className to collect
|
|
</dd>
|
|
<dd>
|
|
<code>tag <String></code>
|
|
(optional) The tag to use in
|
|
conjunction with class name
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Array
|
|
</code></dt>
|
|
<dd>Array of HTMLElements</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getElementsByTagName">getElementsByTagName</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>getElementsByTagName</strong>
|
|
(
|
|
|
|
|
|
tag
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Wrapper for HTMLElement method.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>tag <String></code>
|
|
The tagName to collect
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getStyle">getStyle</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
String
|
|
<strong>getStyle</strong>
|
|
(
|
|
|
|
|
|
property
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Wrapper for Dom method.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>property <String></code>
|
|
The style property to retrieve
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
String
|
|
</code></dt>
|
|
<dd>The current value of the property</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_hasChildNodes">hasChildNodes</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong>hasChildNodes</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Wrapper for HTMLElement method.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd>Whether or not the element has childNodes</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_hasClass">hasClass</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong>hasClass</strong>
|
|
(
|
|
|
|
|
|
className
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Wrapper for Dom method.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>className <String></code>
|
|
The className to add
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd>Whether or not the element has the class name</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_initAttributes">initAttributes</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>initAttributes</strong>
|
|
(
|
|
|
|
|
|
map
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Registers Element specific attributes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>map <Object></code>
|
|
A key-value map of initial attribute configs
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_insertBefore">insertBefore</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>insertBefore</strong>
|
|
(
|
|
|
|
|
|
element
|
|
|
|
|
|
,
|
|
before
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Wrapper for HTMLElement method.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>element <HTMLElement></code>
|
|
The HTMLElement to insert
|
|
</dd>
|
|
<dd>
|
|
<code>before <HTMLElement></code>
|
|
The HTMLElement to insert
|
|
the element before.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_on">on</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>on</strong>
|
|
(
|
|
|
|
|
|
type
|
|
|
|
|
|
,
|
|
fn
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
,
|
|
scope
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Alias for addListener
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>type <String></code>
|
|
The name of the event to listen for
|
|
</dd>
|
|
<dd>
|
|
<code>fn <Function></code>
|
|
The function call when the event fires
|
|
</dd>
|
|
<dd>
|
|
<code>obj <Any></code>
|
|
A variable to pass to the handler
|
|
</dd>
|
|
<dd>
|
|
<code>scope <Object></code>
|
|
The object to use for the scope of the handler
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_removeChild">removeChild</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>removeChild</strong>
|
|
(
|
|
|
|
|
|
child
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Wrapper for HTMLElement method.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>child <HTMLElement></code>
|
|
The HTMLElement to remove
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_removeClass">removeClass</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>removeClass</strong>
|
|
(
|
|
|
|
|
|
className
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Wrapper for Dom method.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>className <String></code>
|
|
The className to remove
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_removeListener">removeListener</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>removeListener</strong>
|
|
(
|
|
|
|
|
|
type
|
|
|
|
|
|
,
|
|
fn
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Remove an event listener
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>type <String></code>
|
|
The name of the event to listen for
|
|
</dd>
|
|
<dd>
|
|
<code>fn <Function></code>
|
|
The function call when the event fires
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_replaceChild">replaceChild</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>replaceChild</strong>
|
|
(
|
|
|
|
|
|
newNode
|
|
|
|
|
|
,
|
|
oldNode
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Wrapper for HTMLElement method.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>newNode <HTMLElement></code>
|
|
The HTMLElement to insert
|
|
</dd>
|
|
<dd>
|
|
<code>oldNode <HTMLElement></code>
|
|
The HTMLElement to replace
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_replaceClass">replaceClass</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>replaceClass</strong>
|
|
(
|
|
|
|
|
|
oldClassName
|
|
|
|
|
|
,
|
|
newClassName
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Wrapper for Dom method.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oldClassName <String></code>
|
|
The className to replace
|
|
</dd>
|
|
<dd>
|
|
<code>newClassName <String></code>
|
|
The className to add
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_setStyle">setStyle</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>setStyle</strong>
|
|
(
|
|
|
|
|
|
property
|
|
|
|
|
|
,
|
|
value
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Wrapper for Dom method.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>property <String></code>
|
|
The style property to set
|
|
</dd>
|
|
<dd>
|
|
<code>value <String></code>
|
|
The value to apply to the style property
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_subscribe">subscribe</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>subscribe</strong>
|
|
(
|
|
|
|
|
|
type
|
|
|
|
|
|
,
|
|
fn
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
,
|
|
scope
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Alias for addListener
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>type <String></code>
|
|
The name of the event to listen for
|
|
</dd>
|
|
<dd>
|
|
<code>fn <Function></code>
|
|
The function call when the event fires
|
|
</dd>
|
|
<dd>
|
|
<code>obj <Any></code>
|
|
A variable to pass to the handler
|
|
</dd>
|
|
<dd>
|
|
<code>scope <Object></code>
|
|
The object to use for the scope of the handler
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field inheritance">
|
|
<h4>Methods inherited from <a href="YAHOO.util.AttributeProvider.html">YAHOO.util.AttributeProvider</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
<a class="" href="YAHOO.util.AttributeProvider.html#method_configureAttribute">configureAttribute</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_fireBeforeChangeEvent">fireBeforeChangeEvent</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_fireChangeEvent">fireChangeEvent</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_get">get</a><span class="">,</span> <a class="private" href="YAHOO.util.AttributeProvider.html#method_getAttributeConfig">getAttributeConfig</a><span class="private">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_getAttributeKeys">getAttributeKeys</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_refresh">refresh</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_register">register</a><span class="">,</span> <a class="private" href="YAHOO.util.AttributeProvider.html#method_resetAttributeConfig">resetAttributeConfig</a><span class="private">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_resetValue">resetValue</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_set">set</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_setAttributeConfig">setAttributeConfig</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_setAttributes">setAttributes</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
<div class="section field inheritance">
|
|
<h4>Methods inherited from <a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
<a class="" href="YAHOO.util.EventProvider.html#method_createEvent">createEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_fireEvent">fireEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_hasEvent">hasEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_subscribe">subscribe</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_unsubscribe">unsubscribe</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_unsubscribeAll">unsubscribeAll</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section method details">
|
|
<h3 id="events">Events</h3>
|
|
<div class="content">
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_appendTo">appendTo</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>appendTo</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires after the Element is appended to another Element.
|
|
<p>See: <a href="#addListener">Element.addListener</a></p>
|
|
<p><strong>Event fields:</strong><br>
|
|
<code><String> type</code> appendTo<br>
|
|
<code><HTMLElement/Element>
|
|
target</code> the HTMLElement/Element being appended to
|
|
<p><strong>Usage:</strong><br>
|
|
<code>var handler = function(e) {var target = e.target};<br>
|
|
myTabs.addListener('appendTo', handler);</code></p>
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_available">available</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>available</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the Element's HTMLElement can be retrieved by Id.
|
|
<p>See: <a href="#addListener">Element.addListener</a></p>
|
|
<p><strong>Event fields:</strong><br>
|
|
<code><String> type</code> available<br>
|
|
<code><HTMLElement>
|
|
target</code> the HTMLElement bound to this Element instance<br>
|
|
<p><strong>Usage:</strong><br>
|
|
<code>var handler = function(e) {var target = e.target};<br>
|
|
myTabs.addListener('available', handler);</code></p>
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeAppendTo">beforeAppendTo</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeAppendTo</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the Element is appended to another Element.
|
|
<p>See: <a href="#addListener">Element.addListener</a></p>
|
|
<p><strong>Event fields:</strong><br>
|
|
<code><String> type</code> beforeAppendTo<br>
|
|
<code><HTMLElement/Element>
|
|
target</code> the HTMLElement/Element being appended to
|
|
<p><strong>Usage:</strong><br>
|
|
<code>var handler = function(e) {var target = e.target};<br>
|
|
myTabs.addListener('beforeAppendTo', handler);</code></p>
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeElementChange">beforeElementChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeElementChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'element' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_contentReady">contentReady</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>contentReady</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the Element's HTMLElement subtree is rendered.
|
|
<p>See: <a href="#addListener">Element.addListener</a></p>
|
|
<p><strong>Event fields:</strong><br>
|
|
<code><String> type</code> contentReady<br>
|
|
<code><HTMLElement>
|
|
target</code> the HTMLElement bound to this Element instance<br>
|
|
<p><strong>Usage:</strong><br>
|
|
<code>var handler = function(e) {var target = e.target};<br>
|
|
myTabs.addListener('contentReady', handler);</code></p>
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_elementChange">elementChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>elementChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'element' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="section field details">
|
|
<h3 id="configattributes">Configuration Attributes</h3>
|
|
<div class="content">
|
|
<div class="">
|
|
<h4><a name="config_element">element</a>
|
|
<code>- HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The HTMLElement the Element instance refers to.
|
|
</div>
|
|
</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_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="selected"><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=""><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.util.Attribute.html">YAHOO.util.Attribute</a></li>
|
|
<li class=""><a href="YAHOO.util.AttributeProvider.html">YAHOO.util.AttributeProvider</a></li>
|
|
<li class="selected"><a href="YAHOO.util.Element.html">YAHOO.util.Element</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Files</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="Attribute.js.html">Attribute.js</a></li>
|
|
<li class=""><a href="AttributeProvider.js.html">AttributeProvider.js</a></li>
|
|
<li class=""><a href="Element.js.html">Element.js</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Properties</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="#property_DOM_EVENTS">DOM_EVENTS</a>
|
|
<!--<code><Object></code>-->
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Methods</h4>
|
|
<ul class="content">
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__registerHTMLAttr">_registerHTMLAttr</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_addClass">addClass</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_addListener">addListener</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_appendChild">appendChild</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_appendTo">appendTo</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_fireQueue">fireQueue</a>
|
|
</li>
|
|
<li class=""><!--<code>Array</code>-->
|
|
<a href="#method_getElementsByClassName">getElementsByClassName</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_getElementsByTagName">getElementsByTagName</a>
|
|
</li>
|
|
<li class=""><!--<code>String</code>-->
|
|
<a href="#method_getStyle">getStyle</a>
|
|
</li>
|
|
<li class=""><!--<code>Boolean</code>-->
|
|
<a href="#method_hasChildNodes">hasChildNodes</a>
|
|
</li>
|
|
<li class=""><!--<code>Boolean</code>-->
|
|
<a href="#method_hasClass">hasClass</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_initAttributes">initAttributes</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_insertBefore">insertBefore</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_on">on</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_removeChild">removeChild</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_removeClass">removeClass</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_removeListener">removeListener</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_replaceChild">replaceChild</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_replaceClass">replaceClass</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_setStyle">setStyle</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_subscribe">subscribe</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Events</h4>
|
|
<ul class="content">
|
|
<li class="">
|
|
<a href="#event_appendTo">appendTo</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_available">available</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeAppendTo">beforeAppendTo</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeElementChange">beforeElementChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_contentReady">contentReady</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_elementChange">elementChange</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Configuration Attributes</h4>
|
|
<ul class="content">
|
|
<li class="">
|
|
<a href="#config_element">element</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="ft">
|
|
<hr />
|
|
Copyright © 2007 Yahoo! Inc. All rights reserved.
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|