+++ /dev/null
-{
- "name" : "Roo.util.Format",
- "augments" : [
- ],
- "desc" : "Reusable data formatting functions",
- "isSingleton" : true,
- "isStatic" : false,
- "isBuiltin" : false,
- "memberOf" : "Format",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- ],
- "returns" : [
- ],
- "config" : [
- ],
- "methods" : [
- {
- "name" : "uppercase",
- "desc" : "Converts a string to all upper case letters",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Format",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The text to convert",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The converted text"
- }
- ]
- },
- {
- "name" : "date",
- "desc" : "Parse a value into a formatted date using the specified format pattern.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Format",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to format",
- "isOptional" : false
- },
- {
- "name" : "format",
- "type" : "String",
- "desc" : "(optional) Any valid date format string (defaults to 'm/d/Y')",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The formatted date string"
- }
- ]
- },
- {
- "name" : "lowercase",
- "desc" : "Converts a string to all lower case letters",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Format",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The text to convert",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The converted text"
- }
- ]
- },
- {
- "name" : "undef",
- "desc" : "Checks a reference and converts it to empty string if it is undefined",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Format",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "Reference to check",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "Empty string if converted, otherwise the original value"
- }
- ]
- },
- {
- "name" : "stripTags",
- "desc" : "Strips all HTML tags",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Format",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The text from which to strip tags",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The stripped text"
- }
- ]
- },
- {
- "name" : "ellipsis",
- "desc" : "Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Format",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The string to truncate",
- "isOptional" : false
- },
- {
- "name" : "length",
- "type" : "Number",
- "desc" : "The maximum length to allow before truncating",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The converted text"
- }
- ]
- },
- {
- "name" : "htmlDecode",
- "desc" : "Convert certain characters (&, <, >, and ') from their HTML character equivalents.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Format",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The string to decode",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The decoded text"
- }
- ]
- },
- {
- "name" : "htmlEncode",
- "desc" : "Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Format",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The string to encode",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The encoded text"
- }
- ]
- },
- {
- "name" : "toFixed",
- "desc" : "safer version of Math.toFixed..??/",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Format",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Number/String",
- "desc" : "The numeric value to format",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "Number/String",
- "desc" : "Decimal places",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The formatted currency string"
- }
- ]
- },
- {
- "name" : "substr",
- "desc" : "Returns a substring from within an original string",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Format",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The original text",
- "isOptional" : false
- },
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "The start index of the substring",
- "isOptional" : false
- },
- {
- "name" : "length",
- "type" : "Number",
- "desc" : "The length of the substring",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The substring"
- }
- ]
- },
- {
- "name" : "number",
- "desc" : "Format a number\neventually this should probably emulate php's number_format",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Format",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Number/String",
- "desc" : "The numeric value to format",
- "isOptional" : false
- },
- {
- "name" : "decimals",
- "type" : "Number",
- "desc" : "number of decimal places",
- "isOptional" : false
- },
- {
- "name" : "delimiter",
- "type" : "String",
- "desc" : "for thousands (default comma)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The formatted currency string"
- }
- ]
- },
- {
- "name" : "usMoney",
- "desc" : "Format a number as US currency",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Format",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Number/String",
- "desc" : "The numeric value to format",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The formatted currency string"
- }
- ]
- },
- {
- "name" : "capitalize",
- "desc" : "Converts the first character only of a string to upper case",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Format",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The text to convert",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The converted text"
- }
- ]
- },
- {
- "name" : "trim",
- "desc" : "Trims any whitespace from either side of a string",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Format",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The text to trim",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The trimmed text"
- }
- ]
- },
- {
- "name" : "dateRenderer",
- "desc" : "Returns a date rendering function that can be reused to apply a date format multiple times efficiently",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.util.Format",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "format",
- "type" : "String",
- "desc" : "Any valid date format string",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Function",
- "desc" : "The date formatting function"
- }
- ]
- }
- ],
- "events" : [
- ]
-}
\ No newline at end of file