yui/docs/Column.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3 <head>
   4         <title>API: datatable  Column   (YUI Library)</title>
   5         <link rel="stylesheet" type="text/css" href="assets/api.css">
   6 </head>
   7
   8 <body id="yahoo-com">
   9 <div id="doc3" class="yui-t2">
  10
  11         <div id="hd">
  12         <h1>Yahoo! UI Library</h1>
  13         <h3>DataTable Widget&nbsp; <span class="subtitle">2.2.0</span></h3>
  14         <p>
  15         <a href="./index.html">Yahoo! UI Library</a>
  16             &gt; <a href="./module_datatable.html">datatable</a>
  17                  &gt; Column
  18
  19             </p>
  20         </div>
  21
  22         <div id="bd">
  23                 <div id="yui-main">
  24                         <div class="yui-b">
  25
  26
  27                     <h2>
  28
  29
  30
  31
  32                             Class <b>Column</b>
  33                         <span class="extends">
  34                         </span>
  35
  36                         <span class="extends">
  37                         </span>
  38
  39                         </code>
  40                     </h2>
  41                     <!-- class tree goes here -->
  42
  43
  44
  45
  46                     <div class="summary description">
  47                         The Column class defines and manages attributes of DataTable Columns
  48                     </div>
  49
  50                         <div class="section constructor details">
  51                         <h3><a name="constructor_detail">Constructor</a></h3>
  52                         <div class="content">
  53                             <div class="detail">
  54                                 <strong>Column</strong>
  55                                 <code>
  56                                     (
  57
  58
  59
  60                                                 oConfigs
  61                                     )
  62                                 </code>
  63                                 <div class="description">
  64                                         <dl>
  65                                             <dt>Parameters:</dt>
  66                                                 <dd>
  67                                                     <code>oConfigs
  68                                                     &lt;Object&gt;
  69                                                     </code>
  70                                                       Object literal of configuration values.
  71                                                 </dd>
  72                                         </dl>
  73
  74
  75                                 </div>
  76                             </div>
  77                         </div>
  78                     </div>
  79
  80                         <div class="section field details">
  81                             <h3><a name="field_detail">Properties</a></h3>
  82                             <div class="content">
  83                                     <h4><a name="_children">_children</a>
  84                                         <code>- private YAHOO.widget.Column[]</code>
  85                                     </h4>
  86                                     <div class="detail">
  87                                         <div class="description">
  88                                             Array of Column's chilren, or null.
  89                                         </div>
  90                                     </div>
  91
  92
  93
  94
  95                                     <hr />
  96                                     <h4><a name="_colspan">_colspan</a>
  97                                         <code>- private Number</code>
  98                                     </h4>
  99                                     <div class="detail">
 100                                         <div class="description">
 101                                             Number of table cells the Column spans.
 102                                         </div>
 103                                     </div>
 104
 105
 106
 107
 108                                     <hr />
 109                                     <h4><a name="_id">_id</a>
 110                                         <code>- private String</code>
 111                                     </h4>
 112                                     <div class="detail">
 113                                         <div class="description">
 114                                             Unique ID, also assigned as DOM ID.
 115                                         </div>
 116                                     </div>
 117
 118
 119
 120
 121                                     <hr />
 122                                     <h4><a name="_index">_index</a>
 123                                         <code>- private Number</code>
 124                                     </h4>
 125                                     <div class="detail">
 126                                         <div class="description">
 127                                             Reference to Column's index within its ColumnSet's key array, or null if not applicable.
 128                                         </div>
 129                                     </div>
 130
 131
 132
 133
 134                                     <hr />
 135                                     <h4><a name="_minWidth">_minWidth</a>
 136                                         <code>- private Number</code>
 137                                     </h4>
 138                                     <div class="detail">
 139                                         <div class="description">
 140                                             Minimum width the Column can support (in pixels). Value is populated only if table
 141 is fixedwidth, null otherwise.
 142                                         </div>
 143                                     </div>
 144
 145
 146
 147
 148                                     <hr />
 149                                     <h4><a name="_nCount">_nCount</a>
 150                                         <code>- static Number</code>
 151                                     </h4>
 152                                     <div class="detail">
 153                                         <div class="description">
 154                                             Internal instance counter.
 155                                         </div>
 156                                     </div>
 157
 158
 159                                     <div class="default">
 160                                         Default Value: 0
 161                                     </div>
 162
 163
 164                                     <hr />
 165                                     <h4><a name="_parent">_parent</a>
 166                                         <code>- private YAHOO.widget.Column</code>
 167                                     </h4>
 168                                     <div class="detail">
 169                                         <div class="description">
 170                                             Column's parent, or null.
 171                                         </div>
 172                                     </div>
 173
 174
 175
 176
 177                                     <hr />
 178                                     <h4><a name="_rowspan">_rowspan</a>
 179                                         <code>- private Number</code>
 180                                     </h4>
 181                                     <div class="detail">
 182                                         <div class="description">
 183                                             Number of table rows the Column spans.
 184                                         </div>
 185                                     </div>
 186
 187
 188
 189
 190                                     <hr />
 191                                     <h4><a name="_width">_width</a>
 192                                         <code>- private Number</code>
 193                                     </h4>
 194                                     <div class="detail">
 195                                         <div class="description">
 196                                             Current offsetWidth of the Column (in pixels).
 197                                         </div>
 198                                     </div>
 199
 200
 201
 202
 203                                     <hr />
 204                                     <h4><a name="abbr">abbr</a>
 205                                         <code>- String</code>
 206                                     </h4>
 207                                     <div class="detail">
 208                                         <div class="description">
 209                                             Column head cell ABBR for accessibility.
 210                                         </div>
 211                                     </div>
 212
 213
 214
 215
 216                                     <hr />
 217                                     <h4><a name="children">children</a>
 218                                         <code>- Object[]</code>
 219                                     </h4>
 220                                     <div class="detail">
 221                                         <div class="description">
 222                                             Array of object literals that define children (nested headers) of a Column.
 223                                         </div>
 224                                     </div>
 225
 226
 227
 228
 229                                     <hr />
 230                                     <h4><a name="className">className</a>
 231                                         <code>- String</code>
 232                                     </h4>
 233                                     <div class="detail">
 234                                         <div class="description">
 235                                             Custom CSS class to be applied to every cell in the Column.
 236                                         </div>
 237                                     </div>
 238
 239
 240
 241
 242                                     <hr />
 243                                     <h4><a name="editor">editor</a>
 244                                         <code>- String</code>
 245                                     </h4>
 246                                     <div class="detail">
 247                                         <div class="description">
 248                                             Defines the type of editor for Column, otherwise Column is not editable.
 249                                         </div>
 250                                     </div>
 251
 252
 253
 254
 255                                     <hr />
 256                                     <h4><a name="formatter">formatter</a>
 257                                         <code>- HTMLFunction</code>
 258                                     </h4>
 259                                     <div class="detail">
 260                                         <div class="description">
 261                                             Defines a custom format function for Column, otherwise default is used,
 262 according to Column type.
 263                                         </div>
 264                                     </div>
 265
 266
 267
 268
 269                                     <hr />
 270                                     <h4><a name="key">key</a>
 271                                         <code>- String</code>
 272                                     </h4>
 273                                     <div class="detail">
 274                                         <div class="description">
 275                                             Associated database field, or null.
 276                                         </div>
 277                                     </div>
 278
 279
 280
 281
 282                                     <hr />
 283                                     <h4><a name="parser">parser</a>
 284                                         <code>- HTMLFunction</code>
 285                                     </h4>
 286                                     <div class="detail">
 287                                         <div class="description">
 288                                             Defines a custom parse function for Column, otherwise default is used,
 289 according to Column type.
 290                                         </div>
 291                                     </div>
 292
 293
 294
 295
 296                                     <hr />
 297                                     <h4><a name="resizeable">resizeable</a>
 298                                         <code>- Boolean</code>
 299                                     </h4>
 300                                     <div class="detail">
 301                                         <div class="description">
 302                                             True if Column is resizeable, false otherwise.
 303                                         </div>
 304                                     </div>
 305
 306
 307                                     <div class="default">
 308                                         Default Value: false
 309                                     </div>
 310
 311
 312                                     <hr />
 313                                     <h4><a name="sortable">sortable</a>
 314                                         <code>- Boolean</code>
 315                                     </h4>
 316                                     <div class="detail">
 317                                         <div class="description">
 318                                             True if Column is sortable, false otherwise.
 319                                         </div>
 320                                     </div>
 321
 322
 323                                     <div class="default">
 324                                         Default Value: false
 325                                     </div>
 326
 327
 328                                     <hr />
 329                                     <h4><a name="sortOptions.ascFunction">sortOptions.ascFunction</a>
 330                                         <code>- Function</code>
 331                                     </h4>
 332                                     <div class="detail">
 333                                         <div class="description">
 334                                             Custom sort handler to arrange Column in ascending order.
 335                                         </div>
 336                                     </div>
 337
 338
 339                                     <div class="default">
 340                                         Default Value: null
 341                                     </div>
 342
 343
 344                                     <hr />
 345                                     <h4><a name="sortOptions.descFunction">sortOptions.descFunction</a>
 346                                         <code>- Function</code>
 347                                     </h4>
 348                                     <div class="detail">
 349                                         <div class="description">
 350                                             Custom sort handler to arrange Column in descending order.
 351                                         </div>
 352                                     </div>
 353
 354
 355                                     <div class="default">
 356                                         Default Value: null
 357                                     </div>
 358
 359
 360                                     <hr />
 361                                     <h4><a name="text">text</a>
 362                                         <code>- String</code>
 363                                     </h4>
 364                                     <div class="detail">
 365                                         <div class="description">
 366                                             Text or HTML for display in Column's assocated TH element.
 367                                         </div>
 368                                     </div>
 369
 370
 371
 372
 373                                     <hr />
 374                                     <h4><a name="type">type</a>
 375                                         <code>- String</code>
 376                                     </h4>
 377                                     <div class="detail">
 378                                         <div class="description">
 379                                             Data types: "string", "number", "date", "currency", "checkbox", "select",
 380 "email", "link".
 381                                         </div>
 382                                     </div>
 383
 384
 385                                     <div class="default">
 386                                         Default Value: "string"
 387                                     </div>
 388
 389
 390                                     <hr />
 391                                     <h4><a name="width">width</a>
 392                                         <code>- String</code>
 393                                     </h4>
 394                                     <div class="detail">
 395                                         <div class="description">
 396                                             Column width.
 397                                         </div>
 398                                     </div>
 399
 400
 401
 402
 403                                     <hr />
 404
 405
 406                             </div>
 407                         </div>
 408
 409
 410                         <div class="section method details">
 411                             <h3><a name="methodDetails">Methods</a></h3>
 412                             <div class="content">
 413                                     <h4>
 414                                         <a name="format">format</a></h4>
 415                                     <div class="detail">
 416                                         <code>
 417
 418
 419
 420                                         HTML
 421                                             <strong>format</strong>
 422                                            (
 423
 424
 425                                                          elCell
 426
 427
 428                                                         ,
 429                                                          oRecord
 430
 431
 432                                             )
 433                                         </code>
 434
 435                                         <div class="description">
 436                                             Outputs markup into the given TD based on given Record.
 437                                         </div>
 438
 439                                         <div class="description">
 440
 441                                                 <dl>
 442                                                     <dt>Parameters:</dt>
 443                                                         <dd>
 444                                                             <code>elCell &lt;HTMLElement&gt;</code>
 445                                                               TD to format for display.
 446                                                         </dd>
 447                                                         <dd>
 448                                                             <code>oRecord &lt;YAHOO.widget.Record&gt;</code>
 449                                                               Record that holds data for the row.
 450                                                         </dd>
 451                                                 </dl>
 452
 453                                                 <dl>
 454                                                     <dt>Returns:
 455                                                     <code>
 456                                                         HTML
 457                                                     </code></dt>
 458                                                     <dd>Markup.</dd>
 459                                                 </dl>
 460
 461                                         </div>
 462
 463                                     </div>
 464                                     <hr />
 465                                     <h4>
 466                                         <a name="formatCheckbox">formatCheckbox</a></h4>
 467                                     <div class="detail">
 468                                         <code>
 469
 470                                          static
 471
 472                                         void
 473                                             <strong>formatCheckbox</strong>
 474                                            (
 475
 476
 477                                                          elCell
 478
 479
 480                                                         ,
 481                                                          oRecord
 482
 483
 484                                                         ,
 485                                                          oColumn
 486
 487
 488                                                         ,
 489                                                          oData
 490
 491
 492                                             )
 493                                         </code>
 494
 495                                         <div class="description">
 496                                             Formats cells in Columns of type "checkbox".
 497                                         </div>
 498
 499                                         <div class="description">
 500
 501                                                 <dl>
 502                                                     <dt>Parameters:</dt>
 503                                                         <dd>
 504                                                             <code>elCell &lt;HTMLElement&gt;</code>
 505                                                               Table cell element.
 506                                                         </dd>
 507                                                         <dd>
 508                                                             <code>oRecord &lt;YAHOO.widget.Record&gt;</code>
 509                                                               Record instance.
 510                                                         </dd>
 511                                                         <dd>
 512                                                             <code>oColumn &lt;YAHOO.widget.Column&gt;</code>
 513                                                               Column instance.
 514                                                         </dd>
 515                                                         <dd>
 516                                                             <code>oData &lt;Object&gt;</code>
 517                                                               Data value for the cell, or null
 518                                                         </dd>
 519                                                 </dl>
 520
 521                                                 <dl>
 522                                                     <dt>Returns:
 523                                                     <code>
 524                                                         void
 525                                                     </code></dt>
 526                                                     <dd></dd>
 527                                                 </dl>
 528
 529                                         </div>
 530
 531                                     </div>
 532                                     <hr />
 533                                     <h4>
 534                                         <a name="formatCurrency">formatCurrency</a></h4>
 535                                     <div class="detail">
 536                                         <code>
 537
 538                                          static
 539
 540                                         void
 541                                             <strong>formatCurrency</strong>
 542                                            (
 543
 544
 545                                                          elCell
 546
 547
 548                                                         ,
 549                                                          oRecord
 550
 551
 552                                                         ,
 553                                                          oColumn
 554
 555
 556                                                         ,
 557                                                          oData
 558
 559
 560                                             )
 561                                         </code>
 562
 563                                         <div class="description">
 564                                             Formats cells in Columns of type "currency". Can be overridden for custom formatting.
 565                                         </div>
 566
 567                                         <div class="description">
 568
 569                                                 <dl>
 570                                                     <dt>Parameters:</dt>
 571                                                         <dd>
 572                                                             <code>elCell &lt;HTMLElement&gt;</code>
 573                                                               Table cell element.
 574                                                         </dd>
 575                                                         <dd>
 576                                                             <code>oRecord &lt;YAHOO.widget.Record&gt;</code>
 577                                                               Record instance.
 578                                                         </dd>
 579                                                         <dd>
 580                                                             <code>oColumn &lt;YAHOO.widget.Column&gt;</code>
 581                                                               Column instance.
 582                                                         </dd>
 583                                                         <dd>
 584                                                             <code>oData &lt;Object&gt;</code>
 585                                                               Data value for the cell, or null
 586                                                         </dd>
 587                                                 </dl>
 588
 589                                                 <dl>
 590                                                     <dt>Returns:
 591                                                     <code>
 592                                                         void
 593                                                     </code></dt>
 594                                                     <dd></dd>
 595                                                 </dl>
 596
 597                                         </div>
 598
 599                                     </div>
 600                                     <hr />
 601                                     <h4>
 602                                         <a name="formatDate">formatDate</a></h4>
 603                                     <div class="detail">
 604                                         <code>
 605
 606                                          static
 607
 608                                         void
 609                                             <strong>formatDate</strong>
 610                                            (
 611
 612
 613                                                          elCell
 614
 615
 616                                                         ,
 617                                                          oRecord
 618
 619
 620                                                         ,
 621                                                          oColumn
 622
 623
 624                                                         ,
 625                                                          oData
 626
 627
 628                                             )
 629                                         </code>
 630
 631                                         <div class="description">
 632                                             Formats cells in Columns of type "date".
 633                                         </div>
 634
 635                                         <div class="description">
 636
 637                                                 <dl>
 638                                                     <dt>Parameters:</dt>
 639                                                         <dd>
 640                                                             <code>elCell &lt;HTMLElement&gt;</code>
 641                                                               Table cell element.
 642                                                         </dd>
 643                                                         <dd>
 644                                                             <code>oRecord &lt;YAHOO.widget.Record&gt;</code>
 645                                                               Record instance.
 646                                                         </dd>
 647                                                         <dd>
 648                                                             <code>oColumn &lt;YAHOO.widget.Column&gt;</code>
 649                                                               Column instance.
 650                                                         </dd>
 651                                                         <dd>
 652                                                             <code>oData &lt;Object&gt;</code>
 653                                                               Data value for the cell, or null
 654                                                         </dd>
 655                                                 </dl>
 656
 657                                                 <dl>
 658                                                     <dt>Returns:
 659                                                     <code>
 660                                                         void
 661                                                     </code></dt>
 662                                                     <dd></dd>
 663                                                 </dl>
 664
 665                                         </div>
 666
 667                                     </div>
 668                                     <hr />
 669                                     <h4>
 670                                         <a name="formatEmail">formatEmail</a></h4>
 671                                     <div class="detail">
 672                                         <code>
 673
 674                                          static
 675
 676                                         void
 677                                             <strong>formatEmail</strong>
 678                                            (
 679
 680
 681                                                          elCell
 682
 683
 684                                                         ,
 685                                                          oRecord
 686
 687
 688                                                         ,
 689                                                          oColumn
 690
 691
 692                                                         ,
 693                                                          oData
 694
 695
 696                                             )
 697                                         </code>
 698
 699                                         <div class="description">
 700                                             Formats cells in Columns of type "email".
 701                                         </div>
 702
 703                                         <div class="description">
 704
 705                                                 <dl>
 706                                                     <dt>Parameters:</dt>
 707                                                         <dd>
 708                                                             <code>elCell &lt;HTMLElement&gt;</code>
 709                                                               Table cell element.
 710                                                         </dd>
 711                                                         <dd>
 712                                                             <code>oRecord &lt;YAHOO.widget.Record&gt;</code>
 713                                                               Record instance.
 714                                                         </dd>
 715                                                         <dd>
 716                                                             <code>oColumn &lt;YAHOO.widget.Column&gt;</code>
 717                                                               Column instance.
 718                                                         </dd>
 719                                                         <dd>
 720                                                             <code>oData &lt;Object&gt;</code>
 721                                                               Data value for the cell, or null
 722                                                         </dd>
 723                                                 </dl>
 724
 725                                                 <dl>
 726                                                     <dt>Returns:
 727                                                     <code>
 728                                                         void
 729                                                     </code></dt>
 730                                                     <dd></dd>
 731                                                 </dl>
 732
 733                                         </div>
 734
 735                                     </div>
 736                                     <hr />
 737                                     <h4>
 738                                         <a name="formatLink">formatLink</a></h4>
 739                                     <div class="detail">
 740                                         <code>
 741
 742                                          static
 743
 744                                         void
 745                                             <strong>formatLink</strong>
 746                                            (
 747
 748
 749                                                          elCell
 750
 751
 752                                                         ,
 753                                                          oRecord
 754
 755
 756                                                         ,
 757                                                          oColumn
 758
 759
 760                                                         ,
 761                                                          oData
 762
 763
 764                                             )
 765                                         </code>
 766
 767                                         <div class="description">
 768                                             Formats cells in Columns of type "link".
 769                                         </div>
 770
 771                                         <div class="description">
 772
 773                                                 <dl>
 774                                                     <dt>Parameters:</dt>
 775                                                         <dd>
 776                                                             <code>elCell &lt;HTMLElement&gt;</code>
 777                                                               Table cell element.
 778                                                         </dd>
 779                                                         <dd>
 780                                                             <code>oRecord &lt;YAHOO.widget.Record&gt;</code>
 781                                                               Record instance.
 782                                                         </dd>
 783                                                         <dd>
 784                                                             <code>oColumn &lt;YAHOO.widget.Column&gt;</code>
 785                                                               Column instance.
 786                                                         </dd>
 787                                                         <dd>
 788                                                             <code>oData &lt;Object&gt;</code>
 789                                                               Data value for the cell, or null
 790                                                         </dd>
 791                                                 </dl>
 792
 793                                                 <dl>
 794                                                     <dt>Returns:
 795                                                     <code>
 796                                                         void
 797                                                     </code></dt>
 798                                                     <dd></dd>
 799                                                 </dl>
 800
 801                                         </div>
 802
 803                                     </div>
 804                                     <hr />
 805                                     <h4>
 806                                         <a name="formatNumber">formatNumber</a></h4>
 807                                     <div class="detail">
 808                                         <code>
 809
 810                                          static
 811
 812                                         void
 813                                             <strong>formatNumber</strong>
 814                                            (
 815
 816
 817                                                          elCell
 818
 819
 820                                                         ,
 821                                                          oRecord
 822
 823
 824                                                         ,
 825                                                          oColumn
 826
 827
 828                                                         ,
 829                                                          oData
 830
 831
 832                                             )
 833                                         </code>
 834
 835                                         <div class="description">
 836                                             Formats cells in Columns of type "number".
 837                                         </div>
 838
 839                                         <div class="description">
 840
 841                                                 <dl>
 842                                                     <dt>Parameters:</dt>
 843                                                         <dd>
 844                                                             <code>elCell &lt;HTMLElement&gt;</code>
 845                                                               Table cell element.
 846                                                         </dd>
 847                                                         <dd>
 848                                                             <code>oRecord &lt;YAHOO.widget.Record&gt;</code>
 849                                                               Record instance.
 850                                                         </dd>
 851                                                         <dd>
 852                                                             <code>oColumn &lt;YAHOO.widget.Column&gt;</code>
 853                                                               Column instance.
 854                                                         </dd>
 855                                                         <dd>
 856                                                             <code>oData &lt;Object&gt;</code>
 857                                                               Data value for the cell, or null
 858                                                         </dd>
 859                                                 </dl>
 860
 861                                                 <dl>
 862                                                     <dt>Returns:
 863                                                     <code>
 864                                                         void
 865                                                     </code></dt>
 866                                                     <dd></dd>
 867                                                 </dl>
 868
 869                                         </div>
 870
 871                                     </div>
 872                                     <hr />
 873                                     <h4>
 874                                         <a name="formatSelect">formatSelect</a></h4>
 875                                     <div class="detail">
 876                                         <code>
 877
 878                                          static
 879
 880                                         void
 881                                             <strong>formatSelect</strong>
 882                                            (
 883
 884
 885                                                          elCell
 886
 887
 888                                                         ,
 889                                                          oRecord
 890
 891
 892                                                         ,
 893                                                          oColumn
 894
 895
 896                                                         ,
 897                                                          oData
 898
 899
 900                                             )
 901                                         </code>
 902
 903                                         <div class="description">
 904                                             Formats cells in Columns of type "select".
 905                                         </div>
 906
 907                                         <div class="description">
 908
 909                                                 <dl>
 910                                                     <dt>Parameters:</dt>
 911                                                         <dd>
 912                                                             <code>elCell &lt;HTMLElement&gt;</code>
 913                                                               Table cell element.
 914                                                         </dd>
 915                                                         <dd>
 916                                                             <code>oRecord &lt;YAHOO.widget.Record&gt;</code>
 917                                                               Record instance.
 918                                                         </dd>
 919                                                         <dd>
 920                                                             <code>oColumn &lt;YAHOO.widget.Column&gt;</code>
 921                                                               Column instance.
 922                                                         </dd>
 923                                                         <dd>
 924                                                             <code>oData &lt;Object&gt;</code>
 925                                                               Data value for the cell, or null
 926                                                         </dd>
 927                                                 </dl>
 928
 929                                                 <dl>
 930                                                     <dt>Returns:
 931                                                     <code>
 932                                                         void
 933                                                     </code></dt>
 934                                                     <dd></dd>
 935                                                 </dl>
 936
 937                                         </div>
 938
 939                                     </div>
 940                                     <hr />
 941                                     <h4>
 942                                         <a name="getColSpan">getColSpan</a></h4>
 943                                     <div class="detail">
 944                                         <code>
 945
 946
 947
 948                                         Number
 949                                             <strong>getColSpan</strong>
 950                                            (
 951                                             )
 952                                         </code>
 953
 954                                         <div class="description">
 955                                             Public accessor returns Column's colspan number.
 956                                         </div>
 957
 958                                         <div class="description">
 959
 960
 961                                                 <dl>
 962                                                     <dt>Returns:
 963                                                     <code>
 964                                                         Number
 965                                                     </code></dt>
 966                                                     <dd>Column's colspan number.</dd>
 967                                                 </dl>
 968
 969                                         </div>
 970
 971                                     </div>
 972                                     <hr />
 973                                     <h4>
 974                                         <a name="getId">getId</a></h4>
 975                                     <div class="detail">
 976                                         <code>
 977
 978
 979
 980                                         String
 981                                             <strong>getId</strong>
 982                                            (
 983                                             )
 984                                         </code>
 985
 986                                         <div class="description">
 987                                             Public accessor returns Column's ID string.
 988                                         </div>
 989
 990                                         <div class="description">
 991
 992
 993                                                 <dl>
 994                                                     <dt>Returns:
 995                                                     <code>
 996                                                         String
 997                                                     </code></dt>
 998                                                     <dd>Column's ID string.</dd>
 999                                                 </dl>
1000
1001                                         </div>
1002
1003                                     </div>
1004                                     <hr />
1005                                     <h4>
1006                                         <a name="getRowSpan">getRowSpan</a></h4>
1007                                     <div class="detail">
1008                                         <code>
1009
1010
1011
1012                                         Number
1013                                             <strong>getRowSpan</strong>
1014                                            (
1015                                             )
1016                                         </code>
1017
1018                                         <div class="description">
1019                                             Public accessor returns Column's rowspan number.
1020                                         </div>
1021
1022                                         <div class="description">
1023
1024
1025                                                 <dl>
1026                                                     <dt>Returns:
1027                                                     <code>
1028                                                         Number
1029                                                     </code></dt>
1030                                                     <dd>Column's rowspan number.</dd>
1031                                                 </dl>
1032
1033                                         </div>
1034
1035                                     </div>
1036                                     <hr />
1037                                     <h4>
1038                                         <a name="parse">parse</a></h4>
1039                                     <div class="detail">
1040                                         <code>
1041
1042
1043
1044                                         Object
1045                                             <strong>parse</strong>
1046                                            (
1047
1048
1049                                                          sMarkup
1050
1051
1052                                             )
1053                                         </code>
1054
1055                                         <div class="description">
1056                                             Takes innerHTML from TD and parses out data for storage in RecordSet.
1057                                         </div>
1058
1059                                         <div class="description">
1060
1061                                                 <dl>
1062                                                     <dt>Parameters:</dt>
1063                                                         <dd>
1064                                                             <code>sMarkup &lt;String&gt;</code>
1065                                                               The TD's innerHTML value.
1066                                                         </dd>
1067                                                 </dl>
1068
1069                                                 <dl>
1070                                                     <dt>Returns:
1071                                                     <code>
1072                                                         Object
1073                                                     </code></dt>
1074                                                     <dd>Data.</dd>
1075                                                 </dl>
1076
1077                                         </div>
1078
1079                                     </div>
1080                                     <hr />
1081                                     <h4>
1082                                         <a name="parseCheckbox">parseCheckbox</a></h4>
1083                                     <div class="detail">
1084                                         <code>
1085
1086
1087
1088                                         bChecked
1089                                             <strong>parseCheckbox</strong>
1090                                            (
1091
1092
1093                                                          sMarkup
1094
1095
1096                                             )
1097                                         </code>
1098
1099                                         <div class="description">
1100                                             Default parse function for Columns of type "checkbox" takes markup and
1101 extracts data. Can be overridden for custom parsing.
1102                                         </div>
1103
1104                                         <div class="description">
1105
1106                                                 <dl>
1107                                                     <dt>Parameters:</dt>
1108                                                         <dd>
1109                                                             <code>sMarkup &lt;object&gt;</code>
1110
1111                                                         </dd>
1112                                                 </dl>
1113
1114                                                 <dl>
1115                                                     <dt>Returns:
1116                                                     <code>
1117                                                         bChecked
1118                                                     </code></dt>
1119                                                     <dd>True if checkbox is checked.</dd>
1120                                                 </dl>
1121
1122                                         </div>
1123
1124                                     </div>
1125                                     <hr />
1126                                     <h4>
1127                                         <a name="parseCurrency">parseCurrency</a></h4>
1128                                     <div class="detail">
1129                                         <code>
1130
1131
1132
1133                                         nAmount
1134                                             <strong>parseCurrency</strong>
1135                                            (
1136
1137
1138                                                          sMarkup
1139
1140
1141                                             )
1142                                         </code>
1143
1144                                         <div class="description">
1145                                             Default parse function for Columns of type "currency" takes markup and
1146 extracts data. Can be overridden for custom parsing.
1147                                         </div>
1148
1149                                         <div class="description">
1150
1151                                                 <dl>
1152                                                     <dt>Parameters:</dt>
1153                                                         <dd>
1154                                                             <code>sMarkup &lt;object&gt;</code>
1155
1156                                                         </dd>
1157                                                 </dl>
1158
1159                                                 <dl>
1160                                                     <dt>Returns:
1161                                                     <code>
1162                                                         nAmount
1163                                                     </code></dt>
1164                                                     <dd>Floating point amount.</dd>
1165                                                 </dl>
1166
1167                                         </div>
1168
1169                                     </div>
1170                                     <hr />
1171                                     <h4>
1172                                         <a name="parseDate">parseDate</a></h4>
1173                                     <div class="detail">
1174                                         <code>
1175
1176
1177
1178                                         oDate
1179                                             <strong>parseDate</strong>
1180                                            (
1181
1182
1183                                                          sMarkup
1184
1185
1186                                             )
1187                                         </code>
1188
1189                                         <div class="description">
1190                                             Default parse function for Columns of type "date" takes markup and extracts
1191 data. Can be overridden for custom parsing.
1192                                         </div>
1193
1194                                         <div class="description">
1195
1196                                                 <dl>
1197                                                     <dt>Parameters:</dt>
1198                                                         <dd>
1199                                                             <code>sMarkup &lt;object&gt;</code>
1200
1201                                                         </dd>
1202                                                 </dl>
1203
1204                                                 <dl>
1205                                                     <dt>Returns:
1206                                                     <code>
1207                                                         oDate
1208                                                     </code></dt>
1209                                                     <dd>Date instance.</dd>
1210                                                 </dl>
1211
1212                                         </div>
1213
1214                                     </div>
1215                                     <hr />
1216                                     <h4>
1217                                         <a name="parseNumber">parseNumber</a></h4>
1218                                     <div class="detail">
1219                                         <code>
1220
1221
1222
1223                                         nNumber
1224                                             <strong>parseNumber</strong>
1225                                            (
1226
1227
1228                                                          sMarkup
1229
1230
1231                                             )
1232                                         </code>
1233
1234                                         <div class="description">
1235                                             Default parse function for Columns of type "number" takes markup and extracts
1236 data. Can be overridden for custom parsing.
1237                                         </div>
1238
1239                                         <div class="description">
1240
1241                                                 <dl>
1242                                                     <dt>Parameters:</dt>
1243                                                         <dd>
1244                                                             <code>sMarkup &lt;object&gt;</code>
1245
1246                                                         </dd>
1247                                                 </dl>
1248
1249                                                 <dl>
1250                                                     <dt>Returns:
1251                                                     <code>
1252                                                         nNumber
1253                                                     </code></dt>
1254                                                     <dd>Number.</dd>
1255                                                 </dl>
1256
1257                                         </div>
1258
1259                                     </div>
1260                                     <hr />
1261                                     <h4>
1262                                         <a name="parseSelect">parseSelect</a></h4>
1263                                     <div class="detail">
1264                                         <code>
1265
1266
1267
1268                                         sValue
1269                                             <strong>parseSelect</strong>
1270                                            (
1271
1272
1273                                                          sMarkup
1274
1275
1276                                             )
1277                                         </code>
1278
1279                                         <div class="description">
1280                                             Default parse function for Columns of type "select" takes markup and extracts
1281 data. Can be overridden for custom parsing.
1282                                         </div>
1283
1284                                         <div class="description">
1285
1286                                                 <dl>
1287                                                     <dt>Parameters:</dt>
1288                                                         <dd>
1289                                                             <code>sMarkup &lt;object&gt;</code>
1290
1291                                                         </dd>
1292                                                 </dl>
1293
1294                                                 <dl>
1295                                                     <dt>Returns:
1296                                                     <code>
1297                                                         sValue
1298                                                     </code></dt>
1299                                                     <dd>Value of selected option.</dd>
1300                                                 </dl>
1301
1302                                         </div>
1303
1304                                     </div>
1305                                     <hr />
1306                                     <h4>
1307                                         <a name="showEditor">showEditor</a></h4>
1308                                     <div class="detail">
1309                                         <code>
1310
1311
1312
1313                                         void
1314                                             <strong>showEditor</strong>
1315                                            (
1316
1317
1318                                                          elCell
1319
1320
1321                                                         ,
1322                                                          oRecord
1323
1324
1325                                             )
1326                                         </code>
1327
1328                                         <div class="description">
1329                                             Outputs editor markup into the given TD based on given Record.
1330                                         </div>
1331
1332                                         <div class="description">
1333
1334                                                 <dl>
1335                                                     <dt>Parameters:</dt>
1336                                                         <dd>
1337                                                             <code>elCell &lt;HTMLElement&gt;</code>
1338                                                               The cell to edit.
1339                                                         </dd>
1340                                                         <dd>
1341                                                             <code>oRecord &lt;YAHOO.widget.Record&gt;</code>
1342                                                               The DataTable Record of the cell.
1343                                                         </dd>
1344                                                 </dl>
1345
1346                                                 <dl>
1347                                                     <dt>Returns:
1348                                                     <code>
1349                                                         void
1350                                                     </code></dt>
1351                                                     <dd>YAHOO.widget.ColumnEditor</dd>
1352                                                 </dl>
1353
1354                                         </div>
1355
1356                                     </div>
1357                                     <hr />
1358                             </div>
1359                         </div>
1360
1361
1362
1363
1364
1365
1366
1367                         </div>
1368                 </div>
1369                 <div class="yui-b">
1370             <div class="nav">
1371
1372                     <div class="module">
1373                         <h4>Modules</h4>
1374                         <ul class="content">
1375
1376                                 <li class=""><a href="module_animation.html">animation</a></li>
1377
1378                                 <li class=""><a href="module_autocomplete.html">autocomplete</a></li>
1379
1380                                 <li class=""><a href="module_button.html">button</a></li>
1381
1382                                 <li class=""><a href="module_calendar.html">calendar</a></li>
1383
1384                                 <li class=""><a href="module_connection.html">connection</a></li>
1385
1386                                 <li class=""><a href="module_container.html">container</a></li>
1387
1388                                 <li class=""><a href="module_datasource.html">datasource</a></li>
1389
1390                                 <li class="selected"><a href="module_datatable.html">datatable</a></li>
1391
1392                                 <li class=""><a href="module_dom.html">dom</a></li>
1393
1394                                 <li class=""><a href="module_dragdrop.html">dragdrop</a></li>
1395
1396                                 <li class=""><a href="module_element.html">element</a></li>
1397
1398                                 <li class=""><a href="module_event.html">event</a></li>
1399
1400                                 <li class=""><a href="module_history.html">history</a></li>
1401
1402                                 <li class=""><a href="module_logger.html">logger</a></li>
1403
1404                                 <li class=""><a href="module_menu.html">menu</a></li>
1405
1406                                 <li class=""><a href="module_slider.html">slider</a></li>
1407
1408                                 <li class=""><a href="module_tabview.html">tabview</a></li>
1409
1410                                 <li class=""><a href="module_treeview.html">treeview</a></li>
1411
1412                                 <li class=""><a href="module_yahoo.html">yahoo</a></li>
1413                         </ul>
1414                     </div>
1415
1416                     <div class="module">
1417                         <h4>Classes</h4>
1418                         <ul class="content">
1419                                 <li class="selected"><a href="Column.html">Column</a></li>
1420                                 <li class=""><a href="ColumnEditor.html">ColumnEditor</a></li>
1421                                 <li class=""><a href="ColumnSet.html">ColumnSet</a></li>
1422                                 <li class=""><a href="DataTable.html">DataTable</a></li>
1423                                 <li class=""><a href="Record.html">Record</a></li>
1424                                 <li class=""><a href="RecordSet.html">RecordSet</a></li>
1425                                 <li class=""><a href="Sort.html">Sort</a></li>
1426                                 <li class=""><a href="WidthResizer.html">WidthResizer</a></li>
1427                         </ul>
1428                     </div>
1429
1430                     <div class="module">
1431                         <h4>Files</h4>
1432                         <ul class="content">
1433                                 <li class=""><a href="ColumnSet.js.html">ColumnSet.js</a></li>
1434                                 <li class=""><a href="DataTable.js.html">DataTable.js</a></li>
1435                                 <li class=""><a href="RecordSet.js.html">RecordSet.js</a></li>
1436                         </ul>
1437                     </div>
1438
1439                     <div class="module">
1440                         <h4>Properties</h4>
1441                         <ul class="content">
1442                                 <li><a href="#_children">_children</a>
1443                                         <!--<code>&lt;String&gt;</code>-->
1444                                 </li>
1445                                 <li><a href="#_colspan">_colspan</a>
1446                                         <!--<code>&lt;String&gt;</code>-->
1447                                 </li>
1448                                 <li><a href="#_id">_id</a>
1449                                         <!--<code>&lt;String&gt;</code>-->
1450                                 </li>
1451                                 <li><a href="#_index">_index</a>
1452                                         <!--<code>&lt;String&gt;</code>-->
1453                                 </li>
1454                                 <li><a href="#_minWidth">_minWidth</a>
1455                                         <!--<code>&lt;String&gt;</code>-->
1456                                 </li>
1457                                 <li><a href="#_nCount">_nCount</a>
1458                                         <!--<code>&lt;String&gt;</code>-->
1459                                 </li>
1460                                 <li><a href="#_parent">_parent</a>
1461                                         <!--<code>&lt;String&gt;</code>-->
1462                                 </li>
1463                                 <li><a href="#_rowspan">_rowspan</a>
1464                                         <!--<code>&lt;String&gt;</code>-->
1465                                 </li>
1466                                 <li><a href="#_width">_width</a>
1467                                         <!--<code>&lt;String&gt;</code>-->
1468                                 </li>
1469                                 <li><a href="#abbr">abbr</a>
1470                                         <!--<code>&lt;String&gt;</code>-->
1471                                 </li>
1472                                 <li><a href="#children">children</a>
1473                                         <!--<code>&lt;String&gt;</code>-->
1474                                 </li>
1475                                 <li><a href="#className">className</a>
1476                                         <!--<code>&lt;String&gt;</code>-->
1477                                 </li>
1478                                 <li><a href="#editor">editor</a>
1479                                         <!--<code>&lt;String&gt;</code>-->
1480                                 </li>
1481                                 <li><a href="#formatter">formatter</a>
1482                                         <!--<code>&lt;String&gt;</code>-->
1483                                 </li>
1484                                 <li><a href="#key">key</a>
1485                                         <!--<code>&lt;String&gt;</code>-->
1486                                 </li>
1487                                 <li><a href="#parser">parser</a>
1488                                         <!--<code>&lt;String&gt;</code>-->
1489                                 </li>
1490                                 <li><a href="#resizeable">resizeable</a>
1491                                         <!--<code>&lt;String&gt;</code>-->
1492                                 </li>
1493                                 <li><a href="#sortable">sortable</a>
1494                                         <!--<code>&lt;String&gt;</code>-->
1495                                 </li>
1496                                 <li><a href="#sortOptions.ascFunction">sortOptions.ascFunction</a>
1497                                         <!--<code>&lt;String&gt;</code>-->
1498                                 </li>
1499                                 <li><a href="#sortOptions.descFunction">sortOptions.descFunction</a>
1500                                         <!--<code>&lt;String&gt;</code>-->
1501                                 </li>
1502                                 <li><a href="#text">text</a>
1503                                         <!--<code>&lt;String&gt;</code>-->
1504                                 </li>
1505                                 <li><a href="#type">type</a>
1506                                         <!--<code>&lt;String&gt;</code>-->
1507                                 </li>
1508                                 <li><a href="#width">width</a>
1509                                         <!--<code>&lt;String&gt;</code>-->
1510                                 </li>
1511                         </ul>
1512                     </div>
1513
1514                     <div class="module">
1515                         <h4>Methods</h4>
1516                         <ul class="content">
1517                                 <li><!--<code>HTML</code>-->
1518                                 <a href="#format">format</a>
1519                                 </li>
1520                                 <li><!--<code>void</code>-->
1521                                 <a href="#formatCheckbox">formatCheckbox</a>
1522                                 </li>
1523                                 <li><!--<code>void</code>-->
1524                                 <a href="#formatCurrency">formatCurrency</a>
1525                                 </li>
1526                                 <li><!--<code>void</code>-->
1527                                 <a href="#formatDate">formatDate</a>
1528                                 </li>
1529                                 <li><!--<code>void</code>-->
1530                                 <a href="#formatEmail">formatEmail</a>
1531                                 </li>
1532                                 <li><!--<code>void</code>-->
1533                                 <a href="#formatLink">formatLink</a>
1534                                 </li>
1535                                 <li><!--<code>void</code>-->
1536                                 <a href="#formatNumber">formatNumber</a>
1537                                 </li>
1538                                 <li><!--<code>void</code>-->
1539                                 <a href="#formatSelect">formatSelect</a>
1540                                 </li>
1541                                 <li><!--<code>Number</code>-->
1542                                 <a href="#getColSpan">getColSpan</a>
1543                                 </li>
1544                                 <li><!--<code>String</code>-->
1545                                 <a href="#getId">getId</a>
1546                                 </li>
1547                                 <li><!--<code>Number</code>-->
1548                                 <a href="#getRowSpan">getRowSpan</a>
1549                                 </li>
1550                                 <li><!--<code>Object</code>-->
1551                                 <a href="#parse">parse</a>
1552                                 </li>
1553                                 <li><!--<code>bChecked</code>-->
1554                                 <a href="#parseCheckbox">parseCheckbox</a>
1555                                 </li>
1556                                 <li><!--<code>nAmount</code>-->
1557                                 <a href="#parseCurrency">parseCurrency</a>
1558                                 </li>
1559                                 <li><!--<code>oDate</code>-->
1560                                 <a href="#parseDate">parseDate</a>
1561                                 </li>
1562                                 <li><!--<code>nNumber</code>-->
1563                                 <a href="#parseNumber">parseNumber</a>
1564                                 </li>
1565                                 <li><!--<code>sValue</code>-->
1566                                 <a href="#parseSelect">parseSelect</a>
1567                                 </li>
1568                                 <li><!--<code>void</code>-->
1569                                 <a href="#showEditor">showEditor</a>
1570                                 </li>
1571                         </ul>
1572                     </div>
1573
1574
1575
1576             </div>
1577                 </div>
1578         </div>
1579         <div id="ft">
1580         <hr />
1581         Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
1582         </div>
1583 </div>
1584 </body>
1585 </html>