<!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: dom Selector (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>dom <span class="subtitle">3.0.0</span></h3>
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
> <a href="./module_dom.html" title="dom">dom</a>
> Selector
<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>
<h2>
<code>static</code>
Class <b property="yui:name">Selector</b>
<span class="extends">
</span>
</h2>
<!-- class tree goes here -->
<div class="summary description" property="yui:description">
Provides support for using CSS selectors to query the DOM
</div>
<div rel="yui:properties" resource="#properties">
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="" rel="yui:property" resource="#property_operators">
<h4><a name="property_operators" property="yui:name">operators</a>
- <code><span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
List of operators and corresponding boolean functions.
These functions are passed the attribute and the current node's value of the attribute.
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_PARENT_NODE">
<h4><a name="property_PARENT_NODE" property="yui:name">PARENT_NODE</a>
- <code><span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Provides helper methods for collecting and filtering DOM elements.
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_shorthand">
<h4><a name="property_shorthand" property="yui:name">shorthand</a>
- <code><span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Mapping of shorthand tokens to corresponding attribute selector
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
<div rel="yui:methods" resource="#methods">
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="" rel="yui:method" resource="#method__tokenize">
<h4>
<a name="method__tokenize">_tokenize</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">_tokenize</strong>
(
)
</code>
<div class="description" property="yui:description">
Break selector into token units per simple selector.
Combinator is attached to the previous token.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_inRegion">
<h4>
<a name="method_inRegion">inRegion</a></h4>
<div class="detail" >
<code>
Boolean
<strong property="yui:name">inRegion</strong>
(
all
,
altRegion
)
</code>
<div class="description" property="yui:description">
Check if any part of this node is in the passed region
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">all</span>
<<span property="yui:type">Object} node2 The node to get the region from or an Object literal of the region
$param {Boolean</span>>
</code>
<span property="yui:description"> Should all of the node be inside the region</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">altRegion</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> An object literal containing the region for this node if we already have the data (for performance i.e. DragDrop)</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Boolean
</code></dt>
<dd property="yui:returnInfo">True if in region, false if not.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_intersect">
<h4>
<a name="method_intersect">intersect</a></h4>
<div class="detail" >
<code>
Object
<strong property="yui:name">intersect</strong>
(
element
,
element2
,
altRegion
)
</code>
<div class="description" property="yui:description">
Find the intersect information for the passes nodes.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">element</span>
<<span property="yui:type">HTMLElement</span>>
</code>
<span property="yui:description"> The first element</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">element2</span>
<<span property="yui:type">HTMLElement | Object</span>>
</code>
<span property="yui:description"> The element or region to check the interect with</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">altRegion</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> An object literal containing the region for the first element if we already have the data (for performance i.e. DragDrop)</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Object
</code></dt>
<dd property="yui:returnInfo">Object literal containing the following intersection data: (top, right, bottom, left, area, yoff, xoff, inRegion)</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_inViewportRegion">
<h4>
<a name="method_inViewportRegion">inViewportRegion</a></h4>
<div class="detail" >
<code>
Boolean
<strong property="yui:name">inViewportRegion</strong>
(
element
,
all
,
altRegion
)
</code>
<div class="description" property="yui:description">
Check if any part of this element is in the viewport
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">element</span>
<<span property="yui:type">HTMLElement</span>>
</code>
<span property="yui:description"> The DOM element.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">all</span>
<<span property="yui:type">Boolean</span>>
</code>
<span property="yui:description"> Should all of the node be inside the region</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">altRegion</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> An object literal containing the region for this node if we already have the data (for performance i.e. DragDrop)</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Boolean
</code></dt>
<dd property="yui:returnInfo">True if in region, false if not.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_query">
<h4>
<a name="method_query">query</a></h4>
<div class="detail" >
<code>
static
Array
<strong property="yui:name">query</strong>
(
selector
,
root
,
firstOnly
)
</code>
<div class="description" property="yui:description">
Retrieves a set of nodes based on a given CSS selector.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">selector</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> The CSS Selector to test the node against.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">root</span>
<<span property="yui:type">HTMLElement</span>>
</code>
<span property="yui:description"> optional An HTMLElement to start the query from. Defaults to Y.config.doc</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">firstOnly</span>
<<span property="yui:type">Boolean</span>>
</code>
<span property="yui:description"> optional Whether or not to return only the first match.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Array
</code></dt>
<dd property="yui:returnInfo">An array of nodes that match the given selector.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_region">
<h4>
<a name="method_region">region</a></h4>
<div class="detail" >
<code>
Object
<strong property="yui:name">region</strong>
(
element
)
</code>
<div class="description" property="yui:description">
Returns an Object literal containing the following about this element: (top, right, bottom, left)
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">element</span>
<<span property="yui:type">HTMLElement</span>>
</code>
<span property="yui:description"> The DOM element.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Object
</code></dt>
<dd property="yui:returnInfo">Object literal containing the following about this element: (top, right, bottom, left)</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_viewportRegion">
<h4>
<a name="method_viewportRegion">viewportRegion</a></h4>
<div class="detail" >
<code>
Object
<strong property="yui:name">viewportRegion</strong>
(
)
</code>
<div class="description" property="yui:description">
Returns an Object literal containing the following about the visible region of viewport: (top, right, bottom, left)
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
Object
</code></dt>
<dd property="yui:returnInfo">Object literal containing the following about the visible region of the viewport: (top, right, bottom, left)</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
<div rel="yui:events" resource="#events">
</div>
<div rel="yui:attributes" resource="#configattributes">
</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="selected"><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=""><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="DOM.html" title="DOM">DOM</a></li>
<li class="selected"><a href="Selector.html" title="Selector">Selector</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="color.js.html" title="color.js">color.js</a></li>
<li class=""><a href="dom-class.js.html" title="dom-class.js">dom-class.js</a></li>
<li class=""><a href="dom-ie-style.js.html" title="dom-ie-style.js">dom-ie-style.js</a></li>
<li class=""><a href="dom-region.js.html" title="dom-region.js">dom-region.js</a></li>
<li class=""><a href="dom-screen.js.html" title="dom-screen.js">dom-screen.js</a></li>
<li class=""><a href="dom-style.js.html" title="dom-style.js">dom-style.js</a></li>
<li class=""><a href="dom.js.html" title="dom.js">dom.js</a></li>
<li class=""><a href="selector-css2.js.html" title="selector-css2.js">selector-css2.js</a></li>
<li class=""><a href="selector-css3.js.html" title="selector-css3.js">selector-css3.js</a></li>
<li class=""><a href="selector-native.js.html" title="selector-native.js">selector-native.js</a></li>
</ul>
</div>
<div id="propertyList" class="module">
<h4>Properties</h4>
<ul class="content">
<li class=""><a href="#property_operators" title="operators">operators</a></li>
<li class=""><a href="#property_PARENT_NODE" title="PARENT_NODE">PARENT_NODE</a></li>
<li class=""><a href="#property_shorthand" title="shorthand">shorthand</a></li>
</ul>
</div>
<div id="methodsList" class="module">
<h4>Methods</h4>
<ul class="content">
<li class=""><a href="#method__tokenize" title="_tokenize">_tokenize</a></li>
<li class=""><a href="#method_inRegion" title="inRegion">inRegion</a></li>
<li class=""><a href="#method_intersect" title="intersect">intersect</a></li>
<li class=""><a href="#method_inViewportRegion" title="inViewportRegion">inViewportRegion</a></li>
<li class=""><a href="#method_query" title="query">query</a></li>
<li class=""><a href="#method_region" title="region">region</a></li>
<li class=""><a href="#method_viewportRegion" title="viewportRegion">viewportRegion</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": "", "host": "Selector", "name": "inRegion", "url": "Selector.html#method_inRegion", "type": "method"}, {"access": "", "host": "Selector", "name": "intersect", "url": "Selector.html#method_intersect", "type": "method"}, {"access": "", "host": "Selector", "name": "inViewportRegion", "url": "Selector.html#method_inViewportRegion", "type": "method"}, {"access": "", "host": "Selector", "name": "operators", "url": "Selector.html#property_operators", "type": "property"}, {"access": "", "host": "Selector", "name": "PARENT_NODE", "url": "Selector.html#property_PARENT_NODE", "type": "property"}, {"access": "", "host": "Selector", "name": "query", "url": "Selector.html#method_query", "type": "method"}, {"access": "", "host": "Selector", "name": "region", "url": "Selector.html#method_region", "type": "method"}, {"access": "", "host": "Selector", "name": "shorthand", "url": "Selector.html#property_shorthand", "type": "property"}, {"access": "", "host": "Selector", "name": "_tokenize", "url": "Selector.html#method__tokenize", "type": "method"}, {"access": "", "host": "Selector", "name": "viewportRegion", "url": "Selector.html#method_viewportRegion", "type": "method"}];
</script>
</body>
</html>