com.github.jferard.fastods.datastyle

Class PercentageStyleBuilder

java.lang.Object

com.github.jferard.fastods.datastyle.PercentageStyleBuilder

All Implemented Interfaces:

DataStyleBuilder<PercentageStyle,PercentageStyleBuilder>, DecimalStyleBuilder<PercentageStyleBuilder>, IsVolatileBuilder<PercentageStyleBuilder>, LocalizedBuilder<PercentageStyleBuilder>, NumberStyleBuilder<PercentageStyle,PercentageStyleBuilder>, ShowableBuilder<PercentageStyleBuilder>, StyleBuilder<PercentageStyle>

public class PercentageStyleBuilder
extends Object
implements DataStyleBuilder<PercentageStyle,PercentageStyleBuilder>, NumberStyleBuilder<PercentageStyle,PercentageStyleBuilder>, DecimalStyleBuilder<PercentageStyleBuilder>

Author:

Julien Férard

Constructor Summary

Constructors

Constructor and Description
PercentageStyleBuilder(String name, Locale locale) Create a new number style with the name name, minimum integer digits is minIntDigits and decimal places is decPlaces.

Method Summary

Modifier and Type	Method and Description
PercentageStyle	build()
PercentageStyleBuilder	country(String countryCode) Set the country code
PercentageStyleBuilder	decimalPlaces(int decimalPlaces) 20.250 style:decimal-places Set how many digits are to the right of the decimal symbol.
PercentageStyleBuilder	groupThousands(boolean grouping)
PercentageStyleBuilder	language(String languageCode) Set the language code
PercentageStyleBuilder	locale(Locale locale) Set the locale
PercentageStyleBuilder	minIntegerDigits(int minIntegerDigits)
PercentageStyleBuilder	negativeValueColor(Color negativeValueColor)
PercentageStyleBuilder	negativeValueRed() Sets the red color for negative values
PercentageStyleBuilder	visible() Make this style visible, ie part of common styles
PercentageStyleBuilder	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

PercentageStyleBuilder

public PercentageStyleBuilder(String name,
                              Locale locale)

Create a new number style 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

Method Detail

build

public PercentageStyle build()

Specified by:

build in interface StyleBuilder<PercentageStyle>

Returns:

a new S

decimalPlaces

public PercentageStyleBuilder decimalPlaces(int decimalPlaces)

Description copied from interface: DecimalStyleBuilder

20.250 style:decimal-places Set how many digits are to the right of the decimal symbol.

Specified by:

decimalPlaces in interface DecimalStyleBuilder<PercentageStyleBuilder>

Parameters:

decimalPlaces - "the maximum number of decimal places that are displayed if numbers are formatted by a data style that has no setting for number of decimal places itself"

Returns:

this for fluent style

groupThousands

public PercentageStyleBuilder groupThousands(boolean grouping)

Specified by:

groupThousands in interface NumberStyleBuilder<PercentageStyle,PercentageStyleBuilder>

Parameters:

grouping - if true, the thousands separator is shown.

Returns:

this for fluent style

minIntegerDigits

public PercentageStyleBuilder minIntegerDigits(int minIntegerDigits)

Specified by:

minIntegerDigits in interface NumberStyleBuilder<PercentageStyle,PercentageStyleBuilder>

Parameters:

minIntegerDigits - The number of digits for integer part

Returns:

this for fluent style

negativeValueColor

public PercentageStyleBuilder negativeValueColor(Color negativeValueColor)

Specified by:

negativeValueColor in interface NumberStyleBuilder<PercentageStyle,PercentageStyleBuilder>

Parameters:

negativeValueColor - the color for negative values, null if none

Returns:

this for fluent style

negativeValueRed

public PercentageStyleBuilder negativeValueRed()

Description copied from interface: NumberStyleBuilder

Sets the red color for negative values

Specified by:

negativeValueRed in interface NumberStyleBuilder<PercentageStyle,PercentageStyleBuilder>

Returns:

this for fluent style

country

public PercentageStyleBuilder country(String countryCode)

Description copied from interface: LocalizedBuilder

Set the country code

Specified by:

country in interface LocalizedBuilder<PercentageStyleBuilder>

Parameters:

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

Returns:

this for fluent style

language

public PercentageStyleBuilder language(String languageCode)

Description copied from interface: LocalizedBuilder

Set the language code

Specified by:

language in interface LocalizedBuilder<PercentageStyleBuilder>

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 PercentageStyleBuilder locale(Locale locale)

Description copied from interface: LocalizedBuilder

Set the locale

Specified by:

locale in interface LocalizedBuilder<PercentageStyleBuilder>

Parameters:

locale - the locale

Returns:

this for fluent style

volatileStyle

public PercentageStyleBuilder 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<PercentageStyleBuilder>

Parameters:

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

Returns:

this for fluent style

visible

public PercentageStyleBuilder visible()

Description copied from interface: ShowableBuilder

Make this style visible, ie part of common styles

Specified by:

visible in interface ShowableBuilder<PercentageStyleBuilder>

Returns:

this for fluent style