Package com.inet.report.chart.format
Class FixedNumberFormat
java.lang.Object
java.text.Format
java.text.NumberFormat
com.inet.report.chart.format.FixedNumberFormat
- All Implemented Interfaces:
ChartFormat
,Serializable
,Cloneable
This is a "fixed" number format.
There are three format styles available: number, percent and currency. The number style format shows the value as is.
The percent style format multiplies the values with 100 and shows the percent symbol. The currency style format shows the currency symbol.
The percent and currency symbol position is decided from locale to locale.
There are three format styles available: number, percent and currency. The number style format shows the value as is.
The percent style format multiplies the values with 100 and shows the percent symbol. The currency style format shows the currency symbol.
The percent and currency symbol position is decided from locale to locale.
- Since:
- 8.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.text.NumberFormat
NumberFormat.Field, NumberFormat.Style
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Abbreviation
The default abbreviation.static final int
Default number of decimal places.static final boolean
Default using of thousands separator.static final int
The currency format stylestatic final int
The number format stylestatic final int
The percent format stylestatic final int
Minus symbol is placed after number.static final int
Minus symbol is placed before number.static final int
Use brackets instead of minus.static final int
Use system default pattern for negative values.Fields inherited from class java.text.NumberFormat
FRACTION_FIELD, INTEGER_FIELD
-
Constructor Summary
ConstructorDescriptionCreates a new instance of format with typeFORMAT_NUMBER
and default properties.FixedNumberFormat
(int type) Creates a new instance of format with default properties. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Overrides Cloneableformat
(double number, StringBuffer toAppendTo, FieldPosition pos) format
(long number, StringBuffer toAppendTo, FieldPosition pos) Returns the abbreviation of formatted values.int
Returns the flag that control the placing and form of the minus symbol.protected String
getName()
FOR INTERNAL USE ONLY Returns the XML attribute name for this dataset.int
Returns the number of decimal places of this number format.int
getType()
Returns the formating type: number, currency or percent.boolean
Returns the flag that controls the showing of thousands separator.parse
(String source, ParsePosition parsePosition) void
readProperties
(Element element) Reads the XML properties of a chart format.void
saveProperties
(StringBuilder buffer, int depth) Writes the format properties to output.void
setAbbreviation
(Abbreviation abbreviation) Sets the abbreviation of formatted values.void
setFormatingProperties
(com.inet.report.chart.format.FormatingProperties properties) Sets the location specific formating properties, e.g. locale, time zone, first day of week.void
setMinusSymbol
(int minusSymbol) Sets the flag that control the placing and form of the minus symbol.void
setNumberOfDecimalPlaces
(int numberOfDecimalPlaces) Sets the number of decimal places of this number format.void
setUseThousandSeparator
(boolean useThousandSeparator) Sets the flag that controls the showing of thousands separator.Methods inherited from class java.text.NumberFormat
equals, format, format, format, getAvailableLocales, getCompactNumberInstance, getCompactNumberInstance, getCurrency, getCurrencyInstance, getCurrencyInstance, getInstance, getInstance, getIntegerInstance, getIntegerInstance, getMaximumFractionDigits, getMaximumIntegerDigits, getMinimumFractionDigits, getMinimumIntegerDigits, getNumberInstance, getNumberInstance, getPercentInstance, getPercentInstance, getRoundingMode, hashCode, isGroupingUsed, isParseIntegerOnly, parse, parseObject, setCurrency, setGroupingUsed, setMaximumFractionDigits, setMaximumIntegerDigits, setMinimumFractionDigits, setMinimumIntegerDigits, setParseIntegerOnly, setRoundingMode
Methods inherited from class java.text.Format
format, formatToCharacterIterator, parseObject
-
Field Details
-
DEFAULT_NUMBER_OF_DECIMAL_PLACES
public static final int DEFAULT_NUMBER_OF_DECIMAL_PLACESDefault number of decimal places.- See Also:
-
DEFAULT_USE_THOUSANDS_SEPARATOR
public static final boolean DEFAULT_USE_THOUSANDS_SEPARATORDefault using of thousands separator.- See Also:
-
DEFAULT_ABBREVIATION
The default abbreviation. -
MINUS_SIGN_BEFORE
public static final int MINUS_SIGN_BEFOREMinus symbol is placed before number.- See Also:
-
MINUS_SIGN_AFTER
public static final int MINUS_SIGN_AFTERMinus symbol is placed after number.- See Also:
-
MINUS_SIGN_BRACKETS
public static final int MINUS_SIGN_BRACKETSUse brackets instead of minus.- See Also:
-
MINUS_SIGN_SYSTEM_DEFAULT
public static final int MINUS_SIGN_SYSTEM_DEFAULTUse system default pattern for negative values.- See Also:
-
FORMAT_NUMBER
public static final int FORMAT_NUMBERThe number format style- See Also:
-
FORMAT_PERCENT
public static final int FORMAT_PERCENTThe percent format style- See Also:
-
FORMAT_CURRENCY
public static final int FORMAT_CURRENCYThe currency format style- See Also:
-
-
Constructor Details
-
FixedNumberFormat
public FixedNumberFormat()Creates a new instance of format with typeFORMAT_NUMBER
and default properties.- Since:
- 8.0
- See Also:
-
FixedNumberFormat
public FixedNumberFormat(int type) Creates a new instance of format with default properties.- Parameters:
type
- the formating type- Throws:
IllegalArgumentException
- by illegal type.- Since:
- 8.0
- See Also:
-
-
Method Details
-
getAbbreviation
Returns the abbreviation of formatted values.- Returns:
- the abbreviation
- Since:
- 8.0
- See Also:
-
setAbbreviation
Sets the abbreviation of formatted values. Note: this property works with number format only, not with currency or percent.- Parameters:
abbreviation
- the abbreviation (null
not permitted)- Since:
- 8.0
- See Also:
-
getNumberOfDecimalPlaces
public int getNumberOfDecimalPlaces()Returns the number of decimal places of this number format. The format handles a value with more digits to the right of the decimal point as set with this function by rounding up.- Returns:
- the number of decimals.
- Since:
- 8.0
- See Also:
-
setNumberOfDecimalPlaces
public void setNumberOfDecimalPlaces(int numberOfDecimalPlaces) Sets the number of decimal places of this number format. The format handles a value with more digits to the right of the decimal point as set with this function by rounding up.- Parameters:
numberOfDecimalPlaces
- the number of places- Throws:
IllegalArgumentException
- by negative number.- Since:
- 8.0
-
isUseThousandSeparator
public boolean isUseThousandSeparator()Returns the flag that controls the showing of thousands separator.- Returns:
- the flag.
- Since:
- 8.0
- See Also:
-
setUseThousandSeparator
public void setUseThousandSeparator(boolean useThousandSeparator) Sets the flag that controls the showing of thousands separator.- Parameters:
useThousandSeparator
- the flag- Since:
- 8.0
- See Also:
-
getMinusSymbol
public int getMinusSymbol()Returns the flag that control the placing and form of the minus symbol.- Returns:
- the flag.
- Since:
- 8.0
- See Also:
-
setMinusSymbol
public void setMinusSymbol(int minusSymbol) Sets the flag that control the placing and form of the minus symbol.- Parameters:
minusSymbol
- the flag- Since:
- 8.0
- See Also:
-
setFormatingProperties
public void setFormatingProperties(com.inet.report.chart.format.FormatingProperties properties) Sets the location specific formating properties, e.g. locale, time zone, first day of week.- Specified by:
setFormatingProperties
in interfaceChartFormat
- Parameters:
properties
- the properties object (null
not permitted)
-
format
- Specified by:
format
in classNumberFormat
-
format
- Specified by:
format
in classNumberFormat
-
parse
- Specified by:
parse
in classNumberFormat
-
saveProperties
Writes the format properties to output.- Specified by:
saveProperties
in interfaceChartFormat
- Parameters:
buffer
- the outputdepth
- the depth of XML indent
-
readProperties
Reads the XML properties of a chart format.- Specified by:
readProperties
in interfaceChartFormat
- Parameters:
element
- DOM element- See Also:
-
clone
Overrides Cloneable- Specified by:
clone
in interfaceChartFormat
- Overrides:
clone
in classNumberFormat
- Returns:
- the chart format
-
getName
FOR INTERNAL USE ONLY Returns the XML attribute name for this dataset.- Returns:
- the name.
-
getType
public int getType()Returns the formating type: number, currency or percent.- Returns:
- the type
- Since:
- 8.0
- See Also:
-