Class Table
- All Implemented Interfaces:
WithHorizontalAlignment
,Element
,LargeElement
Table
is a Rectangle
that contains Cell
s, ordered in some kind of matrix.
Tables that span multiple pages are cut into different parts automatically. If you want a table header to be repeated
on every page, you may not forget to mark the end of the header section by using the method
endHeaders()
.
The matrix of a table is not necessarily an m x n-matrix. It can contain holes or cells that are bigger than the
unit. Believe me or not, but it took some serious thinking to make this as user friendly as possible. I hope you will
find the result quite simple (I love simple solutions, especially for complex problems). I didn't want it to be
something as complex as the Java GridBagLayout
.
Example:
The result of this code is a table:// Remark: You MUST know the number of columns when constructing a Table. // The number of rows is not important. Table table = new Table(3); table.setBorderWidth(1); table.setBorderColor(new Color(0, 0, 255)); table.setPadding(5); table.setSpacing(5); Cell cell = new Cell("header"); cell.setHeader(true); cell.setColspan(3); table.addCell(cell); table.endHeaders(); cell = new Cell("example cell with colspan 1 and rowspan 2"); cell.setRowspan(2); cell.setBorderColor(new Color(255, 0, 0)); table.addCell(cell); table.addCell("1.1"); table.addCell("2.1"); table.addCell("1.2"); table.addCell("2.2"); table.addCell("cell test1"); cell = new Cell("big cell"); cell.setRowspan(2); cell.setColspan(2); table.addCell(cell); table.addCell("cell test2");
header | ||
---|---|---|
example cell with colspan 1 and rowspan 2 | 1.1 | 2.1 |
1.2 | 2.2 | |
cell test1 | big cell | |
cell test2 |
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
This is the horizontal alignment.protected boolean
Boolean to automatically fill empty cells before a table is rendered (takes CPU so may be set to false in case of certainty)private float
This is cellpadding.(package private) boolean
If true cells may not be split over two pages.private float
This is cellspacing.private int
This is the number of columns in theTable
.protected boolean
Indicates if the PdfPTable is complete once added to the document.protected boolean
if you want to generate tables the old way, set this value to false.private Point
The current Position in the table.private Cell
This Empty Cell contains the DEFAULT layout of each Cell added with the method addCell(String content).private int
This is the number of the last row of the table headers.private boolean
Is the width a percentage (false) or an absolute width (true)?private boolean
Boolean to track if a table was inserted (to avoid unnecessary computations afterwards)protected boolean
Indicates if this is the first time the section was added.(package private) float
This is the offset of the table.This is the list ofRow
s.(package private) boolean
If true this table may not be split over two pages.private float
This is the width of the table (in percent of the available space).private float[]
This is an array containing the widths (in percentages) of every column.Fields inherited from class com.lowagie.text.Rectangle
backgroundColor, border, borderColor, borderColorBottom, borderColorLeft, borderColorRight, borderColorTop, borderWidth, borderWidthBottom, borderWidthLeft, borderWidthRight, borderWidthTop, BOTTOM, BOX, LEFT, llx, lly, NO_BORDER, offsetToTop, RIGHT, rotation, TOP, UNDEFINED, urx, ury, useVariableBorders
Fields inherited from interface com.lowagie.text.Element
ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANCHOR, ANNOTATION, AUTHOR, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, FOOTNOTE, HEADER, IMGRAW, IMGTEMPLATE, JBIG2, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MODIFICATIONDATE, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE, YMARK
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds aCell
to theTable
.void
Adds aCell
to theTable
at a certain row and column.void
Adds aCell
to theTable
at a certain location.void
Adds aCell
to theTable
.void
Adds aCell
to theTable
.void
Adds aCell
to theTable
.void
Adds aCell
to theTable
.void
addColumns
(int aColumns) Gives you the possibility to add columns.private void
assumeTableDefaults
(Cell aCell) Sets the unset cell properties to be the table defaults.void
complete()
Will fill empty cells with valid blankCell
sCreate a PdfPTable based on this Table object.void
Deletes all rows in this table.void
deleteColumn
(int column) Deletes a column in this table.boolean
Deletes the last row in this table.boolean
deleteRow
(int row) Deletes a row.int
Marks the last row of the table headers.private void
adds newCell
's to empty/null spaces.void
Flushes the content that has been added.int
Gets the horizontal alignment.Gets all the chunks in this element.int
Gets the number of columns.Gets the default layout of the Table.Gets the dimension of this tablegetElement
(int row, int column) returns the element at the position row, column (Cast to Cell or Table)int
Gets the last number of the rows that contain headers.float
Gets the offset of this table.float
Gets the cellpadding.float[]
Gets the proportional widths of the columns in thisTable
.float
Gets the cellspacing.float
getWidth()
Gets the table width (a percentage).float[]
getWidths
(float left, float totalWidth) Gets an array with the positions of the borders between every column.void
insertTable
(Table aTable) To put a table within the existing table at the current position generateTable will of course re-arrange the widths of the columns.void
insertTable
(Table aTable, int row, int column) To put a table within the existing table at the given position generateTable will of course re-arrange the widths of the columns.void
insertTable
(Table aTable, Point aLocation) To put a table within the existing table at the given position generateTable will of course re-arrange the widths of the columns.boolean
Checks if the cells of thisTable
have to fit a page.boolean
Indicates if the element is complete or not.boolean
Method to check if the Table should be converted to a PdfPTable or not.boolean
isLocked()
boolean
Checks if this element is nestable.boolean
Indicates if this is the first time the section is added.boolean
Checks if thisTable
has to fit a page.private boolean
isValidLocation
(Cell aCell, Point aLocation) check ifCell
'fits' the table.iterator()
Gets anIterator
of all theRow
s.private void
Integrates all added tables and recalculates column widths.private void
Inserts a Cell in a cell-array and reserves cells defined by row-/colspan.boolean
process
(ElementListener listener) Processes the element by adding it (or the different parts) to anElementListener
.void
setAutoFillEmptyCells
(boolean aDoAutoFill) Enables/disables automatic insertion of empty cells before table is rendered.void
setCellsFitPage
(boolean fitPage) Allows you to control when a page break occurs.void
setComplete
(boolean complete) If you invoke setComplete(false), you indicate that the content of the object isn't complete yet; it can be added to the document partially, but more will follow.void
setConvert2pdfptable
(boolean convert2pdfptable) If set to true, iText will try to convert the Table to a PdfPTable.private void
setCurrentLocationToNextValidPosition
(Point aLocation) Sets current col/row to valid(empty) pos after addCell/Tablevoid
setDefaultCell
(Cell value) Sets the default layout of the Table to the provided Cellvoid
setHorizontalAlignment
(HorizontalAlignment alignment) Sets horizontal alignment mode.void
setLastHeaderRow
(int value) Sets the horizontal alignment.void
setLocked
(boolean locked) void
setNotAddedYet
(boolean notAddedYet) Sets the indication if the section was already added to the document.void
setOffset
(float offset) Sets the offset of this table.void
setPadding
(float value) Sets the cellpadding.void
setSpacing
(float value) Sets the cellspacing.void
setTableFitsPage
(boolean fitPage) Allows you to control when a page break occurs.void
setWidth
(float width) Sets the width of this table (in percentage of the available space).void
setWidths
(float[] widths) Sets the widths of the different columns (percentages).void
setWidths
(int[] widths) Sets the widths of the different columns (percentages).int
size()
Gets the number of rows in thisTable
.int
type()
Gets the type of the text element.Methods inherited from class com.lowagie.text.Rectangle
cloneNonPositionParameters, disableBorderSide, enableBorderSide, getBackgroundColor, getBorder, getBorderColor, getBorderColorBottom, getBorderColorLeft, getBorderColorRight, getBorderColorTop, getBorderWidth, getBorderWidthBottom, getBorderWidthLeft, getBorderWidthRight, getBorderWidthTop, getBottom, getBottom, getGrayFill, getHeight, getLeft, getLeft, getRelativeTop, getRight, getRight, getRotation, getTop, getTop, hasBorder, hasBorders, isContent, isUseVariableBorders, normalize, rectangle, rotate, setBackgroundColor, setBorder, setBorderColor, setBorderColorBottom, setBorderColorLeft, setBorderColorRight, setBorderColorTop, setBorderWidth, setBorderWidthBottom, setBorderWidthLeft, setBorderWidthRight, setBorderWidthTop, setBottom, setGrayFill, setLeft, setRelativeTop, setRight, setRotation, setTop, setUseVariableBorders, softCloneNonPositionParameters, toString
-
Field Details
-
autoFillEmptyCells
protected boolean autoFillEmptyCellsBoolean to automatically fill empty cells before a table is rendered (takes CPU so may be set to false in case of certainty) -
convert2pdfptable
protected boolean convert2pdfptableif you want to generate tables the old way, set this value to false. -
notAddedYet
protected boolean notAddedYetIndicates if this is the first time the section was added.- Since:
- iText 2.0.8
-
complete
protected boolean completeIndicates if the PdfPTable is complete once added to the document.- Since:
- iText 2.0.8
-
tableFitsPage
boolean tableFitsPageIf true this table may not be split over two pages. -
cellsFitPage
boolean cellsFitPageIf true cells may not be split over two pages. -
offset
float offsetThis is the offset of the table. -
columns
private int columnsThis is the number of columns in theTable
. -
rows
This is the list ofRow
s. -
curPosition
The current Position in the table. -
defaultCell
This Empty Cell contains the DEFAULT layout of each Cell added with the method addCell(String content). -
lastHeaderRow
private int lastHeaderRowThis is the number of the last row of the table headers. -
alignment
private int alignmentThis is the horizontal alignment. -
cellpadding
private float cellpaddingThis is cellpadding. -
cellspacing
private float cellspacingThis is cellspacing. -
width
private float widthThis is the width of the table (in percent of the available space). -
locked
private boolean lockedIs the width a percentage (false) or an absolute width (true)? -
widths
private float[] widthsThis is an array containing the widths (in percentages) of every column. -
mTableInserted
private boolean mTableInsertedBoolean to track if a table was inserted (to avoid unnecessary computations afterwards)
-
-
Constructor Details
-
Table
Constructs aTable
with a certain number of columns.- Parameters:
columns
- The number of columns in the table- Throws:
BadElementException
- if the creator was called with less than 1 column
-
Table
Constructs aTable
with a certain number of columns and a certain number ofRow
s.- Parameters:
columns
- The number of columns in the tablerows
- The number of rows- Throws:
BadElementException
- if the creator was called with less than 1 column
-
Table
Copy constructor (shallow copy).- Parameters:
t
- ab object ofTable
new table will created from a shallow copy of this
-
-
Method Details
-
process
Processes the element by adding it (or the different parts) to anElementListener
. -
type
public int type()Gets the type of the text element. -
getChunks
Gets all the chunks in this element. -
isNestable
public boolean isNestable()Description copied from interface:Element
Checks if this element is nestable.- Specified by:
isNestable
in interfaceElement
- Overrides:
isNestable
in classRectangle
- Returns:
- true if this element can be nested inside other elements.
- Since:
- iText 2.0.8
- See Also:
-
getColumns
public int getColumns()Gets the number of columns.- Returns:
- a value
-
size
public int size()Gets the number of rows in thisTable
.- Returns:
- the number of rows in this
Table
-
getDimension
Gets the dimension of this table- Returns:
- dimension
-
getDefaultCell
Gets the default layout of the Table.- Returns:
- a cell with all the defaults
- Since:
- 2.0.7
-
setDefaultCell
Sets the default layout of the Table to the provided Cell- Parameters:
value
- a cell with all the defaults- Since:
- 2.0.7
-
getLastHeaderRow
public int getLastHeaderRow()Gets the last number of the rows that contain headers.- Returns:
- a rownumber
-
setLastHeaderRow
public void setLastHeaderRow(int value) Sets the horizontal alignment.- Parameters:
value
- the new value
-
endHeaders
public int endHeaders()Marks the last row of the table headers.- Returns:
- the number of the last row of the table headers
-
getAlignment
public int getAlignment()Gets the horizontal alignment.- Returns:
- a value
-
setHorizontalAlignment
Description copied from interface:WithHorizontalAlignment
Sets horizontal alignment mode.- Specified by:
setHorizontalAlignment
in interfaceWithHorizontalAlignment
- Parameters:
alignment
- New alignment mode. If null, current alignment must be left unchanged
-
getPadding
public float getPadding()Gets the cellpadding.- Returns:
- a value
-
setPadding
public void setPadding(float value) Sets the cellpadding.- Parameters:
value
- the new value
-
getSpacing
public float getSpacing()Gets the cellspacing.- Returns:
- a value
-
setSpacing
public void setSpacing(float value) Sets the cellspacing.- Parameters:
value
- the new value
-
setAutoFillEmptyCells
public void setAutoFillEmptyCells(boolean aDoAutoFill) Enables/disables automatic insertion of empty cells before table is rendered. (default = false) As some people may want to create a table, fill only a couple of the cells and don't bother with investigating which empty ones need to be added, this default behavior may be very welcome. Disabling is recommended to increase speed. (empty cells should be added through extra code then)- Parameters:
aDoAutoFill
- enable/disable autofill
-
getWidth
public float getWidth()Gets the table width (a percentage). -
setWidth
public void setWidth(float width) Sets the width of this table (in percentage of the available space).- Parameters:
width
- the width
-
isLocked
public boolean isLocked()- Returns:
- the locked
-
setLocked
public void setLocked(boolean locked) - Parameters:
locked
- the locked to set
-
getProportionalWidths
public float[] getProportionalWidths()Gets the proportional widths of the columns in thisTable
.- Returns:
- the proportional widths of the columns in this
Table
-
setWidths
Sets the widths of the different columns (percentages).You can give up relative values of borderwidths. The sum of these values will be considered 100%. The values will be recalculated as percentages of this sum.
example:
The widths will be: a width of 50% for the first column, 25% for the second and third column.float[] widths = {2, 1, 1}; table.setWidths(widths)
- Parameters:
widths
- an array with values- Throws:
BadElementException
- on error
-
setWidths
Sets the widths of the different columns (percentages).You can give up relative values of borderwidths. The sum of these values will be considered 100%. The values will be recalculated as percentages of this sum.
- Parameters:
widths
- an array with values- Throws:
DocumentException
- on error
-
isTableFitsPage
public boolean isTableFitsPage()Checks if thisTable
has to fit a page.- Returns:
true
if the table may not be split
-
setTableFitsPage
public void setTableFitsPage(boolean fitPage) Allows you to control when a page break occurs.When a table doesn't fit a page, it is split in two parts. If you want to avoid this, you should set the tableFitsPage value to true.
- Parameters:
fitPage
- enter true if you don't want to split cells
-
isCellsFitPage
public boolean isCellsFitPage()Checks if the cells of thisTable
have to fit a page.- Returns:
true
if the cells may not be split
-
setCellsFitPage
public void setCellsFitPage(boolean fitPage) Allows you to control when a page break occurs.When a cell doesn't fit a page, it is split in two parts. If you want to avoid this, you should set the cellsFitPage value to true.
- Parameters:
fitPage
- enter true if you don't want to split cells
-
getOffset
public float getOffset()Gets the offset of this table.- Returns:
- the space between this table and the previous element.
-
setOffset
public void setOffset(float offset) Sets the offset of this table.Normally a newline is added before you add a Table object. This newline uses the current leading. If you want to control the space between the table and the previous element yourself, you have to set the offset of this table.
- Parameters:
offset
- the space between this table and the previous object.
-
isConvert2pdfptable
public boolean isConvert2pdfptable()Method to check if the Table should be converted to a PdfPTable or not.- Returns:
- false if the table should be handled the old fashioned way.
-
setConvert2pdfptable
public void setConvert2pdfptable(boolean convert2pdfptable) If set to true, iText will try to convert the Table to a PdfPTable.- Parameters:
convert2pdfptable
- true if you want iText to try to convert the Table to a PdfPTable
-
addCell
Adds aCell
to theTable
at a certain row and column.- Parameters:
aCell
- TheCell
to addrow
- The row where theCell
will be addedcolumn
- The column where theCell
will be added- Throws:
BadElementException
- on error
-
addCell
Adds aCell
to theTable
at a certain location.- Parameters:
aCell
- TheCell
to addaLocation
- The location where theCell
will be added- Throws:
BadElementException
- on error
-
addCell
Adds aCell
to theTable
.- Parameters:
cell
- aCell
-
addCell
Adds aCell
to theTable
.This is a shortcut for
addCell(Cell cell)
. ThePhrase
will be converted to aCell
.- Parameters:
content
- aPhrase
- Throws:
BadElementException
- this should never happen
-
addCell
Adds aCell
to theTable
.This is a shortcut for
addCell(Cell cell, Point location)
. ThePhrase
will be converted to aCell
.- Parameters:
content
- aPhrase
location
- aPoint
- Throws:
BadElementException
- this should never happen
-
addCell
Adds aCell
to theTable
.This is a shortcut for
addCell(Cell cell)
. TheString
will be converted to aCell
.- Parameters:
content
- aString
- Throws:
BadElementException
- this should never happen
-
addCell
Adds aCell
to theTable
.This is a shortcut for
addCell(Cell cell, Point location)
. TheString
will be converted to aCell
.- Parameters:
content
- aString
location
- aPoint
- Throws:
BadElementException
- this should never happen
-
insertTable
To put a table within the existing table at the current position generateTable will of course re-arrange the widths of the columns.- Parameters:
aTable
- the table you want to insert
-
insertTable
To put a table within the existing table at the given position generateTable will of course re-arrange the widths of the columns.- Parameters:
aTable
- TheTable
to addrow
- The row where theCell
will be addedcolumn
- The column where theCell
will be added
-
insertTable
To put a table within the existing table at the given position generateTable will of course re-arrange the widths of the columns.- Parameters:
aTable
- the table you want to insertaLocation
- aPoint
-
addColumns
public void addColumns(int aColumns) Gives you the possibility to add columns.- Parameters:
aColumns
- the number of columns to add
-
deleteColumn
Deletes a column in this table.- Parameters:
column
- the number of the column that has to be deleted- Throws:
BadElementException
- on error
-
deleteRow
public boolean deleteRow(int row) Deletes a row.- Parameters:
row
- the number of the row to delete- Returns:
- boolean
true
if the row was deleted;false
if not
-
deleteAllRows
public void deleteAllRows()Deletes all rows in this table. (contributed by dperezcar@fcc.es) -
deleteLastRow
public boolean deleteLastRow()Deletes the last row in this table.- Returns:
- boolean
true
if the row was deleted;false
if not
-
complete
public void complete()Will fill empty cells with valid blankCell
s -
getElement
returns the element at the position row, column (Cast to Cell or Table)- Parameters:
row
- row numbercolumn
- column number- Returns:
- dimension
- Since:
- 2.1.0 (was made private in 2.0.3)
-
mergeInsertedTables
private void mergeInsertedTables()Integrates all added tables and recalculates column widths. -
fillEmptyMatrixCells
private void fillEmptyMatrixCells()adds newCell
's to empty/null spaces. -
isValidLocation
check ifCell
'fits' the table.- rowspan/colspan not beyond borders
- spanned cell don't overlap existing cells
- Parameters:
aCell
- the cell that has to be checkedaLocation
- the location where the cell has to be placed- Returns:
- true if the location was valid
-
assumeTableDefaults
Sets the unset cell properties to be the table defaults.- Parameters:
aCell
- The cell to set to table defaults as necessary.
-
placeCell
Inserts a Cell in a cell-array and reserves cells defined by row-/colspan.- Parameters:
someRows
- some rowsaCell
- the cell that has to be insertedaPosition
- the position where the cell has to be placed
-
setCurrentLocationToNextValidPosition
Sets current col/row to valid(empty) pos after addCell/Table- Parameters:
aLocation
- a location in the Table
-
getWidths
public float[] getWidths(float left, float totalWidth) Gets an array with the positions of the borders between every column.This method translates the widths expressed in percentages into the x-coordinate of the borders of the columns on a real document.
- Parameters:
left
- this is the position of the first border at the left (cellpadding not included)totalWidth
- this is the space between the first border at the left and the last border at the right (cellpadding not included)- Returns:
- an array with border positions
-
iterator
Gets anIterator
of all theRow
s.- Returns:
- an
Iterator
-
createPdfPTable
Create a PdfPTable based on this Table object.- Returns:
- a PdfPTable object
- Throws:
BadElementException
- on error
-
isNotAddedYet
public boolean isNotAddedYet()Indicates if this is the first time the section is added.- Returns:
- true if the section wasn't added yet
- Since:
- iText2.0.8
-
setNotAddedYet
public void setNotAddedYet(boolean notAddedYet) Sets the indication if the section was already added to the document.- Parameters:
notAddedYet
-notAddedYet
- Since:
- iText2.0.8
-
flushContent
public void flushContent()Description copied from interface:LargeElement
Flushes the content that has been added.- Specified by:
flushContent
in interfaceLargeElement
- Since:
- iText 2.0.8
- See Also:
-
isComplete
public boolean isComplete()Description copied from interface:LargeElement
Indicates if the element is complete or not.- Specified by:
isComplete
in interfaceLargeElement
- Returns:
- indicates if the element is complete according to the user.
- Since:
- iText 2.0.8
- See Also:
-
setComplete
public void setComplete(boolean complete) Description copied from interface:LargeElement
If you invoke setComplete(false), you indicate that the content of the object isn't complete yet; it can be added to the document partially, but more will follow. If you invoke setComplete(true), you indicate that you won't add any more data to the object.- Specified by:
setComplete
in interfaceLargeElement
- Parameters:
complete
- false if you'll be adding more data after adding the object to the document.- Since:
- iText 2.0.8
- See Also:
-