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

2091 lines
104 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: layout YAHOO.widget.Layout (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/api.css">
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
<h3>layout&nbsp; <span class="subtitle">2.6.0</span></h3>
<p>
<a href="./index.html">Yahoo! UI Library</a>
&gt; <a href="./module_layout.html">layout</a>
&gt; YAHOO.widget.Layout
</p>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form name="yui-classopts-form">
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> <label for="showprivate">Show Private</label></span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> <label for="showprotected">Show Protected</label></span>
<span id="classopts"><input type="checkbox" name="showdeprecated" id="showdeprecated" /> <label for="showdeprecated">Show Deprecated</label></span>
</form>
<h2>
Class <b>YAHOO.widget.Layout</b>
<span class="extends">
- extends <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>
</span>
<span class="extends">
</span>
</code>
</h2>
<!-- class tree goes here -->
<div class="summary description">
<p>Provides a fixed layout containing, top, bottom, left, right and center layout units. It can be applied to either the body or an element.</p>
</div>
<div class="section constructor details">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong>YAHOO.widget.Layout</strong>
<code>
(
el
,
attrs
)
</code>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el
&lt;String/HTMLElement&gt;
</code>
The element to make contain a layout.
</dd>
<dd>
<code>attrs
&lt;Object&gt;
</code>
Object liternal containing configuration parameters.
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="private">
<h4><a name="property__doc">_doc</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
Reference to the root element
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__instances">_instances</a>
<code>- private static Object</code>
</h4>
<div class="detail">
<div class="description">
Internal hash table for all layout instances
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__isBody">_isBody</a>
<code>- private Boolean</code>
</h4>
<div class="detail">
<div class="description">
Flag to determine if we are using the body as the root element.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__rendered">_rendered</a>
<code>- private Boolean</code>
</h4>
<div class="detail">
<div class="description">
Set to true when the layout is rendered
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__sizes">_sizes</a>
<code>- private Object</code>
</h4>
<div class="detail">
<div class="description">
A collection of the current sizes of all usable LayoutUnits to be used for calculations
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__units">_units</a>
<code>- private Object</code>
</h4>
<div class="detail">
<div class="description">
An object literal that contains a list of units in the layout
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__zIndex">_zIndex</a>
<code>- private Number</code>
</h4>
<div class="detail">
<div class="description">
The zIndex to set all LayoutUnits to
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_browser">browser</a>
<code>- Object</code>
</h4>
<div class="detail">
<div class="description">
A modified version of the YAHOO.env.ua object
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.util.Element.html#property_DOM_EVENTS">DOM_EVENTS</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.util.AttributeProvider.html">YAHOO.util.AttributeProvider</a>:</h4>
<div class="content">
<code>
<a class="private" href="YAHOO.util.AttributeProvider.html#property__configs">_configs</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>:</h4>
<div class="content">
<code>
<a class="private" href="YAHOO.util.EventProvider.html#property___yui_events">__yui_events</a><span class="private">,</span>
<a class="private" href="YAHOO.util.EventProvider.html#property___yui_subscribers">__yui_subscribers</a>
</code>
</div>
</div>
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="private">
<h4>
<a name="method__createUnits">_createUnits</a></h4>
<div class="detail">
<code>
private
void
<strong>_createUnits</strong>
(
)
</code>
<div class="description">
Private method to create units from the config that was passed in.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__setBodySize">_setBodySize</a></h4>
<div class="detail">
<code>
private
void
<strong>_setBodySize</strong>
(
set
)
</code>
<div class="description">
Used to set the body size of the layout, sets the height and width of the parent container
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>set &lt;Boolean&gt;</code>
If set to false, it will NOT set the size, just perform the calculations (used for collapsing units)
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__setCenter">_setCenter</a></h4>
<div class="detail">
<code>
private
void
<strong>_setCenter</strong>
(
set
)
</code>
<div class="description">
Used to set the size and position of the center unit
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>set &lt;Boolean&gt;</code>
If set to false, it will NOT set the size, just perform the calculations (used for collapsing units)
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__setSides">_setSides</a></h4>
<div class="detail">
<code>
private
void
<strong>_setSides</strong>
(
set
)
</code>
<div class="description">
Used to set the size and position of the left, right, top and bottom units
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>set &lt;Boolean&gt;</code>
If set to false, it will NOT set the size, just perform the calculations (used for collapsing units)
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__setupBodyElements">_setupBodyElements</a></h4>
<div class="detail">
<code>
private
void
<strong>_setupBodyElements</strong>
(
)
</code>
<div class="description">
Sets up the main doc element when using the body as the main element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__setupElements">_setupElements</a></h4>
<div class="detail">
<code>
private
void
<strong>_setupElements</strong>
(
)
</code>
<div class="description">
Sets up the main doc element when not using the body as the main element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__stamp">_stamp</a></h4>
<div class="detail">
<code>
private
void
<strong>_stamp</strong>
(
)
</code>
<div class="description">
Stamps the root node with a secure classname for ease of use. Also sets the this.browser.standardsMode variable.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_addUnit">addUnit</a></h4>
<div class="detail">
<code>
<a href="YAHOO.widget.LayoutUnit.html">YAHOO.widget.LayoutUnit</a>
<strong>addUnit</strong>
(
cfg
)
</code>
<div class="description">
Add a unit to this layout and if the layout is rendered, resize the layout.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>cfg &lt;Object&gt;</code>
The config for the LayoutUnit that you want to add
</dd>
</dl>
<dl>
<dt>Returns:
<code>
<a href="YAHOO.widget.LayoutUnit.html">YAHOO.widget.LayoutUnit</a>
</code></dt>
<dd>The LayoutUnit instance</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_destroy">destroy</a></h4>
<div class="detail">
<code>
void
<strong>destroy</strong>
(
)
</code>
<div class="description">
Removes this layout from the page and destroys all units that it contains. This will destroy all data inside the layout and it's children.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getLayoutById">getLayoutById</a></h4>
<div class="detail">
<code>
static
Object
<strong>getLayoutById</strong>
(
)
</code>
<div class="description">
Get's a layout object by the HTML id of the element associated with the Layout object.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Object
</code></dt>
<dd>The Layout Object</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getSizes">getSizes</a></h4>
<div class="detail">
<code>
Object
<strong>getSizes</strong>
(
)
</code>
<div class="description">
Get a reference to the internal Layout Unit sizes object used to build the layout wireframe
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Object
</code></dt>
<dd>An object of the layout unit sizes</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getUnitById">getUnitById</a></h4>
<div class="detail">
<code>
<a href="YAHOO.widget.LayoutUnit.html">YAHOO.widget.LayoutUnit</a>
<strong>getUnitById</strong>
(
id
)
</code>
<div class="description">
Get the LayoutUnit by it's HTML id
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>id &lt;String&gt;</code>
The HTML element id of the unit
</dd>
</dl>
<dl>
<dt>Returns:
<code>
<a href="YAHOO.widget.LayoutUnit.html">YAHOO.widget.LayoutUnit</a>
</code></dt>
<dd>The LayoutUnit instance</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getUnitByPosition">getUnitByPosition</a></h4>
<div class="detail">
<code>
<a href="YAHOO.widget.LayoutUnit.html">YAHOO.widget.LayoutUnit</a>
<strong>getUnitByPosition</strong>
(
pos
)
</code>
<div class="description">
Get the LayoutUnit by it's position in this layout
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>pos &lt;String&gt;</code>
The position of the unit in this layout
</dd>
</dl>
<dl>
<dt>Returns:
<code>
<a href="YAHOO.widget.LayoutUnit.html">YAHOO.widget.LayoutUnit</a>
</code></dt>
<dd>The LayoutUnit instance</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_init">init</a></h4>
<div class="detail">
<code>
private
void
<strong>init</strong>
(
)
</code>
<div class="description">
The Layout class' initialization method
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_initAttributes">initAttributes</a></h4>
<div class="detail">
<code>
private
void
<strong>initAttributes</strong>
(
)
</code>
<div class="description">
Processes the config
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_removeUnit">removeUnit</a></h4>
<div class="detail">
<code>
void
<strong>removeUnit</strong>
(
unit
)
</code>
<div class="description">
Remove the unit from this layout and resize the layout.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>unit &lt;Object&gt;</code>
The LayoutUnit that you want to remove
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_render">render</a></h4>
<div class="detail">
<code>
<a href="YAHOO.widget.Layout.html">YAHOO.widget.Layout</a>
<strong>render</strong>
(
)
</code>
<div class="description">
This method starts the render process, applying classnames and creating elements
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
<a href="YAHOO.widget.Layout.html">YAHOO.widget.Layout</a>
</code></dt>
<dd>The Layout instance</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_resize">resize</a></h4>
<div class="detail">
<code>
<a href="YAHOO.widget.Layout.html">YAHOO.widget.Layout</a>
<strong>resize</strong>
(
set
)
</code>
<div class="description">
Starts the chain of resize routines that will resize all the units.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>set &lt;Boolean&gt;</code>
If set to false, it will NOT set the size, just perform the calculations (used for collapsing units)
</dd>
</dl>
<dl>
<dt>Returns:
<code>
<a href="YAHOO.widget.Layout.html">YAHOO.widget.Layout</a>
</code></dt>
<dd>The Layout instance</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_toString">toString</a></h4>
<div class="detail">
<code>
String
<strong>toString</strong>
(
)
</code>
<div class="description">
Returns a string representing the Layout.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
<div class="content">
<code>
<a class="private" href="YAHOO.util.Element.html#method__registerHTMLAttr">_registerHTMLAttr</a><span class="private">,</span> <a class="" href="YAHOO.util.Element.html#method_addClass">addClass</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_addListener">addListener</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_appendChild">appendChild</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_appendTo">appendTo</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_fireQueue">fireQueue</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_getElementsByClassName">getElementsByClassName</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_getElementsByTagName">getElementsByTagName</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_getStyle">getStyle</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_hasChildNodes">hasChildNodes</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_hasClass">hasClass</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_initAttributes">initAttributes</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_insertBefore">insertBefore</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_on">on</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_removeChild">removeChild</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_removeClass">removeClass</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_removeListener">removeListener</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_replaceChild">replaceChild</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_replaceClass">replaceClass</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_setStyle">setStyle</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_subscribe">subscribe</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.util.AttributeProvider.html">YAHOO.util.AttributeProvider</a>:</h4>
<div class="content">
<code>
<a class=" deprecated" href="YAHOO.util.AttributeProvider.html#method_configureAttribute">configureAttribute</a><span class=" deprecated">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_fireBeforeChangeEvent">fireBeforeChangeEvent</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_fireChangeEvent">fireChangeEvent</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_get">get</a><span class="">,</span> <a class="private" href="YAHOO.util.AttributeProvider.html#method_getAttributeConfig">getAttributeConfig</a><span class="private">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_getAttributeKeys">getAttributeKeys</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_refresh">refresh</a><span class="">,</span> <a class=" deprecated" href="YAHOO.util.AttributeProvider.html#method_register">register</a><span class=" deprecated">,</span> <a class="private" href="YAHOO.util.AttributeProvider.html#method_resetAttributeConfig">resetAttributeConfig</a><span class="private">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_resetValue">resetValue</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_set">set</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_setAttributeConfig">setAttributeConfig</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_setAttributes">setAttributes</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.util.EventProvider.html#method_createEvent">createEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_fireEvent">fireEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_hasEvent">hasEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_subscribe">subscribe</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_unsubscribe">unsubscribe</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_unsubscribeAll">unsubscribeAll</a>
</code>
</div>
</div>
<div class="section method details">
<h3 id="events">Events</h3>
<div class="content">
<div class="">
<h4>
<a name="event_beforeHeightChange">beforeHeightChange</a></h4>
<div class="detail">
<code>
<strong>beforeHeightChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'height' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeMinHeightChange">beforeMinHeightChange</a></h4>
<div class="detail">
<code>
<strong>beforeMinHeightChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'minHeight' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeMinWidthChange">beforeMinWidthChange</a></h4>
<div class="detail">
<code>
<strong>beforeMinWidthChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'minWidth' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeParentChange">beforeParentChange</a></h4>
<div class="detail">
<code>
<strong>beforeParentChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'parent' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeResize">beforeResize</a></h4>
<div class="detail">
<code>
<strong>beforeResize</strong>
(
)
</code>
<div class="description">
Firef at the beginning of the resize method. If you return false, the resize is cancelled.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeUnitsChange">beforeUnitsChange</a></h4>
<div class="detail">
<code>
<strong>beforeUnitsChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'units' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeWidthChange">beforeWidthChange</a></h4>
<div class="detail">
<code>
<strong>beforeWidthChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'width' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_heightChange">heightChange</a></h4>
<div class="detail">
<code>
<strong>heightChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'height' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_minHeightChange">minHeightChange</a></h4>
<div class="detail">
<code>
<strong>minHeightChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'minHeight' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_minWidthChange">minWidthChange</a></h4>
<div class="detail">
<code>
<strong>minWidthChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'minWidth' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_parentChange">parentChange</a></h4>
<div class="detail">
<code>
<strong>parentChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'parent' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_render">render</a></h4>
<div class="detail">
<code>
<strong>render</strong>
(
)
</code>
<div class="description">
Fired after the render method completes.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_resize">resize</a></h4>
<div class="detail">
<code>
<strong>resize</strong>
(
)
</code>
<div class="description">
Fired when this.resize is called
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_startResize">startResize</a></h4>
<div class="detail">
<code>
<strong>startResize</strong>
(
)
</code>
<div class="description">
Fired when the Resize Utility for a Unit fires it's startResize Event.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_unitsChange">unitsChange</a></h4>
<div class="detail">
<code>
<strong>unitsChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'units' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_widthChange">widthChange</a></h4>
<div class="detail">
<code>
<strong>widthChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'width' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Events inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.util.Element.html#event_appendTo">appendTo</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_available">available</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_beforeAppendTo">beforeAppendTo</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_beforeElementChange">beforeElementChange</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_contentReady">contentReady</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_elementChange">elementChange</a><span class="">,</span>
</code>
</div>
</div>
<div class="section field details">
<h3 id="configattributes">Configuration Attributes</h3>
<div class="content">
<div class="">
<h4><a name="config_height">height</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
The height in pixels
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="config_minHeight">minHeight</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
The minimum height in pixels
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="config_minWidth">minWidth</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
The minimum width in pixels
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="config_parent">parent</a>
<code>- Object YAHOO.widget.Layout</code>
</h4>
<div class="detail">
<div class="description">
If this layout is to be used as a child of another Layout instance, this config will bind the resize events together.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="config_units">units</a>
<code>- Array</code>
</h4>
<div class="detail">
<div class="description">
An array of config definitions for the LayoutUnits to add to this layout
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="config_width">width</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
The width in pixels
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Configuration attributes inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.util.Element.html#config_element">element</a><span class="">,</span>
</code>
</div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_animation.html">animation</a></li>
<li class=""><a href="module_autocomplete.html">autocomplete</a></li>
<li class=""><a href="module_button.html">button</a></li>
<li class=""><a href="module_calendar.html">calendar</a></li>
<li class=""><a href="module_carousel.html">carousel</a></li>
<li class=""><a href="module_charts.html">charts</a></li>
<li class=""><a href="module_colorpicker.html">colorpicker</a></li>
<li class=""><a href="module_connection.html">connection</a></li>
<li class=""><a href="module_container.html">container</a></li>
<li class=""><a href="module_cookie.html">cookie</a></li>
<li class=""><a href="module_datasource.html">datasource</a></li>
<li class=""><a href="module_datatable.html">datatable</a></li>
<li class=""><a href="module_dom.html">dom</a></li>
<li class=""><a href="module_dragdrop.html">dragdrop</a></li>
<li class=""><a href="module_editor.html">editor</a></li>
<li class=""><a href="module_element.html">element</a></li>
<li class=""><a href="module_event.html">event</a></li>
<li class=""><a href="module_get.html">get</a></li>
<li class=""><a href="module_history.html">history</a></li>
<li class=""><a href="module_imagecropper.html">imagecropper</a></li>
<li class=""><a href="module_imageloader.html">imageloader</a></li>
<li class=""><a href="module_json.html">json</a></li>
<li class="selected"><a href="module_layout.html">layout</a></li>
<li class=""><a href="module_logger.html">logger</a></li>
<li class=""><a href="module_menu.html">menu</a></li>
<li class=""><a href="module_paginator.html">paginator</a></li>
<li class=""><a href="module_profiler.html">profiler</a></li>
<li class=""><a href="module_profilerviewer.html">profilerviewer</a></li>
<li class=""><a href="module_resize.html">resize</a></li>
<li class=""><a href="module_selector.html">selector</a></li>
<li class=""><a href="module_slider.html">slider</a></li>
<li class=""><a href="module_tabview.html">tabview</a></li>
<li class=""><a href="module_treeview.html">treeview</a></li>
<li class=""><a href="module_uploader.html">uploader</a></li>
<li class=""><a href="module_yahoo.html">yahoo</a></li>
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
<li class=""><a href="module_yuitest.html">yuitest</a></li>
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
<li class="selected"><a href="YAHOO.widget.Layout.html">YAHOO.widget.Layout</a></li>
<li class=""><a href="YAHOO.widget.LayoutUnit.html">YAHOO.widget.LayoutUnit</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="layout.js.html">layout.js</a></li>
<li class=""><a href="layoutunit.js.html">layoutunit.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li class="private"><a href="#property__doc">_doc</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__instances">_instances</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__isBody">_isBody</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__rendered">_rendered</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__sizes">_sizes</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__units">_units</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__zIndex">_zIndex</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_browser">browser</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li class="private"><!--<code>void</code>-->
<a href="#method__createUnits">_createUnits</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__setBodySize">_setBodySize</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__setCenter">_setCenter</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__setSides">_setSides</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__setupBodyElements">_setupBodyElements</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__setupElements">_setupElements</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__stamp">_stamp</a>
</li>
<li class=""><!--<code><a href="YAHOO.widget.LayoutUnit.html">YAHOO.widget.LayoutUnit</a></code>-->
<a href="#method_addUnit">addUnit</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_destroy">destroy</a>
</li>
<li class=""><!--<code>Object</code>-->
<a href="#method_getLayoutById">getLayoutById</a>
</li>
<li class=""><!--<code>Object</code>-->
<a href="#method_getSizes">getSizes</a>
</li>
<li class=""><!--<code><a href="YAHOO.widget.LayoutUnit.html">YAHOO.widget.LayoutUnit</a></code>-->
<a href="#method_getUnitById">getUnitById</a>
</li>
<li class=""><!--<code><a href="YAHOO.widget.LayoutUnit.html">YAHOO.widget.LayoutUnit</a></code>-->
<a href="#method_getUnitByPosition">getUnitByPosition</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_init">init</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_initAttributes">initAttributes</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_removeUnit">removeUnit</a>
</li>
<li class=""><!--<code><a href="YAHOO.widget.Layout.html">YAHOO.widget.Layout</a></code>-->
<a href="#method_render">render</a>
</li>
<li class=""><!--<code><a href="YAHOO.widget.Layout.html">YAHOO.widget.Layout</a></code>-->
<a href="#method_resize">resize</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#method_toString">toString</a>
</li>
</ul>
</div>
<div class="module">
<h4>Events</h4>
<ul class="content">
<li class="">
<a href="#event_beforeHeightChange">beforeHeightChange</a>
</li>
<li class="">
<a href="#event_beforeMinHeightChange">beforeMinHeightChange</a>
</li>
<li class="">
<a href="#event_beforeMinWidthChange">beforeMinWidthChange</a>
</li>
<li class="">
<a href="#event_beforeParentChange">beforeParentChange</a>
</li>
<li class="">
<a href="#event_beforeResize">beforeResize</a>
</li>
<li class="">
<a href="#event_beforeUnitsChange">beforeUnitsChange</a>
</li>
<li class="">
<a href="#event_beforeWidthChange">beforeWidthChange</a>
</li>
<li class="">
<a href="#event_heightChange">heightChange</a>
</li>
<li class="">
<a href="#event_minHeightChange">minHeightChange</a>
</li>
<li class="">
<a href="#event_minWidthChange">minWidthChange</a>
</li>
<li class="">
<a href="#event_parentChange">parentChange</a>
</li>
<li class="">
<a href="#event_render">render</a>
</li>
<li class="">
<a href="#event_resize">resize</a>
</li>
<li class="">
<a href="#event_startResize">startResize</a>
</li>
<li class="">
<a href="#event_unitsChange">unitsChange</a>
</li>
<li class="">
<a href="#event_widthChange">widthChange</a>
</li>
</ul>
</div>
<div class="module">
<h4>Configuration Attributes</h4>
<ul class="content">
<li class="">
<a href="#config_height">height</a>
</li>
<li class="">
<a href="#config_minHeight">minHeight</a>
</li>
<li class="">
<a href="#config_minWidth">minWidth</a>
</li>
<li class="">
<a href="#config_parent">parent</a>
</li>
<li class="">
<a href="#config_units">units</a>
</li>
<li class="">
<a href="#config_width">width</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2008 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>