git.roojs.org Git - roojs1/blob - docs/symbols/Roo.data.SortTypes.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2
   3
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5
   6         <head>
   7                 <meta http-equiv="content-type" content="text/html; charset=undefined" />
   8                 <meta name="generator" content="JsDoc Toolkit" />
   9
  10
  11                 <title>JsDoc Reference - Roo.data.SortTypes</title>
  12
  13
  14         <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
  15         <link rel="stylesheet" type="text/css" href="../default.css" />
  16
  17
  18         <script type="text/javascript" src="../page.js">
  19
  20         </script>
  21
  22
  23         </head>
  24
  25         <body onload="RooDocsPage.onload();">
  26
  27
  28 <div class="body-wrap">
  29
  30     <!-- ============================== links to methods. ================================= -->
  31
  32     <div class="top-tools">
  33     <!--
  34         <a class="inner-link" href="#Roo.data.SortTypes-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.data.SortTypes-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.data.SortTypes-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.data.SortTypes-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
  38         <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
  39         -->
  40     </div>
  41
  42
  43 <!-- ============================== inheritance Block. ================================= -->
  44
  45 <!-- ============================== class title / details ============================ -->
  46
  47
  48     <h1 class="classTitle">
  49
  50                                 Class Roo.data.SortTypes
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55                 <tr><td class="label">Package:</td><td class="hd-info">Roo.data</td></tr>
  56
  57         <tr><td class="label">Defined In:</td><td class="hd-info">
  58
  59                                         <a href="./src/Roo_data_SortTypes.js.html">Roo/data/SortTypes.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">SortTypes</td></tr>
  63
  64
  65
  66
  67     </table>
  68
  69
  70 <!-- ============================== class summary ========================== -->
  71     <div class="description">
  72         Defines the default sorting (casting?) comparison functions used when sorting data.
  73     </div>
  74
  75
  76 <!-- ============================== Class comment block... ========================== -->
  77
  78 <div class="comments">
  79         <b>Class Comments / Notes</B> =>
  80         <u onclick="parent.CommentDialog.showCommentId = 'Roo.data.SortTypes';">[Add Your comment/notes about this class]</u>
  81         <br/>
  82         <iframe frameborder="0"  id="comments-Roo.data" style="border: none;width:100%;"
  83                 src="/blog.php/GtkDjsComments/Roo.data.SortTypes.html"></iframe>
  84 </div>
  85
  86
  87
  88 <!-- ============================== config options ========================== -->
  89
  90
  91
  92
  93     <div class="hr"></div>
  94     <a id="Roo.data.SortTypes-configs"></a>
  95
  96
  97
  98      <table cellspacing="0" class="member-table">
  99       <caption class="Empty">Config Options - Has None</caption>
 100      </table>
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113   <!-- ============================== public properties ==================== -->
 114
 115
 116
 117     <a id="Roo.data.SortTypes-props"></a>
 118
 119
 120
 121
 122
 123
 124
 125       <table cellspacing="0" class="member-table">
 126       <caption>Public Properties </caption>
 127         <tr>
 128             <th class="sig-header" colspan="2">Property</th>
 129             <th class="sig-header">Description</th>
 130             <th class="msource-header">Defined By</th>
 131         </tr>
 132
 133
 134
 135
 136
 137
 138
 139
 140           <tr class="property-row config-row-alt0 notInherited">
 141             <td class="micon">
 142                 <a class="exi" href="#expand">&nbsp;</a>
 143             </td>
 144             <td class="sig">
 145                <a id="Roo.data.SortTypes-prop-stripTagsRE" name=".stripTagsRE"></a>
 146                <div class="fixedFont">
 147                     <span class="attributes">Roo.data.SortTypes.</span><b  class="itemname">stripTagsRE</b> :
 148                      <span type="etype"></span>
 149                      </div>
 150             </td>
 151             <td class="sig">
 152                 <div class="mdesc">
 153
 154
 155                    <div class="short">
 156                         The regular expression used to strip tags
 157
 158
 159
 160                    </div>
 161
 162                     <div class="long">
 163
 164                         The regular expression used to strip tags
 165
 166                 </div>
 167                 </div>
 168             </td>
 169
 170             <td class="msource">
 171             Roo.data.SortTypes
 172             </td>
 173
 174           </tr>
 175
 176
 177
 178
 179
 180         <!-- TODO: implement this alt row.  also notice non-linked "Defined by" when property is a part of this class.
 181         <tr class="property-row alt">
 182
 183         -->
 184
 185     </table>
 186
 187
 188   <!-- ============================== methods summary / details ======================== -->
 189
 190
 191   <a id="Roo.data.SortTypes-methods"></a>
 192         <!-- constructor?? -->
 193
 194         <!-- static's first
 195
 196
 197         -->
 198
 199         <!-- then dynamics first -->
 200
 201
 202
 203
 204
 205
 206       <table cellspacing="0" class="member-table">
 207       <caption>Public Methods</caption>
 208         <tr>
 209             <th class="sig-header" colspan="2">Method</th>
 210             <th class="msource-header">Defined By</th>
 211
 212         </tr>
 213
 214
 215
 216
 217
 218
 219
 220           <tr class="method-row config-row-alt0 expandable notInherited">
 221             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 222
 223
 224             <td class="sig">
 225                 <a id="Roo.data.SortTypes-method-asDate"   name=".asDate"></a>
 226                 <div class="fixedFont">
 227                         <span class="attributes">Roo.data.SortTypes.</span><b class="itemname">asDate</b>
 228
 229                                  (Mixed <B><i>s</i></B>)
 230
 231
 232                                          :
 233
 234
 235                                                 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 236
 237
 238
 239
 240
 241                 </div>
 242                 <div class="mdesc">
 243
 244                    <div class="short">Date sorting</div>
 245
 246
 247
 248                     <div class="long">
 249
 250                                 Date sorting
 251
 252
 253
 254
 255
 256
 257                                 <dl class="detailList">
 258                                 <dt class="heading">Parameters:</dt>
 259
 260                                         <dt>
 261                                                 <span class="fixedFont">Mixed</span>  <b>s</b>
 262
 263                                         </dt>
 264                                         <dd>The value being converted</dd>
 265
 266                                 </dl>
 267
 268
 269
 270
 271
 272                                 <dl class="detailList">
 273                                 <dt class="heading">Returns:</dt>
 274
 275                                         <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  The comparison value</dd>
 276
 277                                 </dl>
 278
 279
 280
 281
 282
 283
 284
 285                     </div>
 286                 </div>
 287
 288             </td>
 289             <td class="msource">
 290
 291                         Roo.data.SortTypes
 292                 &nbsp;
 293             </td>
 294         </tr>
 295
 296
 297           <tr class="method-row config-row-alt1 expandable notInherited">
 298             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 299
 300
 301             <td class="sig">
 302                 <a id="Roo.data.SortTypes-method-asFloat"   name=".asFloat"></a>
 303                 <div class="fixedFont">
 304                         <span class="attributes">Roo.data.SortTypes.</span><b class="itemname">asFloat</b>
 305
 306                                  (Mixed <B><i>s</i></B>)
 307
 308
 309                                          :
 310
 311
 312                                                 Float
 313
 314
 315
 316
 317
 318                 </div>
 319                 <div class="mdesc">
 320
 321                    <div class="short">Float sorting</div>
 322
 323
 324
 325                     <div class="long">
 326
 327                                 Float sorting
 328
 329
 330
 331
 332
 333
 334                                 <dl class="detailList">
 335                                 <dt class="heading">Parameters:</dt>
 336
 337                                         <dt>
 338                                                 <span class="fixedFont">Mixed</span>  <b>s</b>
 339
 340                                         </dt>
 341                                         <dd>The value being converted</dd>
 342
 343                                 </dl>
 344
 345
 346
 347
 348
 349                                 <dl class="detailList">
 350                                 <dt class="heading">Returns:</dt>
 351
 352                                         <dd><span class="fixedFont">Float</span>  The comparison value</dd>
 353
 354                                 </dl>
 355
 356
 357
 358
 359
 360
 361
 362                     </div>
 363                 </div>
 364
 365             </td>
 366             <td class="msource">
 367
 368                         Roo.data.SortTypes
 369                 &nbsp;
 370             </td>
 371         </tr>
 372
 373
 374           <tr class="method-row config-row-alt0 expandable notInherited">
 375             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 376
 377
 378             <td class="sig">
 379                 <a id="Roo.data.SortTypes-method-asInt"   name=".asInt"></a>
 380                 <div class="fixedFont">
 381                         <span class="attributes">Roo.data.SortTypes.</span><b class="itemname">asInt</b>
 382
 383                                  (Mixed <B><i>s</i></B>)
 384
 385
 386                                          :
 387
 388
 389                                                 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 390
 391
 392
 393
 394
 395                 </div>
 396                 <div class="mdesc">
 397
 398                    <div class="short">Integer sorting</div>
 399
 400
 401
 402                     <div class="long">
 403
 404                                 Integer sorting
 405
 406
 407
 408
 409
 410
 411                                 <dl class="detailList">
 412                                 <dt class="heading">Parameters:</dt>
 413
 414                                         <dt>
 415                                                 <span class="fixedFont">Mixed</span>  <b>s</b>
 416
 417                                         </dt>
 418                                         <dd>The value being converted</dd>
 419
 420                                 </dl>
 421
 422
 423
 424
 425
 426                                 <dl class="detailList">
 427                                 <dt class="heading">Returns:</dt>
 428
 429                                         <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  The comparison value</dd>
 430
 431                                 </dl>
 432
 433
 434
 435
 436
 437
 438
 439                     </div>
 440                 </div>
 441
 442             </td>
 443             <td class="msource">
 444
 445                         Roo.data.SortTypes
 446                 &nbsp;
 447             </td>
 448         </tr>
 449
 450
 451           <tr class="method-row config-row-alt1 expandable notInherited">
 452             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 453
 454
 455             <td class="sig">
 456                 <a id="Roo.data.SortTypes-method-asText"   name=".asText"></a>
 457                 <div class="fixedFont">
 458                         <span class="attributes">Roo.data.SortTypes.</span><b class="itemname">asText</b>
 459
 460                                  (Mixed <B><i>s</i></B>)
 461
 462
 463                                          :
 464
 465
 466                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 467
 468
 469
 470
 471
 472                 </div>
 473                 <div class="mdesc">
 474
 475                    <div class="short">Strips all HTML tags to sort on text only</div>
 476
 477
 478
 479                     <div class="long">
 480
 481                                 Strips all HTML tags to sort on text only
 482
 483
 484
 485
 486
 487
 488                                 <dl class="detailList">
 489                                 <dt class="heading">Parameters:</dt>
 490
 491                                         <dt>
 492                                                 <span class="fixedFont">Mixed</span>  <b>s</b>
 493
 494                                         </dt>
 495                                         <dd>The value being converted</dd>
 496
 497                                 </dl>
 498
 499
 500
 501
 502
 503                                 <dl class="detailList">
 504                                 <dt class="heading">Returns:</dt>
 505
 506                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The comparison value</dd>
 507
 508                                 </dl>
 509
 510
 511
 512
 513
 514
 515
 516                     </div>
 517                 </div>
 518
 519             </td>
 520             <td class="msource">
 521
 522                         Roo.data.SortTypes
 523                 &nbsp;
 524             </td>
 525         </tr>
 526
 527
 528           <tr class="method-row config-row-alt0 expandable notInherited">
 529             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 530
 531
 532             <td class="sig">
 533                 <a id="Roo.data.SortTypes-method-asUCString"   name=".asUCString"></a>
 534                 <div class="fixedFont">
 535                         <span class="attributes">Roo.data.SortTypes.</span><b class="itemname">asUCString</b>
 536
 537                                  (Mixed <B><i>s</i></B>)
 538
 539
 540                                          :
 541
 542
 543                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 544
 545
 546
 547
 548
 549                 </div>
 550                 <div class="mdesc">
 551
 552                    <div class="short">Case insensitive string</div>
 553
 554
 555
 556                     <div class="long">
 557
 558                                 Case insensitive string
 559
 560
 561
 562
 563
 564
 565                                 <dl class="detailList">
 566                                 <dt class="heading">Parameters:</dt>
 567
 568                                         <dt>
 569                                                 <span class="fixedFont">Mixed</span>  <b>s</b>
 570
 571                                         </dt>
 572                                         <dd>The value being converted</dd>
 573
 574                                 </dl>
 575
 576
 577
 578
 579
 580                                 <dl class="detailList">
 581                                 <dt class="heading">Returns:</dt>
 582
 583                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The comparison value</dd>
 584
 585                                 </dl>
 586
 587
 588
 589
 590
 591
 592
 593                     </div>
 594                 </div>
 595
 596             </td>
 597             <td class="msource">
 598
 599                         Roo.data.SortTypes
 600                 &nbsp;
 601             </td>
 602         </tr>
 603
 604
 605           <tr class="method-row config-row-alt1 expandable notInherited">
 606             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 607
 608
 609             <td class="sig">
 610                 <a id="Roo.data.SortTypes-method-asUCText"   name=".asUCText"></a>
 611                 <div class="fixedFont">
 612                         <span class="attributes">Roo.data.SortTypes.</span><b class="itemname">asUCText</b>
 613
 614                                  (Mixed <B><i>s</i></B>)
 615
 616
 617                                          :
 618
 619
 620                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 621
 622
 623
 624
 625
 626                 </div>
 627                 <div class="mdesc">
 628
 629                    <div class="short">Strips all HTML tags to sort on text only - Case insensitive</div>
 630
 631
 632
 633                     <div class="long">
 634
 635                                 Strips all HTML tags to sort on text only - Case insensitive
 636
 637
 638
 639
 640
 641
 642                                 <dl class="detailList">
 643                                 <dt class="heading">Parameters:</dt>
 644
 645                                         <dt>
 646                                                 <span class="fixedFont">Mixed</span>  <b>s</b>
 647
 648                                         </dt>
 649                                         <dd>The value being converted</dd>
 650
 651                                 </dl>
 652
 653
 654
 655
 656
 657                                 <dl class="detailList">
 658                                 <dt class="heading">Returns:</dt>
 659
 660                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The comparison value</dd>
 661
 662                                 </dl>
 663
 664
 665
 666
 667
 668
 669
 670                     </div>
 671                 </div>
 672
 673             </td>
 674             <td class="msource">
 675
 676                         Roo.data.SortTypes
 677                 &nbsp;
 678             </td>
 679         </tr>
 680
 681
 682           <tr class="method-row config-row-alt0 expandable notInherited">
 683             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 684
 685
 686             <td class="sig">
 687                 <a id="Roo.data.SortTypes-method-none"   name=".none"></a>
 688                 <div class="fixedFont">
 689                         <span class="attributes">Roo.data.SortTypes.</span><b class="itemname">none</b>
 690
 691                                  (Mixed <B><i>s</i></B>)
 692
 693
 694                                          :
 695
 696
 697                                                 Mixed
 698
 699
 700
 701
 702
 703                 </div>
 704                 <div class="mdesc">
 705
 706                    <div class="short">Default sort that does nothing</div>
 707
 708
 709
 710                     <div class="long">
 711
 712                                 Default sort that does nothing
 713
 714
 715
 716
 717
 718
 719                                 <dl class="detailList">
 720                                 <dt class="heading">Parameters:</dt>
 721
 722                                         <dt>
 723                                                 <span class="fixedFont">Mixed</span>  <b>s</b>
 724
 725                                         </dt>
 726                                         <dd>The value being converted</dd>
 727
 728                                 </dl>
 729
 730
 731
 732
 733
 734                                 <dl class="detailList">
 735                                 <dt class="heading">Returns:</dt>
 736
 737                                         <dd><span class="fixedFont">Mixed</span>  The comparison value</dd>
 738
 739                                 </dl>
 740
 741
 742
 743
 744
 745
 746
 747                     </div>
 748                 </div>
 749
 750             </td>
 751             <td class="msource">
 752
 753                         Roo.data.SortTypes
 754                 &nbsp;
 755             </td>
 756         </tr>
 757
 758
 759     </table>
 760
 761
 762   <!-- ============================== events summary / details ======================== -->
 763
 764
 765   <a id="Roo.data.SortTypes-events"></a>
 766
 767
 768
 769
 770
 771      <table cellspacing="0" class="member-table">
 772       <caption class="Empty">Events - Has None</caption>
 773      </table>
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783 <!-- ============================== footer ================================= -->
 784                 <div class="fineprint" style="clear:both">
 785
 786                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Tue Jul 27 2010 11:05:07 GMT+0800 (HKT)
 787                         Based on
 788                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 789                 </div>
 790         </body>
 791 </html>