<g:formatNumber number="${myNumber}" format="\\$###,##0" />formatNumber
Purpose
Formats a number using the patterns defined by the {javase}java.base/java/text/DecimalFormat.html[DecimalFormat] class. Also supports attributes used in the JSTL formatNumber tag.
Examples
Example of formatting an EUR currency amount:
<g:formatNumber number="${myCurrencyAmount}" type="currency" currencyCode="EUR" />Example of formatting a USD currency amount:
<g:formatNumber number="${myCurrencyAmount}" type="currency" currencyCode="USD" />For USD, the currency symbol will be based on the locale of the request. For the "en_US" locale, the result is "$123.45" and for "fi_FI" locale, the formatting is "123,45 USD". The formatting rules come from the {javase}java.base/java/util/Currency.html[Currency] class.
Example of left padding a number with zeros:
<g:formatNumber number="${myNumber}" type="number" minIntegerDigits="9" />Example of formatting a number showing 2 fraction digits:
<g:formatNumber number="${myNumber}" type="number" maxFractionDigits="2" />Example of formatting a number showing 2 fraction digits, rounding with RoundingMode.HALF_DOWN:
<g:formatNumber number="${myNumber}" type="number"
maxFractionDigits="2" roundingMode="HALF_DOWN" />Description
Attributes
-
number(required) - The number object to format -
format(optional) - The formatting pattern to use for the number, see {javase}java.base/java/text/DecimalFormat.html[DecimalFormat] -
formatName(optional) - Look upformatfrom the default MessageSource / ResourceBundle (i18n/.properties file) with this key. Look upformatfrom the default MessageSource / ResourceBundle (i18n/.properties file) with this key. IfformatandformatNameare empty,formatis looked up with ‘default.number.format’ key. If the key is missing, '0' formatting pattern is used. -
type(optional) - The type of formatter to use: 'number', 'currency' or 'percent' .formatorformatNamearen’t used whentypeis specified. -
locale(optional) - Override the locale of the request , String or {javase}java.base/java/util/Locale.html[Locale] value -
groupingUsed(optional) - Set whether grouping will be used in this format. -
minIntegerDigits(optional) - Sets the minimum number of digits allowed in the integer portion of a number. -
maxIntegerDigits(optional) - Sets the maximum number of digits allowed in the integer portion of a number. -
minFractionDigits(optional) - Sets the minimum number of digits allowed in the fraction portion of a number. -
maxFractionDigits(optional) - Sets the maximum number of digits allowed in the fraction portion of a number. -
currencyCode(optional) - The standard currency code ('EUR', 'USD', etc.), uses formatting settings for the currency. type='currency' attribute is recommended. -
currencySymbol(optional) - Force the currency symbol to some symbol, recommended way is to usecurrencyCodeattribute instead (takes symbol information from {javase}java.base/java/util/Currency.html[Currency]) -
roundingMode(optional) - Sets the {javase}java.base/java/math/RoundingMode.html[RoundingMode] used in this DecimalFormat. Usual values:HALF_UP,HALF_DOWN. If roundingMode isUNNECESSARYand anArithemeticExceptionoccurs, the original number formatted with default number formatting will be returned.