5a920362 |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
2 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
3 | <head> |
4 | <meta http-equiv="content-type" content="text/html; charset=utf-8" /> |
5 | <meta name="generator" content="JsDoc Toolkit" /> |
6 | |
7 | <title>JsDoc Reference - ColVis#dom</title> |
8 | <link href="../css/default.css" type="text/css" rel="stylesheet" media="all" /> |
9 | </head> |
10 | |
11 | <body> |
12 | <div id="header"> |
13 | </div> |
14 | |
15 | <div class="index"> |
16 | <div class="menu"> |
17 | <!-- begin publish.classesIndex --> |
18 | <div align="center"><a href="../index.html">Class Index</a> | <a href="../files.html">File Index</a></div> |
19 | |
20 | <h2 class="heading1">Classes</h2> |
21 | |
22 | <ul class="classList"> |
23 | |
24 | <li><a href="../symbols/_global_.html">_global_</a></li> |
25 | |
26 | <li><a href="../symbols/ColVis.html">ColVis</a></li> |
27 | |
28 | <li><a href="../symbols/ColVis%23dom.html">ColVis#dom</a></li> |
29 | |
30 | <li><a href="../symbols/ColVis%23s.html">ColVis#s</a></li> |
31 | |
32 | </ul> |
33 | |
34 | <!-- end publish.classesIndex --> |
35 | </div> |
36 | |
37 | <div class="fineprint" style="clear:both"> |
38 | |
39 | Generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Sat Sep 10 2011 10:46:55 GMT+0100 (BST)<br /> |
40 | HTML template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a> |
41 | </div> |
42 | </div> |
43 | |
44 | <div class="content"> |
45 | <div class="innerContent"> |
46 | <h1 class="classTitle"> |
47 | |
48 | Namespace <span>ColVis#dom</span> |
49 | </h1> |
50 | |
51 | <p class="description summary"> |
52 | |
53 | |
54 | |
55 | |
56 | Common and useful DOM elements for the class instance |
57 | |
58 | |
59 | <br /><em>Defined in: </em> <a href="../symbols/src/js_ColVis.js.html">ColVis.js</a>. |
60 | |
61 | </p> |
62 | |
63 | |
64 | <div class="props"> |
65 | <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class ColVis#dom."> |
66 | <caption>Namespace Summary</caption> |
67 | <thead> |
68 | <tr> |
69 | <th scope="col">Constructor Attributes</th> |
70 | <th scope="col">Constructor Name and Description</th> |
71 | </tr> |
72 | </thead> |
73 | <tbody> |
74 | <tr> |
75 | <td class="attributes"> </td> |
76 | <td class="nameDescription" > |
77 | <div class="fixedFont"> |
78 | <b><a href="../symbols/ColVis%23dom.html#constructor">ColVis#dom</a></b> |
79 | </div> |
80 | <div class="description"></div> |
81 | </td> |
82 | </tr> |
83 | </tbody> |
84 | </table> |
85 | </div> |
86 | |
87 | |
88 | |
89 | |
90 | |
91 | <div class="props"> |
92 | <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class ColVis#dom."> |
93 | <caption>Field Summary</caption> |
94 | |
95 | <thead> |
96 | <tr> |
97 | <th scope="col">Field Attributes</th> |
98 | <th scope="col">Field Name and Description</th> |
99 | </tr> |
100 | </thead> |
101 | |
102 | <tbody> |
103 | |
104 | <tr> |
105 | <td class="attributes"><static> </td> |
106 | <td class="nameDescription"> |
107 | <div class="fixedFont"> |
108 | ColVis#dom.<b><a href="../symbols/ColVis%23dom.html#.background">background</a></b> |
109 | </div> |
110 | <div class="description">Background node used for shading the display and event capturing</div> |
111 | </td> |
112 | </tr> |
113 | |
114 | <tr> |
115 | <td class="attributes"><static> </td> |
116 | <td class="nameDescription"> |
117 | <div class="fixedFont"> |
118 | ColVis#dom.<b><a href="../symbols/ColVis%23dom.html#.button">button</a></b> |
119 | </div> |
120 | <div class="description">Activation button</div> |
121 | </td> |
122 | </tr> |
123 | |
124 | <tr> |
125 | <td class="attributes"><static> </td> |
126 | <td class="nameDescription"> |
127 | <div class="fixedFont"> |
128 | ColVis#dom.<b><a href="../symbols/ColVis%23dom.html#.buttons">buttons</a></b> |
129 | </div> |
130 | <div class="description">List of button elements</div> |
131 | </td> |
132 | </tr> |
133 | |
134 | <tr> |
135 | <td class="attributes"><static> </td> |
136 | <td class="nameDescription"> |
137 | <div class="fixedFont"> |
138 | ColVis#dom.<b><a href="../symbols/ColVis%23dom.html#.catcher">catcher</a></b> |
139 | </div> |
140 | <div class="description">Element to position over the activation button to catch mouse events when using mouseover</div> |
141 | </td> |
142 | </tr> |
143 | |
144 | <tr> |
145 | <td class="attributes"><static> </td> |
146 | <td class="nameDescription"> |
147 | <div class="fixedFont"> |
148 | ColVis#dom.<b><a href="../symbols/ColVis%23dom.html#.collection">collection</a></b> |
149 | </div> |
150 | <div class="description">Collection list node</div> |
151 | </td> |
152 | </tr> |
153 | |
154 | <tr> |
155 | <td class="attributes"><static> </td> |
156 | <td class="nameDescription"> |
157 | <div class="fixedFont"> |
158 | ColVis#dom.<b><a href="../symbols/ColVis%23dom.html#.restore">restore</a></b> |
159 | </div> |
160 | <div class="description">Restore button</div> |
161 | </td> |
162 | </tr> |
163 | |
164 | <tr> |
165 | <td class="attributes"><static> </td> |
166 | <td class="nameDescription"> |
167 | <div class="fixedFont"> |
168 | ColVis#dom.<b><a href="../symbols/ColVis%23dom.html#.wrapper">wrapper</a></b> |
169 | </div> |
170 | <div class="description">Wrapper for the button - given back to DataTables as the node to insert</div> |
171 | </td> |
172 | </tr> |
173 | |
174 | </tbody> |
175 | </table> |
176 | </div> |
177 | |
178 | |
179 | |
180 | |
181 | |
182 | <!-- |
183 | #### METHODS SUMMARY |
184 | --> |
185 | |
186 | |
187 | <!-- |
188 | #### EVENTS SUMMARY |
189 | --> |
190 | |
191 | |
192 | <!-- |
193 | #### CONSTRUCTOR DETAILS |
194 | --> |
195 | |
196 | <div class="details props"> |
197 | <div class="innerProps"> |
198 | <a name="constructor"></a> |
199 | |
200 | <div class="sectionTitle"> |
201 | Namespace Detail |
202 | </div> |
203 | |
204 | <div class="fixedFont"> |
205 | <b>ColVis#dom</b> |
206 | </div> |
207 | |
208 | <div class="description"> |
209 | |
210 | |
211 | </div> |
212 | |
213 | |
214 | |
215 | |
216 | |
217 | |
218 | </div> |
219 | </div> |
220 | |
221 | |
222 | <!-- |
223 | #### FIELD DETAILS |
224 | --> |
225 | |
226 | <div class="details props"> |
227 | <div class="innerProps"> |
228 | |
229 | <div class="sectionTitle"> |
230 | Field Detail |
231 | </div> |
232 | |
233 | |
234 | <a name=".background"></a> |
235 | |
236 | <div class="fixedFont heading"> |
237 | <span class='lighter'> |
238 | <static> |
239 | </span> |
240 | |
241 | <span class="light">{Node}</span> |
242 | |
243 | <span class="light">ColVis#dom.</span><b>background</b> |
244 | </div> |
245 | |
246 | <div class="description"> |
247 | Background node used for shading the display and event capturing |
248 | |
249 | |
250 | |
251 | </div> |
252 | |
253 | |
254 | |
255 | |
256 | <dl class="detailList nomargin"> |
257 | |
258 | |
259 | |
260 | |
261 | |
262 | <dt class="heading">Default Value:</dt> |
263 | <dd> |
264 | null |
265 | </dd> |
266 | |
267 | </dl> |
268 | |
269 | |
270 | <div class="hr"></div> |
271 | |
272 | <a name=".button"></a> |
273 | |
274 | <div class="fixedFont heading"> |
275 | <span class='lighter'> |
276 | <static> |
277 | </span> |
278 | |
279 | <span class="light">{Node}</span> |
280 | |
281 | <span class="light">ColVis#dom.</span><b>button</b> |
282 | </div> |
283 | |
284 | <div class="description"> |
285 | Activation button |
286 | |
287 | |
288 | |
289 | </div> |
290 | |
291 | |
292 | |
293 | |
294 | <dl class="detailList nomargin"> |
295 | |
296 | |
297 | |
298 | |
299 | |
300 | <dt class="heading">Default Value:</dt> |
301 | <dd> |
302 | null |
303 | </dd> |
304 | |
305 | </dl> |
306 | |
307 | |
308 | <div class="hr"></div> |
309 | |
310 | <a name=".buttons"></a> |
311 | |
312 | <div class="fixedFont heading"> |
313 | <span class='lighter'> |
314 | <static> |
315 | </span> |
316 | |
317 | <span class="light">{Array}</span> |
318 | |
319 | <span class="light">ColVis#dom.</span><b>buttons</b> |
320 | </div> |
321 | |
322 | <div class="description"> |
323 | List of button elements |
324 | |
325 | |
326 | |
327 | </div> |
328 | |
329 | |
330 | |
331 | |
332 | <dl class="detailList nomargin"> |
333 | |
334 | |
335 | |
336 | |
337 | |
338 | <dt class="heading">Default Value:</dt> |
339 | <dd> |
340 | [] |
341 | </dd> |
342 | |
343 | </dl> |
344 | |
345 | |
346 | <div class="hr"></div> |
347 | |
348 | <a name=".catcher"></a> |
349 | |
350 | <div class="fixedFont heading"> |
351 | <span class='lighter'> |
352 | <static> |
353 | </span> |
354 | |
355 | <span class="light">{Node}</span> |
356 | |
357 | <span class="light">ColVis#dom.</span><b>catcher</b> |
358 | </div> |
359 | |
360 | <div class="description"> |
361 | Element to position over the activation button to catch mouse events when using mouseover |
362 | |
363 | |
364 | |
365 | </div> |
366 | |
367 | |
368 | |
369 | |
370 | <dl class="detailList nomargin"> |
371 | |
372 | |
373 | |
374 | |
375 | |
376 | <dt class="heading">Default Value:</dt> |
377 | <dd> |
378 | null |
379 | </dd> |
380 | |
381 | </dl> |
382 | |
383 | |
384 | <div class="hr"></div> |
385 | |
386 | <a name=".collection"></a> |
387 | |
388 | <div class="fixedFont heading"> |
389 | <span class='lighter'> |
390 | <static> |
391 | </span> |
392 | |
393 | <span class="light">{Node}</span> |
394 | |
395 | <span class="light">ColVis#dom.</span><b>collection</b> |
396 | </div> |
397 | |
398 | <div class="description"> |
399 | Collection list node |
400 | |
401 | |
402 | |
403 | </div> |
404 | |
405 | |
406 | |
407 | |
408 | <dl class="detailList nomargin"> |
409 | |
410 | |
411 | |
412 | |
413 | |
414 | <dt class="heading">Default Value:</dt> |
415 | <dd> |
416 | null |
417 | </dd> |
418 | |
419 | </dl> |
420 | |
421 | |
422 | <div class="hr"></div> |
423 | |
424 | <a name=".restore"></a> |
425 | |
426 | <div class="fixedFont heading"> |
427 | <span class='lighter'> |
428 | <static> |
429 | </span> |
430 | |
431 | <span class="light">{Node}</span> |
432 | |
433 | <span class="light">ColVis#dom.</span><b>restore</b> |
434 | </div> |
435 | |
436 | <div class="description"> |
437 | Restore button |
438 | |
439 | |
440 | |
441 | </div> |
442 | |
443 | |
444 | |
445 | |
446 | <dl class="detailList nomargin"> |
447 | |
448 | |
449 | |
450 | |
451 | |
452 | <dt class="heading">Default Value:</dt> |
453 | <dd> |
454 | null |
455 | </dd> |
456 | |
457 | </dl> |
458 | |
459 | |
460 | <div class="hr"></div> |
461 | |
462 | <a name=".wrapper"></a> |
463 | |
464 | <div class="fixedFont heading"> |
465 | <span class='lighter'> |
466 | <static> |
467 | </span> |
468 | |
469 | <span class="light">{Node}</span> |
470 | |
471 | <span class="light">ColVis#dom.</span><b>wrapper</b> |
472 | </div> |
473 | |
474 | <div class="description"> |
475 | Wrapper for the button - given back to DataTables as the node to insert |
476 | |
477 | |
478 | |
479 | </div> |
480 | |
481 | |
482 | |
483 | |
484 | <dl class="detailList nomargin"> |
485 | |
486 | |
487 | |
488 | |
489 | |
490 | <dt class="heading">Default Value:</dt> |
491 | <dd> |
492 | null |
493 | </dd> |
494 | |
495 | </dl> |
496 | |
497 | |
498 | |
499 | |
500 | </div> |
501 | </div> |
502 | |
503 | |
504 | <!-- |
505 | #### METHOD DETAILS |
506 | --> |
507 | |
508 | |
509 | <!-- |
510 | #### EVENT DETAILS |
511 | --> |
512 | |
513 | </div> |
514 | </div> |
515 | </body> |
516 | </html> |