2896 lines
No EOL
188 KiB
HTML
2896 lines
No EOL
188 KiB
HTML
<!doctype html public "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>YAHOO.ext.Element</title>
|
|
<link rel="stylesheet" type="text/css" href="../resources/reset.css"/>
|
|
<link rel="stylesheet" type="text/css" href="../resources/style.css" media="screen"/>
|
|
<link rel="stylesheet" type="text/css" href="../resources/print.css" media="print">
|
|
</head>
|
|
<body>
|
|
<div class="body-wrap">
|
|
<div class="top-tools"><img src="../resources/print.gif" width="16" height="16" align="absmiddle"> <a href="YAHOO.ext.Element.html" target="_blank">Print Friendly</a></div>
|
|
<h1>Class YAHOO.ext.Element</h1>
|
|
<table cellspacing="0">
|
|
<tr><td class="label">Package:</td><td>YAHOO.ext</td></tr>
|
|
<tr><td class="label">Class:</td><td>Element</td></tr>
|
|
<tr><td class="label">Extends:</td><td>Object</td></tr>
|
|
<tr><td class="label">Subclasses:</td><td><a href="YAHOO.ext.Actor.html">Actor</a></td></tr>
|
|
<tr><td class="label">Defined In:</td><td><a href="Element.js.html">Element.js</a></td></tr>
|
|
</table>
|
|
<div class="description">
|
|
Wraps around a DOM element and provides convenient access to Yahoo
|
|
UI library functionality (and more).<br><br>
|
|
Usage:<br>
|
|
<pre><code>
|
|
var el = YAHOO.ext.Element.get('myElementId');
|
|
// or the shorter
|
|
var el = getEl('myElementId');
|
|
</code></pre>
|
|
Using YAHOO.ext.Element.get() instead of calling the constructor directly ensures you get the same object
|
|
each call instead of constructing a new one.<br><br>
|
|
For working with collections of Elements, see <a href="YAHOO.ext.CompositeElement.html">YAHOO.ext.CompositeElement</a> </div>
|
|
<hr />
|
|
<a name="properties"></a>
|
|
<h2>Public Properties</h2>
|
|
<table cellspacing="0" class="member-table">
|
|
<tr>
|
|
<th class="sig-header" colspan="2">Property</th>
|
|
<th class="msource-header">Defined By</th>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#DISPLAY<static>">DISPLAY<static></a> : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc"><static> Visibility mode constant - Use display to hide element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#VISIBILITY<static>">VISIBILITY<static></a> : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc"><static> Visibility mode constant - Use visibility to hide element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#autoBoxAdjust">autoBoxAdjust</a> : Object</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">true to automatically adjust width and height settings for box-model issues (default to true)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#autoDisplayMode">autoDisplayMode</a> : Object</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">true to automatically detect display mode and use display instead of visibility with show()/hide() (defaults to false...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#defaultUnit">defaultUnit</a> : String</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">The default unit to append to CSS values where a unit isn't provided (Defaults to px).</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#dom">dom</a> : HTMLElement</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">The DOM element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#id">id</a> : String</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">The DOM element ID</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#originalDisplay">originalDisplay</a> : String</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">The element's default display mode</td>
|
|
</tr>
|
|
</table>
|
|
<a name="methods"></a>
|
|
<h2>Public Methods</h2>
|
|
<table cellspacing="0" class="member-table">
|
|
<tr>
|
|
<th class="sig-header" colspan="2">Method</th>
|
|
<th class="msource-header">Defined By</th>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#Element">Element</a>(<code>String/HTMLElement element</code>, <span class="optional" title="Optional">[<code>Boolean forceNew</code>]</span>)</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Create a new Element directly.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addClass">addClass</a>(<code>String className</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Add a CSS class to the element.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addClassOnOver">addClassOnOver</a>(<code>String className</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sets up event handlers to add and remove a css class when the mouse is over this element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addHandler">addHandler</a>(<code>String eventName</code>, <code>Boolean stopPropagation</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>boolean override</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Appends an event handler to this element. The difference between this function and addListener is this
|
|
function preve...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addListener">addListener</a>(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>boolean override</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Appends an event handler to this element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addManagedListener">addManagedListener</a>(<code>String eventName</code>, <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>boolean override</code>]</span>) : Function</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Append a managed listener - See <a href="YAHOO.ext.EventObject.html">YAHOO.ext.EventObject</a> for more details. Use mon() for a shorter version.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#alignTo">alignTo</a>(<code>String/HTMLElement/YAHOO.ext.Element element</code>, <code>String position</code>, <span class="optional" title="Optional">[<code>Array offsets</code>]</span>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Align this element with another element.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#animate">animate</a>(<code>Object args</code>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>, <span class="optional" title="Optional">[<code>Function animType</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Perform Yahoo UI animation on this element.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#appendChild">appendChild</a>(<code>String/HTMLElement/Array/Element/CompositeElement el</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Appends the passed element(s) to this element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#appendTo">appendTo</a>(<code>String/HTMLElement/Element el</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Appends this element to the passed element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#applyStyles">applyStyles</a>(<code>String/Object/Function styles</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">More flexible version of <a href="#setStyle">setStyle</a> for setting style properties.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#autoHeight">autoHeight</a>(<span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Measures the elements content height and updates height to match. Note, this function uses setTimeout and
|
|
the new he...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#beginMeasure">beginMeasure</a>() : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#center">center</a>(<span class="optional" title="Optional">[<code>String/HTMLElement/YAHOO.ext.Element centerIn</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Centers the Element in either the viewport, or another Element.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#clearOpacity">clearOpacity</a>() : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Clears any opacity settings from this element. Required in some cases for IE.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#clearPositioning">clearPositioning</a>() : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Clear positioning back to the default when the document was loaded</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#clip">clip</a>() : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Store the current overflow setting and clip overflow on the element - use <a href="#unclip">unclip</a> to remove</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#createChild">createChild</a>(<code>Object config</code>, <span class="optional" title="Optional">[<code>HTMLElement insertBefore</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child e...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#createProxy">createProxy</a>(<code>String/Object config</code>, <span class="optional" title="Optional">[<code>String/HTMLElement renderTo</code>]</span>, <span class="optional" title="Optional">[<code>Boolean matchBox</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Creates a proxy element of this element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#createShim">createShim</a>() : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Creates an iframe shim for this element to keep selects and other windowed objects from
|
|
showing through.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#enableDisplayMode">enableDisplayMode</a>(<span class="optional" title="Optional">[<code>String display</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Convenience method for setVisibilityMode(Element.DISPLAY)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#endMeasure">endMeasure</a>() : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Restores displays to before beginMeasure was called</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#fitToParent">fitToParent</a>(<span class="optional" title="Optional">[<code>Boolean monitorResize</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sizes this element to it's parent element's dimensions performing
|
|
neccessary box adjustments.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#focus">focus</a>() : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Tries to focus the element. Any exceptions are caught.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#get<static>">get<static></a>(<code>String/HTMLElement/Element el</code>, <span class="optional" title="Optional">[<code>Boolean autoGenerateId</code>]</span>) : Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc"><static> Static method to retreive Element objects. Uses simple caching to consistently return the same object....</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getBorderWidth">getBorderWidth</a>(<code>String side</code>) : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Gets the width of the border(s) for the specified side(s)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getBottom">getBottom</a>(<code>Boolean local</code>) : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Gets the bottom Y coordinate of the element (element Y position + element height)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getBox">getBox</a>(<span class="optional" title="Optional">[<code>Boolean contentBox</code>]</span>, <span class="optional" title="Optional">[<code>Boolean local</code>]</span>) : Object</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Return a box {x, y, width, height} that can be used to set another elements
|
|
size/location to match this element.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getCenterXY">getCenterXY</a>(<code>Boolean offsetScroll</code>) : Array</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Calculates the x, y to center this element on the screen</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getChildrenByClassName">getChildrenByClassName</a>(<code>String className</code>, <span class="optional" title="Optional">[<code>String tagName</code>]</span>) : Array</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Gets an array of child YAHOO.ext.Element objects by class name and optional tagName</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getChildrenByTagName">getChildrenByTagName</a>(<code>String tagName</code>) : Array</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Gets an array of child YAHOO.ext.Element objects by tag name</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getHeight">getHeight</a>(<span class="optional" title="Optional">[<code>Boolean contentHeight</code>]</span>) : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns the offset height of the element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getLeft">getLeft</a>(<code>Boolean local</code>) : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Gets the left X coordinate</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getMargins">getMargins</a>(<span class="optional" title="Optional">[<code>String sides</code>]</span>) : Object/Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns an object with properties top, left, right and bottom representing the margins of this element unless sides i...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getNextSibling">getNextSibling</a>() : HTMLElement</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Gets the next sibling, skipping text nodes</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getPadding">getPadding</a>(<code>String side</code>) : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Gets the width of the padding(s) for the specified side(s)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getPositioning">getPositioning</a>() : Object</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Gets an object with all CSS positioning properties. Useful along with setPostioning to get
|
|
snapshot before performin...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getPrevSibling">getPrevSibling</a>() : HTMLElement</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Gets the previous sibling, skipping text nodes</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getRegion">getRegion</a>() : Region</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns the region of the given element.
|
|
The element must be part of the DOM tree to have a region (display:none or e...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getRight">getRight</a>(<code>Boolean local</code>) : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Gets the right X coordinate of the element (element X position + element width)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getSize">getSize</a>(<span class="optional" title="Optional">[<code>Boolean contentSize</code>]</span>) : Object</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns the size of the element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getStyle">getStyle</a>(<code>String property</code>) : String</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Normalizes currentStyle and ComputedStyle.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getTop">getTop</a>(<code>Boolean local</code>) : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Gets the top Y coordinate</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getUpdateManager">getUpdateManager</a>() : YAHOO.ext.UpdateManager</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Gets this elements UpdateManager</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getWidth">getWidth</a>(<span class="optional" title="Optional">[<code>Boolean contentWidth</code>]</span>) : Number</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns the offset width of the element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getX">getX</a>() : void</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have p...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getXY">getXY</a>() : void</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have pag...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getY">getY</a>() : void</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have p...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#hasClass">hasClass</a>(<code>String className</code>) : Boolean</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Checks if a CSS class is in use by the element.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#hide">hide</a>(<span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Hide this element - Uses display mode to determine whether to use "display" or "visibility". See <a href="#setVisible">setVisible</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#initDD">initDD</a>(<code>String group</code>, <code>Object config</code>, <code>Object overrides</code>) : YAHOO.util.DD</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Initializes a YAHOO.util.DD object for this element.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#initDDProxy">initDDProxy</a>(<code>String group</code>, <code>Object config</code>, <code>Object overrides</code>) : YAHOO.util.DDProxy</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Initializes a YAHOO.util.DDProxy object for this element.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#initDDTarget">initDDTarget</a>(<code>String group</code>, <code>Object config</code>, <code>Object overrides</code>) : YAHOO.util.DDTarget</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Initializes a YAHOO.util.DDTarget object for this element.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#insertAfter">insertAfter</a>(<code>String/HTMLElement/Element el</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Inserts this element after the passed element in the DOM</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#insertBefore">insertBefore</a>(<code>String/HTMLElement/Element el</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Inserts this element before the passed element in the DOM</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#insertHtml">insertHtml</a>(<code>String where</code>, <code>String html</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Inserts an html fragment into this element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#isBorderBox">isBorderBox</a>() : Boolean</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Tests various css rules/browsers to determine if this element uses a border box</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#isDisplayed">isDisplayed</a>() : Boolean</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns true if display is not "none"</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#isVisible">isVisible</a>(<span class="optional" title="Optional">[<code>Boolean deep</code>]</span>) : Boolean</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Checks whether the element is currently visible using both visibility and display properties.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#load">load</a>(<code>String/Function url</code>, <span class="optional" title="Optional">[<code>String/Object params</code>]</span>, <span class="optional" title="Optional">[<code>Function callback</code>]</span>, <span class="optional" title="Optional">[<code>Boolean discardUrl</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Direct access to the UpdateManager update() method (takes the same parameters).</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#mon">mon</a>(<code>String eventName</code>, <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>boolean override</code>]</span>) : Function</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Append a managed listener (shorthanded for <a href="#addManagedListener">addManagedListener</a>)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#move">move</a>(<code>String direction</code>, <code>Number distance</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Move this element relative to it's current position.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#moveTo">moveTo</a>(<code>Number x</code>, <code>Number y</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Set the position of the element in page coordinates, regardless of how the element is positioned.
|
|
The element must be...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#on">on</a>(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>boolean override</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Appends an event handler to this element (Same as addListener)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#radioClass">radioClass</a>(<code>String className</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Adds the passed className to this element and removes the class from all siblings</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#remove">remove</a>() : void</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Removes this element from the DOM and deletes it from the cache</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#removeAllListeners">removeAllListeners</a>() : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Removes all previous added listeners from this element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#removeClass">removeClass</a>(<code>String className</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Removes a CSS class from the element.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#removeListener">removeListener</a>(<code>String sType</code>, <code>Function fn</code>, <code>Object scope</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Removes an event handler from this element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#repaint">repaint</a>() : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Forces the browser to repaint this element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#replace">replace</a>(<code>String/HTMLElement/Element el</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Replaces the passed element with this element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#replaceClass">replaceClass</a>(<code>String oldClassName</code>, <code>String newClassName</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Replaces a CSS class on the element with another.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#scrollIntoView">scrollIntoView</a>(<span class="optional" title="Optional">[<code>String/HTMLElement/Element container</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Scrolls this element into view within the passed container.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#select">select</a>(<code>String selector</code>, <code>Boolean unique</code>) : CompositeElement/CompositeElementLite</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Selects child nodes based on the passed CSS selector (the selector should not contain an id)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#select<static>">select<static></a>(<code>String/Array selector</code>, <span class="optional" title="Optional">[<code>Boolean unique</code>]</span>) : CompositeElementLite/CompositeElement</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc"><static> Selects elements based on the passed CSS selector to enable working on them as 1.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#set">set</a>(<code>Object o</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setAbsolutePositioned">setAbsolutePositioned</a>(<span class="optional" title="Optional">[<code>Number zIndex</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Set the element as absolute positioned with the specified z-index</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setBottom">setBottom</a>(<code>String bottom</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Set the element's css bottom style</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setBounds">setBounds</a>(<code>Number x</code>, <code>Number y</code>, <code>Number width</code>, <code>Number height</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated c...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setBox">setBox</a>(<code>Object box</code>, <span class="optional" title="Optional">[<code>Boolean adjust</code>]</span>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x an...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setDisplayed">setDisplayed</a>(<code>Boolean value</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sets the css display. Uses originalDisplay if value is a boolean true.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setHeight">setHeight</a>(<code>Number height</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Set the height of the element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setLeft">setLeft</a>(<code>String left</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Set the element's left position directly using CSS style (instead of setX())</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setLeftTop">setLeftTop</a>() : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Quick set left and top adding default units</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setLocation">setLocation</a>(<code>Number x</code>, <code>Number y</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Set the position of the element in page coordinates, regardless of how the element is positioned.
|
|
The element must be...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setOpacity">setOpacity</a>(<code>Float opacity</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Set the opacity of the element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setPositioning">setPositioning</a>(<code>Object posCfg</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Set positioning with an object returned by getPositioning().</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setRegion">setRegion</a>(<code>YAHOO.util.Region region</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Sets the element's position and size the the specified region. If animation is true then width, height, x and y will ...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setRelativePositioned">setRelativePositioned</a>(<span class="optional" title="Optional">[<code>Number zIndex</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Set the element as relative positioned with the specified z-index</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setRight">setRight</a>(<code>String right</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Set the element's css right style</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setSize">setSize</a>(<code>Number width</code>, <code>Number height</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Set the size of the element. If animation is true, both width an height will be animated concurrently.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setStyle">setStyle</a>(<code>String/Object property</code>, <span class="optional" title="Optional">[<code>String val</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Wrapper for setting style properties, also takes single object parameter of multiple styles</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setTop">setTop</a>(<code>String top</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Set the element's top position directly using CSS style (instead of setY())</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setVisibilityMode">setVisibilityMode</a>(<code>visMode Element.VISIBILITY</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Sets the elements visibility mode. When setVisible() is called it
|
|
will use this to determine whether to set the visib...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setVisible">setVisible</a>(<code>Boolean visible</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use
|
|
the d...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setWidth">setWidth</a>(<code>Number width</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Set the width of the element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setX">setX</a>(<code>Number The</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coor...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setXY">setXY</a>(<code>Array pos</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Set the position of the element in page coordinates, regardless of how the element is positioned.
|
|
The element must be...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setY">setY</a>(<code>Number The</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coor...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#show">show</a>(<span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Show this element - Uses display mode to determine whether to use "display" or "visibility". See <a href="#setVisible">setVisible</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#swallowEvent">swallowEvent</a>(<code>String eventName</code>, <span class="optional" title="Optional">[<code>Boolean preventDefault</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Stops the specified event from bubbling and optionally prevent's the default action</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#toggle">toggle</a>(<span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Toggles the elements visibility or display, depending on visibility mode.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#toggleClass">toggleClass</a>(<code>String className</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Toggles (adds or removes) the passed class.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#unclip">unclip</a>() : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Return clipping (overflow) to original clipping before clip() was called</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#unselectable">unselectable</a>() : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Disables text selection for this element (normalized across browsers)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#update">update</a>(<code>String html</code>, <span class="optional" title="Optional">[<code>Boolean loadScripts</code>]</span>, <code>Function callback</code>) : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Update the innerHTML of this element, optionally searching for and processing scripts</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#wrap">wrap</a>(<span class="optional" title="Optional">[<code>Object config</code>]</span>) : Element</td>
|
|
<td class="msource" rowspan="2">Element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Creates and wraps this element with another element</td>
|
|
</tr>
|
|
</table>
|
|
<a name="events"></a>
|
|
<h2>Public Events</h2>
|
|
<div class="no-members">This class has no public events.</div>
|
|
<h2 class="mdetail-head">Property Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="DISPLAY<static>"></a>
|
|
<div class="mdetail">
|
|
<h3>DISPLAY<static></i></h3>
|
|
<code>public Number DISPLAY<static></code>
|
|
<div class="mdetail-desc">
|
|
<static> Visibility mode constant - Use display to hide element </div>
|
|
<div class="mdetail-def">This property is defined by Element.</div>
|
|
</div>
|
|
<a name="VISIBILITY<static>"></a>
|
|
<div class="mdetail alt">
|
|
<h3>VISIBILITY<static></i></h3>
|
|
<code>public Number VISIBILITY<static></code>
|
|
<div class="mdetail-desc">
|
|
<static> Visibility mode constant - Use visibility to hide element </div>
|
|
<div class="mdetail-def">This property is defined by Element.</div>
|
|
</div>
|
|
<a name="autoBoxAdjust"></a>
|
|
<div class="mdetail">
|
|
<h3>autoBoxAdjust</i></h3>
|
|
<code>public Object autoBoxAdjust</code>
|
|
<div class="mdetail-desc">
|
|
true to automatically adjust width and height settings for box-model issues (default to true) </div>
|
|
<div class="mdetail-def">This property is defined by Element.</div>
|
|
</div>
|
|
<a name="autoDisplayMode"></a>
|
|
<div class="mdetail alt">
|
|
<h3>autoDisplayMode</i></h3>
|
|
<code>public Object autoDisplayMode</code>
|
|
<div class="mdetail-desc">
|
|
true to automatically detect display mode and use display instead of visibility with show()/hide() (defaults to false).
|
|
To enable this globally:<pre><code>YAHOO.ext.Element.prototype.autoDisplayMode = true;</code></pre> </div>
|
|
<div class="mdetail-def">This property is defined by Element.</div>
|
|
</div>
|
|
<a name="defaultUnit"></a>
|
|
<div class="mdetail">
|
|
<h3>defaultUnit</i></h3>
|
|
<code>public String defaultUnit</code>
|
|
<div class="mdetail-desc">
|
|
The default unit to append to CSS values where a unit isn't provided (Defaults to px). </div>
|
|
<div class="mdetail-def">This property is defined by Element.</div>
|
|
</div>
|
|
<a name="dom"></a>
|
|
<div class="mdetail alt">
|
|
<h3>dom</i></h3>
|
|
<code>public HTMLElement dom</code>
|
|
<div class="mdetail-desc">
|
|
The DOM element </div>
|
|
<div class="mdetail-def">This property is defined by Element.</div>
|
|
</div>
|
|
<a name="id"></a>
|
|
<div class="mdetail">
|
|
<h3>id</i></h3>
|
|
<code>public String id</code>
|
|
<div class="mdetail-desc">
|
|
The DOM element ID </div>
|
|
<div class="mdetail-def">This property is defined by Element.</div>
|
|
</div>
|
|
<a name="originalDisplay"></a>
|
|
<div class="mdetail alt">
|
|
<h3>originalDisplay</i></h3>
|
|
<code>public String originalDisplay</code>
|
|
<div class="mdetail-desc">
|
|
The element's default display mode </div>
|
|
<div class="mdetail-def">This property is defined by Element.</div>
|
|
</div>
|
|
</div>
|
|
|
|
<a name="Element"></a>
|
|
<h2 class="mdetail-head">Constructor Details</h2>
|
|
<div class="detail-wrap">
|
|
<div class="mdetail">
|
|
<h3>Element</i></h3>
|
|
<code>public function Element(<code>String/HTMLElement element</code>, <span class="optional" title="Optional">[<code>Boolean forceNew</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Create a new Element directly. <div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>element</code> : String/HTMLElement<div class="sub-desc"></div></li><li><code>forceNew</code> : Boolean<div class="sub-desc">(optional) By default the constructor checks to see if there is already an instance of this element in the cache and if there is it returns the same instance. This will skip that check (useful for extending this class).</div></li> </ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<h2 class="mdetail-head">Method Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="addClass"></a>
|
|
<div class="mdetail">
|
|
<h3>addClass</i></h3>
|
|
<code>public function addClass(<code>String className</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Add a CSS class to the element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>className</code> : String<div class="sub-desc">The CSS class to add</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="addClassOnOver"></a>
|
|
<div class="mdetail alt">
|
|
<h3>addClassOnOver</i></h3>
|
|
<code>public function addClassOnOver(<code>String className</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets up event handlers to add and remove a css class when the mouse is over this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>className</code> : String<div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="addHandler"></a>
|
|
<div class="mdetail">
|
|
<h3>addHandler</i></h3>
|
|
<code>public function addHandler(<code>String eventName</code>, <code>Boolean stopPropagation</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>boolean override</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Appends an event handler to this element. The difference between this function and addListener is this
|
|
function prevents the default action, and if set stops propagation (bubbling) as well
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>stopPropagation</code> : Boolean<div class="sub-desc">Whether to also stopPropagation (bubbling)</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) An arbitrary object that will be passed as a parameter to the handler</div></li><li><code>override</code> : boolean<div class="sub-desc">(optional) If true, the obj passed in becomes the execution scope of the listener</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="addListener"></a>
|
|
<div class="mdetail alt">
|
|
<h3>addListener</i></h3>
|
|
<code>public function addListener(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>boolean override</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Appends an event handler to this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) An arbitrary object that will be passed as a parameter to the handler</div></li><li><code>override</code> : boolean<div class="sub-desc">(optional) If true, the obj passed in becomes the execution scope of the listener</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="addManagedListener"></a>
|
|
<div class="mdetail">
|
|
<h3>addManagedListener</i></h3>
|
|
<code>public function addManagedListener(<code>String eventName</code>, <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>boolean override</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Append a managed listener - See <a href="YAHOO.ext.EventObject.html">YAHOO.ext.EventObject</a> for more details. Use mon() for a shorter version.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>fn</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) An arbitrary object that will be passed as a parameter to the handler</div></li><li><code>override</code> : boolean<div class="sub-desc">(optional) If true, the obj passed in becomes the execution scope of the listener</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Function</code><div class="sub-desc">The EventManager wrapped function that can be used to remove the listener</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="alignTo"></a>
|
|
<div class="mdetail alt">
|
|
<h3>alignTo</i></h3>
|
|
<code>public function alignTo(<code>String/HTMLElement/YAHOO.ext.Element element</code>, <code>String position</code>, <span class="optional" title="Optional">[<code>Array offsets</code>]</span>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Align this element with another element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>element</code> : String/HTMLElement/YAHOO.ext.Element<div class="sub-desc">The element to align to.</div></li><li><code>position</code> : String<div class="sub-desc">The position to align to. Possible values are 'tl' - top left, 'tr' - top right, 'bl' - bottom left, and 'br' - bottom right.</div></li><li><code>offsets</code> : Array<div class="sub-desc">(optional) Offset the positioning by [x, y]</div></li><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Animate the movement (Default is false)</div></li><li><code>duration</code> : Float<div class="sub-desc">(optional) How long the animation lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="animate"></a>
|
|
<div class="mdetail">
|
|
<h3>animate</i></h3>
|
|
<code>public function animate(<code>Object args</code>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>, <span class="optional" title="Optional">[<code>Function animType</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Perform Yahoo UI animation on this element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>args</code> : Object<div class="sub-desc">The YUI animation control args</div></li><li><code>duration</code> : Float<div class="sub-desc">(optional) How long the animation lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)</div></li><li><code>animType</code> : Function<div class="sub-desc">(optional) YAHOO.util.Anim subclass to use. For example: YAHOO.util.Motion</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="appendChild"></a>
|
|
<div class="mdetail alt">
|
|
<h3>appendChild</i></h3>
|
|
<code>public function appendChild(<code>String/HTMLElement/Array/Element/CompositeElement el</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Appends the passed element(s) to this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>el</code> : String/HTMLElement/Array/Element/CompositeElement<div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="appendTo"></a>
|
|
<div class="mdetail">
|
|
<h3>appendTo</i></h3>
|
|
<code>public function appendTo(<code>String/HTMLElement/Element el</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Appends this element to the passed element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>el</code> : String/HTMLElement/Element<div class="sub-desc">The new parent element</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="applyStyles"></a>
|
|
<div class="mdetail alt">
|
|
<h3>applyStyles</i></h3>
|
|
<code>public function applyStyles(<code>String/Object/Function styles</code>)</code>
|
|
<div class="mdetail-desc">
|
|
More flexible version of <a href="#setStyle">setStyle</a> for setting style properties.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>styles</code> : String/Object/Function<div class="sub-desc">A style specification string eg "width:100px", or object in the form {width:"100px"}, or a function which returns such a specification.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="autoHeight"></a>
|
|
<div class="mdetail">
|
|
<h3>autoHeight</i></h3>
|
|
<code>public function autoHeight(<span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Measures the elements content height and updates height to match. Note, this function uses setTimeout and
|
|
the new height may not be available immediately.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Animate the transition (Default is false)</div></li><li><code>duration</code> : Float<div class="sub-desc">(optional) Length of the animation. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeOut for hiding or YAHOO.util.Easing.easeIn for showing)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="beginMeasure"></a>
|
|
<div class="mdetail alt">
|
|
<h3>beginMeasure</i></h3>
|
|
<code>public function beginMeasure()</code>
|
|
<div class="mdetail-desc">
|
|
Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="center"></a>
|
|
<div class="mdetail">
|
|
<h3>center</i></h3>
|
|
<code>public function center(<span class="optional" title="Optional">[<code>String/HTMLElement/YAHOO.ext.Element centerIn</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Centers the Element in either the viewport, or another Element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>centerIn</code> : String/HTMLElement/YAHOO.ext.Element<div class="sub-desc">(optional) The element in which to center the element.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="clearOpacity"></a>
|
|
<div class="mdetail alt">
|
|
<h3>clearOpacity</i></h3>
|
|
<code>public function clearOpacity()</code>
|
|
<div class="mdetail-desc">
|
|
Clears any opacity settings from this element. Required in some cases for IE.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="clearPositioning"></a>
|
|
<div class="mdetail">
|
|
<h3>clearPositioning</i></h3>
|
|
<code>public function clearPositioning()</code>
|
|
<div class="mdetail-desc">
|
|
Clear positioning back to the default when the document was loaded
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="clip"></a>
|
|
<div class="mdetail alt">
|
|
<h3>clip</i></h3>
|
|
<code>public function clip()</code>
|
|
<div class="mdetail-desc">
|
|
Store the current overflow setting and clip overflow on the element - use <a href="#unclip">unclip</a> to remove
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="createChild"></a>
|
|
<div class="mdetail">
|
|
<h3>createChild</i></h3>
|
|
<code>public function createChild(<code>Object config</code>, <span class="optional" title="Optional">[<code>HTMLElement insertBefore</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>config</code> : Object<div class="sub-desc">DomHelper element config object</div></li><li><code>insertBefore</code> : HTMLElement<div class="sub-desc">(optional) a child element of this element</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">The new child element</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="createProxy"></a>
|
|
<div class="mdetail alt">
|
|
<h3>createProxy</i></h3>
|
|
<code>public function createProxy(<code>String/Object config</code>, <span class="optional" title="Optional">[<code>String/HTMLElement renderTo</code>]</span>, <span class="optional" title="Optional">[<code>Boolean matchBox</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Creates a proxy element of this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>config</code> : String/Object<div class="sub-desc">The class name of the proxy element or a DomHelper config object</div></li><li><code>renderTo</code> : String/HTMLElement<div class="sub-desc">(optional) The element or element id to render the proxy to (defaults to document.body)</div></li><li><code>matchBox</code> : Boolean<div class="sub-desc">(optional) True to align and size the proxy to this element now (defaults to false)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">The new proxy element</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="createShim"></a>
|
|
<div class="mdetail">
|
|
<h3>createShim</i></h3>
|
|
<code>public function createShim()</code>
|
|
<div class="mdetail-desc">
|
|
Creates an iframe shim for this element to keep selects and other windowed objects from
|
|
showing through.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">The new shim element</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="enableDisplayMode"></a>
|
|
<div class="mdetail alt">
|
|
<h3>enableDisplayMode</i></h3>
|
|
<code>public function enableDisplayMode(<span class="optional" title="Optional">[<code>String display</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Convenience method for setVisibilityMode(Element.DISPLAY)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>display</code> : String<div class="sub-desc">(optional) What to set display to when visible</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="endMeasure"></a>
|
|
<div class="mdetail">
|
|
<h3>endMeasure</i></h3>
|
|
<code>public function endMeasure()</code>
|
|
<div class="mdetail-desc">
|
|
Restores displays to before beginMeasure was called
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="fitToParent"></a>
|
|
<div class="mdetail alt">
|
|
<h3>fitToParent</i></h3>
|
|
<code>public function fitToParent(<span class="optional" title="Optional">[<code>Boolean monitorResize</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Sizes this element to it's parent element's dimensions performing
|
|
neccessary box adjustments.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>monitorResize</code> : Boolean<div class="sub-desc">(optional) If true maintains the fit when the browser window is resized.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="focus"></a>
|
|
<div class="mdetail">
|
|
<h3>focus</i></h3>
|
|
<code>public function focus()</code>
|
|
<div class="mdetail-desc">
|
|
Tries to focus the element. Any exceptions are caught.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="get<static>"></a>
|
|
<div class="mdetail alt">
|
|
<h3>get<static></i></h3>
|
|
<code>public function get<static>(<code>String/HTMLElement/Element el</code>, <span class="optional" title="Optional">[<code>Boolean autoGenerateId</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
<static> Static method to retreive Element objects. Uses simple caching to consistently return the same object.
|
|
Automatically fixes if an object was recreated with the same id via AJAX or DOM.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>el</code> : String/HTMLElement/Element<div class="sub-desc">The id of the element or the element to wrap (must have an id). If you pass in an element, it is returned</div></li><li><code>autoGenerateId</code> : Boolean<div class="sub-desc">(optional) Set this flag to true if you are passing an element without an id (like document.body). It will auto generate an id if one isn't present.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Element</code><div class="sub-desc">The element object</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getBorderWidth"></a>
|
|
<div class="mdetail">
|
|
<h3>getBorderWidth</i></h3>
|
|
<code>public function getBorderWidth(<code>String side</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Gets the width of the border(s) for the specified side(s)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>side</code> : String<div class="sub-desc">Can be t, l, r, b or any combination of those to add multiple values. For example, passing lr would get the border (l)eft width + the border (r)ight width.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code><div class="sub-desc">The width of the sides passed added together</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getBottom"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getBottom</i></h3>
|
|
<code>public function getBottom(<code>Boolean local</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Gets the bottom Y coordinate of the element (element Y position + element height)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>local</code> : Boolean<div class="sub-desc">True to get the local css position instead of page coordinate</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getBox"></a>
|
|
<div class="mdetail">
|
|
<h3>getBox</i></h3>
|
|
<code>public function getBox(<span class="optional" title="Optional">[<code>Boolean contentBox</code>]</span>, <span class="optional" title="Optional">[<code>Boolean local</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Return a box {x, y, width, height} that can be used to set another elements
|
|
size/location to match this element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>contentBox</code> : Boolean<div class="sub-desc">(optional) If true a box for the content of the element is returned.</div></li><li><code>local</code> : Boolean<div class="sub-desc">(optional) If true the element's left and top are returned instead of page x/y.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Object</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getCenterXY"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getCenterXY</i></h3>
|
|
<code>public function getCenterXY(<code>Boolean offsetScroll</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Calculates the x, y to center this element on the screen
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>offsetScroll</code> : Boolean<div class="sub-desc">True to offset the documents current scroll position</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Array</code><div class="sub-desc">The x, y values [x, y]</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getChildrenByClassName"></a>
|
|
<div class="mdetail">
|
|
<h3>getChildrenByClassName</i></h3>
|
|
<code>public function getChildrenByClassName(<code>String className</code>, <span class="optional" title="Optional">[<code>String tagName</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Gets an array of child YAHOO.ext.Element objects by class name and optional tagName
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>className</code> : String<div class="sub-desc"></div></li><li><code>tagName</code> : String<div class="sub-desc">(optional)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Array</code><div class="sub-desc">The children</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getChildrenByTagName"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getChildrenByTagName</i></h3>
|
|
<code>public function getChildrenByTagName(<code>String tagName</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Gets an array of child YAHOO.ext.Element objects by tag name
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>tagName</code> : String<div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Array</code><div class="sub-desc">The children</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getHeight"></a>
|
|
<div class="mdetail">
|
|
<h3>getHeight</i></h3>
|
|
<code>public function getHeight(<span class="optional" title="Optional">[<code>Boolean contentHeight</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Returns the offset height of the element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>contentHeight</code> : Boolean<div class="sub-desc">(optional) true to get the height minus borders and padding</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code><div class="sub-desc">The element's height</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getLeft"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getLeft</i></h3>
|
|
<code>public function getLeft(<code>Boolean local</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Gets the left X coordinate
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>local</code> : Boolean<div class="sub-desc">True to get the local css position instead of page coordinate</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getMargins"></a>
|
|
<div class="mdetail">
|
|
<h3>getMargins</i></h3>
|
|
<code>public function getMargins(<span class="optional" title="Optional">[<code>String sides</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed,
|
|
then it returns the calculated width of the sides (see getPadding)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>sides</code> : String<div class="sub-desc">(optional) Any combination of l, r, t, b to get the sum of those sides</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Object/Number</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getNextSibling"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getNextSibling</i></h3>
|
|
<code>public function getNextSibling()</code>
|
|
<div class="mdetail-desc">
|
|
Gets the next sibling, skipping text nodes
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>HTMLElement</code><div class="sub-desc">The next sibling or null</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getPadding"></a>
|
|
<div class="mdetail">
|
|
<h3>getPadding</i></h3>
|
|
<code>public function getPadding(<code>String side</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Gets the width of the padding(s) for the specified side(s)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>side</code> : String<div class="sub-desc">Can be t, l, r, b or any combination of those to add multiple values. For example, passing lr would get the padding (l)eft + the padding (r)ight.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code><div class="sub-desc">The padding of the sides passed added together</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getPositioning"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getPositioning</i></h3>
|
|
<code>public function getPositioning()</code>
|
|
<div class="mdetail-desc">
|
|
Gets an object with all CSS positioning properties. Useful along with setPostioning to get
|
|
snapshot before performing an update and then restoring the element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Object</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getPrevSibling"></a>
|
|
<div class="mdetail">
|
|
<h3>getPrevSibling</i></h3>
|
|
<code>public function getPrevSibling()</code>
|
|
<div class="mdetail-desc">
|
|
Gets the previous sibling, skipping text nodes
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>HTMLElement</code><div class="sub-desc">The previous sibling or null</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getRegion"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getRegion</i></h3>
|
|
<code>public function getRegion()</code>
|
|
<div class="mdetail-desc">
|
|
Returns the region of the given element.
|
|
The element must be part of the DOM tree to have a region (display:none or elements not appended return false).
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Region</code><div class="sub-desc">A YAHOO.util.Region containing "top, left, bottom, right" member data.</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getRight"></a>
|
|
<div class="mdetail">
|
|
<h3>getRight</i></h3>
|
|
<code>public function getRight(<code>Boolean local</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Gets the right X coordinate of the element (element X position + element width)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>local</code> : Boolean<div class="sub-desc">True to get the local css position instead of page coordinate</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getSize"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getSize</i></h3>
|
|
<code>public function getSize(<span class="optional" title="Optional">[<code>Boolean contentSize</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Returns the size of the element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>contentSize</code> : Boolean<div class="sub-desc">(optional) true to get the width/size minus borders and padding</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Object</code><div class="sub-desc">An object containing the element's size {width: (element width), height: (element height)}</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getStyle"></a>
|
|
<div class="mdetail">
|
|
<h3>getStyle</i></h3>
|
|
<code>public function getStyle(<code>String property</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Normalizes currentStyle and ComputedStyle.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>property</code> : String<div class="sub-desc">The style property whose value is returned.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>String</code><div class="sub-desc">The current value of the style property for this element.</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getTop"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getTop</i></h3>
|
|
<code>public function getTop(<code>Boolean local</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Gets the top Y coordinate
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>local</code> : Boolean<div class="sub-desc">True to get the local css position instead of page coordinate</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getUpdateManager"></a>
|
|
<div class="mdetail">
|
|
<h3>getUpdateManager</i></h3>
|
|
<code>public function getUpdateManager()</code>
|
|
<div class="mdetail-desc">
|
|
Gets this elements UpdateManager
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.UpdateManager</code><div class="sub-desc">The UpdateManager</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getWidth"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getWidth</i></h3>
|
|
<code>public function getWidth(<span class="optional" title="Optional">[<code>Boolean contentWidth</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Returns the offset width of the element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>contentWidth</code> : Boolean<div class="sub-desc">(optional) true to get the width minus borders and padding</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code><div class="sub-desc">The element's width</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getX"></a>
|
|
<div class="mdetail">
|
|
<h3>getX</i></h3>
|
|
<code>public function getX()</code>
|
|
<div class="mdetail-desc">
|
|
Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
|
|
@ return {Number} The X position of the element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getXY"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getXY</i></h3>
|
|
<code>public function getXY()</code>
|
|
<div class="mdetail-desc">
|
|
Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
|
|
@ return {Array} The XY position of the element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="getY"></a>
|
|
<div class="mdetail">
|
|
<h3>getY</i></h3>
|
|
<code>public function getY()</code>
|
|
<div class="mdetail-desc">
|
|
Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
|
|
@ return {Number} The Y position of the element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="hasClass"></a>
|
|
<div class="mdetail alt">
|
|
<h3>hasClass</i></h3>
|
|
<code>public function hasClass(<code>String className</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Checks if a CSS class is in use by the element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>className</code> : String<div class="sub-desc">The CSS class to check</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code><div class="sub-desc">true or false</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="hide"></a>
|
|
<div class="mdetail">
|
|
<h3>hide</i></h3>
|
|
<code>public function hide(<span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Hide this element - Uses display mode to determine whether to use "display" or "visibility". See <a href="#setVisible">setVisible</a>.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Animate (fade) the transition (Default is false)</div></li><li><code>duration</code> : Float<div class="sub-desc">(optional) How long the animation lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="initDD"></a>
|
|
<div class="mdetail alt">
|
|
<h3>initDD</i></h3>
|
|
<code>public function initDD(<code>String group</code>, <code>Object config</code>, <code>Object overrides</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Initializes a YAHOO.util.DD object for this element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>group</code> : String<div class="sub-desc">The group the DD object is member of</div></li><li><code>config</code> : Object<div class="sub-desc">The DD config object</div></li><li><code>overrides</code> : Object<div class="sub-desc">An object containing methods to override/implement on the DD object</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.util.DD</code><div class="sub-desc">The DD object</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="initDDProxy"></a>
|
|
<div class="mdetail">
|
|
<h3>initDDProxy</i></h3>
|
|
<code>public function initDDProxy(<code>String group</code>, <code>Object config</code>, <code>Object overrides</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Initializes a YAHOO.util.DDProxy object for this element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>group</code> : String<div class="sub-desc">The group the DDProxy object is member of</div></li><li><code>config</code> : Object<div class="sub-desc">The DDProxy config object</div></li><li><code>overrides</code> : Object<div class="sub-desc">An object containing methods to override/implement on the DDProxy object</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.util.DDProxy</code><div class="sub-desc">The DDProxy object</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="initDDTarget"></a>
|
|
<div class="mdetail alt">
|
|
<h3>initDDTarget</i></h3>
|
|
<code>public function initDDTarget(<code>String group</code>, <code>Object config</code>, <code>Object overrides</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Initializes a YAHOO.util.DDTarget object for this element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>group</code> : String<div class="sub-desc">The group the DDTarget object is member of</div></li><li><code>config</code> : Object<div class="sub-desc">The DDTarget config object</div></li><li><code>overrides</code> : Object<div class="sub-desc">An object containing methods to override/implement on the DDTarget object</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.util.DDTarget</code><div class="sub-desc">The DDTarget object</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="insertAfter"></a>
|
|
<div class="mdetail">
|
|
<h3>insertAfter</i></h3>
|
|
<code>public function insertAfter(<code>String/HTMLElement/Element el</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Inserts this element after the passed element in the DOM
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>el</code> : String/HTMLElement/Element<div class="sub-desc">The element to insert after</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="insertBefore"></a>
|
|
<div class="mdetail alt">
|
|
<h3>insertBefore</i></h3>
|
|
<code>public function insertBefore(<code>String/HTMLElement/Element el</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Inserts this element before the passed element in the DOM
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>el</code> : String/HTMLElement/Element<div class="sub-desc">The element to insert before</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="insertHtml"></a>
|
|
<div class="mdetail">
|
|
<h3>insertHtml</i></h3>
|
|
<code>public function insertHtml(<code>String where</code>, <code>String html</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Inserts an html fragment into this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>where</code> : String<div class="sub-desc">Where to insert the html in relation to the this element - beforeBegin, afterBegin, beforeEnd, afterEnd.</div></li><li><code>html</code> : String<div class="sub-desc">The HTML fragment</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="isBorderBox"></a>
|
|
<div class="mdetail alt">
|
|
<h3>isBorderBox</i></h3>
|
|
<code>public function isBorderBox()</code>
|
|
<div class="mdetail-desc">
|
|
Tests various css rules/browsers to determine if this element uses a border box
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="isDisplayed"></a>
|
|
<div class="mdetail">
|
|
<h3>isDisplayed</i></h3>
|
|
<code>public function isDisplayed()</code>
|
|
<div class="mdetail-desc">
|
|
Returns true if display is not "none"
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="isVisible"></a>
|
|
<div class="mdetail alt">
|
|
<h3>isVisible</i></h3>
|
|
<code>public function isVisible(<span class="optional" title="Optional">[<code>Boolean deep</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Checks whether the element is currently visible using both visibility and display properties.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>deep</code> : Boolean<div class="sub-desc">True to walk the dom and see if parent elements are hidden.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code><div class="sub-desc">true if the element is currently visible</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="load"></a>
|
|
<div class="mdetail">
|
|
<h3>load</i></h3>
|
|
<code>public function load(<code>String/Function url</code>, <span class="optional" title="Optional">[<code>String/Object params</code>]</span>, <span class="optional" title="Optional">[<code>Function callback</code>]</span>, <span class="optional" title="Optional">[<code>Boolean discardUrl</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Direct access to the UpdateManager update() method (takes the same parameters).
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>url</code> : String/Function<div class="sub-desc">The url for this request or a function to call to get the url</div></li><li><code>params</code> : String/Object<div class="sub-desc">(optional) The parameters to pass as either a url encoded string "param1=1&param2=2" or an object {param1: 1, param2: 2}</div></li><li><code>callback</code> : Function<div class="sub-desc">(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)</div></li><li><code>discardUrl</code> : Boolean<div class="sub-desc">(optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="mon"></a>
|
|
<div class="mdetail alt">
|
|
<h3>mon</i></h3>
|
|
<code>public function mon(<code>String eventName</code>, <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>boolean override</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Append a managed listener (shorthanded for <a href="#addManagedListener">addManagedListener</a>)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>fn</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) An arbitrary object that will be passed as a parameter to the handler</div></li><li><code>override</code> : boolean<div class="sub-desc">(optional) If true, the obj passed in becomes the execution scope of the listener</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Function</code><div class="sub-desc">The EventManager wrapped function that can be used to remove the listener</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="move"></a>
|
|
<div class="mdetail">
|
|
<h3>move</i></h3>
|
|
<code>public function move(<code>String direction</code>, <code>Number distance</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Move this element relative to it's current position.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>direction</code> : String<div class="sub-desc">Possible values are: 'l','left' - 'r','right' - 't','top','up' - 'b','bottom','down'.</div></li><li><code>distance</code> : Number<div class="sub-desc">How far to move the element in pixels</div></li><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Animate the movement (Default is false)</div></li><li><code>duration</code> : Float<div class="sub-desc">(optional) How long the animation lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="moveTo"></a>
|
|
<div class="mdetail alt">
|
|
<h3>moveTo</i></h3>
|
|
<code>public function moveTo(<code>Number x</code>, <code>Number y</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the position of the element in page coordinates, regardless of how the element is positioned.
|
|
The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>x</code> : Number<div class="sub-desc">X value for new position (coordinates are page-based)</div></li><li><code>y</code> : Number<div class="sub-desc">Y value for new position (coordinates are page-based)</div></li><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Animate the transition (Default is false)</div></li><li><code>duration</code> : float<div class="sub-desc">(optional) How long the animation lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="on"></a>
|
|
<div class="mdetail">
|
|
<h3>on</i></h3>
|
|
<code>public function on(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>boolean override</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Appends an event handler to this element (Same as addListener)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) An arbitrary object that will be passed as a parameter to the handler</div></li><li><code>override</code> : boolean<div class="sub-desc">(optional) If true, the obj passed in becomes the execution scope of the listener</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="radioClass"></a>
|
|
<div class="mdetail alt">
|
|
<h3>radioClass</i></h3>
|
|
<code>public function radioClass(<code>String className</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Adds the passed className to this element and removes the class from all siblings
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>className</code> : String<div class="sub-desc">The className to add</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="remove"></a>
|
|
<div class="mdetail">
|
|
<h3>remove</i></h3>
|
|
<code>public function remove()</code>
|
|
<div class="mdetail-desc">
|
|
Removes this element from the DOM and deletes it from the cache
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="removeAllListeners"></a>
|
|
<div class="mdetail alt">
|
|
<h3>removeAllListeners</i></h3>
|
|
<code>public function removeAllListeners()</code>
|
|
<div class="mdetail-desc">
|
|
Removes all previous added listeners from this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="removeClass"></a>
|
|
<div class="mdetail">
|
|
<h3>removeClass</i></h3>
|
|
<code>public function removeClass(<code>String className</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Removes a CSS class from the element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>className</code> : String<div class="sub-desc">The CSS class to remove</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="removeListener"></a>
|
|
<div class="mdetail alt">
|
|
<h3>removeListener</i></h3>
|
|
<code>public function removeListener(<code>String sType</code>, <code>Function fn</code>, <code>Object scope</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Removes an event handler from this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>sType</code> : String<div class="sub-desc">the type of event to remove</div></li><li><code>fn</code> : Function<div class="sub-desc">the method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="repaint"></a>
|
|
<div class="mdetail">
|
|
<h3>repaint</i></h3>
|
|
<code>public function repaint()</code>
|
|
<div class="mdetail-desc">
|
|
Forces the browser to repaint this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="replace"></a>
|
|
<div class="mdetail alt">
|
|
<h3>replace</i></h3>
|
|
<code>public function replace(<code>String/HTMLElement/Element el</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Replaces the passed element with this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>el</code> : String/HTMLElement/Element<div class="sub-desc">The element to replace</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="replaceClass"></a>
|
|
<div class="mdetail">
|
|
<h3>replaceClass</i></h3>
|
|
<code>public function replaceClass(<code>String oldClassName</code>, <code>String newClassName</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Replaces a CSS class on the element with another.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>oldClassName</code> : String<div class="sub-desc">The CSS class to replace</div></li><li><code>newClassName</code> : String<div class="sub-desc">The replacement CSS class</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="scrollIntoView"></a>
|
|
<div class="mdetail alt">
|
|
<h3>scrollIntoView</i></h3>
|
|
<code>public function scrollIntoView(<span class="optional" title="Optional">[<code>String/HTMLElement/Element container</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Scrolls this element into view within the passed container.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>container</code> : String/HTMLElement/Element<div class="sub-desc">(optional) The container element to scroll (defaults to document.body)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="select"></a>
|
|
<div class="mdetail">
|
|
<h3>select</i></h3>
|
|
<code>public function select(<code>String selector</code>, <code>Boolean unique</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Selects child nodes based on the passed CSS selector (the selector should not contain an id)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>selector</code> : String<div class="sub-desc">The CSS selector</div></li><li><code>unique</code> : Boolean<div class="sub-desc">true to create a unique YAHOO.ext.Element for each child (defaults to a shared flyweight object)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>CompositeElement/CompositeElementLite</code><div class="sub-desc">The composite element</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="select<static>"></a>
|
|
<div class="mdetail alt">
|
|
<h3>select<static></i></h3>
|
|
<code>public function select<static>(<code>String/Array selector</code>, <span class="optional" title="Optional">[<code>Boolean unique</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
<static> Selects elements based on the passed CSS selector to enable working on them as 1.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>selector</code> : String/Array<div class="sub-desc">The CSS selector or an array of elements</div></li><li><code>unique</code> : Boolean<div class="sub-desc">(optional) true to create a unique YAHOO.ext.Element for each element (defaults to a shared flyweight object)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>CompositeElementLite/CompositeElement</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="set"></a>
|
|
<div class="mdetail">
|
|
<h3>set</i></h3>
|
|
<code>public function set(<code>Object o</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>o</code> : Object<div class="sub-desc">The object with the attributes</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setAbsolutePositioned"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setAbsolutePositioned</i></h3>
|
|
<code>public function setAbsolutePositioned(<span class="optional" title="Optional">[<code>Number zIndex</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the element as absolute positioned with the specified z-index
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>zIndex</code> : Number<div class="sub-desc">(optional)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setBottom"></a>
|
|
<div class="mdetail">
|
|
<h3>setBottom</i></h3>
|
|
<code>public function setBottom(<code>String bottom</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the element's css bottom style
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>bottom</code> : String<div class="sub-desc">The bottom CSS property value</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setBounds"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setBounds</i></h3>
|
|
<code>public function setBounds(<code>Number x</code>, <code>Number y</code>, <code>Number width</code>, <code>Number height</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>x</code> : Number<div class="sub-desc">X value for new position (coordinates are page-based)</div></li><li><code>y</code> : Number<div class="sub-desc">Y value for new position (coordinates are page-based)</div></li><li><code>width</code> : Number<div class="sub-desc">The new width</div></li><li><code>height</code> : Number<div class="sub-desc">The new height</div></li><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Animate the transition (Default is false)</div></li><li><code>duration</code> : float<div class="sub-desc">(optional) How long the animation lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setBox"></a>
|
|
<div class="mdetail">
|
|
<h3>setBox</i></h3>
|
|
<code>public function setBox(<code>Object box</code>, <span class="optional" title="Optional">[<code>Boolean adjust</code>]</span>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x and y will be animated concurrently.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>box</code> : Object<div class="sub-desc">The box to fill {x, y, width, height}</div></li><li><code>adjust</code> : Boolean<div class="sub-desc">(optional) Whether to adjust for box-model issues automatically</div></li><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Animate the transition (Default is false)</div></li><li><code>duration</code> : float<div class="sub-desc">(optional) How long the animation lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setDisplayed"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setDisplayed</i></h3>
|
|
<code>public function setDisplayed(<code>Boolean value</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets the css display. Uses originalDisplay if value is a boolean true.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>value</code> : Boolean<div class="sub-desc">Boolean to display the element using it's default display or a string to set the display directly</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setHeight"></a>
|
|
<div class="mdetail">
|
|
<h3>setHeight</i></h3>
|
|
<code>public function setHeight(<code>Number height</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the height of the element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>height</code> : Number<div class="sub-desc">The new height</div></li><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Animate the transition (Default is false)</div></li><li><code>duration</code> : float<div class="sub-desc">(optional) How long the animation lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeOut if height is larger or YAHOO.util.Easing.easeIn if it is smaller)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setLeft"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setLeft</i></h3>
|
|
<code>public function setLeft(<code>String left</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the element's left position directly using CSS style (instead of setX())
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>left</code> : String<div class="sub-desc">The left CSS property value</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setLeftTop"></a>
|
|
<div class="mdetail">
|
|
<h3>setLeftTop</i></h3>
|
|
<code>public function setLeftTop()</code>
|
|
<div class="mdetail-desc">
|
|
Quick set left and top adding default units
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setLocation"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setLocation</i></h3>
|
|
<code>public function setLocation(<code>Number x</code>, <code>Number y</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the position of the element in page coordinates, regardless of how the element is positioned.
|
|
The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>x</code> : Number<div class="sub-desc">X value for new position (coordinates are page-based)</div></li><li><code>y</code> : Number<div class="sub-desc">Y value for new position (coordinates are page-based)</div></li><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Animate the transition (Default is false)</div></li><li><code>duration</code> : float<div class="sub-desc">(optional) How long the animation lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setOpacity"></a>
|
|
<div class="mdetail">
|
|
<h3>setOpacity</i></h3>
|
|
<code>public function setOpacity(<code>Float opacity</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the opacity of the element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>opacity</code> : Float<div class="sub-desc">The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc</div></li><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Animate (fade) the transition (Default is false)</div></li><li><code>duration</code> : Float<div class="sub-desc">(optional) How long the animation lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeOut if height is larger or YAHOO.util.Easing.easeIn if it is smaller)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setPositioning"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setPositioning</i></h3>
|
|
<code>public function setPositioning(<code>Object posCfg</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Set positioning with an object returned by getPositioning().
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>posCfg</code> : Object<div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setRegion"></a>
|
|
<div class="mdetail">
|
|
<h3>setRegion</i></h3>
|
|
<code>public function setRegion(<code>YAHOO.util.Region region</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets the element's position and size the the specified region. If animation is true then width, height, x and y will be animated concurrently.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>region</code> : YAHOO.util.Region<div class="sub-desc">The region to fill</div></li><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Animate the transition (Default is false)</div></li><li><code>duration</code> : float<div class="sub-desc">(optional) How long the animation lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setRelativePositioned"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setRelativePositioned</i></h3>
|
|
<code>public function setRelativePositioned(<span class="optional" title="Optional">[<code>Number zIndex</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the element as relative positioned with the specified z-index
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>zIndex</code> : Number<div class="sub-desc">(optional)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setRight"></a>
|
|
<div class="mdetail">
|
|
<h3>setRight</i></h3>
|
|
<code>public function setRight(<code>String right</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the element's css right style
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>right</code> : String<div class="sub-desc">The right CSS property value</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setSize"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setSize</i></h3>
|
|
<code>public function setSize(<code>Number width</code>, <code>Number height</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the size of the element. If animation is true, both width an height will be animated concurrently.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>width</code> : Number<div class="sub-desc">The new width</div></li><li><code>height</code> : Number<div class="sub-desc">The new height</div></li><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Animate the transition (Default is false)</div></li><li><code>duration</code> : float<div class="sub-desc">(optional) How long the animation lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setStyle"></a>
|
|
<div class="mdetail">
|
|
<h3>setStyle</i></h3>
|
|
<code>public function setStyle(<code>String/Object property</code>, <span class="optional" title="Optional">[<code>String val</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Wrapper for setting style properties, also takes single object parameter of multiple styles
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>property</code> : String/Object<div class="sub-desc">The style property to be set or an object of multiple styles.</div></li><li><code>val</code> : String<div class="sub-desc">(optional) The value to apply to the given property or null if an object was passed.</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setTop"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setTop</i></h3>
|
|
<code>public function setTop(<code>String top</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the element's top position directly using CSS style (instead of setY())
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>top</code> : String<div class="sub-desc">The top CSS property value</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setVisibilityMode"></a>
|
|
<div class="mdetail">
|
|
<h3>setVisibilityMode</i></h3>
|
|
<code>public function setVisibilityMode(<code>visMode Element.VISIBILITY</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets the elements visibility mode. When setVisible() is called it
|
|
will use this to determine whether to set the visibility or the display property.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>Element.VISIBILITY</code> : visMode<div class="sub-desc">or Element.DISPLAY</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setVisible"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setVisible</i></h3>
|
|
<code>public function setVisible(<code>Boolean visible</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use
|
|
the display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>visible</code> : Boolean<div class="sub-desc">Whether the element is visible</div></li><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Fade the element in or out (Default is false)</div></li><li><code>duration</code> : Float<div class="sub-desc">(optional) How long the fade effect lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeOut for hiding or YAHOO.util.Easing.easeIn for showing)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setWidth"></a>
|
|
<div class="mdetail">
|
|
<h3>setWidth</i></h3>
|
|
<code>public function setWidth(<code>Number width</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the width of the element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>width</code> : Number<div class="sub-desc">The new width</div></li><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Animate the transition (Default is false)</div></li><li><code>duration</code> : float<div class="sub-desc">(optional) How long the animation lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeOut if width is larger or YAHOO.util.Easing.easeIn if it is smaller)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setX"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setX</i></h3>
|
|
<code>public function setX(<code>Number The</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>The</code> : Number<div class="sub-desc">X position of the element</div></li><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Animate the transition (Default is false)</div></li><li><code>duration</code> : float<div class="sub-desc">(optional) How long the animation lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setXY"></a>
|
|
<div class="mdetail">
|
|
<h3>setXY</i></h3>
|
|
<code>public function setXY(<code>Array pos</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Set the position of the element in page coordinates, regardless of how the element is positioned.
|
|
The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>pos</code> : Array<div class="sub-desc">Contains X & Y [x, y] values for new position (coordinates are page-based)</div></li><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Animate the transition (Default is false)</div></li><li><code>duration</code> : float<div class="sub-desc">(optional) How long the animation lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="setY"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setY</i></h3>
|
|
<code>public function setY(<code>Number The</code>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>The</code> : Number<div class="sub-desc">Y position of the element</div></li><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Animate the transition (Default is false)</div></li><li><code>duration</code> : float<div class="sub-desc">(optional) How long the animation lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="show"></a>
|
|
<div class="mdetail">
|
|
<h3>show</i></h3>
|
|
<code>public function show(<span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>Float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Show this element - Uses display mode to determine whether to use "display" or "visibility". See <a href="#setVisible">setVisible</a>.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Animate (fade in) the transition (Default is false)</div></li><li><code>duration</code> : Float<div class="sub-desc">(optional) How long the animation lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="swallowEvent"></a>
|
|
<div class="mdetail alt">
|
|
<h3>swallowEvent</i></h3>
|
|
<code>public function swallowEvent(<code>String eventName</code>, <span class="optional" title="Optional">[<code>Boolean preventDefault</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Stops the specified event from bubbling and optionally prevent's the default action
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>preventDefault</code> : Boolean<div class="sub-desc">(optional) true to prevent the default action too</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="toggle"></a>
|
|
<div class="mdetail">
|
|
<h3>toggle</i></h3>
|
|
<code>public function toggle(<span class="optional" title="Optional">[<code>Boolean animate</code>]</span>, <span class="optional" title="Optional">[<code>float duration</code>]</span>, <span class="optional" title="Optional">[<code>Function onComplete</code>]</span>, <span class="optional" title="Optional">[<code>Function easing</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Toggles the elements visibility or display, depending on visibility mode.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Fade the element in or out (Default is false)</div></li><li><code>duration</code> : float<div class="sub-desc">(optional) How long the fade effect lasts. (Defaults to .35 seconds)</div></li><li><code>onComplete</code> : Function<div class="sub-desc">(optional) Function to call when animation completes.</div></li><li><code>easing</code> : Function<div class="sub-desc">(optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeOut for hiding or YAHOO.util.Easing.easeIn for showing)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="toggleClass"></a>
|
|
<div class="mdetail alt">
|
|
<h3>toggleClass</i></h3>
|
|
<code>public function toggleClass(<code>String className</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Toggles (adds or removes) the passed class.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>className</code> : String<div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="unclip"></a>
|
|
<div class="mdetail">
|
|
<h3>unclip</i></h3>
|
|
<code>public function unclip()</code>
|
|
<div class="mdetail-desc">
|
|
Return clipping (overflow) to original clipping before clip() was called
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="unselectable"></a>
|
|
<div class="mdetail alt">
|
|
<h3>unselectable</i></h3>
|
|
<code>public function unselectable()</code>
|
|
<div class="mdetail-desc">
|
|
Disables text selection for this element (normalized across browsers)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="update"></a>
|
|
<div class="mdetail">
|
|
<h3>update</i></h3>
|
|
<code>public function update(<code>String html</code>, <span class="optional" title="Optional">[<code>Boolean loadScripts</code>]</span>, <code>Function callback</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Update the innerHTML of this element, optionally searching for and processing scripts
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>html</code> : String<div class="sub-desc">The new HTML</div></li><li><code>loadScripts</code> : Boolean<div class="sub-desc">(optional) true to look for and process scripts</div></li><li><code>callback</code> : Function<div class="sub-desc">For async script loading you can be noticed when the update completes</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code><div class="sub-desc">this</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
<a name="wrap"></a>
|
|
<div class="mdetail alt">
|
|
<h3>wrap</i></h3>
|
|
<code>public function wrap(<span class="optional" title="Optional">[<code>Object config</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Creates and wraps this element with another element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>config</code> : Object<div class="sub-desc">(optional) DomHelper element config object for the wrapper element or null for an empty div</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Element</code><div class="sub-desc">The newly created wrapper element</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Element.</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<hr>
|
|
Copyright © 2006 Jack Slocum. All rights reserved.
|
|
</body>
|
|
</html>
|
|
|