org.simpleods

Class TableStyle

java.lang.Object

org.simpleods.TableStyle

public class TableStyle
extends java.lang.Object

Author:

Martin Schulz
Copyright 2008-2013 Martin Schulz
This file TableStyle.java is part of SimpleODS.
0.5.1 Changed all 'throw Exception' to 'throw SimpleOdsException'
0.5.2 Replaced all text properties with a TextStyle object

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALIGN_CENTER
static int	ALIGN_JUSTIFY
static int	ALIGN_LEFT
static int	ALIGN_RIGHT
static int	STYLE_TABLE
static int	STYLE_TABLECELL
static int	STYLE_TABLECOLUMN
static int	STYLE_TABLEROW
static int	VERTICALALIGN_BOTTOM
static int	VERTICALALIGN_MIDDLE
static int	VERTICALALIGN_TOP

Constructor Summary

Constructors

Constructor and Description
TableStyle(int nFamily, java.lang.String sStyleName, OdsFile odsFile) Create a new table style and add it to content.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBorderStyle(BorderStyle bs) Add a border style to this cell.
void	addBorderStyle(java.lang.String sSize, java.lang.String sBorderColor, int nStyle, int nPosition) Add a border style to this cell.
java.lang.String	getDefaultCellStyle()
java.lang.String	getFontSize() Get the font size as string, e.g. '10.5pt' or '8pt'
int	getFontUnderline()
java.lang.String	getName() Get the name of this table style.
int	getStyleType() Get the style type of this TableStyle, this is either: TableStyle.STYLE_TABLE, TableStyle.STYLE_TABLECOLUMN ,TableStyle.STYLE_TABLEROW or TableStyle.STYLE_TABLECELL.
TextStyle	getTextStyle() Get the current TextStyle object.
boolean	resetFontWrap() Deprecated. - Use setFontWrap(false)
boolean	resetTextAlign() Reset any text alignment.
boolean	resetVerticalAlign() Reset any vertical text alignment.
boolean	setBackgroundColor(java.lang.String sColor) Set the cell background color to sColor.
boolean	setColumnWidth(java.lang.String sWidth) Set the column width of a table column.
void	setDataStyle(CurrencyStyle cs) Set the data style for this TableStyle to cs.
void	setDataStyle(DateStyle ds) Set the data style for this TableStyle to ds.
void	setDataStyle(NumberStyle ns) Set the data style for this TableStyle to ns.
boolean	setDefaultCellStyle(TableStyle ts) Set the default cell style of a table column.
boolean	setFontColor(java.lang.String sColor) Set the font color to sColor.
void	setFontSize(int fontSize) Set the font size in points to the given value.
void	setFontSize(java.lang.String fontSize) Set the font size to the given value fontSize is a length value expressed as a number followed by pt, e.g. 12pt
void	setFontUnderline(int nUnderlineStyle) Set the style that should be used for the underline.
boolean	setFontWeightBold() Set the font weight to bold.
boolean	setFontWeightItalic() Set the font weight to italic.
boolean	setFontWeightNormal() Set the font weight to normal.
boolean	setFontWrap() Deprecated. - Use setFontWrap(true)
boolean	setFontWrap(boolean fSetWrap) Set font wrap.
boolean	setRowHeight(java.lang.String sHeight) Set the row height to a table row.
boolean	setTextAlign(int nAlign) Set the alignment of text.
void	setTextStyle(TextStyle textStyle) Set a new TextStyle object.
boolean	setVerticalAlign(int nAlign) Set the vertical alignment of text.

Methods inherited from class java.lang.Object

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

Field Detail

STYLE_TABLE

public static final int STYLE_TABLE

See Also:

Constant Field Values

STYLE_TABLECOLUMN

public static final int STYLE_TABLECOLUMN

See Also:

Constant Field Values

STYLE_TABLEROW

public static final int STYLE_TABLEROW

See Also:

Constant Field Values

STYLE_TABLECELL

public static final int STYLE_TABLECELL

See Also:

Constant Field Values

VERTICALALIGN_TOP

public static final int VERTICALALIGN_TOP

See Also:

Constant Field Values

VERTICALALIGN_MIDDLE

public static final int VERTICALALIGN_MIDDLE

See Also:

Constant Field Values

VERTICALALIGN_BOTTOM

public static final int VERTICALALIGN_BOTTOM

See Also:

Constant Field Values

ALIGN_LEFT

public static final int ALIGN_LEFT

See Also:

Constant Field Values

ALIGN_CENTER

public static final int ALIGN_CENTER

See Also:

Constant Field Values

ALIGN_RIGHT

public static final int ALIGN_RIGHT

See Also:

Constant Field Values

ALIGN_JUSTIFY

public static final int ALIGN_JUSTIFY

See Also:

Constant Field Values

Constructor Detail

TableStyle

public TableStyle(int nFamily,
          java.lang.String sStyleName,
          OdsFile odsFile)

Create a new table style and add it to content.
Version 0.5.0 Added parameter OdsFile o

Parameters:

nFamily - The type of this style, either STYLE_TABLECOLUMN,STYLE_TABLEROW,STYLE_TABLE or STYLE_TABLECELL

sStyleName - A unique name for this style

odsFile - The OdsFile to add this style to

Method Detail

getName

public java.lang.String getName()

Get the name of this table style.

Returns:

The table style name

getStyleType

public int getStyleType()

Get the style type of this TableStyle, this is either:
TableStyle.STYLE_TABLE, TableStyle.STYLE_TABLECOLUMN ,TableStyle.STYLE_TABLEROW or TableStyle.STYLE_TABLECELL.

Returns:

One of the table styles

getDefaultCellStyle

public java.lang.String getDefaultCellStyle()

setColumnWidth

public boolean setColumnWidth(java.lang.String sWidth)

Set the column width of a table column.
sWidth is a length value expressed as a number followed by a unit of measurement e.g. 1.5cm or 12px
The valid units in OpenDocument are in, cm, mm, px (pixels), pc (picas; 6 picas equals one inch),
and pt (points; 72points equal one inch).

Parameters:

sWidth - - The width of a column, e.g. '10cm'

Returns:

true - The width was set, false - this object is no table column, you can not set the default cell to it

setDefaultCellStyle

public boolean setDefaultCellStyle(TableStyle ts)

Set the default cell style of a table column.

Parameters:

ts - The table cell style to be used as default

Returns:

true - The style was set as default,
false - this object is no table column, you can not set the default cell to it

setRowHeight

public boolean setRowHeight(java.lang.String sHeight)

Set the row height to a table row.
sHeight is a length value expressed as a number followed by a unit of measurement e.g. 1.5cm or 12px
The valid units in OpenDocument are in, cm, mm, px (pixels), pc (picas; 6 picas equals one inch),
and pt (points; 72points equal one inch).

Parameters:

sHeight - The table row height to be used, e.g. '1.0cm'

Returns:

true - The height was set,
false - his object is no table row, you can not set the height to it

setBackgroundColor

public boolean setBackgroundColor(java.lang.String sColor)

Set the cell background color to sColor.
The TableStyle must be of a format of TableStyle.STYLE_TABLECELL

Parameters:

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

Returns:

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

setFontColor

public boolean setFontColor(java.lang.String sColor)

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

Parameters:

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

Returns:

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

setFontWeightItalic

public boolean setFontWeightItalic()

Set the font weight to italic.
The TableStyle must be of a format of TableStyle.STYLE_TABLECELL

Returns:

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

setFontWeightBold

public boolean setFontWeightBold()

Set the font weight to bold.
The TableStyle must be of a format of TableStyle.STYLE_TABLECELL

Returns:

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

setFontWeightNormal

public boolean setFontWeightNormal()

Set the font weight to normal.
The TableStyle must be of a format of TableStyle.STYLE_TABLECELL

Returns:

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

getFontSize

public java.lang.String getFontSize()

Get the font size as string, e.g. '10.5pt' or '8pt'

Returns:

The font size as string, e.g. '10.5pt' or '8pt'

setFontSize

public void setFontSize(java.lang.String fontSize)

Set the font size to the given value
fontSize is a length value expressed as a number followed by pt, e.g. 12pt

Parameters:

fontSize - - The font size as string, e.g. '10.5pt' or '8pt'

setFontSize

public void setFontSize(int fontSize)

Set the font size in points to the given value.

Parameters:

fontSize - - The font size as int , e.g. 10 or 8

setFontWrap

public boolean setFontWrap(boolean fSetWrap)

Set font wrap.

Parameters:

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

Returns:

true - successful,
false - style must be either STYLE_TABLECELL or STYLE_TABLECOLUMN

setFontWrap

public boolean setFontWrap()

Deprecated. - Use setFontWrap(true)

Set fond wrap to true.

Returns:

true - successful, false - style must be either STYLE_TABLECELL or STYLE_TABLECOLUMN

resetFontWrap

public boolean resetFontWrap()

Deprecated. - Use setFontWrap(false)

Reset the fond wrap.

Returns:

true - successful, false - style must be either STYLE_TABLECELL or STYLE_TABLECOLUMN

setTextAlign

public boolean setTextAlign(int nAlign)

Set the alignment of text.

Parameters:

nAlign - - The text alignment flag,

Returns:

true - successful,
false - style must be either STYLE_TABLECELL or STYLE_TABLECOLUMN

resetTextAlign

public boolean resetTextAlign()

Reset any text alignment.

Returns:

true - successful,
false - style must be either STYLE_TABLECELL or STYLE_TABLECOLUMN

setVerticalAlign

public boolean setVerticalAlign(int nAlign)

Set the vertical alignment of text.

Parameters:

nAlign - - The vertical alignment flag,
either: VERTICALALIGN_TOP,VERTICALALIGN_MIDDLE or VERTICALALIGN_BOTTOM

Returns:

true - successful,
false - style must be either STYLE_TABLECELL or STYLE_TABLECOLUMN

resetVerticalAlign

public boolean resetVerticalAlign()

Reset any vertical text alignment.

Returns:

true - successful,
false - style must be either STYLE_TABLECELL or STYLE_TABLECOLUMN

addBorderStyle

public void addBorderStyle(java.lang.String sSize,
                  java.lang.String sBorderColor,
                  int nStyle,
                  int nPosition)

Add a border style to this cell.

Parameters:

sSize - The size of the line e.g. '0.1cm'

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

nStyle - - The style of the border line, either BorderStyle.BORDER_SOLID or BorderStyle.BORDER_DOUBLE

nPosition - - The position of the line in this cell, e.g. BorderStyle.POSITION_TOP

addBorderStyle

public void addBorderStyle(BorderStyle bs)

Add a border style to this cell.

Parameters:

bs - - The border style to be used

setDataStyle

public void setDataStyle(NumberStyle ns)
                  throws SimpleOdsException

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

Parameters:

ns - The number style to be used

Throws:

SimpleOdsException - Thrown if the style type of ns is not TableStyle.STYLE_TABLECELL

setDataStyle

public void setDataStyle(CurrencyStyle cs)
                  throws SimpleOdsException

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

Parameters:

cs - The currency style to be used

Throws:

SimpleOdsException - Thrown if the style type of cs is not TableStyle.STYLE_TABLECELL

setDataStyle

public void setDataStyle(DateStyle ds)
                  throws SimpleOdsException

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

Parameters:

ds - The date style to be used

Throws:

SimpleOdsException - Thrown if the style type of ds is not TableStyle.STYLE_TABLECELL

getFontUnderline

public int getFontUnderline()

Returns:

The currently set style for the underline.

setFontUnderline

public void setFontUnderline(int nUnderlineStyle)

Set the style that should be used for the underline. Valid is:
TextStyle.STYLE_UNDERLINE_NONE
TextStyle.STYLE_UNDERLINE_SOLID
TextStyle.STYLE_UNDERLINE_DOTTED
TextStyle.STYLE_UNDERLINE_DASH
TextStyle.STYLE_UNDERLINE_LONGDASH
TextStyle.STYLE_UNDERLINE_DOTDASH
TextStyle.STYLE_UNDERLINE_DOTDOTDASH
TextStyle.STYLE_UNDERLINE_WAVE
Other values are ignored.

Parameters:

nUnderlineStyle - The underline stlye

getTextStyle

public TextStyle getTextStyle()

Get the current TextStyle object.

Returns:

The current textStyle object

setTextStyle

public void setTextStyle(TextStyle textStyle)

Set a new TextStyle object. This will overwrite all previous changed to the text styles
with the new textStyle.

Parameters:

textStyle - The new text style to be used