crm.fsf.org/20131203/files/sites/all/modules/civicrm/packages/jquery/plugins/DataTables/extras/ColVis/ColVis/media/docs_private/symbols/ColVis.html

   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</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:49 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                                         Class <span>ColVis</span>
  49                                 </h1>
  50
  51                                 <p class="description summary">
  52
  53
  54
  55
  56                                         ColVis
  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.">
  66                                                         <caption>Class 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">&nbsp;</td>
  76                                                                         <td class="nameDescription" >
  77                                                                                 <div class="fixedFont">
  78                                                                                         <b><a href="../symbols/ColVis.html#constructor">ColVis</a></b>(DataTables, oInit)
  79                                                                                 </div>
  80                                                                                 <div class="description">ColVis provides column visiblity control for DataTables</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.">
  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">&lt;static&gt; &nbsp;</td>
 106                                                                                         <td class="nameDescription">
 107                                                                                                 <div class="fixedFont">
 108                                                                                                 ColVis.<b><a href="../symbols/ColVis.html#.aInstances">aInstances</a></b>
 109                                                                                                 </div>
 110                                                                                                 <div class="description">Collection of all ColVis instances</div>
 111                                                                                         </td>
 112                                                                                 </tr>
 113
 114                                                                                 <tr>
 115                                                                                         <td class="attributes">&lt;constant&gt; &nbsp;</td>
 116                                                                                         <td class="nameDescription">
 117                                                                                                 <div class="fixedFont">
 118                                                                                                 <b><a href="../symbols/ColVis.html#CLASS">CLASS</a></b>
 119                                                                                                 </div>
 120                                                                                                 <div class="description">Name of this class</div>
 121                                                                                         </td>
 122                                                                                 </tr>
 123
 124                                                                                 <tr>
 125                                                                                         <td class="attributes">&lt;static&gt; &lt;constant&gt; &nbsp;</td>
 126                                                                                         <td class="nameDescription">
 127                                                                                                 <div class="fixedFont">
 128                                                                                                 ColVis.<b><a href="../symbols/ColVis.html#.VERSION">VERSION</a></b>
 129                                                                                                 </div>
 130                                                                                                 <div class="description">ColVis version</div>
 131                                                                                         </td>
 132                                                                                 </tr>
 133
 134                                                                 </tbody>
 135                                                         </table>
 136                                                 </div>
 137
 138
 139
 140
 141
 142         <!--
 143         #### METHODS SUMMARY
 144         -->
 145
 146
 147
 148                                                 <div class="props">
 149                                                         <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class ColVis.">
 150                                                                 <caption>Method Summary</caption>
 151
 152                                                                 <thead>
 153                                                                         <tr>
 154                                                                                 <th scope="col">Method Attributes</th>
 155                                                                                 <th scope="col">Method Name and Description</th>
 156                                                                         </tr>
 157                                                                 </thead>
 158
 159                                                                 <tbody>
 160
 161                                                                                 <tr>
 162                                                                                         <td class="attributes">&lt;private&gt; &nbsp;</td>
 163                                                                                         <td class="nameDescription">
 164                                                                                                 <div class="fixedFont"><b><a href="../symbols/ColVis.html#_fnAddButtons">_fnAddButtons</a></b>()
 165                                                                                                 </div>
 166                                                                                                 <div class="description">Loop through the columns in the table and as a new button for each one.</div>
 167                                                                                         </td>
 168                                                                                 </tr>
 169
 170                                                                                 <tr>
 171                                                                                         <td class="attributes">&lt;private&gt; &nbsp;</td>
 172                                                                                         <td class="nameDescription">
 173                                                                                                 <div class="fixedFont"><b><a href="../symbols/ColVis.html#_fnApplyCustomisation">_fnApplyCustomisation</a></b>()
 174                                                                                                 </div>
 175                                                                                                 <div class="description">Apply any customisation to the settings from the DataTables initialisation</div>
 176                                                                                         </td>
 177                                                                                 </tr>
 178
 179                                                                                 <tr>
 180                                                                                         <td class="attributes">&lt;private&gt; &nbsp;</td>
 181                                                                                         <td class="nameDescription">
 182                                                                                                 <div class="fixedFont"><b><a href="../symbols/ColVis.html#_fnCollectionHide">_fnCollectionHide</a></b>()
 183                                                                                                 </div>
 184                                                                                                 <div class="description">Hide the show / hide list and the background</div>
 185                                                                                         </td>
 186                                                                                 </tr>
 187
 188                                                                                 <tr>
 189                                                                                         <td class="attributes">&lt;private&gt; &nbsp;</td>
 190                                                                                         <td class="nameDescription">
 191                                                                                                 <div class="fixedFont"><b><a href="../symbols/ColVis.html#_fnCollectionShow">_fnCollectionShow</a></b>()
 192                                                                                                 </div>
 193                                                                                                 <div class="description">Show the show / hide list and the background</div>
 194                                                                                         </td>
 195                                                                                 </tr>
 196
 197                                                                                 <tr>
 198                                                                                         <td class="attributes">&lt;private&gt; &nbsp;</td>
 199                                                                                         <td class="nameDescription">
 200                                                                                                 <div class="fixedFont"><b><a href="../symbols/ColVis.html#_fnConstruct">_fnConstruct</a></b>()
 201                                                                                                 </div>
 202                                                                                                 <div class="description">Constructor logic</div>
 203                                                                                         </td>
 204                                                                                 </tr>
 205
 206                                                                                 <tr>
 207                                                                                         <td class="attributes">&lt;private&gt; &nbsp;</td>
 208                                                                                         <td class="nameDescription">
 209                                                                                                 <div class="fixedFont"><b><a href="../symbols/ColVis.html#_fnDataTablesApiIndex">_fnDataTablesApiIndex</a></b>()
 210                                                                                                 </div>
 211                                                                                                 <div class="description">Get the position in the DataTables instance array of the table for this instance of ColVis</div>
 212                                                                                         </td>
 213                                                                                 </tr>
 214
 215                                                                                 <tr>
 216                                                                                         <td class="attributes">&lt;private&gt; &nbsp;</td>
 217                                                                                         <td class="nameDescription">
 218                                                                                                 <div class="fixedFont"><b><a href="../symbols/ColVis.html#_fnDomBackground">_fnDomBackground</a></b>()
 219                                                                                                 </div>
 220                                                                                                 <div class="description">Create the element used to shade the background, and capture hide events (it is shown and
 221 hidden as needed)</div>
 222                                                                                         </td>
 223                                                                                 </tr>
 224
 225                                                                                 <tr>
 226                                                                                         <td class="attributes">&lt;private&gt; &nbsp;</td>
 227                                                                                         <td class="nameDescription">
 228                                                                                                 <div class="fixedFont"><b><a href="../symbols/ColVis.html#_fnDomBaseButton">_fnDomBaseButton</a></b>(text)
 229                                                                                                 </div>
 230                                                                                                 <div class="description">Create the DOM needed for the button and apply some base properties.</div>
 231                                                                                         </td>
 232                                                                                 </tr>
 233
 234                                                                                 <tr>
 235                                                                                         <td class="attributes">&lt;private&gt; &nbsp;</td>
 236                                                                                         <td class="nameDescription">
 237                                                                                                 <div class="fixedFont"><b><a href="../symbols/ColVis.html#_fnDomCatcher">_fnDomCatcher</a></b>()
 238                                                                                                 </div>
 239                                                                                                 <div class="description">An element to be placed on top of the activate button to catch events</div>
 240                                                                                         </td>
 241                                                                                 </tr>
 242
 243                                                                                 <tr>
 244                                                                                         <td class="attributes">&lt;private&gt; &nbsp;</td>
 245                                                                                         <td class="nameDescription">
 246                                                                                                 <div class="fixedFont"><b><a href="../symbols/ColVis.html#_fnDomCollection">_fnDomCollection</a></b>()
 247                                                                                                 </div>
 248                                                                                                 <div class="description">Create the element used to contain list the columns (it is shown and hidden as needed)</div>
 249                                                                                         </td>
 250                                                                                 </tr>
 251
 252                                                                                 <tr>
 253                                                                                         <td class="attributes">&lt;private&gt; &nbsp;</td>
 254                                                                                         <td class="nameDescription">
 255                                                                                                 <div class="fixedFont"><b><a href="../symbols/ColVis.html#_fnDomColumnButton">_fnDomColumnButton</a></b>(i)
 256                                                                                                 </div>
 257                                                                                                 <div class="description">Create the DOM for a show / hide button</div>
 258                                                                                         </td>
 259                                                                                 </tr>
 260
 261                                                                                 <tr>
 262                                                                                         <td class="attributes">&lt;private&gt; &nbsp;</td>
 263                                                                                         <td class="nameDescription">
 264                                                                                                 <div class="fixedFont"><b><a href="../symbols/ColVis.html#_fnDomRestoreButton">_fnDomRestoreButton</a></b>()
 265                                                                                                 </div>
 266                                                                                                 <div class="description">Create a button which allows a "restore" action</div>
 267                                                                                         </td>
 268                                                                                 </tr>
 269
 270                                                                                 <tr>
 271                                                                                         <td class="attributes">&lt;private&gt; &nbsp;</td>
 272                                                                                         <td class="nameDescription">
 273                                                                                                 <div class="fixedFont"><b><a href="../symbols/ColVis.html#_fnDrawCallback">_fnDrawCallback</a></b>()
 274                                                                                                 </div>
 275                                                                                                 <div class="description">On each table draw, check the visiblity checkboxes as needed.</div>
 276                                                                                         </td>
 277                                                                                 </tr>
 278
 279                                                                                 <tr>
 280                                                                                         <td class="attributes">&lt;static&gt; &nbsp;</td>
 281                                                                                         <td class="nameDescription">
 282                                                                                                 <div class="fixedFont">ColVis.<b><a href="../symbols/ColVis.html#.fnRebuild">fnRebuild</a></b>(object)
 283                                                                                                 </div>
 284                                                                                                 <div class="description">Rebuild the collection for a given table, or all tables if no parameter given</div>
 285                                                                                         </td>
 286                                                                                 </tr>
 287
 288                                                                                 <tr>
 289                                                                                         <td class="attributes">&nbsp;</td>
 290                                                                                         <td class="nameDescription">
 291                                                                                                 <div class="fixedFont"><b><a href="../symbols/ColVis.html#fnRebuild">fnRebuild</a></b>()
 292                                                                                                 </div>
 293                                                                                                 <div class="description">Rebuild the list of buttons for this instance (i.e.</div>
 294                                                                                         </td>
 295                                                                                 </tr>
 296
 297                                                                 </tbody>
 298                                                         </table>
 299                                                 </div>
 300
 301
 302
 303
 304
 305         <!--
 306         #### EVENTS SUMMARY
 307         -->
 308
 309
 310         <!--
 311         #### CONSTRUCTOR DETAILS
 312         -->
 313
 314                                         <div class="details props">
 315                                                 <div class="innerProps">
 316                                                         <a name="constructor"></a>
 317
 318                                                         <div class="sectionTitle">
 319                                                                 Class Detail
 320                                                         </div>
 321
 322                                                         <div class="fixedFont">
 323                                                                 <b>ColVis</b>(DataTables, oInit)
 324                                                         </div>
 325
 326                                                         <div class="description">
 327                                                                 ColVis provides column visiblity control for DataTables
 328
 329                                                         </div>
 330
 331
 332
 333
 334                                                                 <dl class="detailList params">
 335                                                                         <dt class="heading">Parameters:</dt>
 336
 337                                                                                 <dt>
 338                                                                                         <span class="light fixedFont">{object}</span>  <b>DataTables</b>
 339
 340                                                                                 </dt>
 341                                                                                 <dd>settings object</dd>
 342
 343                                                                                 <dt>
 344                                                                                          <b>oInit</b>
 345
 346                                                                                 </dt>
 347                                                                                 <dd></dd>
 348
 349                                                                 </dl>
 350
 351
 352
 353                                                 </div>
 354                                         </div>
 355
 356
 357         <!--
 358         #### FIELD DETAILS
 359         -->
 360
 361                                         <div class="details props">
 362                                                 <div class="innerProps">
 363
 364                                                         <div class="sectionTitle">
 365                                                                 Field Detail
 366                                                         </div>
 367
 368
 369                                                                 <a name=".aInstances"></a>
 370
 371                                                                 <div class="fixedFont heading">
 372                                                                         <span class='lighter'>
 373                                                                         &lt;static&gt;
 374                                                                         </span>
 375
 376                                                                         <span class="light">{Array}</span>
 377
 378                                                                         <span class="light">ColVis.</span><b>aInstances</b>
 379                                                                 </div>
 380
 381                                                                 <div class="description">
 382                                                                         Collection of all ColVis instances
 383
 384
 385
 386                                                                 </div>
 387
 388
 389
 390
 391                                                                         <dl class="detailList nomargin">
 392
 393
 394
 395
 396
 397                                                                                         <dt class="heading">Default Value:</dt>
 398                                                                                         <dd>
 399                                                                                                 []
 400                                                                                         </dd>
 401
 402                                                                         </dl>
 403
 404
 405                                                                 <div class="hr"></div>
 406
 407                                                                 <a name="CLASS"></a>
 408
 409                                                                 <div class="fixedFont heading">
 410                                                                         <span class='lighter'>
 411                                                                         &lt;constant&gt;
 412                                                                         </span>
 413
 414                                                                         <span class="light">{String}</span>
 415
 416                                                                         <b>CLASS</b>
 417                                                                 </div>
 418
 419                                                                 <div class="description">
 420                                                                         Name of this class
 421
 422
 423
 424                                                                 </div>
 425
 426
 427
 428
 429                                                                         <dl class="detailList nomargin">
 430
 431
 432
 433
 434
 435                                                                                         <dt class="heading">Default Value:</dt>
 436                                                                                         <dd>
 437                                                                                                 ColVis
 438                                                                                         </dd>
 439
 440                                                                         </dl>
 441
 442
 443                                                                 <div class="hr"></div>
 444
 445                                                                 <a name=".VERSION"></a>
 446
 447                                                                 <div class="fixedFont heading">
 448                                                                         <span class='lighter'>
 449                                                                         &lt;static&gt; &lt;constant&gt;
 450                                                                         </span>
 451
 452                                                                         <span class="light">{String}</span>
 453
 454                                                                         <span class="light">ColVis.</span><b>VERSION</b>
 455                                                                 </div>
 456
 457                                                                 <div class="description">
 458                                                                         ColVis version
 459
 460
 461
 462                                                                 </div>
 463
 464
 465
 466
 467                                                                         <dl class="detailList nomargin">
 468
 469
 470
 471
 472
 473                                                                                         <dt class="heading">Default Value:</dt>
 474                                                                                         <dd>
 475                                                                                                 See code
 476                                                                                         </dd>
 477
 478                                                                         </dl>
 479
 480
 481
 482
 483                                                 </div>
 484                                         </div>
 485
 486
 487         <!--
 488         #### METHOD DETAILS
 489         -->
 490
 491                                         <div class="details props">
 492                                                 <div class="innerProps">
 493                                                         <div class="sectionTitle">
 494                                                                 Method Detail
 495                                                         </div>
 496
 497
 498                                                                 <a name="_fnAddButtons"></a>
 499
 500                                                                 <div class="fixedFont heading">
 501                                                                         <span class='lighter'>
 502                                                                         &lt;private&gt;
 503                                                                         </span>
 504
 505
 506
 507                                                                         <b>_fnAddButtons</b>()
 508                                                                 </div>
 509
 510                                                                 <div class="description">
 511                                                                         Loop through the columns in the table and as a new button for each one.
 512
 513
 514
 515
 516                                                                 </div>
 517
 518
 519
 520
 521
 522
 523                                                                         <dl class="detailList nomargin">
 524
 525
 526
 527
 528
 529
 530
 531
 532                                                                                         <dt class="heading">Returns:</dt>
 533
 534                                                                                                 <dd>void</dd>
 535
 536
 537
 538
 539
 540
 541
 542                                                                         </dl>
 543
 544
 545                                                                 <div class="hr"></div>
 546
 547                                                                 <a name="_fnApplyCustomisation"></a>
 548
 549                                                                 <div class="fixedFont heading">
 550                                                                         <span class='lighter'>
 551                                                                         &lt;private&gt;
 552                                                                         </span>
 553
 554
 555
 556                                                                         <b>_fnApplyCustomisation</b>()
 557                                                                 </div>
 558
 559                                                                 <div class="description">
 560                                                                         Apply any customisation to the settings from the DataTables initialisation
 561
 562
 563
 564
 565                                                                 </div>
 566
 567
 568
 569
 570
 571
 572                                                                         <dl class="detailList nomargin">
 573
 574
 575
 576
 577
 578
 579
 580
 581                                                                                         <dt class="heading">Returns:</dt>
 582
 583                                                                                                 <dd>void</dd>
 584
 585
 586
 587
 588
 589
 590
 591                                                                         </dl>
 592
 593
 594                                                                 <div class="hr"></div>
 595
 596                                                                 <a name="_fnCollectionHide"></a>
 597
 598                                                                 <div class="fixedFont heading">
 599                                                                         <span class='lighter'>
 600                                                                         &lt;private&gt;
 601                                                                         </span>
 602
 603
 604
 605                                                                         <b>_fnCollectionHide</b>()
 606                                                                 </div>
 607
 608                                                                 <div class="description">
 609                                                                         Hide the show / hide list and the background
 610
 611
 612
 613
 614                                                                 </div>
 615
 616
 617
 618
 619
 620
 621                                                                         <dl class="detailList nomargin">
 622
 623
 624
 625
 626
 627
 628
 629
 630                                                                                         <dt class="heading">Returns:</dt>
 631
 632                                                                                                 <dd>void</dd>
 633
 634
 635
 636
 637
 638
 639
 640                                                                         </dl>
 641
 642
 643                                                                 <div class="hr"></div>
 644
 645                                                                 <a name="_fnCollectionShow"></a>
 646
 647                                                                 <div class="fixedFont heading">
 648                                                                         <span class='lighter'>
 649                                                                         &lt;private&gt;
 650                                                                         </span>
 651
 652
 653
 654                                                                         <b>_fnCollectionShow</b>()
 655                                                                 </div>
 656
 657                                                                 <div class="description">
 658                                                                         Show the show / hide list and the background
 659
 660
 661
 662
 663                                                                 </div>
 664
 665
 666
 667
 668
 669
 670                                                                         <dl class="detailList nomargin">
 671
 672
 673
 674
 675
 676
 677
 678
 679                                                                                         <dt class="heading">Returns:</dt>
 680
 681                                                                                                 <dd>void</dd>
 682
 683
 684
 685
 686
 687
 688
 689                                                                         </dl>
 690
 691
 692                                                                 <div class="hr"></div>
 693
 694                                                                 <a name="_fnConstruct"></a>
 695
 696                                                                 <div class="fixedFont heading">
 697                                                                         <span class='lighter'>
 698                                                                         &lt;private&gt;
 699                                                                         </span>
 700
 701
 702
 703                                                                         <b>_fnConstruct</b>()
 704                                                                 </div>
 705
 706                                                                 <div class="description">
 707                                                                         Constructor logic
 708
 709
 710
 711
 712                                                                 </div>
 713
 714
 715
 716
 717
 718
 719                                                                         <dl class="detailList nomargin">
 720
 721
 722
 723
 724
 725
 726
 727
 728                                                                                         <dt class="heading">Returns:</dt>
 729
 730                                                                                                 <dd>void</dd>
 731
 732
 733
 734
 735
 736
 737
 738                                                                         </dl>
 739
 740
 741                                                                 <div class="hr"></div>
 742
 743                                                                 <a name="_fnDataTablesApiIndex"></a>
 744
 745                                                                 <div class="fixedFont heading">
 746                                                                         <span class='lighter'>
 747                                                                         &lt;private&gt;
 748                                                                         </span>
 749
 750                                                                         <span class="light">{int}</span>
 751
 752                                                                         <b>_fnDataTablesApiIndex</b>()
 753                                                                 </div>
 754
 755                                                                 <div class="description">
 756                                                                         Get the position in the DataTables instance array of the table for this instance of ColVis
 757
 758
 759
 760
 761                                                                 </div>
 762
 763
 764
 765
 766
 767
 768                                                                         <dl class="detailList nomargin">
 769
 770
 771
 772
 773
 774
 775
 776
 777                                                                                         <dt class="heading">Returns:</dt>
 778
 779                                                                                                 <dd><span class="light fixedFont">{int}</span> Index</dd>
 780
 781
 782
 783
 784
 785
 786
 787                                                                         </dl>
 788
 789
 790                                                                 <div class="hr"></div>
 791
 792                                                                 <a name="_fnDomBackground"></a>
 793
 794                                                                 <div class="fixedFont heading">
 795                                                                         <span class='lighter'>
 796                                                                         &lt;private&gt;
 797                                                                         </span>
 798
 799                                                                         <span class="light">{Node}</span>
 800
 801                                                                         <b>_fnDomBackground</b>()
 802                                                                 </div>
 803
 804                                                                 <div class="description">
 805                                                                         Create the element used to shade the background, and capture hide events (it is shown and
 806 hidden as needed)
 807
 808
 809
 810
 811                                                                 </div>
 812
 813
 814
 815
 816
 817
 818                                                                         <dl class="detailList nomargin">
 819
 820
 821
 822
 823
 824
 825
 826
 827                                                                                         <dt class="heading">Returns:</dt>
 828
 829                                                                                                 <dd><span class="light fixedFont">{Node}</span> div container for the background</dd>
 830
 831
 832
 833
 834
 835
 836
 837                                                                         </dl>
 838
 839
 840                                                                 <div class="hr"></div>
 841
 842                                                                 <a name="_fnDomBaseButton"></a>
 843
 844                                                                 <div class="fixedFont heading">
 845                                                                         <span class='lighter'>
 846                                                                         &lt;private&gt;
 847                                                                         </span>
 848
 849                                                                         <span class="light">{Node}</span>
 850
 851                                                                         <b>_fnDomBaseButton</b>(text)
 852                                                                 </div>
 853
 854                                                                 <div class="description">
 855                                                                         Create the DOM needed for the button and apply some base properties. All buttons start here
 856
 857
 858
 859
 860                                                                 </div>
 861
 862
 863
 864
 865                                                                         <dl class="detailList params">
 866                                                                                 <dt class="heading">Parameters:</dt>
 867
 868                                                                                         <dt>
 869                                                                                                 <span class="light fixedFont">{String}</span> <b>text</b>
 870
 871                                                                                         </dt>
 872                                                                                         <dd>Button text</dd>
 873
 874                                                                         </dl>
 875
 876
 877
 878                                                                         <dl class="detailList nomargin">
 879
 880
 881
 882
 883
 884
 885
 886
 887                                                                                         <dt class="heading">Returns:</dt>
 888
 889                                                                                                 <dd><span class="light fixedFont">{Node}</span> DIV element for the button</dd>
 890
 891
 892
 893
 894
 895
 896
 897                                                                         </dl>
 898
 899
 900                                                                 <div class="hr"></div>
 901
 902                                                                 <a name="_fnDomCatcher"></a>
 903
 904                                                                 <div class="fixedFont heading">
 905                                                                         <span class='lighter'>
 906                                                                         &lt;private&gt;
 907                                                                         </span>
 908
 909                                                                         <span class="light">{Node}</span>
 910
 911                                                                         <b>_fnDomCatcher</b>()
 912                                                                 </div>
 913
 914                                                                 <div class="description">
 915                                                                         An element to be placed on top of the activate button to catch events
 916
 917
 918
 919
 920                                                                 </div>
 921
 922
 923
 924
 925
 926
 927                                                                         <dl class="detailList nomargin">
 928
 929
 930
 931
 932
 933
 934
 935
 936                                                                                         <dt class="heading">Returns:</dt>
 937
 938                                                                                                 <dd><span class="light fixedFont">{Node}</span> div container for the collection</dd>
 939
 940
 941
 942
 943
 944
 945
 946                                                                         </dl>
 947
 948
 949                                                                 <div class="hr"></div>
 950
 951                                                                 <a name="_fnDomCollection"></a>
 952
 953                                                                 <div class="fixedFont heading">
 954                                                                         <span class='lighter'>
 955                                                                         &lt;private&gt;
 956                                                                         </span>
 957
 958                                                                         <span class="light">{Node}</span>
 959
 960                                                                         <b>_fnDomCollection</b>()
 961                                                                 </div>
 962
 963                                                                 <div class="description">
 964                                                                         Create the element used to contain list the columns (it is shown and hidden as needed)
 965
 966
 967
 968
 969                                                                 </div>
 970
 971
 972
 973
 974
 975
 976                                                                         <dl class="detailList nomargin">
 977
 978
 979
 980
 981
 982
 983
 984
 985                                                                                         <dt class="heading">Returns:</dt>
 986
 987                                                                                                 <dd><span class="light fixedFont">{Node}</span> div container for the collection</dd>
 988
 989
 990
 991
 992
 993
 994
 995                                                                         </dl>
 996
 997
 998                                                                 <div class="hr"></div>
 999
1000                                                                 <a name="_fnDomColumnButton"></a>
1001
1002                                                                 <div class="fixedFont heading">
1003                                                                         <span class='lighter'>
1004                                                                         &lt;private&gt;
1005                                                                         </span>
1006
1007                                                                         <span class="light">{Node}</span>
1008
1009                                                                         <b>_fnDomColumnButton</b>(i)
1010                                                                 </div>
1011
1012                                                                 <div class="description">
1013                                                                         Create the DOM for a show / hide button
1014
1015
1016
1017
1018                                                                 </div>
1019
1020
1021
1022
1023                                                                         <dl class="detailList params">
1024                                                                                 <dt class="heading">Parameters:</dt>
1025
1026                                                                                         <dt>
1027                                                                                                 <span class="light fixedFont">{int}</span> <b>i</b>
1028
1029                                                                                         </dt>
1030                                                                                         <dd>Column in question</dd>
1031
1032                                                                         </dl>
1033
1034
1035
1036                                                                         <dl class="detailList nomargin">
1037
1038
1039
1040
1041
1042
1043
1044
1045                                                                                         <dt class="heading">Returns:</dt>
1046
1047                                                                                                 <dd><span class="light fixedFont">{Node}</span> Created button</dd>
1048
1049
1050
1051
1052
1053
1054
1055                                                                         </dl>
1056
1057
1058                                                                 <div class="hr"></div>
1059
1060                                                                 <a name="_fnDomRestoreButton"></a>
1061
1062                                                                 <div class="fixedFont heading">
1063                                                                         <span class='lighter'>
1064                                                                         &lt;private&gt;
1065                                                                         </span>
1066
1067                                                                         <span class="light">{Node}</span>
1068
1069                                                                         <b>_fnDomRestoreButton</b>()
1070                                                                 </div>
1071
1072                                                                 <div class="description">
1073                                                                         Create a button which allows a "restore" action
1074
1075
1076
1077
1078                                                                 </div>
1079
1080
1081
1082
1083
1084
1085                                                                         <dl class="detailList nomargin">
1086
1087
1088
1089
1090
1091
1092
1093
1094                                                                                         <dt class="heading">Returns:</dt>
1095
1096                                                                                                 <dd><span class="light fixedFont">{Node}</span> Created button</dd>
1097
1098
1099
1100
1101
1102
1103
1104                                                                         </dl>
1105
1106
1107                                                                 <div class="hr"></div>
1108
1109                                                                 <a name="_fnDrawCallback"></a>
1110
1111                                                                 <div class="fixedFont heading">
1112                                                                         <span class='lighter'>
1113                                                                         &lt;private&gt;
1114                                                                         </span>
1115
1116
1117
1118                                                                         <b>_fnDrawCallback</b>()
1119                                                                 </div>
1120
1121                                                                 <div class="description">
1122                                                                         On each table draw, check the visiblity checkboxes as needed. This allows any process to
1123 update the table's column visiblity and ColVis will still be accurate.
1124
1125
1126
1127
1128                                                                 </div>
1129
1130
1131
1132
1133
1134
1135                                                                         <dl class="detailList nomargin">
1136
1137
1138
1139
1140
1141
1142
1143
1144                                                                                         <dt class="heading">Returns:</dt>
1145
1146                                                                                                 <dd>void</dd>
1147
1148
1149
1150
1151
1152
1153
1154                                                                         </dl>
1155
1156
1157                                                                 <div class="hr"></div>
1158
1159                                                                 <a name=".fnRebuild"></a>
1160
1161                                                                 <div class="fixedFont heading">
1162                                                                         <span class='lighter'>
1163                                                                         &lt;static&gt;
1164                                                                         </span>
1165
1166
1167
1168                                                                         <span class="light">ColVis.</span><b>fnRebuild</b>(object)
1169                                                                 </div>
1170
1171                                                                 <div class="description">
1172                                                                         Rebuild the collection for a given table, or all tables if no parameter given
1173
1174
1175
1176
1177                                                                 </div>
1178
1179
1180
1181
1182                                                                         <dl class="detailList params">
1183                                                                                 <dt class="heading">Parameters:</dt>
1184
1185                                                                                         <dt>
1186                                                                                                 <b>object</b>
1187
1188                                                                                         </dt>
1189                                                                                         <dd>oTable DataTable instance to consider - optional</dd>
1190
1191                                                                         </dl>
1192
1193
1194
1195                                                                         <dl class="detailList nomargin">
1196
1197
1198
1199
1200
1201
1202
1203
1204                                                                                         <dt class="heading">Returns:</dt>
1205
1206                                                                                                 <dd>void</dd>
1207
1208
1209
1210
1211
1212
1213
1214                                                                         </dl>
1215
1216
1217                                                                 <div class="hr"></div>
1218
1219                                                                 <a name="fnRebuild"></a>
1220
1221                                                                 <div class="fixedFont heading">
1222                                                                         <span class='lighter'>
1223
1224                                                                         </span>
1225
1226
1227
1228                                                                         <b>fnRebuild</b>()
1229                                                                 </div>
1230
1231                                                                 <div class="description">
1232                                                                         Rebuild the list of buttons for this instance (i.e. if there is a column header update)
1233
1234
1235
1236
1237                                                                 </div>
1238
1239
1240
1241
1242
1243
1244                                                                         <dl class="detailList nomargin">
1245
1246
1247
1248
1249
1250
1251
1252
1253                                                                                         <dt class="heading">Returns:</dt>
1254
1255                                                                                                 <dd>void</dd>
1256
1257
1258
1259
1260
1261
1262
1263                                                                         </dl>
1264
1265
1266
1267
1268                                                 </div>
1269                                         </div>
1270
1271
1272         <!--
1273         #### EVENT DETAILS
1274         -->
1275
1276                         </div>
1277                 </div>
1278         </body>
1279 </html>