| changeset 0 | 40c8f766c9b8 |
| -1:000000000000 | 0:40c8f766c9b8 |
|---|---|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
2 <html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#"> |
|
3 <head> |
|
4 <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
|
5 <title>API: dom dom-class.js (YUI Library)</title> |
|
6 |
|
7 <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" /> |
|
8 <link rel="stylesheet" type="text/css" href="assets/api.css" /> |
|
9 |
|
10 <script type="text/javascript" src="assets/api-js"></script> |
|
11 <script type="text/javascript" src="assets/ac-js"></script> |
|
12 </head> |
|
13 |
|
14 <body id="yahoo-com"> |
|
15 |
|
16 <div id="doc3" class="yui-t2"> |
|
17 <div id="hd"> |
|
18 <h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1> |
|
19 <h3>dom <span class="subtitle">3.0.0b1</span></h3> |
|
20 <a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
21 > <a href="./module_dom.html" title="dom">dom</a> |
|
22 |
|
23 > dom-class.js (source view) |
|
24 <form onsubmit="return false"> |
|
25 <div id="propertysearch"> |
|
26 Search: <input autocomplete="off" id="searchinput" /> |
|
27 <div id="searchresults"> |
|
28 |
|
29 </div> |
|
30 </div> |
|
31 </form> |
|
32 </div> |
|
33 |
|
34 <div id="bd"> |
|
35 <div id="yui-main"> |
|
36 <div class="yui-b"> |
|
37 <form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form"> |
|
38 <fieldset> |
|
39 <legend>Filters</legend> |
|
40 <span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span> |
|
41 <span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span> |
|
42 <span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span> |
|
43 </fieldset> |
|
44 </form> |
|
45 |
|
46 <div id="srcout"> |
|
47 <style> |
|
48 #doc3 .classopts { display:none; } |
|
49 </style> |
|
50 <div class="highlight" ><pre><span class="nx">Y</span><span class="o">.</span><span class="nx">mix</span><span class="o">(</span><span class="nx">Y</span><span class="o">.</span><span class="nx">DOM</span><span class="o">,</span> <span class="o">{</span> |
|
51 <span class="c">/**</span> |
|
52 <span class="c"> * Determines whether a DOM element has the given className.</span> |
|
53 <span class="c"> * @method hasClass</span> |
|
54 <span class="c"> * @param {HTMLElement} element The DOM element. </span> |
|
55 <span class="c"> * @param {String} className the class name to search for</span> |
|
56 <span class="c"> * @return {Boolean} Whether or not the element has the given class. </span> |
|
57 <span class="c"> */</span> |
|
58 <span class="nx">hasClass</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">className</span><span class="o">)</span> <span class="o">{</span> |
|
59 <span class="k">var</span> <span class="nx">re</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">DOM</span><span class="o">.</span><span class="nx">_getRegExp</span><span class="o">(</span><span class="s1">'(?:^|\\s+)'</span> <span class="o">+</span> <span class="nx">className</span> <span class="o">+</span> <span class="s1">'(?:\\s+|$)'</span><span class="o">);</span> |
|
60 <span class="k">return</span> <span class="nx">re</span><span class="o">.</span><span class="nx">test</span><span class="o">(</span><span class="nx">node</span><span class="o">.</span><span class="nx">className</span><span class="o">);</span> |
|
61 <span class="o">},</span> |
|
62 |
|
63 <span class="c">/**</span> |
|
64 <span class="c"> * Adds a class name to a given DOM element.</span> |
|
65 <span class="c"> * @method addClass </span> |
|
66 <span class="c"> * @param {HTMLElement} element The DOM element. </span> |
|
67 <span class="c"> * @param {String} className the class name to add to the class attribute</span> |
|
68 <span class="c"> */</span> |
|
69 <span class="nx">addClass</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">className</span><span class="o">)</span> <span class="o">{</span> |
|
70 <span class="k">if</span> <span class="o">(!</span><span class="nx">Y</span><span class="o">.</span><span class="nx">DOM</span><span class="o">.</span><span class="nx">hasClass</span><span class="o">(</span><span class="nx">node</span><span class="o">,</span> <span class="nx">className</span><span class="o">))</span> <span class="o">{</span> <span class="c">// skip if already present </span> |
|
71 <span class="c"></span> <span class="nx">node</span><span class="o">.</span><span class="nx">className</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">trim</span><span class="o">([</span><span class="nx">node</span><span class="o">.</span><span class="nx">className</span><span class="o">,</span> <span class="nx">className</span><span class="o">].</span><span class="nx">join</span><span class="o">(</span><span class="s1">' '</span><span class="o">));</span> |
|
72 <span class="o">}</span> |
|
73 <span class="o">},</span> |
|
74 |
|
75 <span class="c">/**</span> |
|
76 <span class="c"> * Removes a class name from a given element.</span> |
|
77 <span class="c"> * @method removeClass </span> |
|
78 <span class="c"> * @param {HTMLElement} element The DOM element. </span> |
|
79 <span class="c"> * @param {String} className the class name to remove from the class attribute</span> |
|
80 <span class="c"> */</span> |
|
81 <span class="nx">removeClass</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">className</span><span class="o">)</span> <span class="o">{</span> |
|
82 <span class="k">if</span> <span class="o">(</span><span class="nx">className</span> <span class="o">&&</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">DOM</span><span class="o">.</span><span class="nx">hasClass</span><span class="o">(</span><span class="nx">node</span><span class="o">,</span> <span class="nx">className</span><span class="o">))</span> <span class="o">{</span> |
|
83 <span class="nx">node</span><span class="o">.</span><span class="nx">className</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">trim</span><span class="o">(</span><span class="nx">node</span><span class="o">.</span><span class="nx">className</span><span class="o">.</span><span class="nx">replace</span><span class="o">(</span><span class="nx">Y</span><span class="o">.</span><span class="nx">DOM</span><span class="o">.</span><span class="nx">_getRegExp</span><span class="o">(</span><span class="s1">'(?:^|\\s+)'</span> <span class="o">+</span> |
|
84 <span class="nx">className</span> <span class="o">+</span> <span class="s1">'(?:\\s+|$)'</span><span class="o">),</span> <span class="s1">' '</span><span class="o">));</span> |
|
85 |
|
86 <span class="k">if</span> <span class="o">(</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">DOM</span><span class="o">.</span><span class="nx">hasClass</span><span class="o">(</span><span class="nx">node</span><span class="o">,</span> <span class="nx">className</span><span class="o">)</span> <span class="o">)</span> <span class="o">{</span> <span class="c">// in case of multiple adjacent</span> |
|
87 <span class="c"></span> <span class="nx">Y</span><span class="o">.</span><span class="nx">DOM</span><span class="o">.</span><span class="nx">removeClass</span><span class="o">(</span><span class="nx">node</span><span class="o">,</span> <span class="nx">className</span><span class="o">);</span> |
|
88 <span class="o">}</span> |
|
89 <span class="o">}</span> |
|
90 <span class="o">},</span> |
|
91 |
|
92 <span class="c">/**</span> |
|
93 <span class="c"> * Replace a class with another class for a given element.</span> |
|
94 <span class="c"> * If no oldClassName is present, the newClassName is simply added.</span> |
|
95 <span class="c"> * @method replaceClass </span> |
|
96 <span class="c"> * @param {HTMLElement} element The DOM element. </span> |
|
97 <span class="c"> * @param {String} oldClassName the class name to be replaced</span> |
|
98 <span class="c"> * @param {String} newClassName the class name that will be replacing the old class name</span> |
|
99 <span class="c"> */</span> |
|
100 <span class="nx">replaceClass</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">oldC</span><span class="o">,</span> <span class="nx">newC</span><span class="o">)</span> <span class="o">{</span> |
|
101 <span class="c">//Y.log('replaceClass replacing ' + oldC + ' with ' + newC, 'info', 'Node');</span> |
|
102 <span class="c"></span> <span class="nx">Y</span><span class="o">.</span><span class="nx">DOM</span><span class="o">.</span><span class="nx">addClass</span><span class="o">(</span><span class="nx">node</span><span class="o">,</span> <span class="nx">newC</span><span class="o">);</span> |
|
103 <span class="nx">Y</span><span class="o">.</span><span class="nx">DOM</span><span class="o">.</span><span class="nx">removeClass</span><span class="o">(</span><span class="nx">node</span><span class="o">,</span> <span class="nx">oldC</span><span class="o">);</span> |
|
104 <span class="o">},</span> |
|
105 |
|
106 <span class="c">/**</span> |
|
107 <span class="c"> * If the className exists on the node it is removed, if it doesn't exist it is added.</span> |
|
108 <span class="c"> * @method toggleClass </span> |
|
109 <span class="c"> * @param {HTMLElement} element The DOM element. </span> |
|
110 <span class="c"> * @param {String} className the class name to be toggled</span> |
|
111 <span class="c"> */</span> |
|
112 <span class="nx">toggleClass</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">className</span><span class="o">)</span> <span class="o">{</span> |
|
113 <span class="k">if</span> <span class="o">(</span><span class="nx">Y</span><span class="o">.</span><span class="nx">DOM</span><span class="o">.</span><span class="nx">hasClass</span><span class="o">(</span><span class="nx">node</span><span class="o">,</span> <span class="nx">className</span><span class="o">))</span> <span class="o">{</span> |
|
114 <span class="nx">Y</span><span class="o">.</span><span class="nx">DOM</span><span class="o">.</span><span class="nx">removeClass</span><span class="o">(</span><span class="nx">node</span><span class="o">,</span> <span class="nx">className</span><span class="o">);</span> |
|
115 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
116 <span class="nx">Y</span><span class="o">.</span><span class="nx">DOM</span><span class="o">.</span><span class="nx">addClass</span><span class="o">(</span><span class="nx">node</span><span class="o">,</span> <span class="nx">className</span><span class="o">);</span> |
|
117 <span class="o">}</span> |
|
118 <span class="o">}</span> |
|
119 <span class="o">});</span> |
|
120 </pre></div> |
|
121 </div> |
|
122 </div> |
|
123 </div> |
|
124 <div class="yui-b"> |
|
125 <div class="nav"> |
|
126 |
|
127 <div id="moduleList" class="module"> |
|
128 <h4>Modules</h4> |
|
129 <ul class="content"> |
|
130 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
131 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
132 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
133 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
134 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
135 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
136 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
137 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
138 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
139 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
140 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
141 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
142 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
143 <li class="selected"><a href="module_dom.html" title="dom">dom</a></li> |
|
144 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
145 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
146 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
147 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
148 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
149 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
150 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
151 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
152 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
153 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
154 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
155 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
156 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
157 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
158 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
159 <li class=""><a href="module_queue.html" title="queue">queue</a></li> |
|
160 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
161 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
162 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
163 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
164 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
165 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
166 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
167 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
168 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
169 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
170 </ul> |
|
171 </div> |
|
172 |
|
173 <div id="classList" class="module"> |
|
174 <h4>Classes</h4> |
|
175 <ul class="content"> |
|
176 <li class=""><a href="DOM.html" title="DOM">DOM</a></li> |
|
177 <li class=""><a href="Selector.html" title="Selector">Selector</a></li> |
|
178 </ul> |
|
179 </div> |
|
180 |
|
181 <div id="fileList" class="module"> |
|
182 <h4>Files</h4> |
|
183 <ul class="content"> |
|
184 <li class=""><a href="color.js.html" title="color.js">color.js</a></li> |
|
185 <li class="selected"><a href="dom-class.js.html" title="dom-class.js">dom-class.js</a></li> |
|
186 <li class=""><a href="dom-ie-style.js.html" title="dom-ie-style.js">dom-ie-style.js</a></li> |
|
187 <li class=""><a href="dom-region.js.html" title="dom-region.js">dom-region.js</a></li> |
|
188 <li class=""><a href="dom-screen.js.html" title="dom-screen.js">dom-screen.js</a></li> |
|
189 <li class=""><a href="dom-style.js.html" title="dom-style.js">dom-style.js</a></li> |
|
190 <li class=""><a href="dom.js.html" title="dom.js">dom.js</a></li> |
|
191 <li class=""><a href="selector-css2.js.html" title="selector-css2.js">selector-css2.js</a></li> |
|
192 <li class=""><a href="selector-css3.js.html" title="selector-css3.js">selector-css3.js</a></li> |
|
193 <li class=""><a href="selector-native.js.html" title="selector-native.js">selector-native.js</a></li> |
|
194 </ul> |
|
195 </div> |
|
196 |
|
197 |
|
198 |
|
199 |
|
200 |
|
201 </div> |
|
202 </div> |
|
203 </div> |
|
204 <div id="ft"> |
|
205 <hr /> |
|
206 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
207 </div> |
|
208 </div> |
|
209 <script type="text/javascript"> |
|
210 ALL_YUI_PROPS = [{"access": "", "host": "DOM", "name": "addClass", "url": "DOM.html#method_addClass", "type": "method"}, {"access": "", "host": "DOM", "name": "addHTML", "url": "DOM.html#method_addHTML", "type": "method"}, {"access": "private", "host": "DOM", "name": "_bruteContains", "url": "DOM.html#method__bruteContains", "type": "method"}, {"access": "", "host": "DOM", "name": "byId", "url": "DOM.html#method_byId", "type": "method"}, {"access": "", "host": "DOM", "name": "contains", "url": "DOM.html#method_contains", "type": "method"}, {"access": "", "host": "DOM", "name": "create", "url": "DOM.html#method_create", "type": "method"}, {"access": "", "host": "DOM", "name": "docHeight", "url": "DOM.html#method_docHeight", "type": "method"}, {"access": "", "host": "DOM", "name": "docScrollX", "url": "DOM.html#method_docScrollX", "type": "method"}, {"access": "", "host": "DOM", "name": "docScrollY", "url": "DOM.html#method_docScrollY", "type": "method"}, {"access": "", "host": "DOM", "name": "docWidth", "url": "DOM.html#method_docWidth", "type": "method"}, {"access": "", "host": "DOM", "name": "elementByAxis", "url": "DOM.html#method_elementByAxis", "type": "method"}, {"access": "", "host": "DOM", "name": "getAttibute", "url": "DOM.html#method_getAttibute", "type": "method"}, {"access": "", "host": "DOM", "name": "getComputedStyle", "url": "DOM.html#method_getComputedStyle", "type": "method"}, {"access": "private", "host": "DOM", "name": "_getDoc", "url": "DOM.html#method__getDoc", "type": "method"}, {"access": "private", "host": "DOM", "name": "_getRegExp", "url": "DOM.html#method__getRegExp", "type": "method"}, {"access": "", "host": "DOM", "name": "getStyle", "url": "DOM.html#method_getStyle", "type": "method"}, {"access": "", "host": "DOM", "name": "getText", "url": "DOM.html#method_getText", "type": "method"}, {"access": "private", "host": "DOM", "name": "_getWin", "url": "DOM.html#method__getWin", "type": "method"}, {"access": "", "host": "DOM", "name": "getX", "url": "DOM.html#method_getX", "type": "method"}, {"access": "", "host": "DOM", "name": "getXY", "url": "DOM.html#method_getXY", "type": "method"}, {"access": "", "host": "DOM", "name": "getY", "url": "DOM.html#method_getY", "type": "method"}, {"access": "", "host": "DOM", "name": "hasClass", "url": "DOM.html#method_hasClass", "type": "method"}, {"access": "", "host": "DOM", "name": "inDoc", "url": "DOM.html#method_inDoc", "type": "method"}, {"access": "", "host": "Selector", "name": "inRegion", "url": "Selector.html#method_inRegion", "type": "method"}, {"access": "", "host": "DOM", "name": "insertAfter", "url": "DOM.html#method_insertAfter", "type": "method"}, {"access": "", "host": "DOM", "name": "insertBefore", "url": "DOM.html#method_insertBefore", "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": "DOM", "name": "removeClass", "url": "DOM.html#method_removeClass", "type": "method"}, {"access": "", "host": "DOM", "name": "replaceClass", "url": "DOM.html#method_replaceClass", "type": "method"}, {"access": "", "host": "DOM", "name": "setAttibute", "url": "DOM.html#method_setAttibute", "type": "method"}, {"access": "", "host": "DOM", "name": "setStyle", "url": "DOM.html#method_setStyle", "type": "method"}, {"access": "", "host": "DOM", "name": "setStyles", "url": "DOM.html#method_setStyles", "type": "method"}, {"access": "", "host": "DOM", "name": "setText", "url": "DOM.html#method_setText", "type": "method"}, {"access": "", "host": "DOM", "name": "setX", "url": "DOM.html#method_setX", "type": "method"}, {"access": "", "host": "DOM", "name": "setXY", "url": "DOM.html#method_setXY", "type": "method"}, {"access": "", "host": "DOM", "name": "setY", "url": "DOM.html#method_setY", "type": "method"}, {"access": "", "host": "Selector", "name": "shorthand", "url": "Selector.html#property_shorthand", "type": "property"}, {"access": "", "host": "DOM", "name": "toggleClass", "url": "DOM.html#method_toggleClass", "type": "method"}, {"access": "", "host": "Selector", "name": "_tokenize", "url": "Selector.html#method__tokenize", "type": "method"}, {"access": "", "host": "Selector", "name": "viewportRegion", "url": "Selector.html#method_viewportRegion", "type": "method"}, {"access": "", "host": "DOM", "name": "winHeight", "url": "DOM.html#method_winHeight", "type": "method"}, {"access": "", "host": "DOM", "name": "winWidth", "url": "DOM.html#method_winWidth", "type": "method"}]; |
|
211 </script> |
|
212 </body> |
|
213 </html> |