com.github.jferard.fastods.style

Class TextPropertiesBuilder

java.lang.Object

com.github.jferard.fastods.style.TextPropertiesBuilder

public class TextPropertiesBuilder
extends Object

Author:

Julien Férard

Method Summary

Modifier and Type	Method and Description
TextProperties	build()
TextStyle	buildHiddenStyle(String name) Deprecated. use `TextStyle.builder(name).build()`
TextStyle	buildVisibleStyle(String name) Deprecated. use `TextStyle.builder(name).visible().build()`
TextPropertiesBuilder	fontColor(Color color) Set the font color to color.
TextPropertiesBuilder	fontName(String fontName) Set the font name to be used for this style.
TextPropertiesBuilder	fontSize(Length fontSize) Set the font size to the given value.
TextPropertiesBuilder	fontSizePercentage(double percentage) Set the font size to the given fontSizePercentage.
TextPropertiesBuilder	fontStyleItalic() Set the font weight to italic.
TextPropertiesBuilder	fontStyleNormal() Set the font weight to italic.
TextPropertiesBuilder	fontUnderlineColor(Color color) Set the font underline color to color.
TextPropertiesBuilder	fontUnderlineStyle(TextProperties.Underline style) Set the style that should be used for the underline.
TextPropertiesBuilder	fontWeightBold() Set the font weight to bold.
TextPropertiesBuilder	fontWeightNormal() Set the font weight to normal.
boolean	hasFontSizePercentage()

Methods inherited from class java.lang.Object

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

Method Detail

build

public TextProperties build()

Returns:

the TextProperties

buildVisibleStyle

@Deprecated
public TextStyle buildVisibleStyle(String name)

Deprecated. use `TextStyle.builder(name).visible().build()`

Parameters:

name - the name of the style

Returns:

the TextStyle of that name

buildHiddenStyle

@Deprecated
public TextStyle buildHiddenStyle(String name)

Deprecated. use `TextStyle.builder(name).build()`

Parameters:

name - the name of the style

Returns:

the TextStyle of that name

fontColor

public TextPropertiesBuilder fontColor(Color color)

Set the font color to color.

Parameters:

color - The color to be used in format #rrggbb e.g. #ff0000 for a red cell background

Returns:

this for fluent style

fontName

public TextPropertiesBuilder fontName(String fontName)

Set the font name to be used for this style.

Parameters:

fontName - The font name for this TextStyle

Returns:

this for fluent style

fontSize

public TextPropertiesBuilder fontSize(Length fontSize)

Set the font size to the given value.

Parameters:

fontSize - - The font size

Returns:

this for fluent style

fontSizePercentage

public TextPropertiesBuilder fontSizePercentage(double percentage)

Set the font size to the given fontSizePercentage. See 20.183 fo:font-size "fontSizePercentage values can be used within common styles only and are based on the font height of the parent style rather than to the font height of the attributes neighborhood"

Parameters:

percentage - the font size as a fontSizePercentage.

Returns:

this for fluent style

fontStyleItalic

public TextPropertiesBuilder fontStyleItalic()

Set the font weight to italic.

Returns:

true

fontStyleNormal

public TextPropertiesBuilder fontStyleNormal()

Set the font weight to italic.

Returns:

true

fontUnderlineColor

public TextPropertiesBuilder fontUnderlineColor(Color color)

Set the font underline color to color. Use an empty string to reset it to 'auto'.

Parameters:

color - The color to be used in format #rrggbb e.g. #ff0000 for a red cell background.

Returns:

this for fluent style

fontUnderlineStyle

public TextPropertiesBuilder fontUnderlineStyle(TextProperties.Underline style)

Set the style that should be used for the underline.

Parameters:

style - One of the TextStyle.STYLE_UNDERLINE

Returns:

this for fluent style

fontWeightBold

public TextPropertiesBuilder fontWeightBold()

Set the font weight to bold.

Returns:

this for fluent style

fontWeightNormal

public TextPropertiesBuilder fontWeightNormal()

Set the font weight to normal.

Returns:

this for fluent style

hasFontSizePercentage

public boolean hasFontSizePercentage()

Returns:

true if this builder uses % to define the font size