|
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: classnamemanager ClassNameManager (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>classnamemanager <span class="subtitle">3.0.0</span></h3> |
|
20 <a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
21 > <a href="./module_classnamemanager.html" title="classnamemanager">classnamemanager</a> |
|
22 > ClassNameManager |
|
23 |
|
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 <h2> |
|
47 |
|
48 |
|
49 <code>static</code> |
|
50 |
|
51 Class <b property="yui:name">ClassNameManager</b> |
|
52 <span class="extends"> |
|
53 </span> |
|
54 |
|
55 </h2> |
|
56 <!-- class tree goes here --> |
|
57 |
|
58 |
|
59 |
|
60 |
|
61 <div class="summary description" property="yui:description"> |
|
62 A singleton class providing: |
|
63 <ul> |
|
64 <li>Easy creation of prefixed class names</li> |
|
65 <li>Caching of previously created class names for improved performance.</li> |
|
66 </ul> |
|
67 </div> |
|
68 |
|
69 |
|
70 <div rel="yui:properties" resource="#properties"> |
|
71 <div class="section field details"> |
|
72 <h3 id="properties">Properties</h3> |
|
73 <div class="content"> |
|
74 <div class="" rel="yui:property" resource="#property_Y.config.classNameDelimiter"> |
|
75 <h4><a name="property_Y.config.classNameDelimiter" property="yui:name">Y.config.classNameDelimiter</a> |
|
76 - <code>static <span property="yui:type">{String}</span></code> |
|
77 </h4> |
|
78 <div class="detail"> |
|
79 <div class="description" property="yui:description"> |
|
80 Configuration property indicating the delimiter used to compose all CSS class names in |
|
81 this YUI instance. |
|
82 </div> |
|
83 </div> |
|
84 |
|
85 |
|
86 <div class="default" property="yui:defaultValue"> |
|
87 Default Value: "-" |
|
88 </div> |
|
89 |
|
90 |
|
91 <hr /> |
|
92 </div> |
|
93 <div class="" rel="yui:property" resource="#property_Y.config.classNamePrefix"> |
|
94 <h4><a name="property_Y.config.classNamePrefix" property="yui:name">Y.config.classNamePrefix</a> |
|
95 - <code>static <span property="yui:type">{String}</span></code> |
|
96 </h4> |
|
97 <div class="detail"> |
|
98 <div class="description" property="yui:description"> |
|
99 Configuration property indicating the prefix for all CSS class names in this YUI instance. |
|
100 </div> |
|
101 </div> |
|
102 |
|
103 |
|
104 <div class="default" property="yui:defaultValue"> |
|
105 Default Value: "yui" |
|
106 </div> |
|
107 |
|
108 |
|
109 <hr /> |
|
110 </div> |
|
111 </div> |
|
112 </div> |
|
113 |
|
114 </div> |
|
115 |
|
116 <div rel="yui:methods" resource="#methods"> |
|
117 <div class="section method details"> |
|
118 <h3 id="methods">Methods</h3> |
|
119 <div class="content"> |
|
120 <div class="" rel="yui:method" resource="#method_getClassName"> |
|
121 <h4> |
|
122 <a name="method_getClassName">getClassName</a></h4> |
|
123 <div class="detail" > |
|
124 <code> |
|
125 |
|
126 |
|
127 |
|
128 void |
|
129 <strong property="yui:name">getClassName</strong> |
|
130 ( |
|
131 |
|
132 |
|
133 + |
|
134 |
|
135 |
|
136 ) |
|
137 </code> |
|
138 |
|
139 <div class="description" property="yui:description"> |
|
140 Returns a class name prefixed with the the value of the |
|
141 <code>Y.config.classNamePrefix</code> attribute + the provided strings. |
|
142 Uses the <code>Y.config.classNameDelimiter</code> attribute to delimit the |
|
143 provided strings. E.g. Y.ClassNameManager.getClassName('foo','bar'); // yui-foo-bar |
|
144 </div> |
|
145 |
|
146 <div class="description"> |
|
147 |
|
148 <dl rel="yui:parameters"> |
|
149 <dt>Parameters:</dt> |
|
150 <dd rel="yui:parameter"> |
|
151 <code><span property="yui:name">+</span> |
|
152 <<span property="yui:type">String</span>> |
|
153 </code> |
|
154 <span property="yui:description"> one or more classname bits to be joined and prefixed</span> |
|
155 </dd> |
|
156 </dl> |
|
157 |
|
158 |
|
159 |
|
160 |
|
161 |
|
162 </div> |
|
163 |
|
164 </div> |
|
165 <hr /> |
|
166 </div> |
|
167 </div> |
|
168 </div> |
|
169 |
|
170 </div> |
|
171 |
|
172 <div rel="yui:events" resource="#events"> |
|
173 |
|
174 |
|
175 </div> |
|
176 |
|
177 <div rel="yui:attributes" resource="#configattributes"> |
|
178 |
|
179 </div> |
|
180 |
|
181 </div> |
|
182 </div> |
|
183 <div class="yui-b"> |
|
184 <div class="nav"> |
|
185 |
|
186 <div id="moduleList" class="module"> |
|
187 <h4>Modules</h4> |
|
188 <ul class="content"> |
|
189 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
190 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
191 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
192 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
193 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
194 <li class="selected"><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
195 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
196 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
197 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
198 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
199 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
200 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
201 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
202 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
203 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
204 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
205 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
206 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
207 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
208 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
209 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
210 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
211 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
212 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
213 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
214 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
215 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
216 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
217 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
218 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
219 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
220 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
221 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
222 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
223 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
224 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
225 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
226 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
227 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
228 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
229 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
230 </ul> |
|
231 </div> |
|
232 |
|
233 <div id="classList" class="module"> |
|
234 <h4>Classes</h4> |
|
235 <ul class="content"> |
|
236 <li class="selected"><a href="ClassNameManager.html" title="ClassNameManager">ClassNameManager</a></li> |
|
237 </ul> |
|
238 </div> |
|
239 |
|
240 <div id="fileList" class="module"> |
|
241 <h4>Files</h4> |
|
242 <ul class="content"> |
|
243 <li class=""><a href="classnamemanager.js.html" title="classnamemanager.js">classnamemanager.js</a></li> |
|
244 </ul> |
|
245 </div> |
|
246 |
|
247 <div id="propertyList" class="module"> |
|
248 <h4>Properties</h4> |
|
249 <ul class="content"> |
|
250 <li class=""><a href="#property_Y.config.classNameDelimiter" title="Y.config.classNameDelimiter">Y.config.classNameDelimiter</a></li> |
|
251 <li class=""><a href="#property_Y.config.classNamePrefix" title="Y.config.classNamePrefix">Y.config.classNamePrefix</a></li> |
|
252 </ul> |
|
253 </div> |
|
254 |
|
255 <div id="methodsList" class="module"> |
|
256 <h4>Methods</h4> |
|
257 <ul class="content"> |
|
258 <li class=""><a href="#method_getClassName" title="getClassName">getClassName</a></li> |
|
259 </ul> |
|
260 </div> |
|
261 |
|
262 |
|
263 |
|
264 </div> |
|
265 </div> |
|
266 </div> |
|
267 <div id="ft"> |
|
268 <hr /> |
|
269 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
270 </div> |
|
271 </div> |
|
272 <script type="text/javascript"> |
|
273 ALL_YUI_PROPS = [{"access": "", "host": "ClassNameManager", "name": "getClassName", "url": "ClassNameManager.html#method_getClassName", "type": "method"}, {"access": "", "host": "ClassNameManager", "name": "Y.config.classNameDelimiter", "url": "ClassNameManager.html#property_Y.config.classNameDelimiter", "type": "property"}, {"access": "", "host": "ClassNameManager", "name": "Y.config.classNamePrefix", "url": "ClassNameManager.html#property_Y.config.classNamePrefix", "type": "property"}]; |
|
274 </script> |
|
275 </body> |
|
276 </html> |