git.roojs.org Git - roojs1/blob - docs/symbols/Roo.util.Format.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.util.Format</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.util.Format-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.util.Format-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.util.Format-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.util.Format-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.util.Format
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55                 <tr><td class="label">Package:</td><td class="hd-info">Roo.util</td></tr>
  56
  57         <tr><td class="label">Defined In:</td><td class="hd-info">
  58
  59                                         <a href="./src/Roo_util_Format.js.html">Roo/util/Format.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">Format</td></tr>
  63
  64
  65
  66
  67     </table>
  68
  69
  70 <!-- ============================== class summary ========================== -->
  71     <div class="description">
  72         Reusable data formatting functions
  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.util.Format';">[Add Your comment/notes about this class]</u>
  81         <br/>
  82         <iframe frameborder="0"  id="comments-Roo.util" style="border: none;width:100%;"
  83                 src="/blog.php/GtkDjsComments/Roo.util.Format.html"></iframe>
  84 </div>
  85
  86
  87
  88 <!-- ============================== config options ========================== -->
  89
  90
  91
  92
  93     <div class="hr"></div>
  94     <a id="Roo.util.Format-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.util.Format-props"></a>
 118
 119
 120
 121
 122
 123      <table cellspacing="0" class="member-table">
 124       <caption class="Empty">Public Properties - Has None</caption>
 125      </table>
 126
 127
 128
 129
 130   <!-- ============================== methods summary / details ======================== -->
 131
 132
 133   <a id="Roo.util.Format-methods"></a>
 134         <!-- constructor?? -->
 135
 136         <!-- static's first
 137
 138
 139         -->
 140
 141         <!-- then dynamics first -->
 142
 143
 144
 145
 146
 147
 148       <table cellspacing="0" class="member-table">
 149       <caption>Public Methods</caption>
 150         <tr>
 151             <th class="sig-header" colspan="2">Method</th>
 152             <th class="msource-header">Defined By</th>
 153
 154         </tr>
 155
 156
 157
 158
 159
 160
 161
 162           <tr class="method-row config-row-alt0 expandable notInherited">
 163             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 164
 165
 166             <td class="sig">
 167                 <a id="Roo.util.Format-method-capitalize"   name=".capitalize"></a>
 168                 <div class="fixedFont">
 169                         <span class="attributes">Roo.util.Format.</span><b class="itemname">capitalize</b>
 170
 171                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
 172
 173
 174                                          :
 175
 176
 177                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 178
 179
 180
 181
 182
 183                 </div>
 184                 <div class="mdesc">
 185
 186                    <div class="short">Converts the first character only of a string to upper case</div>
 187
 188
 189
 190                     <div class="long">
 191
 192                                 Converts the first character only of a string to upper case
 193
 194
 195
 196
 197
 198
 199                                 <dl class="detailList">
 200                                 <dt class="heading">Parameters:</dt>
 201
 202                                         <dt>
 203                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>value</b>
 204
 205                                         </dt>
 206                                         <dd>The text to convert</dd>
 207
 208                                 </dl>
 209
 210
 211
 212
 213
 214                                 <dl class="detailList">
 215                                 <dt class="heading">Returns:</dt>
 216
 217                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The converted text</dd>
 218
 219                                 </dl>
 220
 221
 222
 223
 224
 225
 226
 227                     </div>
 228                 </div>
 229
 230             </td>
 231             <td class="msource">
 232
 233                         Roo.util.Format
 234                 &nbsp;
 235             </td>
 236         </tr>
 237
 238
 239           <tr class="method-row config-row-alt1 expandable notInherited">
 240             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 241
 242
 243             <td class="sig">
 244                 <a id="Roo.util.Format-method-date"   name=".date"></a>
 245                 <div class="fixedFont">
 246                         <span class="attributes">Roo.util.Format.</span><b class="itemname">date</b>
 247
 248                                  (Mixed <B><i>value</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>format</i></B>)
 249
 250
 251                                          :
 252
 253
 254                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 255
 256
 257
 258
 259
 260                 </div>
 261                 <div class="mdesc">
 262
 263                    <div class="short">Parse a value into a formatted date using the specified format pattern.</div>
 264
 265
 266
 267                     <div class="long">
 268
 269                                 Parse a value into a formatted date using the specified format pattern.
 270
 271
 272
 273
 274
 275
 276                                 <dl class="detailList">
 277                                 <dt class="heading">Parameters:</dt>
 278
 279                                         <dt>
 280                                                 <span class="fixedFont">Mixed</span>  <b>value</b>
 281
 282                                         </dt>
 283                                         <dd>The value to format</dd>
 284
 285                                         <dt>
 286                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>format</b>
 287
 288                                         </dt>
 289                                         <dd>(optional) Any valid date format string (defaults to 'm/d/Y')</dd>
 290
 291                                 </dl>
 292
 293
 294
 295
 296
 297                                 <dl class="detailList">
 298                                 <dt class="heading">Returns:</dt>
 299
 300                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The formatted date string</dd>
 301
 302                                 </dl>
 303
 304
 305
 306
 307
 308
 309
 310                     </div>
 311                 </div>
 312
 313             </td>
 314             <td class="msource">
 315
 316                         Roo.util.Format
 317                 &nbsp;
 318             </td>
 319         </tr>
 320
 321
 322           <tr class="method-row config-row-alt0 expandable notInherited">
 323             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 324
 325
 326             <td class="sig">
 327                 <a id="Roo.util.Format-method-dateRenderer"   name=".dateRenderer"></a>
 328                 <div class="fixedFont">
 329                         <span class="attributes">Roo.util.Format.</span><b class="itemname">dateRenderer</b>
 330
 331                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>format</i></B>)
 332
 333
 334                                          :
 335
 336
 337                                                 <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
 338
 339
 340
 341
 342
 343                 </div>
 344                 <div class="mdesc">
 345
 346                    <div class="short">Returns a date rendering function that can be reused to apply a date format multiple times efficiently</div>
 347
 348
 349
 350                     <div class="long">
 351
 352                                 Returns a date rendering function that can be reused to apply a date format multiple times efficiently
 353
 354
 355
 356
 357
 358
 359                                 <dl class="detailList">
 360                                 <dt class="heading">Parameters:</dt>
 361
 362                                         <dt>
 363                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>format</b>
 364
 365                                         </dt>
 366                                         <dd>Any valid date format string</dd>
 367
 368                                 </dl>
 369
 370
 371
 372
 373
 374                                 <dl class="detailList">
 375                                 <dt class="heading">Returns:</dt>
 376
 377                                         <dd><span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  The date formatting function</dd>
 378
 379                                 </dl>
 380
 381
 382
 383
 384
 385
 386
 387                     </div>
 388                 </div>
 389
 390             </td>
 391             <td class="msource">
 392
 393                         Roo.util.Format
 394                 &nbsp;
 395             </td>
 396         </tr>
 397
 398
 399           <tr class="method-row config-row-alt1 expandable notInherited">
 400             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 401
 402
 403             <td class="sig">
 404                 <a id="Roo.util.Format-method-ellipsis"   name=".ellipsis"></a>
 405                 <div class="fixedFont">
 406                         <span class="attributes">Roo.util.Format.</span><b class="itemname">ellipsis</b>
 407
 408                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>length</i></B>)
 409
 410
 411                                          :
 412
 413
 414                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 415
 416
 417
 418
 419
 420                 </div>
 421                 <div class="mdesc">
 422
 423                    <div class="short">Truncate a string and add an ellipsis ('.</div>
 424
 425
 426
 427                     <div class="long">
 428
 429                                 Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length
 430
 431
 432
 433
 434
 435
 436                                 <dl class="detailList">
 437                                 <dt class="heading">Parameters:</dt>
 438
 439                                         <dt>
 440                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>value</b>
 441
 442                                         </dt>
 443                                         <dd>The string to truncate</dd>
 444
 445                                         <dt>
 446                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>length</b>
 447
 448                                         </dt>
 449                                         <dd>The maximum length to allow before truncating</dd>
 450
 451                                 </dl>
 452
 453
 454
 455
 456
 457                                 <dl class="detailList">
 458                                 <dt class="heading">Returns:</dt>
 459
 460                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The converted text</dd>
 461
 462                                 </dl>
 463
 464
 465
 466
 467
 468
 469
 470                     </div>
 471                 </div>
 472
 473             </td>
 474             <td class="msource">
 475
 476                         Roo.util.Format
 477                 &nbsp;
 478             </td>
 479         </tr>
 480
 481
 482           <tr class="method-row config-row-alt0 expandable notInherited">
 483             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 484
 485
 486             <td class="sig">
 487                 <a id="Roo.util.Format-method-htmlDecode"   name=".htmlDecode"></a>
 488                 <div class="fixedFont">
 489                         <span class="attributes">Roo.util.Format.</span><b class="itemname">htmlDecode</b>
 490
 491                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
 492
 493
 494                                          :
 495
 496
 497                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 498
 499
 500
 501
 502
 503                 </div>
 504                 <div class="mdesc">
 505
 506                    <div class="short">Convert certain characters (&, <, >, and ') from their HTML character equivalents.</div>
 507
 508
 509
 510                     <div class="long">
 511
 512                                 Convert certain characters (&, <, >, and ') from their HTML character equivalents.
 513
 514
 515
 516
 517
 518
 519                                 <dl class="detailList">
 520                                 <dt class="heading">Parameters:</dt>
 521
 522                                         <dt>
 523                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>value</b>
 524
 525                                         </dt>
 526                                         <dd>The string to decode</dd>
 527
 528                                 </dl>
 529
 530
 531
 532
 533
 534                                 <dl class="detailList">
 535                                 <dt class="heading">Returns:</dt>
 536
 537                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The decoded text</dd>
 538
 539                                 </dl>
 540
 541
 542
 543
 544
 545
 546
 547                     </div>
 548                 </div>
 549
 550             </td>
 551             <td class="msource">
 552
 553                         Roo.util.Format
 554                 &nbsp;
 555             </td>
 556         </tr>
 557
 558
 559           <tr class="method-row config-row-alt1 expandable notInherited">
 560             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 561
 562
 563             <td class="sig">
 564                 <a id="Roo.util.Format-method-htmlEncode"   name=".htmlEncode"></a>
 565                 <div class="fixedFont">
 566                         <span class="attributes">Roo.util.Format.</span><b class="itemname">htmlEncode</b>
 567
 568                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
 569
 570
 571                                          :
 572
 573
 574                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 575
 576
 577
 578
 579
 580                 </div>
 581                 <div class="mdesc">
 582
 583                    <div class="short">Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.</div>
 584
 585
 586
 587                     <div class="long">
 588
 589                                 Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.
 590
 591
 592
 593
 594
 595
 596                                 <dl class="detailList">
 597                                 <dt class="heading">Parameters:</dt>
 598
 599                                         <dt>
 600                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>value</b>
 601
 602                                         </dt>
 603                                         <dd>The string to encode</dd>
 604
 605                                 </dl>
 606
 607
 608
 609
 610
 611                                 <dl class="detailList">
 612                                 <dt class="heading">Returns:</dt>
 613
 614                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The encoded text</dd>
 615
 616                                 </dl>
 617
 618
 619
 620
 621
 622
 623
 624                     </div>
 625                 </div>
 626
 627             </td>
 628             <td class="msource">
 629
 630                         Roo.util.Format
 631                 &nbsp;
 632             </td>
 633         </tr>
 634
 635
 636           <tr class="method-row config-row-alt0 expandable notInherited">
 637             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 638
 639
 640             <td class="sig">
 641                 <a id="Roo.util.Format-method-lowercase"   name=".lowercase"></a>
 642                 <div class="fixedFont">
 643                         <span class="attributes">Roo.util.Format.</span><b class="itemname">lowercase</b>
 644
 645                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
 646
 647
 648                                          :
 649
 650
 651                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 652
 653
 654
 655
 656
 657                 </div>
 658                 <div class="mdesc">
 659
 660                    <div class="short">Converts a string to all lower case letters</div>
 661
 662
 663
 664                     <div class="long">
 665
 666                                 Converts a string to all lower case letters
 667
 668
 669
 670
 671
 672
 673                                 <dl class="detailList">
 674                                 <dt class="heading">Parameters:</dt>
 675
 676                                         <dt>
 677                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>value</b>
 678
 679                                         </dt>
 680                                         <dd>The text to convert</dd>
 681
 682                                 </dl>
 683
 684
 685
 686
 687
 688                                 <dl class="detailList">
 689                                 <dt class="heading">Returns:</dt>
 690
 691                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The converted text</dd>
 692
 693                                 </dl>
 694
 695
 696
 697
 698
 699
 700
 701                     </div>
 702                 </div>
 703
 704             </td>
 705             <td class="msource">
 706
 707                         Roo.util.Format
 708                 &nbsp;
 709             </td>
 710         </tr>
 711
 712
 713           <tr class="method-row config-row-alt1 expandable notInherited">
 714             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 715
 716
 717             <td class="sig">
 718                 <a id="Roo.util.Format-method-number"   name=".number"></a>
 719                 <div class="fixedFont">
 720                         <span class="attributes">Roo.util.Format.</span><b class="itemname">number</b>
 721
 722                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String <B><i>value</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>decimals</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>delimiter</i></B>)
 723
 724
 725                                          :
 726
 727
 728                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 729
 730
 731
 732
 733
 734                 </div>
 735                 <div class="mdesc">
 736
 737                    <div class="short">Format a number<br/>eventually this should probably emulate php's number_format</div>
 738
 739
 740
 741                     <div class="long">
 742
 743                                 Format a number<br/>eventually this should probably emulate php's number_format
 744
 745
 746
 747
 748
 749
 750                                 <dl class="detailList">
 751                                 <dt class="heading">Parameters:</dt>
 752
 753                                         <dt>
 754                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String</span>  <b>value</b>
 755
 756                                         </dt>
 757                                         <dd>The numeric value to format</dd>
 758
 759                                         <dt>
 760                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>decimals</b>
 761
 762                                         </dt>
 763                                         <dd>number of decimal places</dd>
 764
 765                                         <dt>
 766                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>delimiter</b>
 767
 768                                         </dt>
 769                                         <dd>for thousands (default comma)</dd>
 770
 771                                 </dl>
 772
 773
 774
 775
 776
 777                                 <dl class="detailList">
 778                                 <dt class="heading">Returns:</dt>
 779
 780                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The formatted currency string</dd>
 781
 782                                 </dl>
 783
 784
 785
 786
 787
 788
 789
 790                     </div>
 791                 </div>
 792
 793             </td>
 794             <td class="msource">
 795
 796                         Roo.util.Format
 797                 &nbsp;
 798             </td>
 799         </tr>
 800
 801
 802           <tr class="method-row config-row-alt0 expandable notInherited">
 803             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 804
 805
 806             <td class="sig">
 807                 <a id="Roo.util.Format-method-stripTags"   name=".stripTags"></a>
 808                 <div class="fixedFont">
 809                         <span class="attributes">Roo.util.Format.</span><b class="itemname">stripTags</b>
 810
 811                                  (Mixed <B><i>value</i></B>)
 812
 813
 814                                          :
 815
 816
 817                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 818
 819
 820
 821
 822
 823                 </div>
 824                 <div class="mdesc">
 825
 826                    <div class="short">Strips all HTML tags</div>
 827
 828
 829
 830                     <div class="long">
 831
 832                                 Strips all HTML tags
 833
 834
 835
 836
 837
 838
 839                                 <dl class="detailList">
 840                                 <dt class="heading">Parameters:</dt>
 841
 842                                         <dt>
 843                                                 <span class="fixedFont">Mixed</span>  <b>value</b>
 844
 845                                         </dt>
 846                                         <dd>The text from which to strip tags</dd>
 847
 848                                 </dl>
 849
 850
 851
 852
 853
 854                                 <dl class="detailList">
 855                                 <dt class="heading">Returns:</dt>
 856
 857                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The stripped text</dd>
 858
 859                                 </dl>
 860
 861
 862
 863
 864
 865
 866
 867                     </div>
 868                 </div>
 869
 870             </td>
 871             <td class="msource">
 872
 873                         Roo.util.Format
 874                 &nbsp;
 875             </td>
 876         </tr>
 877
 878
 879           <tr class="method-row config-row-alt1 expandable notInherited">
 880             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 881
 882
 883             <td class="sig">
 884                 <a id="Roo.util.Format-method-substr"   name=".substr"></a>
 885                 <div class="fixedFont">
 886                         <span class="attributes">Roo.util.Format.</span><b class="itemname">substr</b>
 887
 888                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>start</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>length</i></B>)
 889
 890
 891                                          :
 892
 893
 894                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 895
 896
 897
 898
 899
 900                 </div>
 901                 <div class="mdesc">
 902
 903                    <div class="short">Returns a substring from within an original string</div>
 904
 905
 906
 907                     <div class="long">
 908
 909                                 Returns a substring from within an original string
 910
 911
 912
 913
 914
 915
 916                                 <dl class="detailList">
 917                                 <dt class="heading">Parameters:</dt>
 918
 919                                         <dt>
 920                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>value</b>
 921
 922                                         </dt>
 923                                         <dd>The original text</dd>
 924
 925                                         <dt>
 926                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>start</b>
 927
 928                                         </dt>
 929                                         <dd>The start index of the substring</dd>
 930
 931                                         <dt>
 932                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>length</b>
 933
 934                                         </dt>
 935                                         <dd>The length of the substring</dd>
 936
 937                                 </dl>
 938
 939
 940
 941
 942
 943                                 <dl class="detailList">
 944                                 <dt class="heading">Returns:</dt>
 945
 946                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The substring</dd>
 947
 948                                 </dl>
 949
 950
 951
 952
 953
 954
 955
 956                     </div>
 957                 </div>
 958
 959             </td>
 960             <td class="msource">
 961
 962                         Roo.util.Format
 963                 &nbsp;
 964             </td>
 965         </tr>
 966
 967
 968           <tr class="method-row config-row-alt0 expandable notInherited">
 969             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 970
 971
 972             <td class="sig">
 973                 <a id="Roo.util.Format-method-toFixed"   name=".toFixed"></a>
 974                 <div class="fixedFont">
 975                         <span class="attributes">Roo.util.Format.</span><b class="itemname">toFixed</b>
 976
 977                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String <B><i>value</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String <B><i>value</i></B>)
 978
 979
 980                                          :
 981
 982
 983                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 984
 985
 986
 987
 988
 989                 </div>
 990                 <div class="mdesc">
 991
 992                    <div class="short">safer version of Math.toFixed.</div>
 993
 994
 995
 996                     <div class="long">
 997
 998                                 safer version of Math.toFixed..??/
 999
1000
1001
1002
1003
1004
1005                                 <dl class="detailList">
1006                                 <dt class="heading">Parameters:</dt>
1007
1008                                         <dt>
1009                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String</span>  <b>value</b>
1010
1011                                         </dt>
1012                                         <dd>The numeric value to format</dd>
1013
1014                                         <dt>
1015                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String</span>  <b>value</b>
1016
1017                                         </dt>
1018                                         <dd>Decimal places</dd>
1019
1020                                 </dl>
1021
1022
1023
1024
1025
1026                                 <dl class="detailList">
1027                                 <dt class="heading">Returns:</dt>
1028
1029                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The formatted currency string</dd>
1030
1031                                 </dl>
1032
1033
1034
1035
1036
1037
1038
1039                     </div>
1040                 </div>
1041
1042             </td>
1043             <td class="msource">
1044
1045                         Roo.util.Format
1046                 &nbsp;
1047             </td>
1048         </tr>
1049
1050
1051           <tr class="method-row config-row-alt1 expandable notInherited">
1052             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1053
1054
1055             <td class="sig">
1056                 <a id="Roo.util.Format-method-trim"   name=".trim"></a>
1057                 <div class="fixedFont">
1058                         <span class="attributes">Roo.util.Format.</span><b class="itemname">trim</b>
1059
1060                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
1061
1062
1063                                          :
1064
1065
1066                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1067
1068
1069
1070
1071
1072                 </div>
1073                 <div class="mdesc">
1074
1075                    <div class="short">Trims any whitespace from either side of a string</div>
1076
1077
1078
1079                     <div class="long">
1080
1081                                 Trims any whitespace from either side of a string
1082
1083
1084
1085
1086
1087
1088                                 <dl class="detailList">
1089                                 <dt class="heading">Parameters:</dt>
1090
1091                                         <dt>
1092                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>value</b>
1093
1094                                         </dt>
1095                                         <dd>The text to trim</dd>
1096
1097                                 </dl>
1098
1099
1100
1101
1102
1103                                 <dl class="detailList">
1104                                 <dt class="heading">Returns:</dt>
1105
1106                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The trimmed text</dd>
1107
1108                                 </dl>
1109
1110
1111
1112
1113
1114
1115
1116                     </div>
1117                 </div>
1118
1119             </td>
1120             <td class="msource">
1121
1122                         Roo.util.Format
1123                 &nbsp;
1124             </td>
1125         </tr>
1126
1127
1128           <tr class="method-row config-row-alt0 expandable notInherited">
1129             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1130
1131
1132             <td class="sig">
1133                 <a id="Roo.util.Format-method-undef"   name=".undef"></a>
1134                 <div class="fixedFont">
1135                         <span class="attributes">Roo.util.Format.</span><b class="itemname">undef</b>
1136
1137                                  (Mixed <B><i>value</i></B>)
1138
1139
1140                                          :
1141
1142
1143                                                 Mixed
1144
1145
1146
1147
1148
1149                 </div>
1150                 <div class="mdesc">
1151
1152                    <div class="short">Checks a reference and converts it to empty string if it is undefined</div>
1153
1154
1155
1156                     <div class="long">
1157
1158                                 Checks a reference and converts it to empty string if it is undefined
1159
1160
1161
1162
1163
1164
1165                                 <dl class="detailList">
1166                                 <dt class="heading">Parameters:</dt>
1167
1168                                         <dt>
1169                                                 <span class="fixedFont">Mixed</span>  <b>value</b>
1170
1171                                         </dt>
1172                                         <dd>Reference to check</dd>
1173
1174                                 </dl>
1175
1176
1177
1178
1179
1180                                 <dl class="detailList">
1181                                 <dt class="heading">Returns:</dt>
1182
1183                                         <dd><span class="fixedFont">Mixed</span>  Empty string if converted, otherwise the original value</dd>
1184
1185                                 </dl>
1186
1187
1188
1189
1190
1191
1192
1193                     </div>
1194                 </div>
1195
1196             </td>
1197             <td class="msource">
1198
1199                         Roo.util.Format
1200                 &nbsp;
1201             </td>
1202         </tr>
1203
1204
1205           <tr class="method-row config-row-alt1 expandable notInherited">
1206             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1207
1208
1209             <td class="sig">
1210                 <a id="Roo.util.Format-method-uppercase"   name=".uppercase"></a>
1211                 <div class="fixedFont">
1212                         <span class="attributes">Roo.util.Format.</span><b class="itemname">uppercase</b>
1213
1214                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
1215
1216
1217                                          :
1218
1219
1220                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1221
1222
1223
1224
1225
1226                 </div>
1227                 <div class="mdesc">
1228
1229                    <div class="short">Converts a string to all upper case letters</div>
1230
1231
1232
1233                     <div class="long">
1234
1235                                 Converts a string to all upper case letters
1236
1237
1238
1239
1240
1241
1242                                 <dl class="detailList">
1243                                 <dt class="heading">Parameters:</dt>
1244
1245                                         <dt>
1246                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>value</b>
1247
1248                                         </dt>
1249                                         <dd>The text to convert</dd>
1250
1251                                 </dl>
1252
1253
1254
1255
1256
1257                                 <dl class="detailList">
1258                                 <dt class="heading">Returns:</dt>
1259
1260                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The converted text</dd>
1261
1262                                 </dl>
1263
1264
1265
1266
1267
1268
1269
1270                     </div>
1271                 </div>
1272
1273             </td>
1274             <td class="msource">
1275
1276                         Roo.util.Format
1277                 &nbsp;
1278             </td>
1279         </tr>
1280
1281
1282           <tr class="method-row config-row-alt0 expandable notInherited">
1283             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1284
1285
1286             <td class="sig">
1287                 <a id="Roo.util.Format-method-usMoney"   name=".usMoney"></a>
1288                 <div class="fixedFont">
1289                         <span class="attributes">Roo.util.Format.</span><b class="itemname">usMoney</b>
1290
1291                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String <B><i>value</i></B>)
1292
1293
1294                                          :
1295
1296
1297                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1298
1299
1300
1301
1302
1303                 </div>
1304                 <div class="mdesc">
1305
1306                    <div class="short">Format a number as US currency</div>
1307
1308
1309
1310                     <div class="long">
1311
1312                                 Format a number as US currency
1313
1314
1315
1316
1317
1318
1319                                 <dl class="detailList">
1320                                 <dt class="heading">Parameters:</dt>
1321
1322                                         <dt>
1323                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String</span>  <b>value</b>
1324
1325                                         </dt>
1326                                         <dd>The numeric value to format</dd>
1327
1328                                 </dl>
1329
1330
1331
1332
1333
1334                                 <dl class="detailList">
1335                                 <dt class="heading">Returns:</dt>
1336
1337                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The formatted currency string</dd>
1338
1339                                 </dl>
1340
1341
1342
1343
1344
1345
1346
1347                     </div>
1348                 </div>
1349
1350             </td>
1351             <td class="msource">
1352
1353                         Roo.util.Format
1354                 &nbsp;
1355             </td>
1356         </tr>
1357
1358
1359     </table>
1360
1361
1362   <!-- ============================== events summary / details ======================== -->
1363
1364
1365   <a id="Roo.util.Format-events"></a>
1366
1367
1368
1369
1370
1371      <table cellspacing="0" class="member-table">
1372       <caption class="Empty">Events - Has None</caption>
1373      </table>
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383 <!-- ============================== footer ================================= -->
1384                 <div class="fineprint" style="clear:both">
1385
1386                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 13 2018 14:10:55 GMT+0800 (HKT)
1387                         Based on
1388                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1389                 </div>
1390         </body>
1391 </html>