Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / docs / source / Format.html
diff --git a/docs/source/Format.html b/docs/source/Format.html
new file mode 100644 (file)
index 0000000..412b2f7
--- /dev/null
@@ -0,0 +1,359 @@
+<html>\r
+<head>\r
+  <title>The source code</title>\r
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
+</head>\r
+<body  onload="prettyPrint();">\r
+    <pre class="prettyprint lang-js"><div id="cls-Ext.util.Format"></div>/**\r
+ * @class Ext.util.Format\r
+ * Reusable data formatting functions\r
+ * @singleton\r
+ */\r
+Ext.util.Format = function(){\r
+    var trimRe = /^\s+|\s+$/g;\r
+    return {\r
+        <div id="method-Ext.util.Format-ellipsis"></div>/**\r
+         * Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length\r
+         * @param {String} value The string to truncate\r
+         * @param {Number} length The maximum length to allow before truncating\r
+         * @param {Boolean} word True to try to find a common work break\r
+         * @return {String} The converted text\r
+         */\r
+        ellipsis : function(value, len, word){\r
+            if(value && value.length > len){\r
+                if(word){\r
+                    var vs = value.substr(0, len - 2);\r
+                    var index = Math.max(vs.lastIndexOf(' '), vs.lastIndexOf('.'), vs.lastIndexOf('!'), vs.lastIndexOf('?'));\r
+                    if(index == -1 || index < (len - 15)){\r
+                        return value.substr(0, len - 3) + "...";\r
+                    }else{\r
+                        return vs.substr(0, index) + "...";\r
+                    }\r
+                } else{\r
+                    return value.substr(0, len - 3) + "...";\r
+                }\r
+            }\r
+            return value;\r
+        },\r
+\r
+        <div id="method-Ext.util.Format-undef"></div>/**\r
+         * Checks a reference and converts it to empty string if it is undefined\r
+         * @param {Mixed} value Reference to check\r
+         * @return {Mixed} Empty string if converted, otherwise the original value\r
+         */\r
+        undef : function(value){\r
+            return value !== undefined ? value : "";\r
+        },\r
+\r
+        <div id="method-Ext.util.Format-defaultValue"></div>/**\r
+         * Checks a reference and converts it to the default value if it's empty\r
+         * @param {Mixed} value Reference to check\r
+         * @param {String} defaultValue The value to insert of it's undefined (defaults to "")\r
+         * @return {String}\r
+         */\r
+        defaultValue : function(value, defaultValue){\r
+            return value !== undefined && value !== '' ? value : defaultValue;\r
+        },\r
+\r
+        <div id="method-Ext.util.Format-htmlEncode"></div>/**\r
+         * Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.\r
+         * @param {String} value The string to encode\r
+         * @return {String} The encoded text\r
+         */\r
+        htmlEncode : function(value){\r
+            return !value ? value : String(value).replace(/&/g, "&amp;").replace(/>/g, "&gt;").replace(/</g, "&lt;").replace(/"/g, "&quot;");\r
+        },\r
+\r
+        <div id="method-Ext.util.Format-htmlDecode"></div>/**\r
+         * Convert certain characters (&, <, >, and ') from their HTML character equivalents.\r
+         * @param {String} value The string to decode\r
+         * @return {String} The decoded text\r
+         */\r
+        htmlDecode : function(value){\r
+            return !value ? value : String(value).replace(/&gt;/g, ">").replace(/&lt;/g, "<").replace(/&quot;/g, '"').replace(/&amp;/g, "&");\r
+        },\r
+\r
+        <div id="method-Ext.util.Format-trim"></div>/**\r
+         * Trims any whitespace from either side of a string\r
+         * @param {String} value The text to trim\r
+         * @return {String} The trimmed text\r
+         */\r
+        trim : function(value){\r
+            return String(value).replace(trimRe, "");\r
+        },\r
+\r
+        <div id="method-Ext.util.Format-substr"></div>/**\r
+         * Returns a substring from within an original string\r
+         * @param {String} value The original text\r
+         * @param {Number} start The start index of the substring\r
+         * @param {Number} length The length of the substring\r
+         * @return {String} The substring\r
+         */\r
+        substr : function(value, start, length){\r
+            return String(value).substr(start, length);\r
+        },\r
+\r
+        <div id="method-Ext.util.Format-lowercase"></div>/**\r
+         * Converts a string to all lower case letters\r
+         * @param {String} value The text to convert\r
+         * @return {String} The converted text\r
+         */\r
+        lowercase : function(value){\r
+            return String(value).toLowerCase();\r
+        },\r
+\r
+        <div id="method-Ext.util.Format-uppercase"></div>/**\r
+         * Converts a string to all upper case letters\r
+         * @param {String} value The text to convert\r
+         * @return {String} The converted text\r
+         */\r
+        uppercase : function(value){\r
+            return String(value).toUpperCase();\r
+        },\r
+\r
+        <div id="method-Ext.util.Format-capitalize"></div>/**\r
+         * Converts the first character only of a string to upper case\r
+         * @param {String} value The text to convert\r
+         * @return {String} The converted text\r
+         */\r
+        capitalize : function(value){\r
+            return !value ? value : value.charAt(0).toUpperCase() + value.substr(1).toLowerCase();\r
+        },\r
+\r
+        // private\r
+        call : function(value, fn){\r
+            if(arguments.length > 2){\r
+                var args = Array.prototype.slice.call(arguments, 2);\r
+                args.unshift(value);\r
+                return eval(fn).apply(window, args);\r
+            }else{\r
+                return eval(fn).call(window, value);\r
+            }\r
+        },\r
+\r
+        <div id="method-Ext.util.Format-usMoney"></div>/**\r
+         * Format a number as US currency\r
+         * @param {Number/String} value The numeric value to format\r
+         * @return {String} The formatted currency string\r
+         */\r
+        usMoney : function(v){\r
+            v = (Math.round((v-0)*100))/100;\r
+            v = (v == Math.floor(v)) ? v + ".00" : ((v*10 == Math.floor(v*10)) ? v + "0" : v);\r
+            v = String(v);\r
+            var ps = v.split('.');\r
+            var whole = ps[0];\r
+            var sub = ps[1] ? '.'+ ps[1] : '.00';\r
+            var r = /(\d+)(\d{3})/;\r
+            while (r.test(whole)) {\r
+                whole = whole.replace(r, '$1' + ',' + '$2');\r
+            }\r
+            v = whole + sub;\r
+            if(v.charAt(0) == '-'){\r
+                return '-$' + v.substr(1);\r
+            }\r
+            return "$" +  v;\r
+        },\r
+\r
+        <div id="method-Ext.util.Format-date"></div>/**\r
+         * Parse a value into a formatted date using the specified format pattern.\r
+         * @param {String/Date} value The value to format (Strings must conform to the format expected by the javascript Date object's <a href="http://www.w3schools.com/jsref/jsref_parse.asp">parse()</a> method)\r
+         * @param {String} format (optional) Any valid date format string (defaults to 'm/d/Y')\r
+         * @return {String} The formatted date string\r
+         */\r
+        date : function(v, format){\r
+            if(!v){\r
+                return "";\r
+            }\r
+            if(!Ext.isDate(v)){\r
+                v = new Date(Date.parse(v));\r
+            }\r
+            return v.dateFormat(format || "m/d/Y");\r
+        },\r
+\r
+        <div id="method-Ext.util.Format-dateRenderer"></div>/**\r
+         * Returns a date rendering function that can be reused to apply a date format multiple times efficiently\r
+         * @param {String} format Any valid date format string\r
+         * @return {Function} The date formatting function\r
+         */\r
+        dateRenderer : function(format){\r
+            return function(v){\r
+                return Ext.util.Format.date(v, format);\r
+            };\r
+        },\r
+\r
+        // private\r
+        stripTagsRE : /<\/?[^>]+>/gi,\r
+        \r
+        <div id="method-Ext.util.Format-stripTags"></div>/**\r
+         * Strips all HTML tags\r
+         * @param {Mixed} value The text from which to strip tags\r
+         * @return {String} The stripped text\r
+         */\r
+        stripTags : function(v){\r
+            return !v ? v : String(v).replace(this.stripTagsRE, "");\r
+        },\r
+\r
+        stripScriptsRe : /(?:<script.*?>)((\n|\r|.)*?)(?:<\/script>)/ig,\r
+\r
+        <div id="method-Ext.util.Format-stripScripts"></div>/**\r
+         * Strips all script tags\r
+         * @param {Mixed} value The text from which to strip script tags\r
+         * @return {String} The stripped text\r
+         */\r
+        stripScripts : function(v){\r
+            return !v ? v : String(v).replace(this.stripScriptsRe, "");\r
+        },\r
+\r
+        <div id="method-Ext.util.Format-fileSize"></div>/**\r
+         * Simple format for a file size (xxx bytes, xxx KB, xxx MB)\r
+         * @param {Number/String} size The numeric value to format\r
+         * @return {String} The formatted file size\r
+         */\r
+        fileSize : function(size){\r
+            if(size < 1024) {\r
+                return size + " bytes";\r
+            } else if(size < 1048576) {\r
+                return (Math.round(((size*10) / 1024))/10) + " KB";\r
+            } else {\r
+                return (Math.round(((size*10) / 1048576))/10) + " MB";\r
+            }\r
+        },\r
+\r
+        <div id="method-Ext.util.Format-math"></div>/**\r
+         * It does simple math for use in a template, for example:<pre><code>\r
+         * var tpl = new Ext.Template('{value} * 10 = {value:math("* 10")}');\r
+         * </code></pre>\r
+         * @return {Function} A function that operates on the passed value.\r
+         */\r
+        math : function(){\r
+            var fns = {};\r
+            return function(v, a){\r
+                if(!fns[a]){\r
+                    fns[a] = new Function('v', 'return v ' + a + ';');\r
+                }\r
+                return fns[a](v);\r
+            }\r
+        }(),\r
+\r
+        <div id="method-Ext.util.Format-round"></div>/**\r
+         * Rounds the passed number to the required decimal precision.\r
+         * @param {Number/String} value The numeric value to round.\r
+         * @param {Number} precision The number of decimal places to which to round the first parameter's value.\r
+         * @return {Number} The rounded value.\r
+         */\r
+        round : function(value, precision) {\r
+            var result = Number(value);\r
+            if (typeof precision == 'number') {\r
+                precision = Math.pow(10, precision);\r
+                result = Math.round(value * precision) / precision;\r
+            }\r
+            return result;\r
+        },\r
+\r
+        <div id="method-Ext.util.Format-number"></div>/**\r
+         * Formats the number according to the format string.\r
+         * <div style="margin-left:40px">examples (123456.789):\r
+         * <div style="margin-left:10px">\r
+         * 0 - (123456) show only digits, no precision<br>\r
+         * 0.00 - (123456.78) show only digits, 2 precision<br>\r
+         * 0.0000 - (123456.7890) show only digits, 4 precision<br>\r
+         * 0,000 - (123,456) show comma and digits, no precision<br>\r
+         * 0,000.00 - (123,456.78) show comma and digits, 2 precision<br>\r
+         * 0,0.00 - (123,456.78) shortcut method, show comma and digits, 2 precision<br>\r
+         * To reverse the grouping (,) and decimal (.) for international numbers, add /i to the end.\r
+         * For example: 0.000,00/i\r
+         * </div></div>\r
+         * @param {Number} v The number to format.\r
+         * @param {String} format The way you would like to format this text.\r
+         * @return {String} The formatted number.\r
+         */\r
+        number: function(v, format) {\r
+            if(!format){\r
+                       return v;\r
+                   }\r
+                   v = Ext.num(v, NaN);\r
+            if (isNaN(v)){\r
+                return '';\r
+            }\r
+                   var comma = ',',\r
+                       dec = '.',\r
+                       i18n = false,\r
+                       neg = v < 0;\r
+               \r
+                   v = Math.abs(v);\r
+                   if(format.substr(format.length - 2) == '/i'){\r
+                       format = format.substr(0, format.length - 2);\r
+                       i18n = true;\r
+                       comma = '.';\r
+                       dec = ',';\r
+                   }\r
+               \r
+                   var hasComma = format.indexOf(comma) != -1, \r
+                       psplit = (i18n ? format.replace(/[^\d\,]/g, '') : format.replace(/[^\d\.]/g, '')).split(dec);\r
+               \r
+                   if(1 < psplit.length){\r
+                       v = v.toFixed(psplit[1].length);\r
+                   }else if(2 < psplit.length){\r
+                       throw ('NumberFormatException: invalid format, formats should have no more than 1 period: ' + format);\r
+                   }else{\r
+                       v = v.toFixed(0);\r
+                   }\r
+               \r
+                   var fnum = v.toString();\r
+                   if(hasComma){\r
+                       psplit = fnum.split('.');\r
+               \r
+                       var cnum = psplit[0], parr = [], j = cnum.length, m = Math.floor(j / 3), n = cnum.length % 3 || 3;\r
+               \r
+                       for(var i = 0; i < j; i += n){\r
+                           if(i != 0){\r
+                               n = 3;\r
+                           }\r
+                           parr[parr.length] = cnum.substr(i, n);\r
+                           m -= 1;\r
+                       }\r
+                       fnum = parr.join(comma);\r
+                       if(psplit[1]){\r
+                           fnum += dec + psplit[1];\r
+                       }\r
+                   }\r
+               \r
+                   return (neg ? '-' : '') + format.replace(/[\d,?\.?]+/, fnum);\r
+        },\r
+\r
+        <div id="method-Ext.util.Format-numberRenderer"></div>/**\r
+         * Returns a number rendering function that can be reused to apply a number format multiple times efficiently\r
+         * @param {String} format Any valid number format string for {@link #number}\r
+         * @return {Function} The number formatting function\r
+         */\r
+        numberRenderer : function(format){\r
+            return function(v){\r
+                return Ext.util.Format.number(v, format);\r
+            };\r
+        },\r
+\r
+        <div id="method-Ext.util.Format-plural"></div>/**\r
+         * Selectively do a plural form of a word based on a numeric value. For example, in a template,\r
+         * {commentCount:plural("Comment")}  would result in "1 Comment" if commentCount was 1 or would be "x Comments"\r
+         * if the value is 0 or greater than 1.\r
+         * @param {Number} value The value to compare against\r
+         * @param {String} singular The singular form of the word\r
+         * @param {String} plural (optional) The plural form of the word (defaults to the singular with an "s")\r
+         */\r
+        plural : function(v, s, p){\r
+            return v +' ' + (v == 1 ? s : (p ? p : s+'s'));\r
+        },\r
+        \r
+        <div id="method-Ext.util.Format-nl2br"></div>/**\r
+         * Converts newline characters to the HTML tag &lt;br/>\r
+         * @param {String} The string value to format.\r
+         * @return {String} The string with embedded &lt;br/> tags in place of newlines.\r
+         */\r
+        nl2br : function(v){\r
+            return v === undefined || v === null ? '' : v.replace(/\n/g, '<br/>');\r
+        }\r
+    }\r
+}();</pre>    \r
+</body>\r
+</html>
\ No newline at end of file