CPDFGeneration.layout

Class CTable

java.lang.Object

CPDFGeneration.layout.CElementPropertyContainer

CPDFGeneration.layout.CAbstractElement

CPDFGeneration.layout.CBlockElement

CPDFGeneration.layout.CTable

All Implemented Interfaces:

CIElement

public class CTable
extends CBlockElement

Field Summary

Fields inherited from class CPDFGeneration.layout.CElementPropertyContainer

elementPtr

Constructor Summary

Constructors

Constructor and Description
CTable(long ptr) Create a table element with native pointer.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear all table content.
CDiv	createCaption() Create a caption container (typically rendered above or below the table).
CCell	createCell() Create a cell in the current row.
CCell	createCell(int rowspan, int colspan) Create a cell in the current row.
CCell	createFooterCell() Create a footer cell in the table footer section.
CCell	createFooterCell(int rowspan, int colspan) Create a footer cell in the table footer section.
CCell	createHeaderCell() Create a header cell in the table header section.
CCell	createHeaderCell(int rowspan, int colspan) Create a header cell in the table header section.
CDiv	getCaption() Get the caption container.
CCell	getCell(int row, int column) Get a cell by row and column.
CUnitValue	getColumnWidth(int column) Get the width of a column.
CTable	getFooter() Get the footer table section.
CTable	getHeader() Get the header table section.
int	getNumberOfColumns() Get number of columns.
int	getNumberOfRows() Get number of rows.
CElementType	getType() Get element type.
boolean	isEmpty() Check whether the table has no cells/content.
void	setBorderCollapse(CBorderCollapseType collapse) Set border collapse type for the table.
void	setColumnWidth(int column, CUnitValue width) Set the width of a column.
void	setHorizontalBorderSpacing(float space) Set horizontal border spacing.
void	setVerticalBorderSpacing(float space) Set vertical border spacing.
int	startNewFooterRow() Start a new row in the table footer section.
int	startNewHeaderRow() Start a new row in the table header section.
int	startNewRow() Start a new row in the table body.
int	useAllAvailableWidth() Make the table use all available width.

Methods inherited from class CPDFGeneration.layout.CBlockElement

getHeight, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getWidth, setHeight, setHeight, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddings, setPaddingTop, setVerticalAlignment, setWidth, setWidth

Methods inherited from class CPDFGeneration.layout.CAbstractElement

addStyle, getChildren, getStyles, hasProperty, isAbsolute

Methods inherited from class CPDFGeneration.layout.CElementPropertyContainer

deleteProperty, getProperties, getStrokeColor, getStrokeWidth, hasProperty, setAbsolutePosition, setAbsolutePosition, setBackgroundColor, setBackgroundImage, setBorder, setBorderBottom, setBorderBottomLeftRadius, setBorderBottomRightRadius, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBorderTopLeftRadius, setBorderTopRightRadius, setCharacterSpacing, setFontColor, setFontFamily, setFontSize, setFontStyle, setFontWeight, setHorizontalAlignment, setInlineVerticalAlignment, setOpacity, setStrokeColor, setStrokeWidth, setTextAlignment, setUnderline, setWordSpacing

Methods inherited from class java.lang.Object

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

Constructor Detail

CTable

public CTable(long ptr)

Create a table element with native pointer.

Parameters:

ptr - Native table pointer/handle.

Method Detail

getType

public CElementType getType()

Get element type.

Returns:

CElementType.ELEMENT_TABLE.

useAllAvailableWidth

public int useAllAvailableWidth()

Make the table use all available width.

Returns:

Native status code (implementation-defined).

getColumnWidth

public CUnitValue getColumnWidth(int column)

Get the width of a column.

Parameters:

column - Column index.

Returns:

Column width as CUnitValue.

setColumnWidth

public void setColumnWidth(int column,
                           CUnitValue width)

Set the width of a column.

Parameters:

column - Column index.

width - Column width as CUnitValue.

getNumberOfColumns

public int getNumberOfColumns()

Get number of columns.

Returns:

Number of columns.

getNumberOfRows

public int getNumberOfRows()

Get number of rows.

Returns:

Number of rows.

createHeaderCell

public CCell createHeaderCell(int rowspan,
                              int colspan)

Create a header cell in the table header section.

Parameters:

rowspan - Row span.

colspan - Column span.

Returns:

Created CCell.

createHeaderCell

public CCell createHeaderCell()

Create a header cell in the table header section.

Returns:

Created CCell.

getHeader

public CTable getHeader()

Get the header table section.

Returns:

Header CTable object.

createFooterCell

public CCell createFooterCell(int rowspan,
                              int colspan)

Create a footer cell in the table footer section.

Parameters:

rowspan - Row span.

colspan - Column span.

Returns:

Created CCell.

createFooterCell

public CCell createFooterCell()

Create a footer cell in the table footer section.

Returns:

Created CCell.

getFooter

public CTable getFooter()

Get the footer table section.

Returns:

Footer CTable object.

createCaption

public CDiv createCaption()

Create a caption container (typically rendered above or below the table).

Returns:

Caption CDiv element.

getCaption

public CDiv getCaption()

Get the caption container.

Returns:

Caption CDiv element.

startNewRow

public int startNewRow()

Start a new row in the table body.

Returns:

Native status code (implementation-defined).

startNewHeaderRow

public int startNewHeaderRow()

Start a new row in the table header section.

Returns:

Native status code (implementation-defined).

startNewFooterRow

public int startNewFooterRow()

Start a new row in the table footer section.

Returns:

Native status code (implementation-defined).

createCell

public CCell createCell(int rowspan,
                        int colspan)

Create a cell in the current row.

Parameters:

rowspan - Row span.

colspan - Column span.

Returns:

Created CCell.

createCell

public CCell createCell()

Create a cell in the current row.

Returns:

Created CCell.

getCell

public CCell getCell(int row,
                     int column)

Get a cell by row and column.

Parameters:

row - Row index.

column - Column index.

Returns:

Cell CCell instance.

setBorderCollapse

public void setBorderCollapse(CBorderCollapseType collapse)

Set border collapse type for the table.

Parameters:

collapse - Border collapse type.

setHorizontalBorderSpacing

public void setHorizontalBorderSpacing(float space)

Set horizontal border spacing.

Parameters:

space - Spacing value (unit is implementation-defined; commonly points).

setVerticalBorderSpacing

public void setVerticalBorderSpacing(float space)

Set vertical border spacing.

Parameters:

space - Spacing value (unit is implementation-defined; commonly points).

isEmpty

public boolean isEmpty()

Check whether the table has no cells/content.

Overrides:

isEmpty in class CAbstractElement

Returns:

true if empty, otherwise false.

clear

public void clear()

Clear all table content.