com.technia.tvc.structurebrowser.render

Interface PDFTableWriter

public interface PDFTableWriter

Since:

6.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PDFTableWriter.PDFColumnSpec
static interface	PDFTableWriter.PDFFontSpec
static interface	PDFTableWriter.PDFHeaderFooter
static interface	PDFTableWriter.PDFText Represents text within a PDF document.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALIGN_BOTTOM
static int	ALIGN_CENTER
static int	ALIGN_LEFT
static int	ALIGN_MIDDLE
static int	ALIGN_RIGHT
static int	ALIGN_TOP

Method Summary

Modifier and Type	Method and Description
void	addCell(PDFTableWriter.PDFText text)
void	addCell(PDFTableWriter.PDFText text, int alignment, boolean nowrap, java.awt.Color backgroundColor) Add a cell to the table.
void	addCell(PDFTableWriter.PDFText text, int alignment, boolean nowrap, java.awt.Color backgroundColor, int colspan) Add a cell to the table.
void	addCell(java.lang.String content) Adds a plain text to the cell.
void	addCell(java.lang.String[] content) Adds multiple text content to the cell.
void	addCell(java.lang.String[] content, int alignment, boolean nowrap, PDFTableWriter.PDFFontSpec[] cellFont)
void	addCell(java.lang.String[] content, int alignment, boolean nowrap, PDFTableWriter.PDFFontSpec[] cellFont, java.awt.Color backgroundColor) Add a cell to the table.
void	addCell(java.lang.String[] content, int alignment, boolean nowrap, PDFTableWriter.PDFFontSpec[] cellFont, java.awt.Color backgroundColor, int colspan) Add a cell to the table.
void	addCell(java.lang.String content, java.awt.Color backgroundColor) Adds text with the specified background color
PDFTableWriter.PDFColumnSpec	addColumn(java.lang.String columnLabel) Adds a simple column label with the default font, background color, alignment and wrapping.
PDFTableWriter.PDFColumnSpec	addColumn(java.lang.String columnLabel, PDFTableWriter.PDFFontSpec font, java.awt.Color backgroundColor, int alignment, boolean noWrap) Adds a label with the specified font, background color, alignment and wrapping.
PDFTableWriter.PDFColumnSpec	addColumn(java.lang.String columnLabel, PDFTableWriter.PDFFontSpec font, java.awt.Color backgroundColor, int alignment, boolean noWrap, java.lang.String groupHeader, java.awt.Color groupHeaderBackgroundColor, PDFTableWriter.PDFFontSpec groupHeaderFont) Adds a label with the specified font, background color, alignment and wrapping.
PDFTableWriter.PDFColumnSpec	addColumn(java.lang.String columnLabel, java.lang.String groupHeader) Adds a simple column with a label and an optional group header.
void	close() Closes this writer.
PDFTableWriter.PDFFontSpec	createFontSpec() Creates a font specification, which can be used to define font behavior when adding content to the table.
PDFTableWriter.PDFHeaderFooter	createHeaderFooter()
PDFTableWriter.PDFText	createText()
void	endRow() Indicates the end of a currently processed row.
void	endTable() Ends the table.
int	getColumnCount() Returns the number of columns that have been added.
java.awt.Color	getCurrentRowBackgroundColor() Returns the background color of the current row.
java.awt.Color	getDefaultHeaderBackgroundColor() Returns the default header background color.
java.awt.Color[]	getRowBackgroundColors() Returns the alternating background colors of the rows.
void	newRow() Indicates start of a new row.
void	newRow(TableData tableData) Indicates start of a new row.
void	setAuthor(java.lang.String author)
void	setFooter(PDFTableWriter.PDFHeaderFooter footer)
void	setFooter(PDFTableWriter.PDFHeaderFooter[] footer)
void	setFooter(java.lang.String footer, boolean numbered, int alignment)
void	setHeader(PDFTableWriter.PDFHeaderFooter header)
void	setHeader(PDFTableWriter.PDFHeaderFooter[] header)
void	setHeader(java.lang.String header)
void	setRowBackgroundColors(java.awt.Color[] colors) Sets the alternating background colors of rows.
void	setShowRowCounter(boolean show)
void	setTitle(java.lang.String title)

Field Detail

ALIGN_LEFT

static final int ALIGN_LEFT

See Also:

Constant Field Values

ALIGN_RIGHT

static final int ALIGN_RIGHT

See Also:

Constant Field Values

ALIGN_CENTER

static final int ALIGN_CENTER

See Also:

Constant Field Values

ALIGN_TOP

static final int ALIGN_TOP

Since:

6.1.4

See Also:

Constant Field Values

ALIGN_MIDDLE

static final int ALIGN_MIDDLE

Since:

6.1.4

See Also:

Constant Field Values

ALIGN_BOTTOM

static final int ALIGN_BOTTOM

Since:

6.1.4

See Also:

Constant Field Values

Method Detail

addCell

void addCell(PDFTableWriter.PDFText text)

Parameters:

text - The cell content.

Since:

6.2.0

addCell

void addCell(PDFTableWriter.PDFText text,
             int alignment,
             boolean nowrap,
             java.awt.Color backgroundColor)

Add a cell to the table.

Parameters:

text - The cell content.

alignment - The alignment of the cell content.

nowrap - Whether to not wrap the text.

backgroundColor - The background color.

Since:

6.2.0

addCell

void addCell(PDFTableWriter.PDFText text,
             int alignment,
             boolean nowrap,
             java.awt.Color backgroundColor,
             int colspan)

Add a cell to the table.

Parameters:

text - The cell content.

alignment - The alignment of the cell content.

nowrap - Whether to not wrap the text.

backgroundColor - The background color.

colspan - The number of columns to span.

Throws:

java.lang.IllegalArgumentException - If colspan is less than 1.

Since:

6.3.3

addCell

void addCell(java.lang.String content)

Adds a plain text to the cell.

Parameters:

content - The cell content.

Since:

6.1.1

addCell

void addCell(java.lang.String content,
             java.awt.Color backgroundColor)

Adds text with the specified background color

Parameters:

content - The cell content.

backgroundColor - The background color.

Since:

6.1.2

addCell

void addCell(java.lang.String[] content)

Adds multiple text content to the cell. Each entry in the array will appear on a separate row.

Parameters:

content - The text content.

Since:

6.1.1

addCell

void addCell(java.lang.String[] content,
             int alignment,
             boolean nowrap,
             PDFTableWriter.PDFFontSpec[] cellFont,
             java.awt.Color backgroundColor,
             int colspan)

Add a cell to the table.

Parameters:

content - The cell content.

alignment - The alignment of the cell content.

nowrap - Whether to not wrap the text.

cellFont - The font.

backgroundColor - The background color.

colspan - The number of columns to span.

Throws:

java.lang.IllegalArgumentException - If colspan is less than 1.

Since:

6.3.3

addCell

void addCell(java.lang.String[] content,
             int alignment,
             boolean nowrap,
             PDFTableWriter.PDFFontSpec[] cellFont)

Parameters:

content -

alignment -

nowrap -

cellFont -

Since:

6.1.2

addCell

void addCell(java.lang.String[] content,
             int alignment,
             boolean nowrap,
             PDFTableWriter.PDFFontSpec[] cellFont,
             java.awt.Color backgroundColor)

Add a cell to the table.

Parameters:

content - The cell content.

alignment - The alignment of the cell content.

nowrap - Whether to not wrap the text.

cellFont - The font.

backgroundColor - The background color.

Since:

6.1.2

addColumn

PDFTableWriter.PDFColumnSpec addColumn(java.lang.String columnLabel)

Adds a simple column label with the default font, background color, alignment and wrapping.

Parameters:

columnLabel - The column label.

Returns:

The created PDFTableWriter.PDFColumnSpec

Since:

6.1.1

addColumn

PDFTableWriter.PDFColumnSpec addColumn(java.lang.String columnLabel,
                                       PDFTableWriter.PDFFontSpec font,
                                       java.awt.Color backgroundColor,
                                       int alignment,
                                       boolean noWrap)

Adds a label with the specified font, background color, alignment and wrapping.

Parameters:

columnLabel - The column label.

font - The font specification

backgroundColor - The background color to apply

alignment - The alignment of the text

noWrap - True if to avoid header wrapping.

Returns:

The created PDFTableWriter.PDFColumnSpec

Since:

6.1.1

addColumn

PDFTableWriter.PDFColumnSpec addColumn(java.lang.String columnLabel,
                                       java.lang.String groupHeader)

Adds a simple column with a label and an optional group header. The label is using the default font, background color, alignment and wrapping.

Parameters:

columnLabel - The column label

groupHeader - The group header (or null if none is used).

Returns:

The created PDFTableWriter.PDFColumnSpec

Since:

2011.2.0

addColumn

PDFTableWriter.PDFColumnSpec addColumn(java.lang.String columnLabel,
                                       PDFTableWriter.PDFFontSpec font,
                                       java.awt.Color backgroundColor,
                                       int alignment,
                                       boolean noWrap,
                                       java.lang.String groupHeader,
                                       java.awt.Color groupHeaderBackgroundColor,
                                       PDFTableWriter.PDFFontSpec groupHeaderFont)

Adds a label with the specified font, background color, alignment and wrapping.

Parameters:

columnLabel - The column label.

font - The font specification.

backgroundColor - The background color to apply.

alignment - The alignment of the text.

noWrap - True if to avoid header wrapping.

groupHeader - The group header.

groupHeaderBackgroundColor - The background color for the group header.

groupHeaderFont - the font to be used for the group header.

Returns:

The created PDFTableWriter.PDFColumnSpec

Since:

2011.2.0

close

void close()

Closes this writer.

Since:

2009.2.0

createFontSpec

PDFTableWriter.PDFFontSpec createFontSpec()

Creates a font specification, which can be used to define font behavior when adding content to the table.

Returns:

The font specification

Since:

6.1.1

createHeaderFooter

PDFTableWriter.PDFHeaderFooter createHeaderFooter()

Returns:

Returns a new PDFTableWriter.PDFHeaderFooter object.

Since:

6.1.4

createText

PDFTableWriter.PDFText createText()

Returns:

A new PDFTableWriter.PDFText instance.

Since:

6.2.0

endRow

void endRow()

Indicates the end of a currently processed row. This method must only be called after that all cells on a row has been added.

Since:

6.1.1

endTable

void endTable()

Ends the table.

Since:

6.1.1

getColumnCount

int getColumnCount()

Returns the number of columns that have been added.

Returns:

The number of columns.

Since:

6.3.3

getCurrentRowBackgroundColor

java.awt.Color getCurrentRowBackgroundColor()

Returns the background color of the current row.

Returns:

Returns the background color of the current row.

Since:

6.1.4

getDefaultHeaderBackgroundColor

java.awt.Color getDefaultHeaderBackgroundColor()

Returns the default header background color.

Returns:

The default header background color.

Since:

6.3.3

getRowBackgroundColors

java.awt.Color[] getRowBackgroundColors()

Returns the alternating background colors of the rows.

Returns:

The current alternating background colors of the rows

Since:

2009.3.1

newRow

void newRow()

Indicates start of a new row. A row that is added with this function will not get a structure column.

Since:

6.3.3

newRow

void newRow(TableData tableData)

Indicates start of a new row. This method must only be called before adding cells on a row.

Parameters:

tableData - The table data instance.

Since:

6.1.1

setAuthor

void setAuthor(java.lang.String author)

setFooter

void setFooter(PDFTableWriter.PDFHeaderFooter footer)

Parameters:

footer - The page footer element.

Since:

6.1.4

setFooter

void setFooter(PDFTableWriter.PDFHeaderFooter[] footer)

Parameters:

footer - The page footer elements (right to left).

Since:

6.1.4

setFooter

void setFooter(java.lang.String footer,
               boolean numbered,
               int alignment)

setHeader

void setHeader(PDFTableWriter.PDFHeaderFooter header)

Parameters:

header - The page header element.

Since:

6.1.4

setHeader

void setHeader(PDFTableWriter.PDFHeaderFooter[] header)

Parameters:

header - The page header elements (right to left).

Since:

6.1.4

setHeader

void setHeader(java.lang.String header)

setRowBackgroundColors

void setRowBackgroundColors(java.awt.Color[] colors)

Sets the alternating background colors of rows.

Parameters:

colors - The background colors.

Since:

6.1.4

setShowRowCounter

void setShowRowCounter(boolean show)

Parameters:

show - True if to display the row counter.

Since:

2009.2.0

setTitle

void setTitle(java.lang.String title)