oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
webgui/www/extras/yui-ext/docs/YAHOO.ext.Element.html
JT Smith 4f68a0933c added YUI and YUI-ext 
fixed the resizable text area with IE problem
fixed the ad space with IE problem
merged the 7.2.0 and 7.1.4 change logs
2006-11-07 23:15:57 +00:00

3670 lines
94 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<TITLE>
YAHOO.ext.Element
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="YAHOO.ext.Element";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();" style="margin:15px;">
<!-- ======== START OF CLASS DATA ======== -->
<H2>Class YAHOO.ext.Element</H2>
<PRE>Object
|
+--<b>YAHOO.ext.Element</b>
</PRE>
<DL>
<DT>
<B>Direct Known Subclasses:</B>
<DD>
<a href="YAHOO.ext.Actor.html">YAHOO.ext.Actor</a>, <a href="YAHOO.ext.Animator.html">YAHOO.ext.Animator</a>
</DD>
</DL>
<HR>
<DL>
<!-- Class definition -->
<DT>class
<B>YAHOO.ext.Element</B>
</DL>
<P>
<BR/>Wraps around a DOM element and provides convenient access to Yahoo
UI library functionality.<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/><I>Defined in <a href='overview-summary-Element.js.html'>Element.js</a></I><BR/><BR/><B>Requires:</B><UL>- YAHOO.util.Dom<BR/>- YAHOO.util.Event<BR/>- <a href="YAHOO.util.CustomEvent.html#">YAHOO.util.CustomEvent</a><BR/>- YAHOO.util.Anim (optional) to support animation<BR/>- YAHOO.util.Motion (optional) to support animation<BR/>- YAHOO.util.Easing (optional) to support animation</UL>
</P>
<HR>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- ======== END NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="2" class="title-cell">Field Summary</TD></TR>
<!-- This is one instance field summary -->
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="#autoBoxAdjust">autoBoxAdjust</A></B></CODE>
<BR>
&nbsp;&nbsp;Whether to automatically adjust width and height settings for box-model issues</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;String</CODE></FONT></TD>
<TD><CODE><B><A HREF="#defaultUnit">defaultUnit</A></B></CODE>
<BR>
&nbsp;&nbsp;The default unit to append to CSS values where a unit isn't provided (Defaults to px).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;String</CODE></FONT></TD>
<TD><CODE><B><A HREF="#id">id</A></B></CODE>
<BR>
&nbsp;&nbsp;The DOM element ID</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;CustomEvent</CODE></FONT></TD>
<TD><CODE><B><A HREF="#onMoved">onMoved</A></B></CODE>
<BR>
&nbsp;&nbsp;Fires when element moves.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;CustomEvent</CODE></FONT></TD>
<TD><CODE><B><A HREF="#onResized">onResized</A></B></CODE>
<BR>
&nbsp;&nbsp;Fires when element is resized.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;CustomEvent</CODE></FONT></TD>
<TD><CODE><B><A HREF="#onVisibilityChanged">onVisibilityChanged</A></B></CODE>
<BR>
&nbsp;&nbsp;Fires when visibility changes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&lt;static&gt; &nbsp;Number</CODE></FONT></TD>
<TD><CODE><B><A HREF="#!s!DISPLAY">DISPLAY</A></B></CODE>
<BR>
&nbsp;&nbsp;Visibility mode constant - Use display to hide element</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&lt;static&gt; &nbsp;Number</CODE></FONT></TD>
<TD><CODE><B><A HREF="#!s!VISIBILITY">VISIBILITY</A></B></CODE>
<BR>
&nbsp;&nbsp;Visibility mode constant - Use visibility to hide element</TD>
</TR>
</TABLE>
&nbsp;
<!-- =========== END FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="2" class="title-cell">
Constructor Summary
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD>
<CODE>
<B>
<A HREF="YAHOO.ext.Element.html#YAHOO.ext.Element()">YAHOO.ext.Element</A>
</B>
(&lt;String&gt; elementId, &lt;<i>Boolean</i>&gt; forceNew)
</CODE>
<BR>
&nbsp;&nbsp;
</TD>
</TR>
</TABLE>
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="2" class="title-cell">
<span style="float:left">Method Summary</span>
<span style="float:right;font-weight:normal;font-size:8pt;">
<i>* Parameter types in italic indicate optional parameters</i>
</span>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#addClass">addClass</A></B>(&lt;String&gt; className)
</CODE>
<BR>
&nbsp;&nbsp;
Add a CSS class to the element.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#addHandler">addHandler</A></B>(&lt;String&gt; eventName, &lt;Boolean&gt; stopPropagation, &lt;<a href="Function.html">Function</a>&gt; handler, &lt;<i>Object</i>&gt; scope, &lt;<i>boolean</i>&gt; override)
</CODE>
<BR>
&nbsp;&nbsp;
Appends an event handler to this element and automatically prevents the default action, and if set stops propagation (bubbling) as well
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#addListener">addListener</A></B>(&lt;String&gt; eventName, &lt;<a href="Function.html">Function</a>&gt; handler, &lt;<i>Object</i>&gt; scope, &lt;<i>boolean</i>&gt; override)
</CODE>
<BR>
&nbsp;&nbsp;
Appends an event handler to this element
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Object</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#addManagedListener">addManagedListener</A></B>(&lt;String&gt; eventName, &lt;<a href="Function.html">Function</a>&gt; fn, &lt;<i>Object</i>&gt; scope, &lt;<i>boolean</i>&gt; override)
</CODE>
<BR>
&nbsp;&nbsp;
Append a managed listener - See <a href="YAHOO.ext.EventObject.html#">YAHOO.ext.EventObject</a> for more details.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#alignTo">alignTo</A></B>(&lt;String/HTMLElement/YAHOO.ext.Element&gt; element, &lt;String&gt; position, &lt;<i>Array</i>&gt; offsets, &lt;<i>Boolean</i>&gt; animate, &lt;<i>Float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)
</CODE>
<BR>
&nbsp;&nbsp;
Align this element with another element.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#animate">animate</A></B>(&lt;Object&gt; args, &lt;<i>Float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing, &lt;<i>Function</i>&gt; animType)
</CODE>
<BR>
&nbsp;&nbsp;
Perform Yahoo UI animation on this element.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#beginMeasure">beginMeasure</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#clearOpacity">clearOpacity</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Clears any opacity settings from this element.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#clearPositioning">clearPositioning</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Clear positioning back to the default when the document was loaded
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#clip">clip</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Clip overflow on the element - use <a href="#unclip">unclip()</a> to remove
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#enableDisplayMode">enableDisplayMode</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Convenience method for setVisibilityMode(Element.DISPLAY)
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#endMeasure">endMeasure</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#focus">focus</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Tries to focus the element.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Number</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getBorderWidth">getBorderWidth</A></B>(&lt;String&gt; side)
</CODE>
<BR>
&nbsp;&nbsp;
Gets the width of the border(s) for the specified side(s)
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;String</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getBottom">getBottom</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Gets the bottom Y coordinate of the element (element Y position + element height)
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getBox">getBox</A></B>(contentBox)
</CODE>
<BR>
&nbsp;&nbsp;
Return a box {x, y, width, height} that can be used to set another elements
size to match this element.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Array</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getCenterXY">getCenterXY</A></B>(offsetScroll)
</CODE>
<BR>
&nbsp;&nbsp;
Calculates the x, y to center this element on the screen
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Array</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getChildrenByClassName">getChildrenByClassName</A></B>(&lt;String&gt; className, &lt;<i>String</i>&gt; tagName)
</CODE>
<BR>
&nbsp;&nbsp;
Gets an array of child YAHOO.ext.Element objects by class name and optional tagName
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Array</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getChildrenByTagName">getChildrenByTagName</A></B>(&lt;String&gt; tagName)
</CODE>
<BR>
&nbsp;&nbsp;
Gets an array of child YAHOO.ext.Element objects by tag name
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Number</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getHeight">getHeight</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Returns the offset height of the element
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Object</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getLeft">getLeft</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Same as getX()
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Number</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getPadding">getPadding</A></B>(&lt;String&gt; side)
</CODE>
<BR>
&nbsp;&nbsp;
Gets the width of the padding(s) for the specified side(s)
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getPositioning">getPositioning</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Gets an object with all CSS positioning properties.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Region</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getRegion">getRegion</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Returns the region position of the given element.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;String</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getRight">getRight</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Gets the right X coordinate of the element (element X position + element width)
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;<a href="An object containing the element's size {width: (element width), height: (element height)">Object}</a></CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getSize">getSize</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Returns the size of the element
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;String</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getStyle">getStyle</A></B>(name)
</CODE>
<BR>
&nbsp;&nbsp;
Normalizes currentStyle and ComputedStyle.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Object</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getTop">getTop</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Same as getY()
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;<a href="YAHOO.ext.UpdateManager.html">YAHOO.ext.UpdateManager</a></CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getUpdateManager">getUpdateManager</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Gets this elements UpdateManager
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Number</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getWidth">getWidth</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Returns the offset width of the element
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Object</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getX">getX</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Gets the current X position of the element based on page coordinates.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Object</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getXY">getXY</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Gets the current position of the element based on page coordinates.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Object</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getY">getY</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Gets the current Y position of the element based on page coordinates.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Boolean</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#hasClass">hasClass</A></B>(&lt;String&gt; className)
</CODE>
<BR>
&nbsp;&nbsp;
Checks if a CSS class is in use by the element.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#hide">hide</A></B>(&lt;<i>Boolean</i>&gt; animate, &lt;<i>Float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)
</CODE>
<BR>
&nbsp;&nbsp;
Hide this element - Uses display mode to determine whether to use "display" or "visibility".
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#isBorderBox">isBorderBox</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Tests various css rules/browsers to determine if this element uses a border box
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Boolean</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#isVisible">isVisible</A></B>(&lt;<i>Boolean</i>&gt; deep)
</CODE>
<BR>
&nbsp;&nbsp;
Checks whether the element is currently visible using both visibility and display properties.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Object</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#mon">mon</A></B>(&lt;String&gt; eventName, &lt;<a href="Function.html">Function</a>&gt; fn, &lt;<i>Object</i>&gt; scope, &lt;<i>boolean</i>&gt; override)
</CODE>
<BR>
&nbsp;&nbsp;
Append a managed listener (shorthanded for <a href="#addManagedListener">addManagedListener()</a>)
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#move">move</A></B>(&lt;String&gt; direction, &lt;Number&gt; distance, &lt;<i>Boolean</i>&gt; animate, &lt;<i>Float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)
</CODE>
<BR>
&nbsp;&nbsp;
Move this element relative to it's current position.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#moveTo">moveTo</A></B>(&lt;Number&gt; x, &lt;Number&gt; y, &lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)
</CODE>
<BR>
&nbsp;&nbsp;
Set the position of the element in page coordinates, regardless of how the element is positioned.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#on">on</A></B>(&lt;String&gt; eventName, &lt;<a href="Function.html">Function</a>&gt; handler, &lt;<i>Object</i>&gt; scope, &lt;<i>boolean</i>&gt; override)
</CODE>
<BR>
&nbsp;&nbsp;
Appends an event handler to this element (Same as addListener)
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#radioClass">radioClass</A></B>(className)
</CODE>
<BR>
&nbsp;&nbsp;
Adds the passed className to this element and removes the class from all siblings
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#removeAllListeners">removeAllListeners</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Removes all previous added listeners from this element
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#removeClass">removeClass</A></B>(&lt;String&gt; className)
</CODE>
<BR>
&nbsp;&nbsp;
Removes a CSS class from the element.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#removeListener">removeListener</A></B>(eventName, handler)
</CODE>
<BR>
&nbsp;&nbsp;
Removes an event handler from this element
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#replaceClass">replaceClass</A></B>(&lt;String&gt; oldClassName, &lt;String&gt; newClassName)
</CODE>
<BR>
&nbsp;&nbsp;
Replaces a CSS class on the element with another.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setAbsolutePositioned">setAbsolutePositioned</A></B>(&lt;<i>Number</i>&gt; zIndex)
</CODE>
<BR>
&nbsp;&nbsp;
Set the element as absolute positioned with the specified z-index
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setBottom">setBottom</A></B>(bottom)
</CODE>
<BR>
&nbsp;&nbsp;
Set the element's css bottom style
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setBounds">setBounds</A></B>(&lt;Number&gt; x, &lt;Number&gt; y, &lt;Number&gt; width, &lt;Number&gt; height, &lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)
</CODE>
<BR>
&nbsp;&nbsp;
Sets the element's position and size in one shot.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setBox">setBox</A></B>(&lt;Object&gt; box, &lt;<i>Boolean</i>&gt; adjust, &lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)
</CODE>
<BR>
&nbsp;&nbsp;
Sets the element's box.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setHeight">setHeight</A></B>(&lt;Number&gt; height, &lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)
</CODE>
<BR>
&nbsp;&nbsp;
Set the height of the element
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setLeft">setLeft</A></B>(&lt;String&gt; left)
</CODE>
<BR>
&nbsp;&nbsp;
Set the element's X position directly using CSS style (instead of setX())
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setLocation">setLocation</A></B>(&lt;Number&gt; x, &lt;Number&gt; y, &lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)
</CODE>
<BR>
&nbsp;&nbsp;
Set the position of the element in page coordinates, regardless of how the element is positioned.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setOpacity">setOpacity</A></B>(&lt;Float&gt; opacity, &lt;<i>Boolean</i>&gt; animate, &lt;<i>Float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)
</CODE>
<BR>
&nbsp;&nbsp;
Set the opacity of the element
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setPositioning">setPositioning</A></B>(positionCfg)
</CODE>
<BR>
&nbsp;&nbsp;
Set positioning with an object returned by <a href="#getPositioning">getPositioning()</a>.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setRegion">setRegion</A></B>(&lt;YAHOO.util.Region&gt; region, &lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)
</CODE>
<BR>
&nbsp;&nbsp;
Sets the element's position and size the the specified region.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setRelativePositioned">setRelativePositioned</A></B>(&lt;<i>Number</i>&gt; zIndex)
</CODE>
<BR>
&nbsp;&nbsp;
Set the element as relative positioned with the specified z-index
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setRight">setRight</A></B>(right)
</CODE>
<BR>
&nbsp;&nbsp;
Set the element's css right style
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setSize">setSize</A></B>(&lt;Number&gt; width, &lt;Number&gt; height, &lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)
</CODE>
<BR>
&nbsp;&nbsp;
Set the size of the element.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setStyle">setStyle</A></B>(name, value)
</CODE>
<BR>
&nbsp;&nbsp;
Wrapper for setting style properties
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setTop">setTop</A></B>(&lt;String&gt; top)
</CODE>
<BR>
&nbsp;&nbsp;
Set the element's Y position directly using CSS style (instead of setY())
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setVisibilityMode">setVisibilityMode</A></B>(visMode)
</CODE>
<BR>
&nbsp;&nbsp;
Sets the elements visibility mode.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setVisible">setVisible</A></B>(&lt;Boolean&gt; visible, &lt;<i>Boolean</i>&gt; animate, &lt;<i>Float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)
</CODE>
<BR>
&nbsp;&nbsp;
Sets the visibility of the element (see details).
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setWidth">setWidth</A></B>(&lt;Number&gt; width, &lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)
</CODE>
<BR>
&nbsp;&nbsp;
Set the width of the element
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setX">setX</A></B>(x)
</CODE>
<BR>
&nbsp;&nbsp;
Sets the X position of the element based on page coordinates.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setXY">setXY</A></B>(&lt;Array&gt; pos, &lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)
</CODE>
<BR>
&nbsp;&nbsp;
Set the position of the element in page coordinates, regardless of how the element is positioned.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setY">setY</A></B>(y)
</CODE>
<BR>
&nbsp;&nbsp;
Sets the Y position of the element based on page coordinates.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#show">show</A></B>(&lt;<i>Boolean</i>&gt; animate, &lt;<i>Float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)
</CODE>
<BR>
&nbsp;&nbsp;
Show this element - Uses display mode to determine whether to use "display" or "visibility".
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#toggle">toggle</A></B>(&lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)
</CODE>
<BR>
&nbsp;&nbsp;
Toggles the elements visibility or display, depending on visibility mode.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#toggleClass">toggleClass</A></B>(className)
</CODE>
<BR>
&nbsp;&nbsp;
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#unclip">unclip</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Return clipping (overflow) to original clipping when the document loaded
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#update">update</A></B>(&lt;String&gt; html, &lt;<i>Boolean</i>&gt; loadScripts)
</CODE>
<BR>
&nbsp;&nbsp;
Update the innerHTML of this element, optionally searching for and processing scripts
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&lt;static&gt;&nbsp;Element</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#!s!get">get</A></B>(&lt;String/HTMLElement/Element&gt; el, &lt;<i>Boolean</i>&gt; autoGenerateId)
</CODE>
<BR>
&nbsp;&nbsp;
Static method to retreive Element objects.
</TD>
</TR>
</TABLE>
<P>
<!-- ========== END METHOD SUMMARY =========== -->
<!-- ============ FIELD DETAIL START =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="1" class="title-cell">Field Detail</TD>
</TR>
</TABLE>
<A NAME="autoBoxAdjust"><!-- --></A>
<H3>autoBoxAdjust</H3>
<PRE>Object&nbsp;<B>autoBoxAdjust</B></PRE>
<UL>
Whether to automatically adjust width and height settings for box-model issues
</UL>
<HR>
<A NAME="defaultUnit"><!-- --></A>
<H3>defaultUnit</H3>
<PRE>String&nbsp;<B>defaultUnit</B></PRE>
<UL>
The default unit to append to CSS values where a unit isn't provided (Defaults to px).
</UL>
<HR>
<A NAME="id"><!-- --></A>
<H3>id</H3>
<PRE>String&nbsp;<B>id</B></PRE>
<UL>
The DOM element ID
</UL>
<HR>
<A NAME="onMoved"><!-- --></A>
<H3>onMoved</H3>
<PRE>CustomEvent&nbsp;<B>onMoved</B></PRE>
<UL>
Fires when element moves. Uses fireDirect with signature: (oElement, newX, newY)
</UL>
<HR>
<A NAME="onResized"><!-- --></A>
<H3>onResized</H3>
<PRE>CustomEvent&nbsp;<B>onResized</B></PRE>
<UL>
Fires when element is resized. Uses fireDirect with signature: (oElement, newWidth, newHeight)
</UL>
<HR>
<A NAME="onVisibilityChanged"><!-- --></A>
<H3>onVisibilityChanged</H3>
<PRE>CustomEvent&nbsp;<B>onVisibilityChanged</B></PRE>
<UL>
Fires when visibility changes. Uses fireDirect with signature: (oElement, boolean isVisible)
</UL>
<HR>
<A NAME="!s!DISPLAY"><!-- --></A>
<H3>DISPLAY</H3>
<PRE>&lt;static&gt;&nbsp;Number&nbsp;<B>DISPLAY</B></PRE>
<UL>
Visibility mode constant - Use display to hide element
</UL>
<HR>
<A NAME="!s!VISIBILITY"><!-- --></A>
<H3>VISIBILITY</H3>
<PRE>&lt;static&gt;&nbsp;Number&nbsp;<B>VISIBILITY</B></PRE>
<UL>
Visibility mode constant - Use visibility to hide element
</UL>
<HR>
<!-- ============ FIELD DETAIL END =========== -->
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="1" class="title-cell">
Constructor Detail
</TD>
</TR>
</TABLE>
<A NAME="YAHOO.ext.Element()"><!-- --></A><H3>
YAHOO.ext.Element</H3>
<PRE><B>YAHOO.ext.Element</B>(&lt;String&gt; elementId, &lt;<i>Boolean</i>&gt; forceNew)</PRE>
<UL>
<B>Parameters:</B>
<UL><CODE>elementId</CODE> -
</UL>
<UL><CODE>forceNew</CODE> - (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).
</UL>
</UL>
<!-- Constructor return value(s) -->
<!-- End constructor return value(s) -->
<!-- ADDITIONAL ATTRIBUTES -->
<UL>
<B>Requires:</B><UL>- YAHOO.util.Dom<BR/>- YAHOO.util.Event<BR/>- <a href="YAHOO.util.CustomEvent.html#">YAHOO.util.CustomEvent</a><BR/>- YAHOO.util.Anim (optional) to support animation<BR/>- YAHOO.util.Motion (optional) to support animation<BR/>- YAHOO.util.Easing (optional) to support animation</UL>
</UL>
<HR/>
<!-- END ADDITIONAL ATTRIBUTES -->
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
<!-- ============ METHOD DETAIL START ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="1" class="title-cell">
Method Detail
</TD>
</TR>
</TABLE>
<!-- One single method detail entry -->
<A NAME="addClass"><!-- --></A>
<H3>addClass</H3>
<PRE>void <B>addClass</B>(&lt;String&gt; className)</PRE>
<UL>Add a CSS class to the element.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>className</CODE> - The CSS class to add
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="addHandler"><!-- --></A>
<H3>addHandler</H3>
<PRE>void <B>addHandler</B>(&lt;String&gt; eventName, &lt;Boolean&gt; stopPropagation, &lt;<a href="Function.html">Function</a>&gt; handler, &lt;<i>Object</i>&gt; scope, &lt;<i>boolean</i>&gt; override)</PRE>
<UL>Appends an event handler to this element and automatically prevents the default action, and if set stops propagation (bubbling) as well</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>eventName</CODE> - The type of event to listen for
</UL>
<UL><CODE>stopPropagation</CODE> - Whether to also stopPropagation (bubbling)
</UL>
<UL><CODE>handler</CODE> - The method the event invokes
</UL>
<UL><CODE>scope</CODE> - (optional) An arbitrary object that will be passed as a parameter to the handler
</UL>
<UL><CODE>override</CODE> - (optional) If true, the obj passed in becomes the execution scope of the listener
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="addListener"><!-- --></A>
<H3>addListener</H3>
<PRE>void <B>addListener</B>(&lt;String&gt; eventName, &lt;<a href="Function.html">Function</a>&gt; handler, &lt;<i>Object</i>&gt; scope, &lt;<i>boolean</i>&gt; override)</PRE>
<UL>Appends an event handler to this element</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>eventName</CODE> - The type of event to listen for
</UL>
<UL><CODE>handler</CODE> - The method the event invokes
</UL>
<UL><CODE>scope</CODE> - (optional) An arbitrary object that will be passed as a parameter to the handler
</UL>
<UL><CODE>override</CODE> - (optional) If true, the obj passed in becomes the execution scope of the listener
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="addManagedListener"><!-- --></A>
<H3>addManagedListener</H3>
<PRE>Object <B>addManagedListener</B>(&lt;String&gt; eventName, &lt;<a href="Function.html">Function</a>&gt; fn, &lt;<i>Object</i>&gt; scope, &lt;<i>boolean</i>&gt; override)</PRE>
<UL>Append a managed listener - See <a href="YAHOO.ext.EventObject.html#">YAHOO.ext.EventObject</a> for more details.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>eventName</CODE> - The type of event to listen for
</UL>
<UL><CODE>fn</CODE> - The method the event invokes
</UL>
<UL><CODE>scope</CODE> - (optional) An arbitrary object that will be passed as a parameter to the handler
</UL>
<UL><CODE>override</CODE> - (optional) If true, the obj passed in becomes the execution scope of the listener
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="alignTo"><!-- --></A>
<H3>alignTo</H3>
<PRE>void <B>alignTo</B>(&lt;String/HTMLElement/YAHOO.ext.Element&gt; element, &lt;String&gt; position, &lt;<i>Array</i>&gt; offsets, &lt;<i>Boolean</i>&gt; animate, &lt;<i>Float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)</PRE>
<UL>Align this element with another element.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>element</CODE> - The element to align to.
</UL>
<UL><CODE>position</CODE> - The position to align to. Possible values are 'tl' - top left, 'tr' - top right, 'bl' - bottom left, and 'br' - bottom right.
</UL>
<UL><CODE>offsets</CODE> - (optional) Offset the positioning by [x, y]
</UL>
<UL><CODE>animate</CODE> - (optional) Animate the movement (Default is false)
</UL>
<UL><CODE>duration</CODE> - (optional) How long the animation lasts. (Defaults to .35 seconds)
</UL>
<UL><CODE>onComplete</CODE> - (optional) Function to call when animation completes.
</UL>
<UL><CODE>easing</CODE> - (optional) YAHOO.util.Easing method to use.
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="animate"><!-- --></A>
<H3>animate</H3>
<PRE>void <B>animate</B>(&lt;Object&gt; args, &lt;<i>Float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing, &lt;<i>Function</i>&gt; animType)</PRE>
<UL>Perform Yahoo UI animation on this element.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>args</CODE> - The YUI animation control args
</UL>
<UL><CODE>duration</CODE> - (optional) How long the animation lasts. (Defaults to .35 seconds)
</UL>
<UL><CODE>onComplete</CODE> - (optional) Function to call when animation completes.
</UL>
<UL><CODE>easing</CODE> - (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)
</UL>
<UL><CODE>animType</CODE> - (optional) YAHOO.util.Anim subclass to use. For YAHOO.ext.Element.prototype.example = YAHOO;.util.Motion
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="beginMeasure"><!-- --></A>
<H3>beginMeasure</H3>
<PRE>void <B>beginMeasure</B>()</PRE>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="clearOpacity"><!-- --></A>
<H3>clearOpacity</H3>
<PRE>void <B>clearOpacity</B>()</PRE>
<UL>Clears any opacity settings from this element. Required in some cases for IE.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="clearPositioning"><!-- --></A>
<H3>clearPositioning</H3>
<PRE>void <B>clearPositioning</B>()</PRE>
<UL>Clear positioning back to the default when the document was loaded</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="clip"><!-- --></A>
<H3>clip</H3>
<PRE>void <B>clip</B>()</PRE>
<UL>Clip overflow on the element - use <a href="#unclip">unclip()</a> to remove</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="enableDisplayMode"><!-- --></A>
<H3>enableDisplayMode</H3>
<PRE>void <B>enableDisplayMode</B>()</PRE>
<UL>Convenience method for setVisibilityMode(Element.DISPLAY)</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="endMeasure"><!-- --></A>
<H3>endMeasure</H3>
<PRE>void <B>endMeasure</B>()</PRE>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="focus"><!-- --></A>
<H3>focus</H3>
<PRE>void <B>focus</B>()</PRE>
<UL>Tries to focus the element. Any exceptions are caught.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getBorderWidth"><!-- --></A>
<H3>getBorderWidth</H3>
<PRE>Number <B>getBorderWidth</B>(&lt;String&gt; side)</PRE>
<UL>Gets the width of the border(s) for the specified side(s)</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>side</CODE> - 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.
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
The width of the sides passed added together
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getBottom"><!-- --></A>
<H3>getBottom</H3>
<PRE>String <B>getBottom</B>()</PRE>
<UL>Gets the bottom Y coordinate of the element (element Y position + element height)</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
The bottom position of the element
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getBox"><!-- --></A>
<H3>getBox</H3>
<PRE>void <B>getBox</B>(contentBox)</PRE>
<UL>Return a box {x, y, width, height} that can be used to set another elements
size to match this element. If contentBox is true, a box for the content
of the element is returned.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getCenterXY"><!-- --></A>
<H3>getCenterXY</H3>
<PRE>Array <B>getCenterXY</B>(offsetScroll)</PRE>
<UL>Calculates the x, y to center this element on the screen</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
The x, y values [x, y]
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getChildrenByClassName"><!-- --></A>
<H3>getChildrenByClassName</H3>
<PRE>Array <B>getChildrenByClassName</B>(&lt;String&gt; className, &lt;<i>String</i>&gt; tagName)</PRE>
<UL>Gets an array of child YAHOO.ext.Element objects by class name and optional tagName</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>className</CODE> -
</UL>
<UL><CODE>tagName</CODE> - (optional)
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
The children
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getChildrenByTagName"><!-- --></A>
<H3>getChildrenByTagName</H3>
<PRE>Array <B>getChildrenByTagName</B>(&lt;String&gt; tagName)</PRE>
<UL>Gets an array of child YAHOO.ext.Element objects by tag name</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>tagName</CODE> -
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
The children
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getHeight"><!-- --></A>
<H3>getHeight</H3>
<PRE>Number <B>getHeight</B>()</PRE>
<UL>Returns the offset height of the element</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
The element's height
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getLeft"><!-- --></A>
<H3>getLeft</H3>
<PRE>Object <B>getLeft</B>()</PRE>
<UL>Same as getX()</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getPadding"><!-- --></A>
<H3>getPadding</H3>
<PRE>Number <B>getPadding</B>(&lt;String&gt; side)</PRE>
<UL>Gets the width of the padding(s) for the specified side(s)</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>side</CODE> - 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.
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
The padding of the sides passed added together
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getPositioning"><!-- --></A>
<H3>getPositioning</H3>
<PRE>void <B>getPositioning</B>()</PRE>
<UL>Gets an object with all CSS positioning properties. Useful along with <a href="#setPositioning">setPositioning()</a> to get snapshot before performing an update and then restoring the element.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getRegion"><!-- --></A>
<H3>getRegion</H3>
<PRE>Region <B>getRegion</B>()</PRE>
<UL>Returns the region position of the given element.
The element must be part of the DOM tree to have a region (YAHOO.ext.Element.prototype.display = none;or elements not appended return false).</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
A YAHOO.util.Region containing "top, left, bottom, right" member data.
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getRight"><!-- --></A>
<H3>getRight</H3>
<PRE>String <B>getRight</B>()</PRE>
<UL>Gets the right X coordinate of the element (element X position + element width)</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
The left position of the element
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getSize"><!-- --></A>
<H3>getSize</H3>
<PRE><a href="An object containing the element's size {width: (element width), height: (element height)">Object}</a> <B>getSize</B>()</PRE>
<UL>Returns the size of the element</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getStyle"><!-- --></A>
<H3>getStyle</H3>
<PRE>String <B>getStyle</B>(name)</PRE>
<UL>Normalizes currentStyle and ComputedStyle.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>property</CODE> - The style property whose value is returned.
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
The current value of the style property for this element.
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getTop"><!-- --></A>
<H3>getTop</H3>
<PRE>Object <B>getTop</B>()</PRE>
<UL>Same as getY()</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getUpdateManager"><!-- --></A>
<H3>getUpdateManager</H3>
<PRE><a href="YAHOO.ext.UpdateManager.html">YAHOO.ext.UpdateManager</a> <B>getUpdateManager</B>()</PRE>
<UL>Gets this elements UpdateManager</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
The UpdateManager
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getWidth"><!-- --></A>
<H3>getWidth</H3>
<PRE>Number <B>getWidth</B>()</PRE>
<UL>Returns the offset width of the element</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
The element's width
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getX"><!-- --></A>
<H3>getX</H3>
<PRE>Object <B>getX</B>()</PRE>
<UL>Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (YAHOO.ext.Element.prototype.display = none;or elements not appended return false).</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getXY"><!-- --></A>
<H3>getXY</H3>
<PRE>Object <B>getXY</B>()</PRE>
<UL>Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (YAHOO.ext.Element.prototype.display = none;or elements not appended return false).</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getY"><!-- --></A>
<H3>getY</H3>
<PRE>Object <B>getY</B>()</PRE>
<UL>Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (YAHOO.ext.Element.prototype.display = none;or elements not appended return false).</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="hasClass"><!-- --></A>
<H3>hasClass</H3>
<PRE>Boolean <B>hasClass</B>(&lt;String&gt; className)</PRE>
<UL>Checks if a CSS class is in use by the element.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>className</CODE> - The CSS class to check
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
true or false
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="hide"><!-- --></A>
<H3>hide</H3>
<PRE>void <B>hide</B>(&lt;<i>Boolean</i>&gt; animate, &lt;<i>Float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)</PRE>
<UL>Hide this element - Uses display mode to determine whether to use "display" or "visibility". See <a href="#setVisible">setVisible()</a>.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>animate</CODE> - (optional) Animate (fade) the transition (Default is false)
</UL>
<UL><CODE>duration</CODE> - (optional) How long the animation lasts. (Defaults to .35 seconds)
</UL>
<UL><CODE>onComplete</CODE> - (optional) Function to call when animation completes.
</UL>
<UL><CODE>easing</CODE> - (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="isBorderBox"><!-- --></A>
<H3>isBorderBox</H3>
<PRE>void <B>isBorderBox</B>()</PRE>
<UL>Tests various css rules/browsers to determine if this element uses a border box</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="isVisible"><!-- --></A>
<H3>isVisible</H3>
<PRE>Boolean <B>isVisible</B>(&lt;<i>Boolean</i>&gt; deep)</PRE>
<UL>Checks whether the element is currently visible using both visibility and display properties.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>deep</CODE> - True to walk the dom and see if parent elements are hidden
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
Whether the element is currently visible
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="mon"><!-- --></A>
<H3>mon</H3>
<PRE>Object <B>mon</B>(&lt;String&gt; eventName, &lt;<a href="Function.html">Function</a>&gt; fn, &lt;<i>Object</i>&gt; scope, &lt;<i>boolean</i>&gt; override)</PRE>
<UL>Append a managed listener (shorthanded for <a href="#addManagedListener">addManagedListener()</a>)</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>eventName</CODE> - The type of event to listen for
</UL>
<UL><CODE>fn</CODE> - The method the event invokes
</UL>
<UL><CODE>scope</CODE> - (optional) An arbitrary object that will be passed as a parameter to the handler
</UL>
<UL><CODE>override</CODE> - (optional) If true, the obj passed in becomes the execution scope of the listener
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="move"><!-- --></A>
<H3>move</H3>
<PRE>void <B>move</B>(&lt;String&gt; direction, &lt;Number&gt; distance, &lt;<i>Boolean</i>&gt; animate, &lt;<i>Float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)</PRE>
<UL>Move this element relative to it's current position.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>direction</CODE> - Possible values YAHOO.ext.Element.prototype.are = 'left'; 'right', 'up', 'down'.
</UL>
<UL><CODE>distance</CODE> - How far to move the element in pixels
</UL>
<UL><CODE>animate</CODE> - (optional) Animate the movement (Default is false)
</UL>
<UL><CODE>duration</CODE> - (optional) How long the animation lasts. (Defaults to .35 seconds)
</UL>
<UL><CODE>onComplete</CODE> - (optional) Function to call when animation completes.
</UL>
<UL><CODE>easing</CODE> - (optional) YAHOO.util.Easing method to use.
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="moveTo"><!-- --></A>
<H3>moveTo</H3>
<PRE>void <B>moveTo</B>(&lt;Number&gt; x, &lt;Number&gt; y, &lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)</PRE>
<UL>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 (YAHOO.ext.Element.prototype.display = none;or elements not appended return false).</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>x</CODE> - X value for new position (coordinates are page-based)
</UL>
<UL><CODE>y</CODE> - Y value for new position (coordinates are page-based)
</UL>
<UL><CODE>animate</CODE> - (optional) Animate the transition (Default is false)
</UL>
<UL><CODE>duration</CODE> - (optional) How long the animation lasts. (Defaults to .35 seconds)
</UL>
<UL><CODE>onComplete</CODE> - (optional) Function to call when animation completes.
</UL>
<UL><CODE>easing</CODE> - (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="on"><!-- --></A>
<H3>on</H3>
<PRE>void <B>on</B>(&lt;String&gt; eventName, &lt;<a href="Function.html">Function</a>&gt; handler, &lt;<i>Object</i>&gt; scope, &lt;<i>boolean</i>&gt; override)</PRE>
<UL>Appends an event handler to this element (Same as addListener)</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>eventName</CODE> - The type of event to listen for
</UL>
<UL><CODE>handler</CODE> - The method the event invokes
</UL>
<UL><CODE>scope</CODE> - (optional) An arbitrary object that will be passed as a parameter to the handler
</UL>
<UL><CODE>override</CODE> - (optional) If true, the obj passed in becomes the execution scope of the listener
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="radioClass"><!-- --></A>
<H3>radioClass</H3>
<PRE>void <B>radioClass</B>(className)</PRE>
<UL>Adds the passed className to this element and removes the class from all siblings</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="removeAllListeners"><!-- --></A>
<H3>removeAllListeners</H3>
<PRE>void <B>removeAllListeners</B>()</PRE>
<UL>Removes all previous added listeners from this element</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="removeClass"><!-- --></A>
<H3>removeClass</H3>
<PRE>void <B>removeClass</B>(&lt;String&gt; className)</PRE>
<UL>Removes a CSS class from the element.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>className</CODE> - The CSS class to remove
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="removeListener"><!-- --></A>
<H3>removeListener</H3>
<PRE>void <B>removeListener</B>(eventName, handler)</PRE>
<UL>Removes an event handler from this element</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>sType</CODE> - the type of event to remove
</UL>
<UL><CODE>fn</CODE> - the method the event invokes
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="replaceClass"><!-- --></A>
<H3>replaceClass</H3>
<PRE>void <B>replaceClass</B>(&lt;String&gt; oldClassName, &lt;String&gt; newClassName)</PRE>
<UL>Replaces a CSS class on the element with another.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>oldClassName</CODE> - The CSS class to replace
</UL>
<UL><CODE>newClassName</CODE> - The replacement CSS class
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setAbsolutePositioned"><!-- --></A>
<H3>setAbsolutePositioned</H3>
<PRE>void <B>setAbsolutePositioned</B>(&lt;<i>Number</i>&gt; zIndex)</PRE>
<UL>Set the element as absolute positioned with the specified z-index</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>zIndex</CODE> - (optional)
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setBottom"><!-- --></A>
<H3>setBottom</H3>
<PRE>void <B>setBottom</B>(bottom)</PRE>
<UL>Set the element's css bottom style</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>top</CODE> - The bottom CSS property value
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setBounds"><!-- --></A>
<H3>setBounds</H3>
<PRE>void <B>setBounds</B>(&lt;Number&gt; x, &lt;Number&gt; y, &lt;Number&gt; width, &lt;Number&gt; height, &lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)</PRE>
<UL>Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>x</CODE> - X value for new position (coordinates are page-based)
</UL>
<UL><CODE>y</CODE> - Y value for new position (coordinates are page-based)
</UL>
<UL><CODE>width</CODE> - The new width
</UL>
<UL><CODE>height</CODE> - The new height
</UL>
<UL><CODE>animate</CODE> - (optional) Animate the transition (Default is false)
</UL>
<UL><CODE>duration</CODE> - (optional) How long the animation lasts. (Defaults to .35 seconds)
</UL>
<UL><CODE>onComplete</CODE> - (optional) Function to call when animation completes.
</UL>
<UL><CODE>easing</CODE> - (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setBox"><!-- --></A>
<H3>setBox</H3>
<PRE>void <B>setBox</B>(&lt;Object&gt; box, &lt;<i>Boolean</i>&gt; adjust, &lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)</PRE>
<UL>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.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>box</CODE> - The box to fill {x, y, width, height}
</UL>
<UL><CODE>adjust</CODE> - (optional) Whether to adjust for box-model issues automatically
</UL>
<UL><CODE>animate</CODE> - (optional) Animate the transition (Default is false)
</UL>
<UL><CODE>duration</CODE> - (optional) How long the animation lasts. (Defaults to .35 seconds)
</UL>
<UL><CODE>onComplete</CODE> - (optional) Function to call when animation completes.
</UL>
<UL><CODE>easing</CODE> - (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setHeight"><!-- --></A>
<H3>setHeight</H3>
<PRE>void <B>setHeight</B>(&lt;Number&gt; height, &lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)</PRE>
<UL>Set the height of the element</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>height</CODE> - The new height
</UL>
<UL><CODE>animate</CODE> - (optional) Animate the transition (Default is false)
</UL>
<UL><CODE>duration</CODE> - (optional) How long the animation lasts. (Defaults to .35 seconds)
</UL>
<UL><CODE>onComplete</CODE> - (optional) Function to call when animation completes.
</UL>
<UL><CODE>easing</CODE> - (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)
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setLeft"><!-- --></A>
<H3>setLeft</H3>
<PRE>void <B>setLeft</B>(&lt;String&gt; left)</PRE>
<UL>Set the element's X position directly using CSS style (instead of setX())</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>left</CODE> - The left CSS property value
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setLocation"><!-- --></A>
<H3>setLocation</H3>
<PRE>void <B>setLocation</B>(&lt;Number&gt; x, &lt;Number&gt; y, &lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)</PRE>
<UL>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 (YAHOO.ext.Element.prototype.display = none;or elements not appended return false).</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>x</CODE> - X value for new position (coordinates are page-based)
</UL>
<UL><CODE>y</CODE> - Y value for new position (coordinates are page-based)
</UL>
<UL><CODE>animate</CODE> - (optional) Animate the transition (Default is false)
</UL>
<UL><CODE>duration</CODE> - (optional) How long the animation lasts. (Defaults to .35 seconds)
</UL>
<UL><CODE>onComplete</CODE> - (optional) Function to call when animation completes.
</UL>
<UL><CODE>easing</CODE> - (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setOpacity"><!-- --></A>
<H3>setOpacity</H3>
<PRE>void <B>setOpacity</B>(&lt;Float&gt; opacity, &lt;<i>Boolean</i>&gt; animate, &lt;<i>Float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)</PRE>
<UL>Set the opacity of the element</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>opacity</CODE> - The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc
</UL>
<UL><CODE>animate</CODE> - (optional) Animate (fade) the transition (Default is false)
</UL>
<UL><CODE>duration</CODE> - (optional) How long the animation lasts. (Defaults to .35 seconds)
</UL>
<UL><CODE>onComplete</CODE> - (optional) Function to call when animation completes.
</UL>
<UL><CODE>easing</CODE> - (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)
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setPositioning"><!-- --></A>
<H3>setPositioning</H3>
<PRE>void <B>setPositioning</B>(positionCfg)</PRE>
<UL>Set positioning with an object returned by <a href="#getPositioning">getPositioning()</a>.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setRegion"><!-- --></A>
<H3>setRegion</H3>
<PRE>void <B>setRegion</B>(&lt;YAHOO.util.Region&gt; region, &lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)</PRE>
<UL>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.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>region</CODE> - The region to fill
</UL>
<UL><CODE>animate</CODE> - (optional) Animate the transition (Default is false)
</UL>
<UL><CODE>duration</CODE> - (optional) How long the animation lasts. (Defaults to .35 seconds)
</UL>
<UL><CODE>onComplete</CODE> - (optional) Function to call when animation completes.
</UL>
<UL><CODE>easing</CODE> - (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setRelativePositioned"><!-- --></A>
<H3>setRelativePositioned</H3>
<PRE>void <B>setRelativePositioned</B>(&lt;<i>Number</i>&gt; zIndex)</PRE>
<UL>Set the element as relative positioned with the specified z-index</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>zIndex</CODE> - (optional)
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setRight"><!-- --></A>
<H3>setRight</H3>
<PRE>void <B>setRight</B>(right)</PRE>
<UL>Set the element's css right style</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>left</CODE> - The right CSS property value
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setSize"><!-- --></A>
<H3>setSize</H3>
<PRE>void <B>setSize</B>(&lt;Number&gt; width, &lt;Number&gt; height, &lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)</PRE>
<UL>Set the size of the element. If animation is true, both width an height will be animated concurrently.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>width</CODE> - The new width
</UL>
<UL><CODE>height</CODE> - The new height
</UL>
<UL><CODE>animate</CODE> - (optional) Animate the transition (Default is false)
</UL>
<UL><CODE>duration</CODE> - (optional) How long the animation lasts. (Defaults to .35 seconds)
</UL>
<UL><CODE>onComplete</CODE> - (optional) Function to call when animation completes.
</UL>
<UL><CODE>easing</CODE> - (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setStyle"><!-- --></A>
<H3>setStyle</H3>
<PRE>void <B>setStyle</B>(name, value)</PRE>
<UL>Wrapper for setting style properties</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>property</CODE> - The style property to be set.
</UL>
<UL><CODE>val</CODE> - The value to apply to the given property.
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setTop"><!-- --></A>
<H3>setTop</H3>
<PRE>void <B>setTop</B>(&lt;String&gt; top)</PRE>
<UL>Set the element's Y position directly using CSS style (instead of setY())</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>top</CODE> - The top CSS property value
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setVisibilityMode"><!-- --></A>
<H3>setVisibilityMode</H3>
<PRE>void <B>setVisibilityMode</B>(visMode)</PRE>
<UL>Sets the elements visibility mode. When setVisible() is called it
will use this to determine whether to set the visibility or the display property.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>visMode</CODE> - Element.VISIBILITY or Element.DISPLAY
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setVisible"><!-- --></A>
<H3>setVisible</H3>
<PRE>void <B>setVisible</B>(&lt;Boolean&gt; visible, &lt;<i>Boolean</i>&gt; animate, &lt;<i>Float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)</PRE>
<UL>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.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>visible</CODE> - Whether the element is visible
</UL>
<UL><CODE>animate</CODE> - (optional) Fade the element in or out (Default is false)
</UL>
<UL><CODE>duration</CODE> - (optional) How long the fade effect lasts. (Defaults to .35 seconds)
</UL>
<UL><CODE>onComplete</CODE> - (optional) Function to call when animation completes.
</UL>
<UL><CODE>easing</CODE> - (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeOut for hiding or YAHOO.util.Easing.easeIn for showing)
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setWidth"><!-- --></A>
<H3>setWidth</H3>
<PRE>void <B>setWidth</B>(&lt;Number&gt; width, &lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)</PRE>
<UL>Set the width of the element</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>width</CODE> - The new width
</UL>
<UL><CODE>animate</CODE> - (optional) Animate the transition (Default is false)
</UL>
<UL><CODE>duration</CODE> - (optional) How long the animation lasts. (Defaults to .35 seconds)
</UL>
<UL><CODE>onComplete</CODE> - (optional) Function to call when animation completes.
</UL>
<UL><CODE>easing</CODE> - (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)
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setX"><!-- --></A>
<H3>setX</H3>
<PRE>void <B>setX</B>(x)</PRE>
<UL>Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (YAHOO.ext.Element.prototype.display = none;or elements not appended return false).</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>The</CODE> - X position of the element
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setXY"><!-- --></A>
<H3>setXY</H3>
<PRE>void <B>setXY</B>(&lt;Array&gt; pos, &lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)</PRE>
<UL>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 (YAHOO.ext.Element.prototype.display = none;or elements not appended return false).</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>pos</CODE> - Contains X & Y [x, y] values for new position (coordinates are page-based)
</UL>
<UL><CODE>animate</CODE> - (optional) Animate the transition (Default is false)
</UL>
<UL><CODE>duration</CODE> - (optional) How long the animation lasts. (Defaults to .35 seconds)
</UL>
<UL><CODE>onComplete</CODE> - (optional) Function to call when animation completes.
</UL>
<UL><CODE>easing</CODE> - (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setY"><!-- --></A>
<H3>setY</H3>
<PRE>void <B>setY</B>(y)</PRE>
<UL>Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (YAHOO.ext.Element.prototype.display = none;or elements not appended return false).</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>The</CODE> - Y position of the element
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="show"><!-- --></A>
<H3>show</H3>
<PRE>void <B>show</B>(&lt;<i>Boolean</i>&gt; animate, &lt;<i>Float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)</PRE>
<UL>Show this element - Uses display mode to determine whether to use "display" or "visibility". See <a href="#setVisible">setVisible()</a>.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>animate</CODE> - (optional) Animate (fade in) the transition (Default is false)
</UL>
<UL><CODE>duration</CODE> - (optional) How long the animation lasts. (Defaults to .35 seconds)
</UL>
<UL><CODE>onComplete</CODE> - (optional) Function to call when animation completes.
</UL>
<UL><CODE>easing</CODE> - (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeBoth)
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="toggle"><!-- --></A>
<H3>toggle</H3>
<PRE>void <B>toggle</B>(&lt;<i>Boolean</i>&gt; animate, &lt;<i>float</i>&gt; duration, &lt;<i>Function</i>&gt; onComplete, &lt;<i>Function</i>&gt; easing)</PRE>
<UL>Toggles the elements visibility or display, depending on visibility mode.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>animate</CODE> - (optional) Fade the element in or out (Default is false)
</UL>
<UL><CODE>duration</CODE> - (optional) How long the fade effect lasts. (Defaults to .35 seconds)
</UL>
<UL><CODE>onComplete</CODE> - (optional) Function to call when animation completes.
</UL>
<UL><CODE>easing</CODE> - (optional) YAHOO.util.Easing method to use. (Defaults to YAHOO.util.Easing.easeOut for hiding or YAHOO.util.Easing.easeIn for showing)
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="toggleClass"><!-- --></A>
<H3>toggleClass</H3>
<PRE>void <B>toggleClass</B>(className)</PRE>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="unclip"><!-- --></A>
<H3>unclip</H3>
<PRE>void <B>unclip</B>()</PRE>
<UL>Return clipping (overflow) to original clipping when the document loaded</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="update"><!-- --></A>
<H3>update</H3>
<PRE>void <B>update</B>(&lt;String&gt; html, &lt;<i>Boolean</i>&gt; loadScripts)</PRE>
<UL>Update the innerHTML of this element, optionally searching for and processing scripts</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>html</CODE> - The new HTML
</UL>
<UL><CODE>loadScripts</CODE> - (optional) true to look for and process scripts
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="!s!get"><!-- --></A>
<H3>get</H3>
<PRE>&lt;static&gt; Element <B>get</B>(&lt;String/HTMLElement/Element&gt; el, &lt;<i>Boolean</i>&gt; autoGenerateId)</PRE>
<UL>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.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>el</CODE> - The id of the element or the element to wrap (must have an id). If you pass in an element, it is returned
</UL>
<UL><CODE>autoGenerateId</CODE> - (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.
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
The element object
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<!-- ============ METHOD DETAIL END ========== -->
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<FONT SIZE="-1">
</FONT>
<div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Sat Oct 14 06:07:10 2006</div>
</BODY>
</HTML>
Reference in a new issue View git blame Copy permalink