git.roojs.org Git - roojs1/blob - docs/symbols/Roo.util.Format.json

   1 {
   2   "name" : "Roo.util.Format",
   3   "augments" : [],
   4   "desc" : "Reusable data formatting functions",
   5   "isSingleton" : true,
   6   "isStatic" : false,
   7   "isBuiltin" : false,
   8   "memberOf" : "Format",
   9   "example" : "",
  10   "deprecated" : "",
  11   "since" : "",
  12   "see" : "",
  13   "params" : [],
  14   "returns" : [],
  15   "config" : [],
  16   "methods" : [
  17     {
  18       "name" : "uppercase",
  19       "desc" : "Converts a string to all upper case letters",
  20       "isStatic" : false,
  21       "isConstructor" : false,
  22       "isPrivate" : false,
  23       "memberOf" : "Roo.util.Format",
  24       "example" : "",
  25       "deprecated" : "",
  26       "since" : "",
  27       "see" : "",
  28       "params" : [
  29         {
  30           "name" : "value",
  31           "type" : "String",
  32           "desc" : "The text to convert",
  33           "isOptional" : false
  34         }
  35       ],
  36       "returns" : [
  37         {
  38           "name" : "",
  39           "type" : "String",
  40           "desc" : "The converted text"
  41         }
  42       ]
  43     },
  44     {
  45       "name" : "date",
  46       "desc" : "Parse a value into a formatted date using the specified format pattern.",
  47       "isStatic" : false,
  48       "isConstructor" : false,
  49       "isPrivate" : false,
  50       "memberOf" : "Roo.util.Format",
  51       "example" : "",
  52       "deprecated" : "",
  53       "since" : "",
  54       "see" : "",
  55       "params" : [
  56         {
  57           "name" : "value",
  58           "type" : "Mixed",
  59           "desc" : "The value to format",
  60           "isOptional" : false
  61         },
  62         {
  63           "name" : "format",
  64           "type" : "String",
  65           "desc" : "(optional) Any valid date format string (defaults to 'm/d/Y')",
  66           "isOptional" : false
  67         }
  68       ],
  69       "returns" : [
  70         {
  71           "name" : "",
  72           "type" : "String",
  73           "desc" : "The formatted date string"
  74         }
  75       ]
  76     },
  77     {
  78       "name" : "lowercase",
  79       "desc" : "Converts a string to all lower case letters",
  80       "isStatic" : false,
  81       "isConstructor" : false,
  82       "isPrivate" : false,
  83       "memberOf" : "Roo.util.Format",
  84       "example" : "",
  85       "deprecated" : "",
  86       "since" : "",
  87       "see" : "",
  88       "params" : [
  89         {
  90           "name" : "value",
  91           "type" : "String",
  92           "desc" : "The text to convert",
  93           "isOptional" : false
  94         }
  95       ],
  96       "returns" : [
  97         {
  98           "name" : "",
  99           "type" : "String",
 100           "desc" : "The converted text"
 101         }
 102       ]
 103     },
 104     {
 105       "name" : "undef",
 106       "desc" : "Checks a reference and converts it to empty string if it is undefined",
 107       "isStatic" : false,
 108       "isConstructor" : false,
 109       "isPrivate" : false,
 110       "memberOf" : "Roo.util.Format",
 111       "example" : "",
 112       "deprecated" : "",
 113       "since" : "",
 114       "see" : "",
 115       "params" : [
 116         {
 117           "name" : "value",
 118           "type" : "Mixed",
 119           "desc" : "Reference to check",
 120           "isOptional" : false
 121         }
 122       ],
 123       "returns" : [
 124         {
 125           "name" : "",
 126           "type" : "Mixed",
 127           "desc" : "Empty string if converted, otherwise the original value"
 128         }
 129       ]
 130     },
 131     {
 132       "name" : "stripTags",
 133       "desc" : "Strips all HTML tags",
 134       "isStatic" : false,
 135       "isConstructor" : false,
 136       "isPrivate" : false,
 137       "memberOf" : "Roo.util.Format",
 138       "example" : "",
 139       "deprecated" : "",
 140       "since" : "",
 141       "see" : "",
 142       "params" : [
 143         {
 144           "name" : "value",
 145           "type" : "Mixed",
 146           "desc" : "The text from which to strip tags",
 147           "isOptional" : false
 148         }
 149       ],
 150       "returns" : [
 151         {
 152           "name" : "",
 153           "type" : "String",
 154           "desc" : "The stripped text"
 155         }
 156       ]
 157     },
 158     {
 159       "name" : "ellipsis",
 160       "desc" : "Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length",
 161       "isStatic" : false,
 162       "isConstructor" : false,
 163       "isPrivate" : false,
 164       "memberOf" : "Roo.util.Format",
 165       "example" : "",
 166       "deprecated" : "",
 167       "since" : "",
 168       "see" : "",
 169       "params" : [
 170         {
 171           "name" : "value",
 172           "type" : "String",
 173           "desc" : "The string to truncate",
 174           "isOptional" : false
 175         },
 176         {
 177           "name" : "length",
 178           "type" : "Number",
 179           "desc" : "The maximum length to allow before truncating",
 180           "isOptional" : false
 181         }
 182       ],
 183       "returns" : [
 184         {
 185           "name" : "",
 186           "type" : "String",
 187           "desc" : "The converted text"
 188         }
 189       ]
 190     },
 191     {
 192       "name" : "htmlDecode",
 193       "desc" : "Convert certain characters (&, <, >, and ') from their HTML character equivalents.",
 194       "isStatic" : false,
 195       "isConstructor" : false,
 196       "isPrivate" : false,
 197       "memberOf" : "Roo.util.Format",
 198       "example" : "",
 199       "deprecated" : "",
 200       "since" : "",
 201       "see" : "",
 202       "params" : [
 203         {
 204           "name" : "value",
 205           "type" : "String",
 206           "desc" : "The string to decode",
 207           "isOptional" : false
 208         }
 209       ],
 210       "returns" : [
 211         {
 212           "name" : "",
 213           "type" : "String",
 214           "desc" : "The decoded text"
 215         }
 216       ]
 217     },
 218     {
 219       "name" : "htmlEncode",
 220       "desc" : "Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.",
 221       "isStatic" : false,
 222       "isConstructor" : false,
 223       "isPrivate" : false,
 224       "memberOf" : "Roo.util.Format",
 225       "example" : "",
 226       "deprecated" : "",
 227       "since" : "",
 228       "see" : "",
 229       "params" : [
 230         {
 231           "name" : "value",
 232           "type" : "String",
 233           "desc" : "The string to encode",
 234           "isOptional" : false
 235         }
 236       ],
 237       "returns" : [
 238         {
 239           "name" : "",
 240           "type" : "String",
 241           "desc" : "The encoded text"
 242         }
 243       ]
 244     },
 245     {
 246       "name" : "size",
 247       "desc" : "Size in Mb,Gb etc.",
 248       "isStatic" : false,
 249       "isConstructor" : false,
 250       "isPrivate" : false,
 251       "memberOf" : "Roo.util.Format",
 252       "example" : "",
 253       "deprecated" : "",
 254       "since" : "",
 255       "see" : "",
 256       "params" : [
 257         {
 258           "name" : "value",
 259           "type" : "Number",
 260           "desc" : "The number to be formated",
 261           "isOptional" : false
 262         },
 263         {
 264           "name" : "decimals",
 265           "type" : "number",
 266           "desc" : "how many decimal places",
 267           "isOptional" : false
 268         }
 269       ],
 270       "returns" : [
 271         {
 272           "name" : "",
 273           "type" : "String",
 274           "desc" : "the formated string"
 275         }
 276       ]
 277     },
 278     {
 279       "name" : "toFixed",
 280       "desc" : "safer version of Math.toFixed..??/",
 281       "isStatic" : false,
 282       "isConstructor" : false,
 283       "isPrivate" : false,
 284       "memberOf" : "Roo.util.Format",
 285       "example" : "",
 286       "deprecated" : "",
 287       "since" : "",
 288       "see" : "",
 289       "params" : [
 290         {
 291           "name" : "value",
 292           "type" : "Number/String",
 293           "desc" : "The numeric value to format",
 294           "isOptional" : false
 295         },
 296         {
 297           "name" : "value",
 298           "type" : "Number/String",
 299           "desc" : "Decimal places",
 300           "isOptional" : false
 301         }
 302       ],
 303       "returns" : [
 304         {
 305           "name" : "",
 306           "type" : "String",
 307           "desc" : "The formatted currency string"
 308         }
 309       ]
 310     },
 311     {
 312       "name" : "substr",
 313       "desc" : "Returns a substring from within an original string",
 314       "isStatic" : false,
 315       "isConstructor" : false,
 316       "isPrivate" : false,
 317       "memberOf" : "Roo.util.Format",
 318       "example" : "",
 319       "deprecated" : "",
 320       "since" : "",
 321       "see" : "",
 322       "params" : [
 323         {
 324           "name" : "value",
 325           "type" : "String",
 326           "desc" : "The original text",
 327           "isOptional" : false
 328         },
 329         {
 330           "name" : "start",
 331           "type" : "Number",
 332           "desc" : "The start index of the substring",
 333           "isOptional" : false
 334         },
 335         {
 336           "name" : "length",
 337           "type" : "Number",
 338           "desc" : "The length of the substring",
 339           "isOptional" : false
 340         }
 341       ],
 342       "returns" : [
 343         {
 344           "name" : "",
 345           "type" : "String",
 346           "desc" : "The substring"
 347         }
 348       ]
 349     },
 350     {
 351       "name" : "number",
 352       "desc" : "Format a number\neventually this should probably emulate php's number_format",
 353       "isStatic" : false,
 354       "isConstructor" : false,
 355       "isPrivate" : false,
 356       "memberOf" : "Roo.util.Format",
 357       "example" : "",
 358       "deprecated" : "",
 359       "since" : "",
 360       "see" : "",
 361       "params" : [
 362         {
 363           "name" : "value",
 364           "type" : "Number/String",
 365           "desc" : "The numeric value to format",
 366           "isOptional" : false
 367         },
 368         {
 369           "name" : "decimals",
 370           "type" : "Number",
 371           "desc" : "number of decimal places",
 372           "isOptional" : false
 373         },
 374         {
 375           "name" : "delimiter",
 376           "type" : "String",
 377           "desc" : "for thousands (default comma)",
 378           "isOptional" : false
 379         }
 380       ],
 381       "returns" : [
 382         {
 383           "name" : "",
 384           "type" : "String",
 385           "desc" : "The formatted currency string"
 386         }
 387       ]
 388     },
 389     {
 390       "name" : "usMoney",
 391       "desc" : "Format a number as US currency",
 392       "isStatic" : false,
 393       "isConstructor" : false,
 394       "isPrivate" : false,
 395       "memberOf" : "Roo.util.Format",
 396       "example" : "",
 397       "deprecated" : "",
 398       "since" : "",
 399       "see" : "",
 400       "params" : [
 401         {
 402           "name" : "value",
 403           "type" : "Number/String",
 404           "desc" : "The numeric value to format",
 405           "isOptional" : false
 406         }
 407       ],
 408       "returns" : [
 409         {
 410           "name" : "",
 411           "type" : "String",
 412           "desc" : "The formatted currency string"
 413         }
 414       ]
 415     },
 416     {
 417       "name" : "capitalize",
 418       "desc" : "Converts the first character only of a string to upper case",
 419       "isStatic" : false,
 420       "isConstructor" : false,
 421       "isPrivate" : false,
 422       "memberOf" : "Roo.util.Format",
 423       "example" : "",
 424       "deprecated" : "",
 425       "since" : "",
 426       "see" : "",
 427       "params" : [
 428         {
 429           "name" : "value",
 430           "type" : "String",
 431           "desc" : "The text to convert",
 432           "isOptional" : false
 433         }
 434       ],
 435       "returns" : [
 436         {
 437           "name" : "",
 438           "type" : "String",
 439           "desc" : "The converted text"
 440         }
 441       ]
 442     },
 443     {
 444       "name" : "trim",
 445       "desc" : "Trims any whitespace from either side of a string",
 446       "isStatic" : false,
 447       "isConstructor" : false,
 448       "isPrivate" : false,
 449       "memberOf" : "Roo.util.Format",
 450       "example" : "",
 451       "deprecated" : "",
 452       "since" : "",
 453       "see" : "",
 454       "params" : [
 455         {
 456           "name" : "value",
 457           "type" : "String",
 458           "desc" : "The text to trim",
 459           "isOptional" : false
 460         }
 461       ],
 462       "returns" : [
 463         {
 464           "name" : "",
 465           "type" : "String",
 466           "desc" : "The trimmed text"
 467         }
 468       ]
 469     },
 470     {
 471       "name" : "dateRenderer",
 472       "desc" : "Returns a date rendering function that can be reused to apply a date format multiple times efficiently",
 473       "isStatic" : false,
 474       "isConstructor" : false,
 475       "isPrivate" : false,
 476       "memberOf" : "Roo.util.Format",
 477       "example" : "",
 478       "deprecated" : "",
 479       "since" : "",
 480       "see" : "",
 481       "params" : [
 482         {
 483           "name" : "format",
 484           "type" : "String",
 485           "desc" : "Any valid date format string",
 486           "isOptional" : false
 487         }
 488       ],
 489       "returns" : [
 490         {
 491           "name" : "",
 492           "type" : "Function",
 493           "desc" : "The date formatting function"
 494         }
 495       ]
 496     }
 497   ],
 498   "events" : []
 499 }