<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>API: widget-position-ext Widget-PositionExt.js (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
<link rel="stylesheet" type="text/css" href="assets/api.css" />
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1>
<h3>widget-position-ext <span class="subtitle">3.0.0</span></h3>
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
> <a href="./module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a>
> Widget-PositionExt.js (source view)
<form onsubmit="return false">
<div id="propertysearch">
Search: <input autocomplete="off" id="searchinput" />
<div id="searchresults">
</div>
</div>
</form>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
<fieldset>
<legend>Filters</legend>
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
</fieldset>
</form>
<div id="srcout">
<style>
#doc3 .classopts { display:none; }
</style>
<div class="highlight" ><pre><span class="c">/**</span>
<span class="c"> * Provides extended/advanced XY positioning support for Widgets, through an extension.</span>
<span class="c"> *</span>
<span class="c"> * It builds on top of the widget-position module, to provide alignmentment and centering support.</span>
<span class="c"> * Future releases aim to add constrained and fixed positioning support.</span>
<span class="c"> *</span>
<span class="c"> * @module widget-position-ext</span>
<span class="c"> */</span>
<span class="k">var</span> <span class="nx">L</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Lang</span><span class="o">,</span>
<span class="nx">ALIGN</span> <span class="o">=</span> <span class="s2">"align"</span><span class="o">,</span>
<span class="nx">BINDUI</span> <span class="o">=</span> <span class="s2">"bindUI"</span><span class="o">,</span>
<span class="nx">SYNCUI</span> <span class="o">=</span> <span class="s2">"syncUI"</span><span class="o">,</span>
<span class="nx">OFFSET_WIDTH</span> <span class="o">=</span> <span class="s2">"offsetWidth"</span><span class="o">,</span>
<span class="nx">OFFSET_HEIGHT</span> <span class="o">=</span> <span class="s2">"offsetHeight"</span><span class="o">,</span>
<span class="nx">VIEWPORT_REGION</span> <span class="o">=</span> <span class="s2">"viewportRegion"</span><span class="o">,</span>
<span class="nx">REGION</span> <span class="o">=</span> <span class="s2">"region"</span><span class="o">,</span>
<span class="nx">AlignChange</span> <span class="o">=</span> <span class="s2">"alignChange"</span><span class="o">;</span>
<span class="c">/**</span>
<span class="c"> * Widget extension, which can be used to add extended XY positioning support to the base Widget class,</span>
<span class="c"> * through the <a href="Base.html#method_build">Base.build</a> method. This extension requires that </span>
<span class="c"> * the WidgetPosition extension be added to the Widget (before WidgetPositionExt, if part of the same </span>
<span class="c"> * extension list passed to Base.build).</span>
<span class="c"> *</span>
<span class="c"> * @class WidgetPositionExt</span>
<span class="c"> * @param {Object} User configuration object</span>
<span class="c"> */</span>
<span class="k">function</span> <span class="nx">PositionExt</span><span class="o">(</span><span class="nx">config</span><span class="o">)</span> <span class="o">{</span>
<span class="k">if</span> <span class="o">(!</span><span class="k">this</span><span class="o">.</span><span class="nx">_posNode</span><span class="o">)</span> <span class="o">{</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">error</span><span class="o">(</span><span class="s2">"WidgetPosition needs to be added to the Widget, before WidgetPositionExt is added"</span><span class="o">);</span>
<span class="o">}</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">after</span><span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">_syncUIPosExtras</span><span class="o">,</span> <span class="k">this</span><span class="o">,</span> <span class="nx">SYNCUI</span><span class="o">);</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">after</span><span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">_bindUIPosExtras</span><span class="o">,</span> <span class="k">this</span><span class="o">,</span> <span class="nx">BINDUI</span><span class="o">);</span>
<span class="o">}</span>
<span class="c">/**</span>
<span class="c"> * Static property used to define the default attribute </span>
<span class="c"> * configuration introduced by WidgetPositionExt.</span>
<span class="c"> * </span>
<span class="c"> * @property WidgetPositionExt.ATTRS</span>
<span class="c"> * @type Object</span>
<span class="c"> * @static</span>
<span class="c"> */</span>
<span class="nx">PositionExt</span><span class="o">.</span><span class="nx">ATTRS</span> <span class="o">=</span> <span class="o">{</span>
<span class="c">/**</span>
<span class="c"> * @attribute align</span>
<span class="c"> * @type Object</span>
<span class="c"> * @default null</span>
<span class="c"> * @desciption The align attribute is used to align a reference point on the widget, with the refernce point on another node, or the viewport. </span>
<span class="c"> * The object which align expects has the following properties:</span>
<span class="c"> * <dl></span>
<span class="c"> * <dt>node</dt></span>
<span class="c"> * <dd></span>
<span class="c"> * The node to which the Widget is to be aligned. If set to null, or not provided, the Widget is aligned to the viewport</span>
<span class="c"> * </dd></span>
<span class="c"> * <dt>points</dt></span>
<span class="c"> * <dd></span>
<span class="c"> * <p></span>
<span class="c"> * A two element array, defining the two points on the Widget and node/viewport which are to be aligned. The first element is the point on the Widget, and the second element is the point on the node/viewport.</span>
<span class="c"> * Supported alignment points are defined as static properties on <code>WidgetPositionExt</code>.</span>
<span class="c"> * </p></span>
<span class="c"> * <p></span>
<span class="c"> * e.g. <code>[WidgetPositionExt.TR, WidgetPositionExt.TL]</code> aligns the Top-Right corner of the Widget with the</span>
<span class="c"> * Top-Left corner of the node/viewport, and <code>[WidgetPositionExt.CC, WidgetPositionExt.TC]</code> aligns the Center of the </span>
<span class="c"> * Widget with the Top-Center edge of the node/viewport.</span>
<span class="c"> * </p></span>
<span class="c"> * </dd></span>
<span class="c"> * </dl></span>
<span class="c"> */</span>
<span class="nx">align</span><span class="o">:</span> <span class="o">{</span>
<span class="nx">value</span><span class="o">:</span><span class="kc">null</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * @attribute centered</span>
<span class="c"> * @type {boolean | node} </span>
<span class="c"> * @default false</span>
<span class="c"> * @description A convenience attribute, which can be used as a shortcut for the align attribute.</span>
<span class="c"> * If set to true, the Widget is centered in the viewport. If set to a node reference or valid selector string,</span>
<span class="c"> * the Widget will be centered within the node. If set the false, no center positioning is applied.</span>
<span class="c"> */</span>
<span class="nx">centered</span><span class="o">:</span> <span class="o">{</span>
<span class="nx">setter</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">val</span><span class="o">)</span> <span class="o">{</span>
<span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">_setAlignCenter</span><span class="o">(</span><span class="nx">val</span><span class="o">);</span>
<span class="o">},</span>
<span class="nx">lazyAdd</span><span class="o">:</span><span class="kc">false</span><span class="o">,</span>
<span class="nx">value</span><span class="o">:</span><span class="kc">false</span>
<span class="o">}</span>
<span class="o">};</span>
<span class="c">/**</span>
<span class="c"> * Constant used to specify the top-left corner for alignment</span>
<span class="c"> * </span>
<span class="c"> * @property WidgetPositionExt.TL</span>
<span class="c"> * @type String</span>
<span class="c"> * @static</span>
<span class="c"> * @value "tl"</span>
<span class="c"> */</span>
<span class="nx">PositionExt</span><span class="o">.</span><span class="nx">TL</span> <span class="o">=</span> <span class="s2">"tl"</span><span class="o">;</span>
<span class="c">/**</span>
<span class="c"> * Constant used to specify the top-right corner for alignment</span>
<span class="c"> * </span>
<span class="c"> * @property WidgetPositionExt.TR</span>
<span class="c"> * @type String</span>
<span class="c"> * @static</span>
<span class="c"> * @value "tr"</span>
<span class="c"> */</span>
<span class="nx">PositionExt</span><span class="o">.</span><span class="nx">TR</span> <span class="o">=</span> <span class="s2">"tr"</span><span class="o">;</span>
<span class="c">/**</span>
<span class="c"> * Constant used to specify the bottom-left corner for alignment</span>
<span class="c"> * </span>
<span class="c"> * @property WidgetPositionExt.BL</span>
<span class="c"> * @type String</span>
<span class="c"> * @static</span>
<span class="c"> * @value "bl"</span>
<span class="c"> */</span>
<span class="nx">PositionExt</span><span class="o">.</span><span class="nx">BL</span> <span class="o">=</span> <span class="s2">"bl"</span><span class="o">;</span>
<span class="c">/**</span>
<span class="c"> * Constant used to specify the bottom-right corner for alignment</span>
<span class="c"> * </span>
<span class="c"> * @property WidgetPositionExt.BR</span>
<span class="c"> * @type String</span>
<span class="c"> * @static</span>
<span class="c"> * @value "br"</span>
<span class="c"> */</span>
<span class="nx">PositionExt</span><span class="o">.</span><span class="nx">BR</span> <span class="o">=</span> <span class="s2">"br"</span><span class="o">;</span>
<span class="c">/**</span>
<span class="c"> * Constant used to specify the top edge-center point for alignment</span>
<span class="c"> * </span>
<span class="c"> * @property WidgetPositionExt.TC</span>
<span class="c"> * @type String</span>
<span class="c"> * @static</span>
<span class="c"> * @value "tc"</span>
<span class="c"> */</span>
<span class="nx">PositionExt</span><span class="o">.</span><span class="nx">TC</span> <span class="o">=</span> <span class="s2">"tc"</span><span class="o">;</span>
<span class="c">/**</span>
<span class="c"> * Constant used to specify the right edge, center point for alignment</span>
<span class="c"> * </span>
<span class="c"> * @property WidgetPositionExt.RC</span>
<span class="c"> * @type String</span>
<span class="c"> * @static</span>
<span class="c"> * @value "rc"</span>
<span class="c"> */</span>
<span class="nx">PositionExt</span><span class="o">.</span><span class="nx">RC</span> <span class="o">=</span> <span class="s2">"rc"</span><span class="o">;</span>
<span class="c">/**</span>
<span class="c"> * Constant used to specify the bottom edge, center point for alignment</span>
<span class="c"> * </span>
<span class="c"> * @property WidgetPositionExt.BC</span>
<span class="c"> * @type String</span>
<span class="c"> * @static</span>
<span class="c"> * @value "bc"</span>
<span class="c"> */</span>
<span class="nx">PositionExt</span><span class="o">.</span><span class="nx">BC</span> <span class="o">=</span> <span class="s2">"bc"</span><span class="o">;</span>
<span class="c">/**</span>
<span class="c"> * Constant used to specify the left edge, center point for alignment</span>
<span class="c"> * </span>
<span class="c"> * @property WidgetPositionExt.LC</span>
<span class="c"> * @type String</span>
<span class="c"> * @static</span>
<span class="c"> * @value "lc"</span>
<span class="c"> */</span>
<span class="nx">PositionExt</span><span class="o">.</span><span class="nx">LC</span> <span class="o">=</span> <span class="s2">"lc"</span><span class="o">;</span>
<span class="c">/**</span>
<span class="c"> * Constant used to specify the center of widget/node/viewport for alignment</span>
<span class="c"> * </span>
<span class="c"> * @property WidgetPositionExt.CC</span>
<span class="c"> * @type String</span>
<span class="c"> * @static</span>
<span class="c"> * @value "cc"</span>
<span class="c"> */</span>
<span class="nx">PositionExt</span><span class="o">.</span><span class="nx">CC</span> <span class="o">=</span> <span class="s2">"cc"</span><span class="o">;</span>
<span class="nx">PositionExt</span><span class="o">.</span><span class="nx">prototype</span> <span class="o">=</span> <span class="o">{</span>
<span class="c">/**</span>
<span class="c"> * Synchronizes the UI to match the Widgets extended positioning state.</span>
<span class="c"> * This method in invoked after syncUI is invoked for the Widget class</span>
<span class="c"> * using YUI's aop infrastructure.</span>
<span class="c"> *</span>
<span class="c"> * @method _syncUIPosExtras</span>
<span class="c"> * @protected</span>
<span class="c"> */</span>
<span class="nx">_syncUIPosExtras</span> <span class="o">:</span> <span class="k">function</span><span class="o">()</span> <span class="o">{</span>
<span class="k">var</span> <span class="nx">align</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">ALIGN</span><span class="o">);</span>
<span class="k">if</span> <span class="o">(</span><span class="nx">align</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="nx">_uiSetAlign</span><span class="o">(</span><span class="nx">align</span><span class="o">.</span><span class="nx">node</span><span class="o">,</span> <span class="nx">align</span><span class="o">.</span><span class="nx">points</span><span class="o">);</span>
<span class="o">}</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Binds event listeners responsible for updating the UI state in response to </span>
<span class="c"> * Widget extended positioning related state changes.</span>
<span class="c"> * <p></span>
<span class="c"> * This method is invoked after bindUI is invoked for the Widget class</span>
<span class="c"> * using YUI's aop infrastructure.</span>
<span class="c"> * </p></span>
<span class="c"> * @method _bindUIStack</span>
<span class="c"> * @protected</span>
<span class="c"> */</span>
<span class="nx">_bindUIPosExtras</span> <span class="o">:</span> <span class="k">function</span><span class="o">()</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="nx">after</span><span class="o">(</span><span class="nx">AlignChange</span><span class="o">,</span> <span class="k">this</span><span class="o">.</span><span class="nx">_afterAlignChange</span><span class="o">);</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Default setter for center attribute changes. Sets up the appropriate value, and passes </span>
<span class="c"> * it through the to the align attribute.</span>
<span class="c"> *</span>
<span class="c"> * @method _setAlignCenter</span>
<span class="c"> * @protected</span>
<span class="c"> * @param {boolean | node} The attribute value being set. </span>
<span class="c"> * @return {Number} The attribute value being set.</span>
<span class="c"> */</span>
<span class="nx">_setAlignCenter</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">val</span><span class="o">)</span> <span class="o">{</span>
<span class="k">if</span> <span class="o">(</span><span class="nx">val</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="nx">set</span><span class="o">(</span><span class="nx">ALIGN</span><span class="o">,</span> <span class="o">{</span>
<span class="nx">node</span><span class="o">:</span> <span class="nx">val</span> <span class="o">===</span> <span class="kc">true</span> <span class="o">?</span> <span class="kc">null</span> <span class="o">:</span> <span class="nx">val</span><span class="o">,</span>
<span class="nx">points</span><span class="o">:</span> <span class="o">[</span><span class="nx">PositionExt</span><span class="o">.</span><span class="nx">CC</span><span class="o">,</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">CC</span><span class="o">]</span>
<span class="o">});</span>
<span class="o">}</span>
<span class="k">return</span> <span class="nx">val</span><span class="o">;</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Default attribute change listener for the align attribute, responsible</span>
<span class="c"> * for updating the UI, in response to attribute changes.</span>
<span class="c"> * </span>
<span class="c"> * @method _afterAlignChange</span>
<span class="c"> * @protected</span>
<span class="c"> * @param {EventFacade} e The event facade for the attribute change</span>
<span class="c"> */</span>
<span class="nx">_afterAlignChange</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">e</span><span class="o">)</span> <span class="o">{</span>
<span class="k">if</span> <span class="o">(</span><span class="nx">e</span><span class="o">.</span><span class="nx">newVal</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="nx">_uiSetAlign</span><span class="o">(</span><span class="nx">e</span><span class="o">.</span><span class="nx">newVal</span><span class="o">.</span><span class="nx">node</span><span class="o">,</span> <span class="nx">e</span><span class="o">.</span><span class="nx">newVal</span><span class="o">.</span><span class="nx">points</span><span class="o">);</span>
<span class="o">}</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Updates the UI to reflect the align value passed in (see the align attribute documentation, for the object stucture expected)</span>
<span class="c"> * @method _uiSetAlign</span>
<span class="c"> * @protected</span>
<span class="c"> * @param {Node | null} The node to align to, or null to indicate the viewport</span>
<span class="c"> */</span>
<span class="nx">_uiSetAlign</span><span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">node</span><span class="o">,</span> <span class="nx">points</span><span class="o">)</span> <span class="o">{</span>
<span class="k">if</span> <span class="o">(!</span><span class="nx">L</span><span class="o">.</span><span class="nx">isArray</span><span class="o">(</span><span class="nx">points</span><span class="o">)</span> <span class="o">||</span> <span class="nx">points</span><span class="o">.</span><span class="nx">length</span> <span class="o">!=</span> <span class="m">2</span><span class="o">)</span> <span class="o">{</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">error</span><span class="o">(</span><span class="s2">"align: Invalid Points Arguments"</span><span class="o">);</span>
<span class="k">return</span><span class="o">;</span>
<span class="o">}</span>
<span class="k">var</span> <span class="nx">nodeRegion</span><span class="o">,</span> <span class="nx">widgetPoint</span><span class="o">,</span> <span class="nx">nodePoint</span><span class="o">,</span> <span class="nx">xy</span><span class="o">;</span>
<span class="k">if</span> <span class="o">(!</span><span class="nx">node</span><span class="o">)</span> <span class="o">{</span>
<span class="nx">nodeRegion</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_posNode</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">VIEWPORT_REGION</span><span class="o">);</span>
<span class="o">}</span> <span class="k">else</span> <span class="o">{</span>
<span class="nx">node</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Node</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">node</span><span class="o">);</span>
<span class="k">if</span> <span class="o">(</span><span class="nx">node</span><span class="o">)</span> <span class="o">{</span>
<span class="nx">nodeRegion</span> <span class="o">=</span> <span class="nx">node</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">REGION</span><span class="o">);</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="k">if</span> <span class="o">(</span><span class="nx">nodeRegion</span><span class="o">)</span> <span class="o">{</span>
<span class="c">// TODO: ViewportRegion doesn't have width/height - Workaround until normalized in Node/Dom</span>
<span class="c"></span> <span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">width</span> <span class="o">=</span> <span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">width</span> <span class="o">||</span> <span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">right</span> <span class="o">-</span> <span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">left</span><span class="o">;</span>
<span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">height</span> <span class="o">=</span> <span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">height</span> <span class="o">||</span> <span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">bottom</span> <span class="o">-</span> <span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">top</span><span class="o">;</span>
<span class="nx">widgetPoint</span> <span class="o">=</span> <span class="nx">points</span><span class="o">[</span><span class="m">0</span><span class="o">];</span>
<span class="nx">nodePoint</span> <span class="o">=</span> <span class="nx">points</span><span class="o">[</span><span class="m">1</span><span class="o">];</span>
<span class="c">// TODO: Optimize KWeight - Would lookup table help?</span>
<span class="c"></span> <span class="nx">switch</span> <span class="o">(</span><span class="nx">nodePoint</span><span class="o">)</span> <span class="o">{</span>
<span class="nx">case</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">TL</span><span class="o">:</span>
<span class="nx">xy</span> <span class="o">=</span> <span class="o">[</span><span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">left</span><span class="o">,</span> <span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">top</span><span class="o">];</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">case</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">TR</span><span class="o">:</span>
<span class="nx">xy</span> <span class="o">=</span> <span class="o">[</span><span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">right</span><span class="o">,</span> <span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">top</span><span class="o">];</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">case</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">BL</span><span class="o">:</span>
<span class="nx">xy</span> <span class="o">=</span> <span class="o">[</span><span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">left</span><span class="o">,</span> <span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">bottom</span><span class="o">];</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">case</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">BR</span><span class="o">:</span>
<span class="nx">xy</span> <span class="o">=</span> <span class="o">[</span><span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">right</span><span class="o">,</span> <span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">bottom</span><span class="o">];</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">case</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">TC</span><span class="o">:</span>
<span class="nx">xy</span> <span class="o">=</span> <span class="o">[</span><span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">left</span> <span class="o">+</span> <span class="nb">Math</span><span class="o">.</span><span class="nx">floor</span><span class="o">(</span><span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">width</span><span class="o">/</span><span class="m">2</span><span class="o">),</span> <span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">top</span><span class="o">];</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">case</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">BC</span><span class="o">:</span>
<span class="nx">xy</span> <span class="o">=</span> <span class="o">[</span><span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">left</span> <span class="o">+</span> <span class="nb">Math</span><span class="o">.</span><span class="nx">floor</span><span class="o">(</span><span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">width</span><span class="o">/</span><span class="m">2</span><span class="o">),</span> <span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">bottom</span><span class="o">];</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">case</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">LC</span><span class="o">:</span>
<span class="nx">xy</span> <span class="o">=</span> <span class="o">[</span><span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">left</span><span class="o">,</span> <span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">top</span> <span class="o">+</span> <span class="nb">Math</span><span class="o">.</span><span class="nx">floor</span><span class="o">(</span><span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">height</span><span class="o">/</span><span class="m">2</span><span class="o">)];</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">case</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">RC</span><span class="o">:</span>
<span class="nx">xy</span> <span class="o">=</span> <span class="o">[</span><span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">right</span><span class="o">,</span> <span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">top</span> <span class="o">+</span> <span class="nb">Math</span><span class="o">.</span><span class="nx">floor</span><span class="o">(</span><span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">height</span><span class="o">/</span><span class="m">2</span><span class="o">),</span> <span class="nx">widgetPoint</span><span class="o">];</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">case</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">CC</span><span class="o">:</span>
<span class="nx">xy</span> <span class="o">=</span> <span class="o">[</span><span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">left</span> <span class="o">+</span> <span class="nb">Math</span><span class="o">.</span><span class="nx">floor</span><span class="o">(</span><span class="nx">nodeRegion</span><span class="o">.</span><span class="nx">width</span><span class="sr">/2), nodeRegion.top + Math.floor(nodeRegion.height/</span><span class="m">2</span><span class="o">),</span> <span class="nx">widgetPoint</span><span class="o">];</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">default</span><span class="o">:</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"align: Invalid Points Arguments"</span><span class="o">,</span> <span class="s2">"info"</span><span class="o">,</span> <span class="s2">"widget-position-extras"</span><span class="o">);</span>
<span class="k">break</span><span class="o">;</span>
<span class="o">}</span>
<span class="k">if</span> <span class="o">(</span><span class="nx">xy</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="nx">_doAlign</span><span class="o">(</span><span class="nx">widgetPoint</span><span class="o">,</span> <span class="nx">xy</span><span class="o">[</span><span class="m">0</span><span class="o">],</span> <span class="nx">xy</span><span class="o">[</span><span class="m">1</span><span class="o">]);</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Helper method, used to align the given point on the widget, with the XY page co-ordinates provided.</span>
<span class="c"> *</span>
<span class="c"> * @method _doAlign</span>
<span class="c"> * @private</span>
<span class="c"> * @param {String} widgetPoint Supported point constant (e.g. WidgetPositionExt.TL)</span>
<span class="c"> * @param {Number} x X page co-ordinate to align to</span>
<span class="c"> * @param {Number} y Y page co-ordinate to align to</span>
<span class="c"> */</span>
<span class="nx">_doAlign</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">widgetPoint</span><span class="o">,</span> <span class="nx">x</span><span class="o">,</span> <span class="nx">y</span><span class="o">)</span> <span class="o">{</span>
<span class="k">var</span> <span class="nx">widgetNode</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_posNode</span><span class="o">,</span>
<span class="nx">xy</span><span class="o">;</span>
<span class="nx">switch</span> <span class="o">(</span><span class="nx">widgetPoint</span><span class="o">)</span> <span class="o">{</span>
<span class="nx">case</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">TL</span><span class="o">:</span>
<span class="nx">xy</span> <span class="o">=</span> <span class="o">[</span><span class="nx">x</span><span class="o">,</span> <span class="nx">y</span><span class="o">];</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">case</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">TR</span><span class="o">:</span>
<span class="nx">xy</span> <span class="o">=</span> <span class="o">[</span><span class="nx">x</span> <span class="o">-</span> <span class="nx">widgetNode</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">OFFSET_WIDTH</span><span class="o">),</span> <span class="nx">y</span><span class="o">];</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">case</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">BL</span><span class="o">:</span>
<span class="nx">xy</span> <span class="o">=</span> <span class="o">[</span><span class="nx">x</span><span class="o">,</span> <span class="nx">y</span> <span class="o">-</span> <span class="nx">widgetNode</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">OFFSET_HEIGHT</span><span class="o">)];</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">case</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">BR</span><span class="o">:</span>
<span class="nx">xy</span> <span class="o">=</span> <span class="o">[</span><span class="nx">x</span> <span class="o">-</span> <span class="nx">widgetNode</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">OFFSET_WIDTH</span><span class="o">),</span> <span class="nx">y</span> <span class="o">-</span> <span class="nx">widgetNode</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">OFFSET_HEIGHT</span><span class="o">)];</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">case</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">TC</span><span class="o">:</span>
<span class="nx">xy</span> <span class="o">=</span> <span class="o">[</span><span class="nx">x</span> <span class="o">-</span> <span class="o">(</span><span class="nx">widgetNode</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">OFFSET_WIDTH</span><span class="o">)/</span><span class="m">2</span><span class="o">),</span> <span class="nx">y</span><span class="o">];</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">case</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">BC</span><span class="o">:</span>
<span class="nx">xy</span> <span class="o">=</span> <span class="o">[</span><span class="nx">x</span> <span class="o">-</span> <span class="o">(</span><span class="nx">widgetNode</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">OFFSET_WIDTH</span><span class="o">)/</span><span class="m">2</span><span class="o">),</span> <span class="nx">y</span> <span class="o">-</span> <span class="nx">widgetNode</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">OFFSET_HEIGHT</span><span class="o">)];</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">case</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">LC</span><span class="o">:</span>
<span class="nx">xy</span> <span class="o">=</span> <span class="o">[</span><span class="nx">x</span><span class="o">,</span> <span class="nx">y</span> <span class="o">-</span> <span class="o">(</span><span class="nx">widgetNode</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">OFFSET_HEIGHT</span><span class="o">)/</span><span class="m">2</span><span class="o">)];</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">case</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">RC</span><span class="o">:</span>
<span class="nx">xy</span> <span class="o">=</span> <span class="o">[(</span><span class="nx">x</span> <span class="o">-</span> <span class="nx">widgetNode</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">OFFSET_WIDTH</span><span class="o">)),</span> <span class="nx">y</span> <span class="o">-</span> <span class="o">(</span><span class="nx">widgetNode</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">OFFSET_HEIGHT</span><span class="o">)/</span><span class="m">2</span><span class="o">)];</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">case</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">CC</span><span class="o">:</span>
<span class="nx">xy</span> <span class="o">=</span> <span class="o">[</span><span class="nx">x</span> <span class="o">-</span> <span class="o">(</span><span class="nx">widgetNode</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="nx">OFFSET_WIDTH</span><span class="o">)</span><span class="sr">/2), y - (widgetNode.get(OFFSET_HEIGHT)/</span><span class="m">2</span><span class="o">)];</span>
<span class="k">break</span><span class="o">;</span>
<span class="nx">default</span><span class="o">:</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s2">"align: Invalid Points Argument"</span><span class="o">,</span> <span class="s2">"info"</span><span class="o">,</span> <span class="s2">"widget-position-extras"</span><span class="o">);</span>
<span class="k">break</span><span class="o">;</span>
<span class="o">}</span>
<span class="k">if</span> <span class="o">(</span><span class="nx">xy</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="nx">move</span><span class="o">(</span><span class="nx">xy</span><span class="o">);</span>
<span class="o">}</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Aligns the Widget to the provided node (or viewport) using the provided</span>
<span class="c"> * points. The method can be invoked directly, however it will result in </span>
<span class="c"> * the align attribute being out of sync with current position of the of Widget.</span>
<span class="c"> * </span>
<span class="c"> * @method align</span>
<span class="c"> * @param {Node | String | null} node A reference (or selector string) for the Node which with the Widget is to be aligned.</span>
<span class="c"> * If null is passed in, the Widget will be aligned with the viewport.</span>
<span class="c"> * @param {Array[2]} points A two element array, specifying the points on the Widget and node/viewport which need to be aligned. </span>
<span class="c"> * The first entry is the point on the Widget, and the second entry is the point on the node/viewport which need to align.</span>
<span class="c"> * Valid point references are defined as static constants on the WidgetPositionExt class. </span>
<span class="c"> * </span>
<span class="c"> * e.g. [WidgetPositionExt.TL, WidgetPositionExt.TR] will align the top-left corner of the Widget with the top-right corner of the node/viewport.</span>
<span class="c"> */</span>
<span class="nx">align</span><span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">node</span><span class="o">,</span> <span class="nx">points</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="nx">set</span><span class="o">(</span><span class="nx">ALIGN</span><span class="o">,</span> <span class="o">{</span><span class="nx">node</span><span class="o">:</span> <span class="nx">node</span><span class="o">,</span> <span class="nx">points</span><span class="o">:</span><span class="nx">points</span><span class="o">});</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Centers the container in the viewport, or if a node is passed in,</span>
<span class="c"> * the node.</span>
<span class="c"> *</span>
<span class="c"> * @method centered</span>
<span class="c"> * @param {Node | String} node Optional. A node reference or selector string defining the node </span>
<span class="c"> * inside which the Widget is to be centered. If not passed in, the Widget will be centered in the </span>
<span class="c"> * viewport.</span>
<span class="c"> */</span>
<span class="nx">centered</span><span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">node</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="nx">align</span><span class="o">(</span><span class="nx">node</span><span class="o">,</span> <span class="o">[</span><span class="nx">PositionExt</span><span class="o">.</span><span class="nx">CC</span><span class="o">,</span> <span class="nx">PositionExt</span><span class="o">.</span><span class="nx">CC</span><span class="o">]);</span>
<span class="o">}</span>
<span class="o">};</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">WidgetPositionExt</span> <span class="o">=</span> <span class="nx">PositionExt</span><span class="o">;</span>
</pre></div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div id="moduleList" class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_anim.html" title="anim">anim</a></li>
<li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li>
<li class=""><a href="module_attribute.html" title="attribute">attribute</a></li>
<li class=""><a href="module_base.html" title="base">base</a></li>
<li class=""><a href="module_cache.html" title="cache">cache</a></li>
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li>
<li class=""><a href="module_collection.html" title="collection">collection</a></li>
<li class=""><a href="module_console.html" title="console">console</a></li>
<li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li>
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
<li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li>
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li>
<li class=""><a href="module_datatype.html" title="datatype">datatype</a></li>
<li class=""><a href="module_dd.html" title="dd">dd</a></li>
<li class=""><a href="module_dom.html" title="dom">dom</a></li>
<li class=""><a href="module_dump.html" title="dump">dump</a></li>
<li class=""><a href="module_event.html" title="event">event</a></li>
<li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li>
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li>
<li class=""><a href="module_history.html" title="history">history</a></li>
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li>
<li class=""><a href="module_io.html" title="io">io</a></li>
<li class=""><a href="module_json.html" title="json">json</a></li>
<li class=""><a href="module_node.html" title="node">node</a></li>
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li>
<li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li>
<li class=""><a href="module_oop.html" title="oop">oop</a></li>
<li class=""><a href="module_overlay.html" title="overlay">overlay</a></li>
<li class=""><a href="module_plugin.html" title="plugin">plugin</a></li>
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li>
<li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li>
<li class=""><a href="module_slider.html" title="slider">slider</a></li>
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li>
<li class=""><a href="module_test.html" title="test">test</a></li>
<li class=""><a href="module_widget.html" title="widget">widget</a></li>
<li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li>
<li class="selected"><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li>
<li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li>
<li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li>
<li class=""><a href="module_yui.html" title="yui">yui</a></li>
</ul>
</div>
<div id="classList" class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="WidgetPositionExt.html" title="WidgetPositionExt">WidgetPositionExt</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class="selected"><a href="Widget-PositionExt.js.html" title="Widget-PositionExt.js">Widget-PositionExt.js</a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright © 2009 Yahoo! Inc. All rights reserved.
</div>
</div>
<script type="text/javascript">
ALL_YUI_PROPS = [{"access": "protected", "host": "WidgetPositionExt", "name": "_afterAlignChange", "url": "WidgetPositionExt.html#method__afterAlignChange", "type": "method"}, {"access": "", "host": "WidgetPositionExt", "name": "align", "url": "WidgetPositionExt.html#method_align", "type": "method"}, {"access": "", "host": "WidgetPositionExt", "name": "align", "url": "WidgetPositionExt.html#config_align", "type": "config"}, {"access": "", "host": "WidgetPositionExt", "name": "alignChange", "url": "WidgetPositionExt.html#event_alignChange", "type": "event"}, {"access": "protected", "host": "WidgetPositionExt", "name": "_bindUIStack", "url": "WidgetPositionExt.html#method__bindUIStack", "type": "method"}, {"access": "", "host": "WidgetPositionExt", "name": "centered", "url": "WidgetPositionExt.html#method_centered", "type": "method"}, {"access": "", "host": "WidgetPositionExt", "name": "centered", "url": "WidgetPositionExt.html#config_centered", "type": "config"}, {"access": "", "host": "WidgetPositionExt", "name": "centeredChange", "url": "WidgetPositionExt.html#event_centeredChange", "type": "event"}, {"access": "private", "host": "WidgetPositionExt", "name": "_doAlign", "url": "WidgetPositionExt.html#method__doAlign", "type": "method"}, {"access": "protected", "host": "WidgetPositionExt", "name": "_setAlignCenter", "url": "WidgetPositionExt.html#method__setAlignCenter", "type": "method"}, {"access": "protected", "host": "WidgetPositionExt", "name": "_syncUIPosExtras", "url": "WidgetPositionExt.html#method__syncUIPosExtras", "type": "method"}, {"access": "protected", "host": "WidgetPositionExt", "name": "_uiSetAlign", "url": "WidgetPositionExt.html#method__uiSetAlign", "type": "method"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.ATTRS", "url": "WidgetPositionExt.html#property_WidgetPositionExt.ATTRS", "type": "property"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.BC", "url": "WidgetPositionExt.html#property_WidgetPositionExt.BC", "type": "property"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.BL", "url": "WidgetPositionExt.html#property_WidgetPositionExt.BL", "type": "property"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.BR", "url": "WidgetPositionExt.html#property_WidgetPositionExt.BR", "type": "property"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.CC", "url": "WidgetPositionExt.html#property_WidgetPositionExt.CC", "type": "property"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.LC", "url": "WidgetPositionExt.html#property_WidgetPositionExt.LC", "type": "property"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.RC", "url": "WidgetPositionExt.html#property_WidgetPositionExt.RC", "type": "property"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.TC", "url": "WidgetPositionExt.html#property_WidgetPositionExt.TC", "type": "property"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.TL", "url": "WidgetPositionExt.html#property_WidgetPositionExt.TL", "type": "property"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.TR", "url": "WidgetPositionExt.html#property_WidgetPositionExt.TR", "type": "property"}];
</script>
</body>
</html>