org.simpleods

Class CurrencyStyle

java.lang.Object

org.simpleods.CurrencyStyle

public class CurrencyStyle
extends java.lang.Object

Author:

Martin Schulz
Copyright 2008-2013 Martin Schulz
This file CurrencyStyle.java is part of SimpleODS.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NUMBER_CURRENCY
static int	SYMBOLPOSITION_BEGIN
static int	SYMBOLPOSITION_END

Constructor Summary

Constructors

Constructor and Description
CurrencyStyle(java.lang.String sName, 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.
CurrencyStyle(java.lang.String sName, 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()
java.lang.String	getCurrencySymbol()
int	getCurrencySymbolPosition() Get the position of the currency symbol.
int	getDecimalPlaces() Get how many digits are to the right of the decimal symbol.
java.lang.String	getLanguage()
int	getMinIntegerDigits() Get how many leading zeros are present.
java.lang.String	getName() Get the name of this currency style.
java.lang.String	getNegativeValueColor()
boolean	getThousandsSeparator()
void	setCountry(java.lang.String country) Set the country and language if you need to distinguish between different countries.
void	setCurrencySymbol(java.lang.String currencySymbol) Change the currency symbol, e.g. '$'.
void	setCurrencySymbolPosition(int nPos) Set the position of the currency symbol, either CurrencyStyle.SYMBOLPOSITION_BEGIN or CurrencyStyle.SYMBOLPOSITION_END.
void	setDecimalPlaces(int decimalPlaces) Set how many digits are to the right of the decimal symbol.
void	setLanguage(java.lang.String language) Set the country and language if you need to distinguish between different countries.
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.
void	setNegativeValueColor(java.lang.String negativeValueColor)
void	setThousandsSeparator(boolean grouping) If this is set to true, the thousands separator is shown.
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_CURRENCY

public static final int NUMBER_CURRENCY

See Also:

Constant Field Values

SYMBOLPOSITION_BEGIN

public static final int SYMBOLPOSITION_BEGIN

See Also:

Constant Field Values

SYMBOLPOSITION_END

public static final int SYMBOLPOSITION_END

See Also:

Constant Field Values

Constructor Detail

CurrencyStyle

public CurrencyStyle(java.lang.String sName,
             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:

sName - The name of the number style.

odsFile - The OdsFile to which this style belongs

CurrencyStyle

public CurrencyStyle(java.lang.String sName,
             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:

sName - The name of the number style.

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

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 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 void setMinIntegerDigits(int minIntegerDigits)

Set how many leading zeros are present.

Parameters:

minIntegerDigits - The number of leading zeros

getThousandsSeparator

public boolean getThousandsSeparator()

setThousandsSeparator

public void setThousandsSeparator(boolean grouping)

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

Parameters:

grouping -

getName

public java.lang.String getName()

Get the name of this currency style.

Returns:

The currency style name

setName

public void setName(java.lang.String name)

Set the name of this style to sName.

Parameters:

name - - The name of this style

getCurrencySymbolPosition

public int getCurrencySymbolPosition()

Get the position of the currency symbol.

Returns:

either CurrencyStyle.SYMBOLPOSITION_BEGIN or CurrencyStyle.SYMBOLPOSITION_END

setCurrencySymbolPosition

public void setCurrencySymbolPosition(int nPos)

Set the position of the currency symbol, either CurrencyStyle.SYMBOLPOSITION_BEGIN or CurrencyStyle.SYMBOLPOSITION_END.

Parameters:

nPos -

getNegativeValueColor

public java.lang.String getNegativeValueColor()

setNegativeValueColor

public void setNegativeValueColor(java.lang.String negativeValueColor)

getCurrencySymbol

public java.lang.String getCurrencySymbol()

Returns:

The currency symbol that is used. e.g. '$'.

setCurrencySymbol

public void setCurrencySymbol(java.lang.String currencySymbol)

Change the currency symbol, e.g. '$'.

Parameters:

currencySymbol -

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'

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.