org.simpleods

Class NumberStyle

java.lang.Object

org.simpleods.NumberStyle

public class NumberStyle
extends java.lang.Object

Author:

martin

Field Summary

Fields

Modifier and Type	Field and Description
static int	NUMBER_FRACTION
static int	NUMBER_NORMAL
static int	NUMBER_PERCENTAGE
static int	NUMBER_SCIENTIFIC

Constructor Summary

Constructors

Constructor and Description
NumberStyle(java.lang.String sStyleName, int nMinIntDigits, int nDecPlaces, OdsFile odsFile) Create a new number style with the name sName, minimum integer digits is nMinIntDigits and decimal places is nDecPlaces.
NumberStyle(java.lang.String sStyleName, OdsFile odsFile) Create a new number style with the name sName, default minimum integer digits is 1 and default decimal places is 2.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCountry()
int	getDecimalPlaces() Get how many digits are to the right of the decimal symbol.
java.lang.String	getLanguage()
int	getMinExponentDigits() Get the current number of leading zeros.
int	getMinIntegerDigits() Get how many leading zeros are present.
java.lang.String	getName()
boolean	getThousandsSeparator() Get the current status of the thousands separator.
boolean	isNegativeValuesRed() Check if this style shows a red color for negative numbers.
void	setCountry(java.lang.String country) Set the country and language if you need to distinguish between different countries.
void	setDecimalPlaces(int decimalPlaces) Set how many digits are to the right of the decimal symbol.
void	setFractionValues(int nNumerator, int nDenominator) Add the numerator and denominator values to be shown.
void	setLanguage(java.lang.String language) Set the country and language if you need to distinguish between different countries.
void	setMinExponentDigits(int minExponentDigits) Set the number of exponent digits.
void	setMinIntegerDigits(int minIntegerDigits) Set how many leading zeros are present.
void	setName(java.lang.String name) Set the name of this style to sName, this name must be unique.
void	setNegativeValuesRed(boolean bValue) Set to true if negative values should be shown in red color.
void	setNumberType(int nType) Set the number type for this style.
void	setThousandsSeparator(boolean grouping) If this is set to true, the thousands separator is shown.
void	setToPercentageStyle() Set the number format to percentage.
java.lang.String	toXML() Write the XML format for this object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NUMBER_NORMAL

public static final int NUMBER_NORMAL

See Also:

Constant Field Values

NUMBER_SCIENTIFIC

public static final int NUMBER_SCIENTIFIC

See Also:

Constant Field Values

NUMBER_FRACTION

public static final int NUMBER_FRACTION

See Also:

Constant Field Values

NUMBER_PERCENTAGE

public static final int NUMBER_PERCENTAGE

See Also:

Constant Field Values

Constructor Detail

NumberStyle

public NumberStyle(java.lang.String sStyleName,
           OdsFile odsFile)

Create a new number style with the name sName, default minimum integer digits is 1 and default decimal places is 2.
Version 0.5.0 Added parameter OdsFile o

Parameters:

sStyleName - The name of the number style, this name must be unique.

odsFile - The OdsFile to which this style belongs to.

NumberStyle

public NumberStyle(java.lang.String sStyleName,
           int nMinIntDigits,
           int nDecPlaces,
           OdsFile odsFile)

Create a new number style with the name sName, minimum integer digits is nMinIntDigits and decimal places is nDecPlaces. The number style is NumberStyle.NUMBER_NORMAL
Version 0.5.0 Added parameter OdsFile o

Parameters:

sStyleName - The name of the number style, this name must be unique.

nMinIntDigits - The minimum integer digits to be shown.

nDecPlaces - The number of decimal places to be shown.

odsFile - The OdsFile to which this style belongs to.

Method Detail

getDecimalPlaces

public int getDecimalPlaces()

Get how many digits are to the right of the decimal symbol.

Returns:

The number of digits

setDecimalPlaces

public final void setDecimalPlaces(int decimalPlaces)

Set how many digits are to the right of the decimal symbol.

Parameters:

decimalPlaces - - The number of digits

getMinIntegerDigits

public int getMinIntegerDigits()

Get how many leading zeros are present.

Returns:

The number of leading zeros

setMinIntegerDigits

public final void setMinIntegerDigits(int minIntegerDigits)

Set how many leading zeros are present.

Parameters:

minIntegerDigits - The number of leading zeros

getMinExponentDigits

public int getMinExponentDigits()

Get the current number of leading zeros.

Returns:

The current number of leading zeros.

setMinExponentDigits

public void setMinExponentDigits(int minExponentDigits)

Set the number of exponent digits.
The number style is set to NUMBER_SCIENTIFIC.

Parameters:

minExponentDigits - The minimum of exponent digits to be used

setFractionValues

public void setFractionValues(int nNumerator,
                     int nDenominator)

Add the numerator and denominator values to be shown.
The number style is set to NUMBER_FRACTION

Parameters:

nNumerator -

nDenominator -

setNumberType

public void setNumberType(int nType)

Set the number type for this style.
Valid is one of the following:
NumberStyle.NUMBER_NORMAL
NumberStyle.NUMBER_SCIENTIFIC
NumberStyle.NUMBER_FRACTION
NumberStyle.NUMBER_PERCENTAGE

Parameters:

nType - The number type to be used.

getThousandsSeparator

public boolean getThousandsSeparator()

Get the current status of the thousands separator.

Returns:

true The thousands separator will be shown.

setThousandsSeparator

public void setThousandsSeparator(boolean grouping)

If this is set to true, the thousands separator is shown.
The default is false.

Parameters:

grouping - true, the thousands separator is shown
false, the thousands separator is not shown

getName

public java.lang.String getName()

Returns:

The name of this style.

setName

public final void setName(java.lang.String name)

Set the name of this style to sName, this name must be unique.

Parameters:

name - - The name of this style.

getLanguage

public java.lang.String getLanguage()

Returns:

The two letter language code, e.g. 'en'

setLanguage

public void setLanguage(java.lang.String language)

Set the country and language if you need to distinguish between different
countries. E.g. set it to country='US' and language='en'

Parameters:

language - The two letter language code, e.g. 'en'

getCountry

public java.lang.String getCountry()

Returns:

The two letter country code, e.g. 'US'

setCountry

public void setCountry(java.lang.String country)

Set the country and language if you need to distinguish between different countries. E.g. set it to country='US' and language='en'

Parameters:

country - The two letter country code, e.g. 'US'

isNegativeValuesRed

public boolean isNegativeValuesRed()

Check if this style shows a red color for negative numbers.

Returns:

true - for negative numbers the font is red
false - for negative numbers the font is not red

setNegativeValuesRed

public void setNegativeValuesRed(boolean bValue)

Set to true if negative values should be shown in red color.

Parameters:

bValue - true negative numbers will be shown in red color.

setToPercentageStyle

public void setToPercentageStyle()

Set the number format to percentage.

toXML

public java.lang.String toXML()

Write the XML format for this object.
This is used while writing the ODS file.

Returns:

The XML string for this object.