com.github.jferard.fastods.style

Class TableCellStyleBuilder

java.lang.Object

com.github.jferard.fastods.style.TableCellStyleBuilder

All Implemented Interfaces:

HidableBuilder<TableCellStyleBuilder>, StyleBuilder<TableCellStyle>

public class TableCellStyleBuilder
extends Object
implements StyleBuilder<TableCellStyle>, HidableBuilder<TableCellStyleBuilder>

Author:

Julien Férard, Martin Schulz

Constructor Summary

Constructors

Constructor and Description
TableCellStyleBuilder(String name, boolean hidden, Borders borders, Margins margins, DataStyle dataStyle, Color backgroundColor, TextProperties textProperties, CellAlign textAlign, VerticalAlign verticalAlign, boolean wrap, TableCellStyle parentCellStyle, Angle textRotating) Reserved to TableCellStyle.toBuilder()

Method Summary

Modifier and Type	Method and Description
TableCellStyleBuilder	allMargins(Length size) Add a margin to this cell.
TableCellStyleBuilder	backgroundColor(Color color) Set the cell background color to color
TableCellStyleBuilder	borderAll(BorderAttribute borderAttribute) Add a border style for all the borders of this cell.
TableCellStyleBuilder	borderAll(Length size, Color borderColor, BorderStyle style) Add a border style for all the borders of this cell.
TableCellStyleBuilder	borderBottom(BorderAttribute borderAttribute) Add a border style for the bottom border of this cell.
TableCellStyleBuilder	borderBottom(Length size, Color borderColor, BorderStyle style) Add a border style for the bottom border of this cell.
TableCellStyleBuilder	borderLeft(BorderAttribute borderAttribute) Add a border style for the left border of this cell.
TableCellStyleBuilder	borderLeft(Length size, Color borderColor, BorderStyle style) Add a border style for the left border of this cell.
TableCellStyleBuilder	borderRight(BorderAttribute borderAttribute) Add a border style for the left border of this cell.
TableCellStyleBuilder	borderRight(Length size, Color borderColor, BorderStyle style) Add a border style for the right border of this cell.
TableCellStyleBuilder	borderTop(BorderAttribute borderAttribute) Add a border style for the top border of this cell.
TableCellStyleBuilder	borderTop(Length size, Color borderColor, BorderStyle style) Add a border style for the top border of this cell.
TableCellStyle	build()
TableCellStyleBuilder	dataStyle(DataStyle ds) Set the data style for this TableFamilyStyle to ds.
TableCellStyleBuilder	fontColor(Color color) Set the font color to color.
TableCellStyleBuilder	fontName(String name) Set the font name to be used for this style.
TableCellStyleBuilder	fontSize(Length fontSize) Set the font size to the given value.
TableCellStyleBuilder	fontSizePercentage(double percentage) Set the font size to the given fontSizePercentage.
TableCellStyleBuilder	fontStyleItalic() Set the font weight to italic.
TableCellStyleBuilder	fontStyleNormal() Set the font weight to normal.
TableCellStyleBuilder	fontUnderlineColor(Color color) Set the font underline color to color.
TableCellStyleBuilder	fontUnderlineStyle(TextProperties.Underline style) Set the style that should be used for the underline.
TableCellStyleBuilder	fontWeightBold() Set the font weight to bold.
TableCellStyleBuilder	fontWeightNormal() Set the font weight to normal.
TableCellStyleBuilder	fontWrap(boolean fSetWrap) /** Set font wrap.
TableCellStyleBuilder	hidden() Make this style hidden, ie part of automatic styles
TableCellStyleBuilder	marginBottom(Length size) Add a border style to this cell.
TableCellStyleBuilder	marginLeft(Length size) Add a border style to this cell.
TableCellStyleBuilder	marginRight(Length size) Add a border style to this cell.
TableCellStyleBuilder	marginTop(Length size) Add a border style to this cell.
TableCellStyleBuilder	parentCellStyle(TableCellStyle tableCellStyle) Sets the parent cell style
TableCellStyleBuilder	textAlign(CellAlign align) Set the alignment of text.
TableCellStyleBuilder	textRotating(Angle angle) Set text rotation angle
TableCellStyleBuilder	verticalAlign(VerticalAlign align) Set the vertical alignment of text.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableCellStyleBuilder

public TableCellStyleBuilder(String name,
                             boolean hidden,
                             Borders borders,
                             Margins margins,
                             DataStyle dataStyle,
                             Color backgroundColor,
                             TextProperties textProperties,
                             CellAlign textAlign,
                             VerticalAlign verticalAlign,
                             boolean wrap,
                             TableCellStyle parentCellStyle,
                             Angle textRotating)

Reserved to TableCellStyle.toBuilder()

Parameters:

name - A unique name for this style

hidden - true if the style is automatic

dataStyle - the style of the data

backgroundColor - the background color

textProperties - the text properties

textAlign - horizontal align

verticalAlign - vertical align

wrap - true if the text is wrapped

parentCellStyle - the parent style

borders - the borders of the cell

margins - the margins of the cell

textRotating - an angle for the rotation

Method Detail

allMargins

public TableCellStyleBuilder allMargins(Length size)

Add a margin to this cell.

Parameters:

size - The size of the margin

Returns:

this for fluent style

backgroundColor

public TableCellStyleBuilder backgroundColor(Color color)

Set the cell background 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

borderAll

public TableCellStyleBuilder borderAll(Length size,
                                       Color borderColor,
                                       BorderStyle style)

Add a border style for all the borders of this cell.

Parameters:

size - the size of the line

borderColor - the color to be used in format #rrggbb e.g. '#ff0000' for a red border

style - the style of the border line, either BorderAttribute.BORDER_SOLID or BorderAttribute.BORDER_DOUBLE

Returns:

this for fluent style

borderAll

public TableCellStyleBuilder borderAll(BorderAttribute borderAttribute)

Add a border style for all the borders of this cell.

Parameters:

borderAttribute - the attribute for the border

Returns:

this for fluent style

borderBottom

public TableCellStyleBuilder borderBottom(Length size,
                                          Color borderColor,
                                          BorderStyle style)

Add a border style for the bottom border of this cell.

Parameters:

size - the size of the line

borderColor - the color to be used in format #rrggbb e.g. '#ff0000' for a red border

style - the style of the border line, either BorderAttribute.BORDER_SOLID or BorderAttribute.BORDER_DOUBLE

Returns:

this for fluent style

borderBottom

public TableCellStyleBuilder borderBottom(BorderAttribute borderAttribute)

Add a border style for the bottom border of this cell.

Parameters:

borderAttribute - the attribute for the border

Returns:

this for fluent style

borderLeft

public TableCellStyleBuilder borderLeft(Length size,
                                        Color borderColor,
                                        BorderStyle style)

Add a border style for the left border of this cell.

Parameters:

size - the size of the line

borderColor - the color to be used in format #rrggbb e.g. '#ff0000' for a red border

style - the style of the border line, either BorderAttribute.BORDER_SOLID or BorderAttribute.BORDER_DOUBLE

Returns:

this for fluent style

borderLeft

public TableCellStyleBuilder borderLeft(BorderAttribute borderAttribute)

Add a border style for the left border of this cell.

Parameters:

borderAttribute - the attribute for the border

Returns:

this for fluent style

borderRight

public TableCellStyleBuilder borderRight(Length size,
                                         Color borderColor,
                                         BorderStyle style)

Add a border style for the right border of this cell.

Parameters:

size - the size of the line

borderColor - the color to be used in format #rrggbb e.g. '#ff0000' for a red border

style - the style of the border line, either BorderAttribute.BORDER_SOLID or BorderAttribute.BORDER_DOUBLE

Returns:

this for fluent style

borderRight

public TableCellStyleBuilder borderRight(BorderAttribute borderAttribute)

Add a border style for the left border of this cell.

Parameters:

borderAttribute - the attribute for the border

Returns:

this for fluent style

borderTop

public TableCellStyleBuilder borderTop(Length size,
                                       Color borderColor,
                                       BorderStyle style)

Add a border style for the top border of this cell.

Parameters:

size - the size of the line

borderColor - the color to be used in format #rrggbb e.g. '#ff0000' for a red border

style - the style of the border line, either BorderAttribute.BORDER_SOLID or BorderAttribute.BORDER_DOUBLE

Returns:

this for fluent style

borderTop

public TableCellStyleBuilder borderTop(BorderAttribute borderAttribute)

Add a border style for the top border of this cell.

Parameters:

borderAttribute - the attribute for the border

Returns:

this for fluent style

build

public TableCellStyle build()

Specified by:

build in interface StyleBuilder<TableCellStyle>

Returns:

a new S

textRotating

public TableCellStyleBuilder textRotating(Angle angle)

Set text rotation angle

Parameters:

angle - TextRotation to be used

Returns:

this for fluent style

dataStyle

public TableCellStyleBuilder dataStyle(DataStyle ds)

Set the data style for this TableFamilyStyle to ds.
If the StyleType of this TableFamilyStyle is not STYLE_TABLECELL, an exception is thrown

Parameters:

ds - The date style to be used

Returns:

this for fluent style

fontColor

public TableCellStyleBuilder fontColor(Color color)

Set the font color to color.
The TableFamilyStyle must be of a format of TableFamilyStyle.STYLE_TABLECELL

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 TableCellStyleBuilder fontName(String name)

Set the font name to be used for this style.

Parameters:

name - The font name for this TextStyle

Returns:

this for fluent style

fontSize

public TableCellStyleBuilder fontSize(Length fontSize)

Set the font size to the given value.

Parameters:

fontSize - - The font size

Returns:

this for fluent style

fontSizePercentage

public TableCellStyleBuilder 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 TableCellStyleBuilder fontStyleItalic()

Set the font weight to italic.

Returns:

this for fluent style

fontStyleNormal

public TableCellStyleBuilder fontStyleNormal()

Set the font weight to normal.

Returns:

this for fluent style

fontUnderlineColor

public TableCellStyleBuilder 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 TableCellStyleBuilder 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 TableCellStyleBuilder fontWeightBold()

Set the font weight to bold.

Returns:

true - the value was set,
false - This object is no table cell, you can not set it to bold

fontWeightNormal

public TableCellStyleBuilder fontWeightNormal()

Set the font weight to normal.

Returns:

this for fluent style

fontWrap

public TableCellStyleBuilder fontWrap(boolean fSetWrap)

/** Set font wrap.

Parameters:

fSetWrap -
true - Font will be wrapped,
false - no font wrapping

Returns:

this for fluent style

marginBottom

public TableCellStyleBuilder marginBottom(Length size)

Add a border style to this cell.

Parameters:

size - The size of the margin as length

Returns:

this for fluent style

marginLeft

public TableCellStyleBuilder marginLeft(Length size)

Add a border style to this cell.

Parameters:

size - The size of the margin as length

Returns:

this for fluent style

marginRight

public TableCellStyleBuilder marginRight(Length size)

Add a border style to this cell.

Parameters:

size - The size of the margin as length

Returns:

this for fluent style

marginTop

public TableCellStyleBuilder marginTop(Length size)

Add a border style to this cell.

Parameters:

size - The size of the margin as length

Returns:

this for fluent style

parentCellStyle

public TableCellStyleBuilder parentCellStyle(TableCellStyle tableCellStyle)

Sets the parent cell style

Parameters:

tableCellStyle - the parent cell style (not null)

Returns:

this for fluent style.

textAlign

public TableCellStyleBuilder textAlign(CellAlign align)

Set the alignment of text.

Parameters:

align - - The text alignment flag,

Returns:

this for fluent style

verticalAlign

public TableCellStyleBuilder verticalAlign(VerticalAlign align)

Set the vertical alignment of text.

Parameters:

align - - The vertical alignment flag

Returns:

this for fluent style

hidden

public TableCellStyleBuilder hidden()

Description copied from interface: HidableBuilder

Make this style hidden, ie part of automatic styles

Specified by:

hidden in interface HidableBuilder<TableCellStyleBuilder>

Returns:

this for fluent style