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

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