<!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: stylesheet StyleSheet (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>stylesheet <span class="subtitle">3.0.0</span></h3>
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
> <a href="./module_stylesheet.html" title="stylesheet">stylesheet</a>
> StyleSheet
<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>
Class <b property="yui:name">StyleSheet</b>
<span class="extends">
</span>
</h2>
<!-- class tree goes here -->
<div class="summary description" property="yui:description">
Create an instance of StyleSheet to encapsulate a css stylesheet.
The constructor can be called using function or constructor syntax.
<pre><code>var sheet = Y.StyleSheet(..);</pre></code>
or
<pre><code>var sheet = new Y.StyleSheet(..);</pre></code>
The first parameter passed can be any of the following things:
<ul>
<li>The desired string name to register a new empty sheet</li>
<li>The string name of an existing StyleSheet instance</li>
<li>The unique guid generated for an existing StyleSheet instance</li>
<li>The id of an existing <code><link></code> or <code><style></code> node</li>
<li>The node reference for an existing <code><link></code> or <code><style></code> node</li>
<li>The Y.Node instance wrapping an existing <code><link></code> or <code><style></code> node</li>
<li>A chunk of css text to create a new stylesheet from</li>
</ul>
<p>If a string is passed, StyleSheet will first look in its static name
registry for an existing sheet, then in the DOM for an element with that id.
If neither are found and the string contains the { character, it will be
used as a the initial cssText for a new StyleSheet. Otherwise, a new empty
StyleSheet is created, assigned the string value as a name, and registered
statically by that name.</p>
<p>The optional second parameter is a string name to register the sheet as.
This param is largely useful when providing a node id/ref or chunk of css
text to create a populated instance.</p>
</div>
<div class="section constructor details" rel="yui:constructor" resource="#constructor">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong property="yui:name">StyleSheet</strong>
<code>
(
seed
,
name
)
</code>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">seed</span>
<<span property="yui:type">String|HTMLElement|Node</span>>
</code>
<span property="yui:description"> a style or link node, its id, or a
name or guid of a StyleSheet, or a string of css text</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">name</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (optional) name to register instance for future static
access</span>
</dd>
</dl>
</div>
</div>
</div>
</div>
<div rel="yui:properties" resource="#properties">
</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_disable">
<h4>
<a name="method_disable">disable</a></h4>
<div class="detail" >
<code>
StyleSheet
<strong property="yui:name">disable</strong>
(
)
</code>
<div class="description" property="yui:description">
Disable all the rules in the sheet. Rules may be changed while the
StyleSheet is disabled.
</div>
<div class="description">
<div class="chainable">
<strong>Chainable:</strong> This method is chainable.
</div>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_enable">
<h4>
<a name="method_enable">enable</a></h4>
<div class="detail" >
<code>
StyleSheet
<strong property="yui:name">enable</strong>
(
)
</code>
<div class="description" property="yui:description">
Enable all the rules in the sheet
</div>
<div class="description">
<div class="chainable">
<strong>Chainable:</strong> This method is chainable.
</div>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_getCssText">
<h4>
<a name="method_getCssText">getCssText</a></h4>
<div class="detail" >
<code>
String
<strong property="yui:name">getCssText</strong>
(
sel
)
</code>
<div class="description" property="yui:description">
Get the current cssText for a rule or the entire sheet. If the
selector param is supplied, only the cssText for that rule will be
returned, if found. If the selector string targets multiple
selectors separated by commas, the cssText of the first rule only
will be returned. If no selector string, the stylesheet's full
cssText will be returned.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">sel</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> Selector string</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_getId">
<h4>
<a name="method_getId">getId</a></h4>
<div class="detail" >
<code>
Number
<strong property="yui:name">getId</strong>
(
)
</code>
<div class="description" property="yui:description">
Get the unique stamp for this StyleSheet instance
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
Number
</code></dt>
<dd property="yui:returnInfo">the static id</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_isEnabled">
<h4>
<a name="method_isEnabled">isEnabled</a></h4>
<div class="detail" >
<code>
Boolean
<strong property="yui:name">isEnabled</strong>
(
)
</code>
<div class="description" property="yui:description">
Returns false if the StyleSheet is disabled. Otherwise true.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_set">
<h4>
<a name="method_set">set</a></h4>
<div class="detail" >
<code>
StyleSheet
<strong property="yui:name">set</strong>
(
sel
,
css
)
</code>
<div class="description" property="yui:description">
<p>Set style properties for a provided selector string.
If the selector includes commas, it will be split into individual
selectors and applied accordingly. If the selector string does not
have a corresponding rule in the sheet, it will be added.</p>
<p>The object properties in the second parameter must be the JavaScript
names of style properties. E.g. fontSize rather than font-size.</p>
<p>The float style property will be set by any of "float",
"styleFloat", or "cssFloat".</p>
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">sel</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> the selector string to apply the changes to</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">css</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> Object literal of style properties and new values</span>
</dd>
</dl>
<div class="chainable">
<strong>Chainable:</strong> This method is chainable.
</div>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_StyleSheet.isValidSelector">
<h4>
<a name="method_StyleSheet.isValidSelector">StyleSheet.isValidSelector</a></h4>
<div class="detail" >
<code>
static
Boolean
<strong property="yui:name">StyleSheet.isValidSelector</strong>
(
sel
)
</code>
<div class="description" property="yui:description">
<p>Determines if a selector string is safe to use. Used internally
in set to prevent IE from locking up when attempting to add a rule for a
"bad selector".</p>
<p>Bad selectors are considered to be any string containing unescaped
`~!@$%^&()+=|{}[];'"?< or space. Also forbidden are . or # followed by
anything other than an alphanumeric. Additionally -abc or .-abc or
#_abc or '# ' all fail. There are likely more failure cases, so
please file a bug if you encounter one.</p>
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">sel</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> the selector string</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_StyleSheet.register">
<h4>
<a name="method_StyleSheet.register">StyleSheet.register</a></h4>
<div class="detail" >
<code>
static
Boolean
<strong property="yui:name">StyleSheet.register</strong>
(
name
,
sheet
)
</code>
<div class="description" property="yui:description">
Registers a StyleSheet instance in the static registry by the given name
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">name</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> the name to assign the StyleSheet in the registry</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">sheet</span>
<<span property="yui:type">StyleSheet</span>>
</code>
<span property="yui:description"> The StyleSheet instance</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Boolean
</code></dt>
<dd property="yui:returnInfo">false if no name or sheet is not a StyleSheet
instance. true otherwise.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_StyleSheet.toCssText">
<h4>
<a name="method_StyleSheet.toCssText">StyleSheet.toCssText</a></h4>
<div class="detail" >
<code>
static
String
<strong property="yui:name">StyleSheet.toCssText</strong>
(
css
,
cssText
)
</code>
<div class="description" property="yui:description">
<p>Converts an object literal of style properties and values into a string
of css text. This can then be assigned to el.style.cssText.</p>
<p>The optional second parameter is a cssText string representing the
starting state of the style prior to alterations. This is most often
extracted from the eventual target's current el.style.cssText.</p>
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">css</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> object literal of style properties and values</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">cssText</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (optional) starting cssText value</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
String
</code></dt>
<dd property="yui:returnInfo">the resulting cssText string</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_unset">
<h4>
<a name="method_unset">unset</a></h4>
<div class="detail" >
<code>
StyleSheet
<strong property="yui:name">unset</strong>
(
sel
,
css
)
</code>
<div class="description" property="yui:description">
<p>Unset style properties for a provided selector string, removing
their effect from the style cascade.</p>
<p>If the selector includes commas, it will be split into individual
selectors and applied accordingly. If there are no properties
remaining in the rule after unsetting, the rule is removed.</p>
<p>The style property or properties in the second parameter must be the
JavaScript style property names. E.g. fontSize rather than font-size.</p>
<p>The float style property will be unset by any of "float",
"styleFloat", or "cssFloat".</p>
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">sel</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> the selector string to apply the changes to</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">css</span>
<<span property="yui:type">String|Array</span>>
</code>
<span property="yui:description"> style property name or Array of names</span>
</dd>
</dl>
<div class="chainable">
<strong>Chainable:</strong> This method is chainable.
</div>
</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=""><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="selected"><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="selected"><a href="StyleSheet.html" title="StyleSheet">StyleSheet</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="stylesheet.js.html" title="stylesheet.js">stylesheet.js</a></li>
</ul>
</div>
<div id="methodsList" class="module">
<h4>Methods</h4>
<ul class="content">
<li class=""><a href="#method_disable" title="disable">disable</a></li>
<li class=""><a href="#method_enable" title="enable">enable</a></li>
<li class=""><a href="#method_getCssText" title="getCssText">getCssText</a></li>
<li class=""><a href="#method_getId" title="getId">getId</a></li>
<li class=""><a href="#method_isEnabled" title="isEnabled">isEnabled</a></li>
<li class=""><a href="#method_set" title="set">set</a></li>
<li class=""><a href="#method_StyleSheet.isValidSelector" title="StyleSheet.isValidSelector">StyleSheet.isValidSelector</a></li>
<li class=""><a href="#method_StyleSheet.register" title="StyleSheet.register">StyleSheet.register</a></li>
<li class=""><a href="#method_StyleSheet.toCssText" title="StyleSheet.toCssText">StyleSheet.toCssText</a></li>
<li class=""><a href="#method_unset" title="unset">unset</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": "StyleSheet", "name": "disable", "url": "StyleSheet.html#method_disable", "type": "method"}, {"access": "", "host": "StyleSheet", "name": "enable", "url": "StyleSheet.html#method_enable", "type": "method"}, {"access": "", "host": "StyleSheet", "name": "getCssText", "url": "StyleSheet.html#method_getCssText", "type": "method"}, {"access": "", "host": "StyleSheet", "name": "getId", "url": "StyleSheet.html#method_getId", "type": "method"}, {"access": "", "host": "StyleSheet", "name": "isEnabled", "url": "StyleSheet.html#method_isEnabled", "type": "method"}, {"access": "", "host": "StyleSheet", "name": "set", "url": "StyleSheet.html#method_set", "type": "method"}, {"access": "", "host": "StyleSheet", "name": "StyleSheet.isValidSelector", "url": "StyleSheet.html#method_StyleSheet.isValidSelector", "type": "method"}, {"access": "", "host": "StyleSheet", "name": "StyleSheet.register", "url": "StyleSheet.html#method_StyleSheet.register", "type": "method"}, {"access": "", "host": "StyleSheet", "name": "StyleSheet.toCssText", "url": "StyleSheet.html#method_StyleSheet.toCssText", "type": "method"}, {"access": "", "host": "StyleSheet", "name": "unset", "url": "StyleSheet.html#method_unset", "type": "method"}];
</script>
</body>
</html>