Package com.storedobject.pdf

Class TableHeader

java.lang.Object

com.storedobject.pdf.TableHeader

public class TableHeader
extends Object

Header-definition for a PDFTable.

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
TableHeader(Iterable<String> cellHeaders)	Constructor.
TableHeader(String... cellHeaders)	Constructor.

Method Summary

Modifier and Type	Method	Description
int	addCells(int startingColumn, Object... cells)	Add cells to the table that was created earlier.
void	addRow(Object... cells)	Add cells to the table that was created earlier.
PDFTable	createTable(PDF pdf)	Create a PDFTable from this header.
void	fillCells(Excel excel, Object... cellValues)	Fill the cell values into the Excel instance provided.
void	fillHeaderCells(Excel excel)	Fill the header values into the Excel instance provided.
void	fillRow(Excel excel, Object... cellValues)	Fill the cell values into the Excel instance provided.
void	setCellCustomizer(Function<PDFCell,PDFCell> cellCustomizer)	Set a customizer for the cells that will be added later.
void	setHeader(int columnIndex, String caption)	Set caption for a specific column.
void	setHorizontalAlignment(int columnIndex, int alignment)	Set horizontal alignment.
void	setHorizontalAlignment(String columnName, int alignment)	Set horizontal alignment.
void	setVerticalAlignment(int columnIndex, int alignment)	Set vertical alignment.
void	setVerticalAlignment(String columnName, int alignment)	Set vertical alignment.
void	setWidth(int columnIndex, int width)	Set the relative width of a specific column.
void	setWidth(String columnName, int width)	Set the relative width of a specific column.
void	setWidths(int... widths)	Set relative widths.
void	setWidths(Iterable<Integer> widths)	Set relative widths.

Methods inherited from class java.lang.Object

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

Constructor Details

TableHeader

public TableHeader(String... cellHeaders)

Constructor. Default relative widths of all columns are set to 10. By default, all headers will be centered.

Parameters:

cellHeaders - Cell headers.

TableHeader

public TableHeader(Iterable<String> cellHeaders)

Constructor. Default relative widths of all columns are set to 10. By default, all headers will be centered.

Parameters:

cellHeaders - Cell headers.

Method Details

setHeader

public void setHeader(int columnIndex,
 String caption)

Set caption for a specific column.

Parameters:

columnIndex - Column index.

caption - Caption to set.

setHorizontalAlignment

public void setHorizontalAlignment(int columnIndex,
 int alignment)

Set horizontal alignment.

Parameters:

columnIndex - Column index.

alignment - Alignment,

setHorizontalAlignment

public void setHorizontalAlignment(String columnName,
 int alignment)

Set horizontal alignment.

Parameters:

columnName - Column name.

alignment - Alignment,

setVerticalAlignment

public void setVerticalAlignment(int columnIndex,
 int alignment)

Set vertical alignment.

Parameters:

columnIndex - Column index.

alignment - Alignment,

setVerticalAlignment

public void setVerticalAlignment(String columnName,
 int alignment)

Set vertical alignment.

Parameters:

columnName - Column name.

alignment - Alignment,

setWidths

public void setWidths(int... widths)

Set relative widths. All non-positive values will be ignored as if that value was not present in the parameter.

Parameters:

widths - Relative widths.

setWidths

public void setWidths(Iterable<Integer> widths)

Set relative widths. All non-positive values will be ignored as if that value was not present in the parameter.

Parameters:

widths - Relative widths.

setWidth

public void setWidth(int columnIndex,
 int width)

Set the relative width of a specific column.

Parameters:

columnIndex - Column index.

width - Relative width.

setWidth

public void setWidth(String columnName,
 int width)

Set the relative width of a specific column.

Parameters:

columnName - Column name.

width - Relative width.

createTable

public PDFTable createTable(PDF pdf)

Create a PDFTable from this header.

Parameters:

pdf - PDF to which the table will be added later. (This is required to retrieve the font information from it.)

Returns:

Newly crated table. The header part of the table will have already created as per the definition of this header.

addRow

public void addRow(Object... cells)

Add cells to the table that was created earlier.

Parameters:

cells - Cells to add.

addCells

public int addCells(int startingColumn,
 Object... cells)

Add cells to the table that was created earlier.

Parameters:

startingColumn - Starting column at which cells to be added.

cells - Cells to add.

Returns:

Next column index where further cells can be added.

setCellCustomizer

public void setCellCustomizer(Function<PDFCell,PDFCell> cellCustomizer)

Set a customizer for the cells that will be added later.

Parameters:

cellCustomizer - Cell customizer.

fillHeaderCells

public void fillHeaderCells(Excel excel)

Fill the header values into the Excel instance provided. Values will be filled from left to right, starting from the current cell. Finally, cell position will be set to the next row of the starting cell.

Parameters:

excel - The Excel instance to which values to be filled.

fillRow

public void fillRow(Excel excel,
 Object... cellValues)

Fill the cell values into the Excel instance provided. Values will be filled from left to right, starting from the current cell. Finally, cell position will be set to the next row of the starting cell.

Parameters:

excel - The Excel instance to which values to be filled.

cellValues - Cell values to fill.

fillCells

public void fillCells(Excel excel,
 Object... cellValues)

Fill the cell values into the Excel instance provided. Values will be filled from left to right, starting from the current cell. Finally, cell position will be set to the next cell on the right.

Parameters:

excel - The Excel instance to which values to be filled.

cellValues - Cell values to fill.