docs/output/Ext.util.Format.js

   1 Ext.data.JsonP.Ext_util_Format({
   2   "tagname": "class",
   3   "name": "Ext.util.Format",
   4   "doc": "<p>This class is a centralized place for formatting functions inside the library. It includes\nfunctions to format various different types of data, such as text, dates and numeric values.</p>\n\n<p><strong>Localization</strong>\nThis class contains several options for localization. These can be set once the library has loaded,\nall calls to the functions from that point will use the locale settings that were specified.\nOptions include:\n- thousandSeparator\n- decimalSeparator\n- currenyPrecision\n- currencySign\n- currencyAtEnd\nThis class also uses the default date format defined here: <a href=\"#/api/Ext.date--defaultFormat\" rel=\"Ext.date--defaultFormat\" class=\"docClass\">Ext.date.defaultFormat</a>.</p>\n\n<p><strong>Using with renderers</strong>\nThere are two helper functions that return a new function that can be used in conjunction with\ngrid renderers:</p>\n\n<pre><code>columns: [{\n    dataIndex: 'date',\n    renderer: Ext.util.Format.dateRenderer('Y-m-d')\n}, {\n    dataIndex: 'time',\n    renderer: Ext.util.Format.numberRenderer('0.000')\n}]\n</code></pre>\n\n<p>Functions that only take a single argument can also be passed directly:</p>\n\n<pre><code>columns: [{\n    dataIndex: 'cost',\n    renderer: Ext.util.Format.usMoney\n}, {\n    dataIndex: 'productCode',\n    renderer: Ext.util.Format.uppercase\n}]\n</code></pre>\n\n<p><strong>Using with XTemplates</strong>\nXTemplates can also directly use <a href=\"#/api/Ext.util.Format\" rel=\"Ext.util.Format\" class=\"docClass\">Ext.util.Format</a> functions:</p>\n\n<pre><code>new Ext.XTemplate([\n    'Date: {startDate:date(\"Y-m-d\")}',\n    'Cost: {cost:usMoney}'\n]);\n</code></pre>\n",
   5   "extends": null,
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": true,
  16   "private": false,
  17   "cfg": [
  18
  19   ],
  20   "method": [
  21     {
  22       "tagname": "method",
  23       "name": "capitalize",
  24       "member": "Ext.util.Format",
  25       "doc": "<p>Capitalize the given string. See <a href=\"#/api/Ext.String-method-capitalize\" rel=\"Ext.String-method-capitalize\" class=\"docClass\">Ext.String.capitalize</a>.</p>\n",
  26       "params": [
  27
  28       ],
  29       "return": {
  30         "type": "void",
  31         "doc": "\n"
  32       },
  33       "private": false,
  34       "static": false,
  35       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
  36       "linenr": 434,
  37       "html_filename": "Format.html",
  38       "href": "Format.html#Ext-util-Format-method-capitalize",
  39       "shortDoc": "<p>Capitalize the given string. See <a href=\"#/api/Ext.String-method-capitalize\" rel=\"Ext.String-method-capitalize\" class=\"docClass\">Ext.String.capitalize</a>.</p>\n"
  40     },
  41     {
  42       "tagname": "method",
  43       "name": "currency",
  44       "member": "Ext.util.Format",
  45       "doc": "<p>Format a number as a currency</p>\n",
  46       "params": [
  47         {
  48           "type": "Number/String",
  49           "name": "value",
  50           "doc": "<p>The numeric value to format</p>\n",
  51           "optional": false
  52         },
  53         {
  54           "type": "String",
  55           "name": "sign",
  56           "doc": "<p>The currency sign to use (defaults to <a href=\"#/api/Ext.util.Format-property-currencySign\" rel=\"Ext.util.Format-property-currencySign\" class=\"docClass\">currencySign</a>)</p>\n",
  57           "optional": false
  58         },
  59         {
  60           "type": "Number",
  61           "name": "decimals",
  62           "doc": "<p>The number of decimals to use for the currency (defaults to <a href=\"#/api/Ext.util.Format-property-currencyPrecision\" rel=\"Ext.util.Format-property-currencyPrecision\" class=\"docClass\">currencyPrecision</a>)</p>\n",
  63           "optional": false
  64         },
  65         {
  66           "type": "Boolean",
  67           "name": "end",
  68           "doc": "<p>True if the currency sign should be at the end of the string (defaults to <a href=\"#/api/Ext.util.Format-property-currencyAtEnd\" rel=\"Ext.util.Format-property-currencyAtEnd\" class=\"docClass\">currencyAtEnd</a>)</p>\n",
  69           "optional": false
  70         }
  71       ],
  72       "return": {
  73         "type": "String",
  74         "doc": "<p>The formatted currency string</p>\n"
  75       },
  76       "private": false,
  77       "static": false,
  78       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
  79       "linenr": 165,
  80       "html_filename": "Format.html",
  81       "href": "Format.html#Ext-util-Format-method-currency",
  82       "shortDoc": "<p>Format a number as a currency</p>\n"
  83     },
  84     {
  85       "tagname": "method",
  86       "name": "date",
  87       "member": "Ext.util.Format",
  88       "doc": "<p>Formats the passed date using the specified format pattern.</p>\n",
  89       "params": [
  90         {
  91           "type": "String/Date",
  92           "name": "value",
  93           "doc": "<p>The value to format. If a string is passed, it is converted to a Date by the Javascript\nDate object's <a href=\"http://www.w3schools.com/jsref/jsref_parse.asp\">parse()</a> method.</p>\n",
  94           "optional": false
  95         },
  96         {
  97           "type": "String",
  98           "name": "format",
  99           "doc": "<p>(Optional) Any valid date format string. Defaults to <a href=\"#/api/Ext.Date-property-defaultFormat\" rel=\"Ext.Date-property-defaultFormat\" class=\"docClass\">Ext.Date.defaultFormat</a>.</p>\n",
 100           "optional": false
 101         }
 102       ],
 103       "return": {
 104         "type": "String",
 105         "doc": "<p>The formatted date string.</p>\n"
 106       },
 107       "private": false,
 108       "static": false,
 109       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 110       "linenr": 195,
 111       "html_filename": "Format.html",
 112       "href": "Format.html#Ext-util-Format-method-date",
 113       "shortDoc": "<p>Formats the passed date using the specified format pattern.</p>\n"
 114     },
 115     {
 116       "tagname": "method",
 117       "name": "dateRenderer",
 118       "member": "Ext.util.Format",
 119       "doc": "<p>Returns a date rendering function that can be reused to apply a date format multiple times efficiently</p>\n",
 120       "params": [
 121         {
 122           "type": "String",
 123           "name": "format",
 124           "doc": "<p>Any valid date format string. Defaults to <a href=\"#/api/Ext.Date-property-defaultFormat\" rel=\"Ext.Date-property-defaultFormat\" class=\"docClass\">Ext.Date.defaultFormat</a>.</p>\n",
 125           "optional": false
 126         }
 127       ],
 128       "return": {
 129         "type": "Function",
 130         "doc": "<p>The date formatting function</p>\n"
 131       },
 132       "private": false,
 133       "static": false,
 134       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 135       "linenr": 212,
 136       "html_filename": "Format.html",
 137       "href": "Format.html#Ext-util-Format-method-dateRenderer",
 138       "shortDoc": "<p>Returns a date rendering function that can be reused to apply a date format multiple times efficiently</p>\n"
 139     },
 140     {
 141       "tagname": "method",
 142       "name": "defaultValue",
 143       "member": "Ext.util.Format",
 144       "doc": "<p>Checks a reference and converts it to the default value if it's empty</p>\n",
 145       "params": [
 146         {
 147           "type": "Mixed",
 148           "name": "value",
 149           "doc": "<p>Reference to check</p>\n",
 150           "optional": false
 151         },
 152         {
 153           "type": "String",
 154           "name": "defaultValue",
 155           "doc": "<p>The value to insert of it's undefined (defaults to \"\")</p>\n",
 156           "optional": false
 157         }
 158       ],
 159       "return": {
 160         "type": "String",
 161         "doc": "\n"
 162       },
 163       "private": false,
 164       "static": false,
 165       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 166       "linenr": 117,
 167       "html_filename": "Format.html",
 168       "href": "Format.html#Ext-util-Format-method-defaultValue",
 169       "shortDoc": "<p>Checks a reference and converts it to the default value if it's empty</p>\n"
 170     },
 171     {
 172       "tagname": "method",
 173       "name": "ellipsis",
 174       "member": "Ext.util.Format",
 175       "doc": "<p>Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length.\nSee <a href=\"#/api/Ext.String-method-ellipsis\" rel=\"Ext.String-method-ellipsis\" class=\"docClass\">Ext.String.ellipsis</a>.</p>\n",
 176       "params": [
 177
 178       ],
 179       "return": {
 180         "type": "void",
 181         "doc": "\n"
 182       },
 183       "private": false,
 184       "static": false,
 185       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 186       "linenr": 440,
 187       "html_filename": "Format.html",
 188       "href": "Format.html#Ext-util-Format-method-ellipsis",
 189       "shortDoc": "<p>Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length.\nSee <a href=\"#/api/Ext.String-method-ellipsis\" rel=\"Ext.String-method-ellipsis\" class=\"docClass\">Ext.String.ellipsis</a>.</p>\n"
 190     },
 191     {
 192       "tagname": "method",
 193       "name": "escapeRegex",
 194       "member": "Ext.util.Format",
 195       "doc": "<p>Escapes the passed string for use in a regular expression</p>\n",
 196       "params": [
 197         {
 198           "type": "String",
 199           "name": "str",
 200           "doc": "\n",
 201           "optional": false
 202         }
 203       ],
 204       "return": {
 205         "type": "String",
 206         "doc": "\n"
 207       },
 208       "private": false,
 209       "static": false,
 210       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 211       "linenr": 511,
 212       "html_filename": "Format.html",
 213       "href": "Format.html#Ext-util-Format-method-escapeRegex",
 214       "shortDoc": "<p>Escapes the passed string for use in a regular expression</p>\n"
 215     },
 216     {
 217       "tagname": "method",
 218       "name": "fileSize",
 219       "member": "Ext.util.Format",
 220       "doc": "<p>Simple format for a file size (xxx bytes, xxx KB, xxx MB)</p>\n",
 221       "params": [
 222         {
 223           "type": "Number/String",
 224           "name": "size",
 225           "doc": "<p>The numeric value to format</p>\n",
 226           "optional": false
 227         }
 228       ],
 229       "return": {
 230         "type": "String",
 231         "doc": "<p>The formatted file size</p>\n"
 232       },
 233       "private": false,
 234       "static": false,
 235       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 236       "linenr": 241,
 237       "html_filename": "Format.html",
 238       "href": "Format.html#Ext-util-Format-method-fileSize",
 239       "shortDoc": "<p>Simple format for a file size (xxx bytes, xxx KB, xxx MB)</p>\n"
 240     },
 241     {
 242       "tagname": "method",
 243       "name": "format",
 244       "member": "Ext.util.Format",
 245       "doc": "<p>Formats to a string. See <a href=\"#/api/Ext.String-method-format\" rel=\"Ext.String-method-format\" class=\"docClass\">Ext.String.format</a></p>\n",
 246       "params": [
 247
 248       ],
 249       "return": {
 250         "type": "void",
 251         "doc": "\n"
 252       },
 253       "private": false,
 254       "static": false,
 255       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 256       "linenr": 447,
 257       "html_filename": "Format.html",
 258       "href": "Format.html#Ext-util-Format-method-format",
 259       "shortDoc": "<p>Formats to a string. See <a href=\"#/api/Ext.String-method-format\" rel=\"Ext.String-method-format\" class=\"docClass\">Ext.String.format</a></p>\n"
 260     },
 261     {
 262       "tagname": "method",
 263       "name": "htmlDecode",
 264       "member": "Ext.util.Format",
 265       "doc": "<p>Convert certain characters (&amp;, &lt;, >, and ') from their HTML character equivalents.\nSee <a href=\"#/api/Ext.string--htmlDecode\" rel=\"Ext.string--htmlDecode\" class=\"docClass\">Ext.string.htmlDecode</a>.</p>\n",
 266       "params": [
 267
 268       ],
 269       "return": {
 270         "type": "void",
 271         "doc": "\n"
 272       },
 273       "private": false,
 274       "static": false,
 275       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 276       "linenr": 453,
 277       "html_filename": "Format.html",
 278       "href": "Format.html#Ext-util-Format-method-htmlDecode",
 279       "shortDoc": "<p>Convert certain characters (&amp;, &lt;, >, and ') from their HTML character equivalents.\nSee <a href=\"#/api/Ext.string--htmlDecode\" rel=\"Ext.string--htmlDecode\" class=\"docClass\">Ext.string.htmlDecode</a>.</p>\n"
 280     },
 281     {
 282       "tagname": "method",
 283       "name": "htmlEncode",
 284       "member": "Ext.util.Format",
 285       "doc": "<p>Convert certain characters (&amp;, &lt;, >, and ') to their HTML character equivalents for literal display in web pages.\nSee <a href=\"#/api/Ext.String-method-htmlEncode\" rel=\"Ext.String-method-htmlEncode\" class=\"docClass\">Ext.String.htmlEncode</a>.</p>\n",
 286       "params": [
 287
 288       ],
 289       "return": {
 290         "type": "void",
 291         "doc": "\n"
 292       },
 293       "private": false,
 294       "static": false,
 295       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 296       "linenr": 460,
 297       "html_filename": "Format.html",
 298       "href": "Format.html#Ext-util-Format-method-htmlEncode",
 299       "shortDoc": "Convert certain characters (&amp;, &lt;, >, and ') to their HTML character equivalents for literal display in web pag..."
 300     },
 301     {
 302       "tagname": "method",
 303       "name": "leftPad",
 304       "member": "Ext.util.Format",
 305       "doc": "<p>Adds left padding to a string. See <a href=\"#/api/Ext.String-method-leftPad\" rel=\"Ext.String-method-leftPad\" class=\"docClass\">Ext.String.leftPad</a></p>\n",
 306       "params": [
 307
 308       ],
 309       "return": {
 310         "type": "void",
 311         "doc": "\n"
 312       },
 313       "private": false,
 314       "static": false,
 315       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 316       "linenr": 467,
 317       "html_filename": "Format.html",
 318       "href": "Format.html#Ext-util-Format-method-leftPad",
 319       "shortDoc": "<p>Adds left padding to a string. See <a href=\"#/api/Ext.String-method-leftPad\" rel=\"Ext.String-method-leftPad\" class=\"docClass\">Ext.String.leftPad</a></p>\n"
 320     },
 321     {
 322       "tagname": "method",
 323       "name": "lowercase",
 324       "member": "Ext.util.Format",
 325       "doc": "<p>Converts a string to all lower case letters</p>\n",
 326       "params": [
 327         {
 328           "type": "String",
 329           "name": "value",
 330           "doc": "<p>The text to convert</p>\n",
 331           "optional": false
 332         }
 333       ],
 334       "return": {
 335         "type": "String",
 336         "doc": "<p>The converted text</p>\n"
 337       },
 338       "private": false,
 339       "static": false,
 340       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 341       "linenr": 138,
 342       "html_filename": "Format.html",
 343       "href": "Format.html#Ext-util-Format-method-lowercase",
 344       "shortDoc": "<p>Converts a string to all lower case letters</p>\n"
 345     },
 346     {
 347       "tagname": "method",
 348       "name": "math",
 349       "member": "Ext.util.Format",
 350       "doc": "<p>It does simple math for use in a template, for example:</p>\n\n<pre><code>var tpl = new Ext.Template('{value} * 10 = {value:math(\"* 10\")}');\n</code></pre>\n\n",
 351       "params": [
 352
 353       ],
 354       "return": {
 355         "type": "Function",
 356         "doc": "<p>A function that operates on the passed value.</p>\n"
 357       },
 358       "private": false,
 359       "static": false,
 360       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 361       "linenr": 256,
 362       "html_filename": "Format.html",
 363       "href": "Format.html#Ext-util-Format-method-math",
 364       "shortDoc": "It does simple math for use in a template, for example:\n\nvar tpl = new Ext.Template('{value} * 10 = {value:math(\"* 10..."
 365     },
 366     {
 367       "tagname": "method",
 368       "name": "nl2br",
 369       "member": "Ext.util.Format",
 370       "doc": "<p>Converts newline characters to the HTML tag &lt;br/></p>\n",
 371       "params": [
 372         {
 373           "type": "String",
 374           "name": "The",
 375           "doc": "<p>string value to format.</p>\n",
 376           "optional": false
 377         }
 378       ],
 379       "return": {
 380         "type": "String",
 381         "doc": "<p>The string with embedded &lt;br/> tags in place of newlines.</p>\n"
 382       },
 383       "private": false,
 384       "static": false,
 385       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 386       "linenr": 425,
 387       "html_filename": "Format.html",
 388       "href": "Format.html#Ext-util-Format-method-nl2br",
 389       "shortDoc": "<p>Converts newline characters to the HTML tag &lt;br/></p>\n"
 390     },
 391     {
 392       "tagname": "method",
 393       "name": "number",
 394       "member": "Ext.util.Format",
 395       "doc": "<p>Formats the passed number according to the passed format string.</p>\n\n\n<p>The number of digits after the decimal separator character specifies the number of\ndecimal places in the resulting string. The <u>local-specific</u> decimal character is used in the result.</p>\n\n\n<p>The <i>presence</i> of a thousand separator character in the format string specifies that\nthe <u>locale-specific</u> thousand separator (if any) is inserted separating thousand groups.</p>\n\n\n<p>By default, \",\" is expected as the thousand separator, and \".\" is expected as the decimal separator.</p>\n\n\n<p><b>New to Ext4</b></p>\n\n\n<p>Locale-specific characters are always used in the formatted output when inserting\nthousand and decimal separators.</p>\n\n\n<p>The format string must specify separator characters according to US/UK conventions (\",\" as the\nthousand separator, and \".\" as the decimal separator)</p>\n\n\n<p>To allow specification of format strings according to local conventions for separator characters, add\nthe string <code>/i</code> to the end of the format string.</p>\n\n\n<div style=\"margin-left:40px\">examples (123456.789):\n<div style=\"margin-left:10px\">\n0 - (123456) show only digits, no precision<br>\n0.00 - (123456.78) show only digits, 2 precision<br>\n0.0000 - (123456.7890) show only digits, 4 precision<br>\n0,000 - (123,456) show comma and digits, no precision<br>\n0,000.00 - (123,456.78) show comma and digits, 2 precision<br>\n0,0.00 - (123,456.78) shortcut method, show comma and digits, 2 precision<br>\nTo allow specification of the formatting string using UK/US grouping characters (,) and decimal (.) for international numbers, add /i to the end.\nFor example: 0.000,00/i\n</div></div>\n\n",
 396       "params": [
 397         {
 398           "type": "Number",
 399           "name": "v",
 400           "doc": "<p>The number to format.</p>\n",
 401           "optional": false
 402         },
 403         {
 404           "type": "String",
 405           "name": "format",
 406           "doc": "<p>The way you would like to format this text.</p>\n",
 407           "optional": false
 408         }
 409       ],
 410       "return": {
 411         "type": "String",
 412         "doc": "<p>The formatted number.</p>\n"
 413       },
 414       "private": false,
 415       "static": false,
 416       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 417       "linenr": 289,
 418       "html_filename": "Format.html",
 419       "href": "Format.html#Ext-util-Format-method-number",
 420       "shortDoc": "Formats the passed number according to the passed format string.\n\n\nThe number of digits after the decimal separator c..."
 421     },
 422     {
 423       "tagname": "method",
 424       "name": "numberRenderer",
 425       "member": "Ext.util.Format",
 426       "doc": "<p>Returns a number rendering function that can be reused to apply a number format multiple times efficiently</p>\n",
 427       "params": [
 428         {
 429           "type": "String",
 430           "name": "format",
 431           "doc": "<p>Any valid number format string for <a href=\"#/api/Ext.util.Format-method-number\" rel=\"Ext.util.Format-method-number\" class=\"docClass\">number</a></p>\n",
 432           "optional": false
 433         }
 434       ],
 435       "return": {
 436         "type": "Function",
 437         "doc": "<p>The number formatting function</p>\n"
 438       },
 439       "private": false,
 440       "static": false,
 441       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 442       "linenr": 402,
 443       "html_filename": "Format.html",
 444       "href": "Format.html#Ext-util-Format-method-numberRenderer",
 445       "shortDoc": "<p>Returns a number rendering function that can be reused to apply a number format multiple times efficiently</p>\n"
 446     },
 447     {
 448       "tagname": "method",
 449       "name": "parseBox",
 450       "member": "Ext.util.Format",
 451       "doc": "<p>Parses a number or string representing margin sizes into an object. Supports CSS-style margin declarations\n(e.g. 10, \"10\", \"10 10\", \"10 10 10\" and \"10 10 10 10\" are all valid options and would return the same result)</p>\n",
 452       "params": [
 453         {
 454           "type": "Number|String",
 455           "name": "v",
 456           "doc": "<p>The encoded margins</p>\n",
 457           "optional": false
 458         }
 459       ],
 460       "return": {
 461         "type": "Object",
 462         "doc": "<p>An object with margin sizes for top, right, bottom and left</p>\n"
 463       },
 464       "private": false,
 465       "static": false,
 466       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 467       "linenr": 479,
 468       "html_filename": "Format.html",
 469       "href": "Format.html#Ext-util-Format-method-parseBox",
 470       "shortDoc": "Parses a number or string representing margin sizes into an object. Supports CSS-style margin declarations\n(e.g. 10, ..."
 471     },
 472     {
 473       "tagname": "method",
 474       "name": "plural",
 475       "member": "Ext.util.Format",
 476       "doc": "<p>Selectively do a plural form of a word based on a numeric value. For example, in a template,\n{commentCount:plural(\"Comment\")}  would result in \"1 Comment\" if commentCount was 1 or would be \"x Comments\"\nif the value is 0 or greater than 1.</p>\n",
 477       "params": [
 478         {
 479           "type": "Number",
 480           "name": "value",
 481           "doc": "<p>The value to compare against</p>\n",
 482           "optional": false
 483         },
 484         {
 485           "type": "String",
 486           "name": "singular",
 487           "doc": "<p>The singular form of the word</p>\n",
 488           "optional": false
 489         },
 490         {
 491           "type": "String",
 492           "name": "plural",
 493           "doc": "<p>(optional) The plural form of the word (defaults to the singular with an \"s\")</p>\n",
 494           "optional": true
 495         }
 496       ],
 497       "return": {
 498         "type": "void",
 499         "doc": "\n"
 500       },
 501       "private": false,
 502       "static": false,
 503       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 504       "linenr": 413,
 505       "html_filename": "Format.html",
 506       "href": "Format.html#Ext-util-Format-method-plural",
 507       "shortDoc": "Selectively do a plural form of a word based on a numeric value. For example, in a template,\n{commentCount:plural(\"Co..."
 508     },
 509     {
 510       "tagname": "method",
 511       "name": "round",
 512       "member": "Ext.util.Format",
 513       "doc": "<p>Rounds the passed number to the required decimal precision.</p>\n",
 514       "params": [
 515         {
 516           "type": "Number/String",
 517           "name": "value",
 518           "doc": "<p>The numeric value to round.</p>\n",
 519           "optional": false
 520         },
 521         {
 522           "type": "Number",
 523           "name": "precision",
 524           "doc": "<p>The number of decimal places to which to round the first parameter's value.</p>\n",
 525           "optional": false
 526         }
 527       ],
 528       "return": {
 529         "type": "Number",
 530         "doc": "<p>The rounded value.</p>\n"
 531       },
 532       "private": false,
 533       "static": false,
 534       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 535       "linenr": 274,
 536       "html_filename": "Format.html",
 537       "href": "Format.html#Ext-util-Format-method-round",
 538       "shortDoc": "<p>Rounds the passed number to the required decimal precision.</p>\n"
 539     },
 540     {
 541       "tagname": "method",
 542       "name": "stripScripts",
 543       "member": "Ext.util.Format",
 544       "doc": "<p>Strips all script tags</p>\n",
 545       "params": [
 546         {
 547           "type": "Mixed",
 548           "name": "value",
 549           "doc": "<p>The text from which to strip script tags</p>\n",
 550           "optional": false
 551         }
 552       ],
 553       "return": {
 554         "type": "String",
 555         "doc": "<p>The stripped text</p>\n"
 556       },
 557       "private": false,
 558       "static": false,
 559       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 560       "linenr": 232,
 561       "html_filename": "Format.html",
 562       "href": "Format.html#Ext-util-Format-method-stripScripts",
 563       "shortDoc": "<p>Strips all script tags</p>\n"
 564     },
 565     {
 566       "tagname": "method",
 567       "name": "stripTags",
 568       "member": "Ext.util.Format",
 569       "doc": "<p>Strips all HTML tags</p>\n",
 570       "params": [
 571         {
 572           "type": "Mixed",
 573           "name": "value",
 574           "doc": "<p>The text from which to strip tags</p>\n",
 575           "optional": false
 576         }
 577       ],
 578       "return": {
 579         "type": "String",
 580         "doc": "<p>The stripped text</p>\n"
 581       },
 582       "private": false,
 583       "static": false,
 584       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 585       "linenr": 223,
 586       "html_filename": "Format.html",
 587       "href": "Format.html#Ext-util-Format-method-stripTags",
 588       "shortDoc": "<p>Strips all HTML tags</p>\n"
 589     },
 590     {
 591       "tagname": "method",
 592       "name": "substr",
 593       "member": "Ext.util.Format",
 594       "doc": "<p>Returns a substring from within an original string</p>\n",
 595       "params": [
 596         {
 597           "type": "String",
 598           "name": "value",
 599           "doc": "<p>The original text</p>\n",
 600           "optional": false
 601         },
 602         {
 603           "type": "Number",
 604           "name": "start",
 605           "doc": "<p>The start index of the substring</p>\n",
 606           "optional": false
 607         },
 608         {
 609           "type": "Number",
 610           "name": "length",
 611           "doc": "<p>The length of the substring</p>\n",
 612           "optional": false
 613         }
 614       ],
 615       "return": {
 616         "type": "String",
 617         "doc": "<p>The substring</p>\n"
 618       },
 619       "private": false,
 620       "static": false,
 621       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 622       "linenr": 127,
 623       "html_filename": "Format.html",
 624       "href": "Format.html#Ext-util-Format-method-substr",
 625       "shortDoc": "<p>Returns a substring from within an original string</p>\n"
 626     },
 627     {
 628       "tagname": "method",
 629       "name": "trim",
 630       "member": "Ext.util.Format",
 631       "doc": "<p>Trims any whitespace from either side of a string. See <a href=\"#/api/Ext.String-method-trim\" rel=\"Ext.String-method-trim\" class=\"docClass\">Ext.String.trim</a>.</p>\n",
 632       "params": [
 633
 634       ],
 635       "return": {
 636         "type": "void",
 637         "doc": "\n"
 638       },
 639       "private": false,
 640       "static": false,
 641       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 642       "linenr": 473,
 643       "html_filename": "Format.html",
 644       "href": "Format.html#Ext-util-Format-method-trim",
 645       "shortDoc": "<p>Trims any whitespace from either side of a string. See <a href=\"#/api/Ext.String-method-trim\" rel=\"Ext.String-method-trim\" class=\"docClass\">Ext.String.trim</a>.</p>\n"
 646     },
 647     {
 648       "tagname": "method",
 649       "name": "undef",
 650       "member": "Ext.util.Format",
 651       "doc": "<p>Checks a reference and converts it to empty string if it is undefined</p>\n",
 652       "params": [
 653         {
 654           "type": "Mixed",
 655           "name": "value",
 656           "doc": "<p>Reference to check</p>\n",
 657           "optional": false
 658         }
 659       ],
 660       "return": {
 661         "type": "Mixed",
 662         "doc": "<p>Empty string if converted, otherwise the original value</p>\n"
 663       },
 664       "private": false,
 665       "static": false,
 666       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 667       "linenr": 108,
 668       "html_filename": "Format.html",
 669       "href": "Format.html#Ext-util-Format-method-undef",
 670       "shortDoc": "<p>Checks a reference and converts it to empty string if it is undefined</p>\n"
 671     },
 672     {
 673       "tagname": "method",
 674       "name": "uppercase",
 675       "member": "Ext.util.Format",
 676       "doc": "<p>Converts a string to all upper case letters</p>\n",
 677       "params": [
 678         {
 679           "type": "String",
 680           "name": "value",
 681           "doc": "<p>The text to convert</p>\n",
 682           "optional": false
 683         }
 684       ],
 685       "return": {
 686         "type": "String",
 687         "doc": "<p>The converted text</p>\n"
 688       },
 689       "private": false,
 690       "static": false,
 691       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 692       "linenr": 147,
 693       "html_filename": "Format.html",
 694       "href": "Format.html#Ext-util-Format-method-uppercase",
 695       "shortDoc": "<p>Converts a string to all upper case letters</p>\n"
 696     },
 697     {
 698       "tagname": "method",
 699       "name": "usMoney",
 700       "member": "Ext.util.Format",
 701       "doc": "<p>Format a number as US currency</p>\n",
 702       "params": [
 703         {
 704           "type": "Number/String",
 705           "name": "value",
 706           "doc": "<p>The numeric value to format</p>\n",
 707           "optional": false
 708         }
 709       ],
 710       "return": {
 711         "type": "String",
 712         "doc": "<p>The formatted currency string</p>\n"
 713       },
 714       "private": false,
 715       "static": false,
 716       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 717       "linenr": 156,
 718       "html_filename": "Format.html",
 719       "href": "Format.html#Ext-util-Format-method-usMoney",
 720       "shortDoc": "<p>Format a number as US currency</p>\n"
 721     }
 722   ],
 723   "property": [
 724     {
 725       "tagname": "property",
 726       "name": "currencyAtEnd",
 727       "member": "Ext.util.Format",
 728       "type": "Boolean",
 729       "doc": "<p>This may be set to <code>true</code> to make the <a href=\"#/api/Ext.util.Format-method-currency\" rel=\"Ext.util.Format-method-currency\" class=\"docClass\">currency</a> function\nappend the currency sign to the formatted value.</p>\n\n\n<p>This defaults to <code>false</code>, but may be overridden in a locale file.</p>\n\n",
 730       "private": false,
 731       "static": false,
 732       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 733       "linenr": 99,
 734       "html_filename": "Format.html",
 735       "href": "Format.html#Ext-util-Format-property-currencyAtEnd",
 736       "shortDoc": "This may be set to true to make the currency function\nappend the currency sign to the formatted value.\n\n\nThis default..."
 737     },
 738     {
 739       "tagname": "property",
 740       "name": "currencyPrecision",
 741       "member": "Ext.util.Format",
 742       "type": "Number",
 743       "doc": "<p>The number of decimal places that the <a href=\"#/api/Ext.util.Format-method-currency\" rel=\"Ext.util.Format-method-currency\" class=\"docClass\">currency</a> function displays.</p>\n\n\n<p>This defaults to <code>2</code>, but may be overridden in a locale file.</p>\n\n",
 744       "private": false,
 745       "static": false,
 746       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 747       "linenr": 83,
 748       "html_filename": "Format.html",
 749       "href": "Format.html#Ext-util-Format-property-currencyPrecision",
 750       "shortDoc": "The number of decimal places that the currency function displays.\n\n\nThis defaults to 2, but may be overridden in a lo..."
 751     },
 752     {
 753       "tagname": "property",
 754       "name": "currencySign",
 755       "member": "Ext.util.Format",
 756       "type": "String",
 757       "doc": "<p>The currency sign that the <a href=\"#/api/Ext.util.Format-method-currency\" rel=\"Ext.util.Format-method-currency\" class=\"docClass\">currency</a> function displays.</p>\n\n\n<p>This defaults to <code>$</code>, but may be overridden in a locale file.</p>\n\n",
 758       "private": false,
 759       "static": false,
 760       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 761       "linenr": 91,
 762       "html_filename": "Format.html",
 763       "href": "Format.html#Ext-util-Format-property-currencySign"
 764     },
 765     {
 766       "tagname": "property",
 767       "name": "decimalSeparator",
 768       "member": "Ext.util.Format",
 769       "type": "String",
 770       "doc": "<p>The character that the <a href=\"#/api/Ext.util.Format-method-number\" rel=\"Ext.util.Format-method-number\" class=\"docClass\">number</a> function uses as a decimal point.</p>\n\n\n<p>This defaults to <code>.</code>, but may be overridden in a locale file.</p>\n\n",
 771       "private": false,
 772       "static": false,
 773       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 774       "linenr": 75,
 775       "html_filename": "Format.html",
 776       "href": "Format.html#Ext-util-Format-property-decimalSeparator",
 777       "shortDoc": "The character that the number function uses as a decimal point.\n\n\nThis defaults to ., but may be overridden in a loca..."
 778     },
 779     {
 780       "tagname": "property",
 781       "name": "thousandSeparator",
 782       "member": "Ext.util.Format",
 783       "type": "String",
 784       "doc": "<p>The character that the <a href=\"#/api/Ext.util.Format-method-number\" rel=\"Ext.util.Format-method-number\" class=\"docClass\">number</a> function uses as a thousand separator.</p>\n\n\n<p>This defaults to <code>,</code>, but may be overridden in a locale file.</p>\n\n",
 785       "private": false,
 786       "static": false,
 787       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 788       "linenr": 67,
 789       "html_filename": "Format.html",
 790       "href": "Format.html#Ext-util-Format-property-thousandSeparator",
 791       "shortDoc": "The character that the number function uses as a thousand separator.\n\n\nThis defaults to ,, but may be overridden in a..."
 792     }
 793   ],
 794   "event": [
 795
 796   ],
 797   "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/util/Format.js",
 798   "linenr": 1,
 799   "html_filename": "Format.html",
 800   "href": "Format.html#Ext-util-Format",
 801   "cssVar": [
 802
 803   ],
 804   "cssMixin": [
 805
 806   ],
 807   "component": false,
 808   "superclasses": [
 809
 810   ],
 811   "subclasses": [
 812
 813   ],
 814   "mixedInto": [
 815
 816   ],
 817   "allMixins": [
 818
 819   ]
 820 });