Class CQ.Ext.util.Format

Package:	CQ.Ext.util
Class:	Format
Extends:	Object
Clientlib:	cq.widgets

Reusable data formatting functions

This class is a singleton and cannot be created directly.

Public Properties

This class has no public properties.

Public Methods

Method		Defined By
	capitalize( `String value` ) : String Converts the first character only of a string to upper case Converts the first character only of a string to upper case Parameters: `value` : String The text to convert Returns: `String` The converted text	Format
	date( `String/Date value`, [`String format`] ) : String Parse a value into a formatted date using the specified format pattern. Parse a value into a formatted date using the specified format pattern. Parameters: `value` : String/Date The value to format (Strings must conform to the format expected by the javascript Date object's parse() method) `format` : String (optional) Any valid date format string (defaults to 'm/d/Y') Returns: `String` The formatted date string	Format
	dateRenderer( `String format` ) : Function Returns a date rendering function that can be reused to apply a date format multiple times efficiently Returns a date rendering function that can be reused to apply a date format multiple times efficiently Parameters: `format` : String Any valid date format string Returns: `Function` The date formatting function	Format
	defaultValue( `Mixed value`, `String defaultValue` ) : String Checks a reference and converts it to the default value if it's empty Checks a reference and converts it to the default value if it's empty Parameters: `value` : Mixed Reference to check `defaultValue` : String The value to insert of it's undefined (defaults to "") Returns: `String`	Format
	ellipsis( `String value`, `Number length`, `Boolean word` ) : String Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length Parameters: `value` : String The string to truncate `length` : Number The maximum length to allow before truncating `word` : Boolean True to try to find a common work break Returns: `String` The converted text	Format
	fileSize( `Number/String size` ) : String Simple format for a file size (xxx bytes, xxx KB, xxx MB) Simple format for a file size (xxx bytes, xxx KB, xxx MB) Parameters: `size` : Number/String The numeric value to format Returns: `String` The formatted file size	Format
	htmlDecode( `String value` ) : String Convert certain characters (&, <, >, and ') from their HTML character equivalents. Convert certain characters (&, <, >, and ') from their HTML character equivalents. Parameters: `value` : String The string to decode Returns: `String` The decoded text	Format
	htmlEncode( `String value` ) : String Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages. Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages. Parameters: `value` : String The string to encode Returns: `String` The encoded text	Format
	lowercase( `String value` ) : String Converts a string to all lower case letters Converts a string to all lower case letters Parameters: `value` : String The text to convert Returns: `String` The converted text	Format
	math() : Function It does simple math for use in a template, for example:var tpl = new CQ.Ext.Template('{value} * 10 = {value:math("* 1... It does simple math for use in a template, for example: `var tpl = new CQ.Ext.Template('{value} * 10 = {value:math("* 10")}');` Parameters: None. Returns: `Function` A function that operates on the passed value.	Format
	nl2br( `String The` ) : String Converts newline characters to the HTML tag <br/> Converts newline characters to the HTML tag <br/> Parameters: `The` : String string value to format. Returns: `String` The string with embedded <br/> tags in place of newlines.	Format
	number( `Number v`, `String format` ) : String Formats the number according to the format string. examples (123456.789): 0 - (123456) show only digits, no precisio... Formats the number according to the format string. examples (123456.789): 0 - (123456) show only digits, no precision 0.00 - (123456.78) show only digits, 2 precision 0.0000 - (123456.7890) show only digits, 4 precision 0,000 - (123,456) show comma and digits, no precision 0,000.00 - (123,456.78) show comma and digits, 2 precision 0,0.00 - (123,456.78) shortcut method, show comma and digits, 2 precision To reverse the grouping (,) and decimal (.) for international numbers, add /i to the end. For example: 0.000,00/i Parameters: `v` : Number The number to format. `format` : String The way you would like to format this text. Returns: `String` The formatted number.	Format
	numberRenderer( `String format` ) : Function Returns a number rendering function that can be reused to apply a number format multiple times efficiently Returns a number rendering function that can be reused to apply a number format multiple times efficiently Parameters: `format` : String Any valid number format string for number Returns: `Function` The number formatting function	Format
	plural( `Number value`, `String singular`, [`String plural`] ) : void Selectively do a plural form of a word based on a numeric value. For example, in a template, {commentCount:plural("Co... Selectively do a plural form of a word based on a numeric value. For example, in a template, {commentCount:plural("Comment")} would result in "1 Comment" if commentCount was 1 or would be "x Comments" if the value is 0 or greater than 1. Parameters: `value` : Number The value to compare against `singular` : String The singular form of the word `plural` : String (optional) The plural form of the word (defaults to the singular with an "s") Returns: `void`	Format
	round( `Number/String value`, `Number precision` ) : Number Rounds the passed number to the required decimal precision. Rounds the passed number to the required decimal precision. Parameters: `value` : Number/String The numeric value to round. `precision` : Number The number of decimal places to which to round the first parameter's value. Returns: `Number` The rounded value.	Format
	stripScripts( `Mixed value` ) : String Strips all script tags Strips all script tags Parameters: `value` : Mixed The text from which to strip script tags Returns: `String` The stripped text	Format
	stripTags( `Mixed value` ) : String Strips all HTML tags Strips all HTML tags Parameters: `value` : Mixed The text from which to strip tags Returns: `String` The stripped text	Format
	substr( `String value`, `Number start`, `Number length` ) : String Returns a substring from within an original string Returns a substring from within an original string Parameters: `value` : String The original text `start` : Number The start index of the substring `length` : Number The length of the substring Returns: `String` The substring	Format
	trim( `String value` ) : String Trims any whitespace from either side of a string Trims any whitespace from either side of a string Parameters: `value` : String The text to trim Returns: `String` The trimmed text	Format
	undef( `Mixed value` ) : Mixed Checks a reference and converts it to empty string if it is undefined Checks a reference and converts it to empty string if it is undefined Parameters: `value` : Mixed Reference to check Returns: `Mixed` Empty string if converted, otherwise the original value	Format
	uppercase( `String value` ) : String Converts a string to all upper case letters Converts a string to all upper case letters Parameters: `value` : String The text to convert Returns: `String` The converted text	Format
	usMoney( `Number/String value` ) : String Format a number as US currency Format a number as US currency Parameters: `value` : Number/String The numeric value to format Returns: `String` The formatted currency string	Format

Public Events

This class has no public events.