com.github.jferard.fastods.datastyle

Class FractionStyleBuilder

java.lang.Object

com.github.jferard.fastods.datastyle.FractionStyleBuilder

All Implemented Interfaces:

DataStyleBuilder<FractionStyle,FractionStyleBuilder>, IsVolatileBuilder<FractionStyleBuilder>, LocalizedBuilder<FractionStyleBuilder>, NumberStyleBuilder<FractionStyle,FractionStyleBuilder>, ShowableBuilder<FractionStyleBuilder>, StyleBuilder<FractionStyle>

public class FractionStyleBuilder
extends Object
implements DataStyleBuilder<FractionStyle,FractionStyleBuilder>, NumberStyleBuilder<FractionStyle,FractionStyleBuilder>

Author:

Julien Férard

Constructor Summary

Constructors

Constructor and Description
FractionStyleBuilder(String name, Locale locale)

Method Summary

Modifier and Type	Method and Description
FractionStyle	build()
FractionStyleBuilder	country(String countryCode) Set the country code
static FractionStyleBuilder	create(String name, Locale locale) Create a new number style builder with the name name, minimum integer digits is minIntDigits and decimal places is decPlaces.
FractionStyleBuilder	fractionValues(int numerator, int denominator) Add the numerator and denominator values to be shown.
FractionStyleBuilder	groupThousands(boolean grouping)
FractionStyleBuilder	language(String languageCode) Set the language code
FractionStyleBuilder	locale(Locale locale) Set the locale
FractionStyleBuilder	minIntegerDigits(int minIntegerDigits)
FractionStyleBuilder	negativeValueColor(Color negativeValueColor)
FractionStyleBuilder	negativeValueRed() Sets the red color for negative values
FractionStyleBuilder	visible() Make this style visible, ie part of common styles
FractionStyleBuilder	volatileStyle(boolean volatileStyle) 19.517 style:volatile "The style:volatile attribute specifies whether unused style in a document are retained or discarded by consumers."

Methods inherited from class java.lang.Object

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

Constructor Detail

FractionStyleBuilder

public FractionStyleBuilder(String name,
                            Locale locale)

Parameters:

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

locale - The locale used

Method Detail

create

public static FractionStyleBuilder create(String name,
                                          Locale locale)

Create a new number style builder with the name name, minimum integer digits is minIntDigits and decimal places is decPlaces.

Parameters:

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

locale - The locale used

Returns:

the builder

build

public FractionStyle build()

Specified by:

build in interface StyleBuilder<FractionStyle>

Returns:

a new S

fractionValues

public FractionStyleBuilder fractionValues(int numerator,
                                           int denominator)

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

Parameters:

numerator - the number of digits for the numerator

denominator - the number of digits for the denominator

Returns:

this for fluent style

groupThousands

public FractionStyleBuilder groupThousands(boolean grouping)

Specified by:

groupThousands in interface NumberStyleBuilder<FractionStyle,FractionStyleBuilder>

Parameters:

grouping - if true, the thousands separator is shown.

Returns:

this for fluent style

minIntegerDigits

public FractionStyleBuilder minIntegerDigits(int minIntegerDigits)

Specified by:

minIntegerDigits in interface NumberStyleBuilder<FractionStyle,FractionStyleBuilder>

Parameters:

minIntegerDigits - The number of digits for integer part

Returns:

this for fluent style

negativeValueColor

public FractionStyleBuilder negativeValueColor(Color negativeValueColor)

Specified by:

negativeValueColor in interface NumberStyleBuilder<FractionStyle,FractionStyleBuilder>

Parameters:

negativeValueColor - the color for negative values, null if none

Returns:

this for fluent style

negativeValueRed

public FractionStyleBuilder negativeValueRed()

Description copied from interface: NumberStyleBuilder

Sets the red color for negative values

Specified by:

negativeValueRed in interface NumberStyleBuilder<FractionStyle,FractionStyleBuilder>

Returns:

this for fluent style

country

public FractionStyleBuilder country(String countryCode)

Description copied from interface: LocalizedBuilder

Set the country code

Specified by:

country in interface LocalizedBuilder<FractionStyleBuilder>

Parameters:

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

Returns:

this for fluent style

language

public FractionStyleBuilder language(String languageCode)

Description copied from interface: LocalizedBuilder

Set the language code

Specified by:

language in interface LocalizedBuilder<FractionStyleBuilder>

Parameters:

languageCode - The two letter language code, e.g. 'en'. See http://www.ietf .org/rfc/rfc3066.txt

Returns:

this for fluent style

locale

public FractionStyleBuilder locale(Locale locale)

Description copied from interface: LocalizedBuilder

Set the locale

Specified by:

locale in interface LocalizedBuilder<FractionStyleBuilder>

Parameters:

locale - the locale

Returns:

this for fluent style

volatileStyle

public FractionStyleBuilder volatileStyle(boolean volatileStyle)

Description copied from interface: IsVolatileBuilder

19.517 style:volatile "The style:volatile attribute specifies whether unused style in a document are retained or discarded by consumers."

Specified by:

volatileStyle in interface IsVolatileBuilder<FractionStyleBuilder>

Parameters:

volatileStyle - true if "consumers should keep unused styles", false otherwise.

Returns:

this for fluent style

visible

public FractionStyleBuilder visible()

Description copied from interface: ShowableBuilder

Make this style visible, ie part of common styles

Specified by:

visible in interface ShowableBuilder<FractionStyleBuilder>

Returns:

this for fluent style