Package csv.impl

Class DefaultExcelFormatter

java.lang.Object

csv.impl.DefaultExcelFormatter

All Implemented Interfaces:

ExcelFormatter

public class DefaultExcelFormatter
extends Object
implements ExcelFormatter

Default implementation of an ExcelFormatter. This class provides a default implementation that provides some basic functionality to emphasize the header row in a sheet by a bold font and formatting hyperlinks in cells. You can derive from this implementation to change formatting, e.g. just setting another color or font size.

Author:

RalphSchuster

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	DefaultExcelFormatter.StyleDescription	Describes a style for a cell.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_DATE_FORMAT	date format "dd.mm.yyyy hh:mm"
static short	DEFAULT_FONT_COLOR	Color Black
static String	DEFAULT_FONT_NAME	Arial font name
static short	DEFAULT_FONT_SIZE	Font Size 10
static String	DEFAULT_INTEGER_FORMAT	integer format "0"
static String	DEFAULT_REAL_FORMAT	real format "0.00"
static short	HYPERLINK_FONT_COLOR	Color Blue

Constructor Summary

Constructors

Constructor	Description
DefaultExcelFormatter()	Default constructor.
DefaultExcelFormatter(boolean emphasizeFirstRow)	Constructor for defining the emphasizing of header rows.
DefaultExcelFormatter(boolean emphasizeFirstRow, String defaultFontName, Short defaultFontSize, Short defaultFontColor, Short defaultHyperlinkColor)	Constructor for defining the various properties.

Method Summary

Modifier and Type	Method	Description
void	finalize(ExcelWriter writer, int rowCount, int columnCount)	Finalizes the workbook.
Short	getAlign(ExcelWriter writer, int row, int column, Object value)	Returns the alignment to be used.
Short	getBackgroundColor(ExcelWriter writer, int row, int column, Object value)	Returns the background color for the specified cell.
org.apache.poi.ss.usermodel.Font	getBoldFont(org.apache.poi.ss.usermodel.Workbook workbook, int row, int column, Object value)	Returns the bold font used for header rows.
Short	getBottomBorderColor(ExcelWriter writer, int row, int column, Object value)
Short	getBottomBorderThickness(ExcelWriter writer, int row, int column, Object value)
String	getDateFormat(int row, int column, Object value)	Returns the default format for dates.
protected Short	getDateFormat(ExcelWriter writer, String format)	Returns the ID of the format or creates a new one if required.
org.apache.poi.ss.usermodel.Font	getDefaultBoldFont(org.apache.poi.ss.usermodel.Workbook workbook)	Returns the default bold font.
short	getDefaultFontColor()	Returns the font color to be used in non-hyperlink cells.
String	getDefaultFontName()	Returns the font name to be used.
short	getDefaultFontSize()	Returns the font size to be used.
short	getDefaultHyperlinkColor()	Returns the font color to be used for hyperlinks.
org.apache.poi.ss.usermodel.Font	getDefaultHyperlinkFont(org.apache.poi.ss.usermodel.Workbook workbook)	Returns the font to be used for hyperlinks.
org.apache.poi.ss.usermodel.Font	getDefaultPlainFont(org.apache.poi.ss.usermodel.Workbook workbook)	Returns the default font used for normal cells.
Short	getFillPattern(ExcelWriter writer, int row, int column, Object value)	Returns the fill pattern for the background.
org.apache.poi.ss.usermodel.Font	getFont(ExcelWriter writer, int row, int column, Object value)	Returns the correct font for the cell.
Short	getForegroundColor(ExcelWriter writer, int row, int column, Object value)	Returns the foreground color for the specified cell.
Short	getFormat(ExcelWriter writer, int row, int column, Object value)	Returns the display format.
org.apache.poi.ss.usermodel.Hyperlink	getHyperlink(ExcelWriter writer, int row, int column, Object value)	Returns a hyperlink object when the given cell shall be linked.
org.apache.poi.ss.usermodel.Font	getHyperlinkFont(org.apache.poi.ss.usermodel.Workbook workbook, int row, int column, Object value)	Returns the font to be used for hyperlinks.
String	getIntegerFormat(int row, int column, Object value)	Returns the default format for shorts, integers and longs.
protected Short	getIntegerFormat(ExcelWriter writer, String format)	Returns the ID of the format or creates a new one if required.
Short	getLeftBorderColor(ExcelWriter writer, int row, int column, Object value)
Short	getLeftBorderThickness(ExcelWriter writer, int row, int column, Object value)
org.apache.poi.ss.usermodel.Font	getPlainFont(org.apache.poi.ss.usermodel.Workbook workbook, int row, int column, Object value)	Returns the default font used for normal cells.
String	getRealFormat(int row, int column, Object value)	Returns the default format for real and float numbers.
protected Short	getRealFormat(ExcelWriter writer, String format)	Returns the ID of the format or creates a new one if required.
Short	getRightBorderColor(ExcelWriter writer, int row, int column, Object value)
Short	getRightBorderThickness(ExcelWriter writer, int row, int column, Object value)
Short	getTopBorderColor(ExcelWriter writer, int row, int column, Object value)
Short	getTopBorderThickness(ExcelWriter writer, int row, int column, Object value)
void	init()
boolean	isEmphasizeFirstRow()	Returns the setting of emphasizing the header row.
boolean	isTextWrap(ExcelWriter writer, int row, int column, Object value)
void	setDefaultBorderColor(Short borderColor)
void	setDefaultBorderThickness(Short borderThickness)
void	setEmphasizeFirstRow(boolean emphasizeFirstRow)	Sets the property of emphasizing header rows.
void	setStyle(ExcelWriter writer, org.apache.poi.ss.usermodel.Cell cell, Object value)	Sets the cell style.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FONT_NAME

public static final String DEFAULT_FONT_NAME

Arial font name

See Also:

Constant Field Values

DEFAULT_FONT_COLOR

public static final short DEFAULT_FONT_COLOR

Color Black

HYPERLINK_FONT_COLOR

public static final short HYPERLINK_FONT_COLOR

Color Blue

DEFAULT_FONT_SIZE

public static final short DEFAULT_FONT_SIZE

Font Size 10

See Also:

Constant Field Values

DEFAULT_DATE_FORMAT

public static final String DEFAULT_DATE_FORMAT

date format "dd.mm.yyyy hh:mm"

See Also:

Constant Field Values

DEFAULT_INTEGER_FORMAT

public static final String DEFAULT_INTEGER_FORMAT

integer format "0"

See Also:

Constant Field Values

DEFAULT_REAL_FORMAT

public static final String DEFAULT_REAL_FORMAT

real format "0.00"

See Also:

Constant Field Values

Constructor Detail

DefaultExcelFormatter

public DefaultExcelFormatter()

Default constructor. This is without any formatting.

DefaultExcelFormatter

public DefaultExcelFormatter(boolean emphasizeFirstRow)

Constructor for defining the emphasizing of header rows.

Parameters:

emphasizeFirstRow - whether row 0 shall be set in bold font

See Also:

getFont(ExcelWriter, int, int, Object)

DefaultExcelFormatter

public DefaultExcelFormatter(boolean emphasizeFirstRow,
                             String defaultFontName,
                             Short defaultFontSize,
                             Short defaultFontColor,
                             Short defaultHyperlinkColor)

Constructor for defining the various properties.

Parameters:

emphasizeFirstRow - whether row 0 shall be set in bold font

defaultFontName - font name of default font

defaultFontSize - font size to be used

defaultFontColor - color to be used for font

defaultHyperlinkColor - color for hyperlinks to be used

See Also:

getFont(ExcelWriter, int, int, Object)

Method Detail

init

public void init()

setStyle

public void setStyle(ExcelWriter writer,
                     org.apache.poi.ss.usermodel.Cell cell,
                     Object value)

Sets the cell style. This implementations calls various other methods to define the style of the cell.

Specified by:

setStyle in interface ExcelFormatter

Parameters:

writer - writer that requires the information

cell - cell to be formatted

value - value in cell

See Also:

getFormat(ExcelWriter, int, int, Object), getBackgroundColor(ExcelWriter, int, int, Object), getFillPattern(ExcelWriter, int, int, Object), getForegroundColor(ExcelWriter, int, int, Object), getFont(ExcelWriter, int, int, Object), getAlign(ExcelWriter, int, int, Object), getHyperlink(ExcelWriter, int, int, Object)

getHyperlink

public org.apache.poi.ss.usermodel.Hyperlink getHyperlink(ExcelWriter writer,
                                                          int row,
                                                          int column,
                                                          Object value)

Returns a hyperlink object when the given cell shall be linked. Notice that you should return a blue underlined font in getFont(ExcelWriter, int, int, Object) when you return a hyperlink here.

Parameters:

writer - the calling writer

row - row index

column - column index

value - value in cell

Returns:

hyperlink object for the cell

finalize

public void finalize(ExcelWriter writer,
                     int rowCount,
                     int columnCount)

Finalizes the workbook. This method is called immediately before the ExcelWriter writes the complete workbook to the underlying output stream. This implementation just sets all columns to auto fit.

Specified by:

finalize in interface ExcelFormatter

Parameters:

writer - the calling writer

rowCount - the number of rows in the selected sheet

columnCount - the number of columns modified in the selected sheet

getAlign

public Short getAlign(ExcelWriter writer,
                      int row,
                      int column,
                      Object value)

Returns the alignment to be used. This implementation returns null.

Parameters:

writer - writer that requires the information

row - row index

column - column index

value - value in cell

Returns:

alignment index for Excel or null if no alignment is required

getFormat

public Short getFormat(ExcelWriter writer,
                       int row,
                       int column,
                       Object value)

Returns the display format. The format of the value. This implementation sets format for dates and numbers.

Parameters:

writer - writer that requires the information

row - row index

column - column index

value - value in cell

Returns:

format index for Excel or null if no formatting is required

See Also:

getDateFormat(int, int, Object), getIntegerFormat(int, int, Object), getRealFormat(int, int, Object)

getDateFormat

protected Short getDateFormat(ExcelWriter writer,
                              String format)

Returns the ID of the format or creates a new one if required.

Parameters:

writer - writer that provides the workbook

format - format to be used

Returns:

ID of format

getIntegerFormat

protected Short getIntegerFormat(ExcelWriter writer,
                                 String format)

Returns the ID of the format or creates a new one if required.

Parameters:

writer - writer that provides the workbook

format - format to be used

Returns:

ID of format

getRealFormat

protected Short getRealFormat(ExcelWriter writer,
                              String format)

Returns the ID of the format or creates a new one if required.

Parameters:

writer - writer that provides the workbook

format - format to be used

Returns:

ID of format

getDateFormat

public String getDateFormat(int row,
                            int column,
                            Object value)

Returns the default format for dates. This implementation returns DEFAULT_DATE_FORMAT.

Parameters:

row - the row that this format will be used for

column - the column that this format will be used for

value - the value that this format will be used for

Returns:

date formats

See Also:

DEFAULT_DATE_FORMAT

getIntegerFormat

public String getIntegerFormat(int row,
                               int column,
                               Object value)

Returns the default format for shorts, integers and longs. This implementation returns DEFAULT_INTEGER_FORMAT.

Parameters:

row - the row that this format will be used for

column - the column that this format will be used for

value - the value that this format will be used for

Returns:

date formats

See Also:

DEFAULT_INTEGER_FORMAT

getRealFormat

public String getRealFormat(int row,
                            int column,
                            Object value)

Returns the default format for real and float numbers. This implementation returns DEFAULT_REAL_FORMAT.

Parameters:

row - the row that this format will be used for

column - the column that this format will be used for

value - the value that this format will be used for

Returns:

date formats

See Also:

DEFAULT_REAL_FORMAT

getBackgroundColor

public Short getBackgroundColor(ExcelWriter writer,
                                int row,
                                int column,
                                Object value)

Returns the background color for the specified cell. This implementation returns null (default background color). You can use IndexedColors.LIGHT_GREEN.getIndex() to return the color. Notice that background colors is somehow misleading as foreground and background color build up a cell's background (behind the text itself).

Parameters:

writer - writer that requires the information

row - row index

column - column index

value - value in cell

Returns:

color index for Excel or null

getFillPattern

public Short getFillPattern(ExcelWriter writer,
                            int row,
                            int column,
                            Object value)

Returns the fill pattern for the background. This implementation returns CellStyle.SOLID_FOREGROUND if a foreground color was set.

Parameters:

writer - writer that requires the information

row - row index

column - column index

value - value in cell

Returns:

the fill pattern or null if default pattern shall be applied.

getForegroundColor

public Short getForegroundColor(ExcelWriter writer,
                                int row,
                                int column,
                                Object value)

Returns the foreground color for the specified cell. This implementation returns null (default foreground color). You can use IndexedColors.LIGHT_GREEN.getIndex() to return the color. This is the correct implementation if you want to set the cell's color.

Parameters:

writer - writer that requires the information

row - row index

column - column index

value - value in cell

Returns:

color index for Excel or null

getFont

public org.apache.poi.ss.usermodel.Font getFont(ExcelWriter writer,
                                                int row,
                                                int column,
                                                Object value)

Returns the correct font for the cell. This implementation will return bold font for the first row if required and hyperlink fonts for hyperlink cells. An overwritten implementation could look like this:

 font = writer.getWorkbook().createFont();
 font.setBoldweight(Font.BOLDWEIGHT_BOLD);
 font.setColor(IndexedColors.BLACK.getIndex());
 font.setFontHeightInPoints((short)10);
 font.setFontName("Arial");
 

Parameters:

writer - writer that requires the information

row - row index

column - column index

value - value in cell

Returns:

correct font or null if no special font is required.

See Also:

getBoldFont(Workbook, int, int, Object), getPlainFont(Workbook, int, int, Object), getHyperlinkFont(Workbook, int, int, Object)

getDefaultFontSize

public short getDefaultFontSize()

Returns the font size to be used.

Returns:

the default font size

See Also:

DEFAULT_FONT_SIZE

getDefaultFontColor

public short getDefaultFontColor()

Returns the font color to be used in non-hyperlink cells.

Returns:

the font color

See Also:

DEFAULT_FONT_COLOR

getDefaultHyperlinkColor

public short getDefaultHyperlinkColor()

Returns the font color to be used for hyperlinks.

Returns:

the hyperlink color

getDefaultFontName

public String getDefaultFontName()

Returns the font name to be used.

Returns:

the font name

isEmphasizeFirstRow

public boolean isEmphasizeFirstRow()

Returns the setting of emphasizing the header row.

Returns:

the emphasizeFirstRow

setEmphasizeFirstRow

public void setEmphasizeFirstRow(boolean emphasizeFirstRow)

Sets the property of emphasizing header rows.

Parameters:

emphasizeFirstRow - the emphasizeFirstRow to set

getBoldFont

public org.apache.poi.ss.usermodel.Font getBoldFont(org.apache.poi.ss.usermodel.Workbook workbook,
                                                    int row,
                                                    int column,
                                                    Object value)

Returns the bold font used for header rows. This implementation returns the font returned by getDefaultBoldFont(Workbook).

Parameters:

row - the row that this font will be used for

column - the column that this font will be used for

value - the value that this font will be used for

workbook - the workbook for creation

Returns:

the bold Font for this cell

See Also:

getDefaultBoldFont(Workbook)

getDefaultBoldFont

public org.apache.poi.ss.usermodel.Font getDefaultBoldFont(org.apache.poi.ss.usermodel.Workbook workbook)

Returns the default bold font. This implementation returns the font defined by getDefaultFontName(), getDefaultFontSize() and getDefaultFontColor() with bold weight.

Parameters:

workbook - workbook object for creation

Returns:

default bold font

getPlainFont

public org.apache.poi.ss.usermodel.Font getPlainFont(org.apache.poi.ss.usermodel.Workbook workbook,
                                                     int row,
                                                     int column,
                                                     Object value)

Returns the default font used for normal cells. This implementation returns the font defined by , getDefaultPlainFont(Workbook).

Parameters:

row - the row that this font will be used for

column - the column that this font will be used for

value - the value that this font will be used for

workbook - the workbook for creation

Returns:

the font for this cell

getDefaultPlainFont

public org.apache.poi.ss.usermodel.Font getDefaultPlainFont(org.apache.poi.ss.usermodel.Workbook workbook)

Returns the default font used for normal cells. This implementation returns the font defined by getDefaultFontName(), getDefaultFontSize() and getDefaultFontColor() with normal weight.

Parameters:

workbook - the workbook for creation

Returns:

the default plain font

getHyperlinkFont

public org.apache.poi.ss.usermodel.Font getHyperlinkFont(org.apache.poi.ss.usermodel.Workbook workbook,
                                                         int row,
                                                         int column,
                                                         Object value)

Returns the font to be used for hyperlinks. This implementation returns the font defined by getDefaultHyperlinkFont(Workbook).

Parameters:

workbook - the workbook for creation

row - the row that this font will be used for

column - the column that this font will be used for

value - the value that this font will be used for

Returns:

font object

getDefaultHyperlinkFont

public org.apache.poi.ss.usermodel.Font getDefaultHyperlinkFont(org.apache.poi.ss.usermodel.Workbook workbook)

Returns the font to be used for hyperlinks. This implementation returns the font defined by getDefaultFontName(), getDefaultFontSize() and getDefaultHyperlinkColor(). This font will be underlined with normal weight.

Parameters:

workbook - the workbook for creation

Returns:

font object for hyperlinks

getTopBorderColor

public Short getTopBorderColor(ExcelWriter writer,
                               int row,
                               int column,
                               Object value)

getLeftBorderColor

public Short getLeftBorderColor(ExcelWriter writer,
                                int row,
                                int column,
                                Object value)

getRightBorderColor

public Short getRightBorderColor(ExcelWriter writer,
                                 int row,
                                 int column,
                                 Object value)

getBottomBorderColor

public Short getBottomBorderColor(ExcelWriter writer,
                                  int row,
                                  int column,
                                  Object value)

getTopBorderThickness

public Short getTopBorderThickness(ExcelWriter writer,
                                   int row,
                                   int column,
                                   Object value)

getLeftBorderThickness

public Short getLeftBorderThickness(ExcelWriter writer,
                                    int row,
                                    int column,
                                    Object value)

getRightBorderThickness

public Short getRightBorderThickness(ExcelWriter writer,
                                     int row,
                                     int column,
                                     Object value)

getBottomBorderThickness

public Short getBottomBorderThickness(ExcelWriter writer,
                                      int row,
                                      int column,
                                      Object value)

setDefaultBorderColor

public void setDefaultBorderColor(Short borderColor)

Parameters:

borderColor - the borderColor to set

setDefaultBorderThickness

public void setDefaultBorderThickness(Short borderThickness)

Parameters:

borderThickness - the borderThickness to set

isTextWrap

public boolean isTextWrap(ExcelWriter writer,
                          int row,
                          int column,
                          Object value)