com.lowagie.text.pdf.PdfPTable Maven / Gradle / Ivy
/*
* $Id: PdfPTable.java 4065 2009-09-16 23:09:11Z psoares33 $
*
* Copyright 2001, 2002 Paulo Soares
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the License.
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
* Alternatively, the contents of this file may be used under the terms of the
* LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
* provisions of LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the LGPL
* License and not to allow others to use your version of this file under
* the MPL, indicate your decision by deleting the provisions above and
* replace them with the notice and other provisions required by the LGPL.
* If you do not delete the provisions above, a recipient may use your version
* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MPL as stated above or under the terms of the GNU
* Library General Public License as published by the Free Software Foundation;
* either version 2 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
* details.
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* https://github.com/LibrePDF/OpenPDF
*/
package com.lowagie.text.pdf;
import java.util.ArrayList;
import java.util.Comparator;
import com.lowagie.text.error_messages.MessageLocalization;
import com.lowagie.text.DocumentException;
import com.lowagie.text.Element;
import com.lowagie.text.ElementListener;
import com.lowagie.text.Image;
import com.lowagie.text.LargeElement;
import com.lowagie.text.Phrase;
import com.lowagie.text.Rectangle;
import com.lowagie.text.pdf.events.PdfPTableEventForwarder;
/**
* This is a table that can be put at an absolute position but can also
* be added to the document as the class Table.
* In the last case when crossing pages the table always break at full rows; if a
* row is bigger than the page it is dropped silently to avoid infinite loops.
*
* A PdfPTableEvent can be associated to the table to do custom drawing
* when the table is rendered.
* @author Paulo Soares ([email protected])
*/
public class PdfPTable implements LargeElement{
/**
* The index of the original PdfcontentByte.
*/
public static final int BASECANVAS = 0;
/**
* The index of the duplicate PdfContentByte where the background will be drawn.
*/
public static final int BACKGROUNDCANVAS = 1;
/**
* The index of the duplicate PdfContentByte where the border lines will be drawn.
*/
public static final int LINECANVAS = 2;
/**
* The index of the duplicate PdfContentByte where the text will be drawn.
*/
public static final int TEXTCANVAS = 3;
protected ArrayList rows = new ArrayList<>();
protected float totalHeight = 0;
protected PdfPCell[] currentRow;
protected int currentRowIdx = 0;
protected PdfPCell defaultCell = new PdfPCell((Phrase)null);
protected float totalWidth = 0;
protected float[] relativeWidths;
protected float[] absoluteWidths;
protected PdfPTableEvent tableEvent;
/**
* Holds value of property headerRows.
*/
protected int headerRows;
/**
* Holds value of property widthPercentage.
*/
protected float widthPercentage = 80;
/**
* Holds value of property horizontalAlignment.
*/
private int horizontalAlignment = Element.ALIGN_CENTER;
/**
* Holds value of property skipFirstHeader.
*/
private boolean skipFirstHeader = false;
/**
* Holds value of property skipLastFooter.
* @since 2.1.6
*/
private boolean skipLastFooter = false;
protected boolean isColspan = false;
protected int runDirection = PdfWriter.RUN_DIRECTION_DEFAULT;
/**
* Holds value of property lockedWidth.
*/
private boolean lockedWidth = false;
/**
* Holds value of property splitRows.
*/
private boolean splitRows = true;
/**
* The spacing before the table.
*/
protected float spacingBefore;
/**
* The spacing after the table.
*/
protected float spacingAfter;
/**
* Holds value of property extendLastRow.
*/
private boolean[] extendLastRow = { false, false };
/**
* Holds value of property headersInEvent.
*/
private boolean headersInEvent;
/**
* Holds value of property splitLate.
*/
private boolean splitLate = true;
/**
* Defines if the table should be kept
* on one page if possible
*/
private boolean keepTogether;
/**
* Indicates if the PdfPTable is complete once added to the document.
*
* @since iText 2.0.8
*/
protected boolean complete = true;
/**
* Holds value of property footerRows.
*/
private int footerRows;
/**
* Keeps track of the completeness of the current row.
* @since 2.1.6
*/
protected boolean rowCompleted = true;
protected PdfPTable() {
}
/**
* Constructs a PdfPTable with the relative column widths.
*
* @param relativeWidths the relative column widths
*/
public PdfPTable(float[] relativeWidths) {
if (relativeWidths == null)
throw new NullPointerException(MessageLocalization.getComposedMessage("the.widths.array.in.pdfptable.constructor.can.not.be.null"));
if (relativeWidths.length == 0)
throw new IllegalArgumentException(MessageLocalization.getComposedMessage("the.widths.array.in.pdfptable.constructor.can.not.have.zero.length"));
this.relativeWidths = new float[relativeWidths.length];
System.arraycopy(relativeWidths, 0, this.relativeWidths, 0, relativeWidths.length);
absoluteWidths = new float[relativeWidths.length];
calculateWidths();
currentRow = new PdfPCell[absoluteWidths.length];
keepTogether = false;
}
/**
* Constructs a PdfPTable with numColumns columns.
*
* @param numColumns the number of columns
*/
public PdfPTable(int numColumns) {
if (numColumns <= 0)
throw new IllegalArgumentException(MessageLocalization.getComposedMessage("the.number.of.columns.in.pdfptable.constructor.must.be.greater.than.zero"));
relativeWidths = new float[numColumns];
for (int k = 0; k < numColumns; ++k)
relativeWidths[k] = 1;
absoluteWidths = new float[relativeWidths.length];
calculateWidths();
currentRow = new PdfPCell[absoluteWidths.length];
keepTogether = false;
}
/**
* Constructs a copy of a PdfPTable.
*
* @param table the PdfPTable to be copied
*/
public PdfPTable(PdfPTable table) {
copyFormat(table);
for (int k = 0; k < currentRow.length; ++k) {
if (table.currentRow[k] == null)
break;
currentRow[k] = new PdfPCell(table.currentRow[k]);
}
for (int k = 0; k < table.rows.size(); ++k) {
PdfPRow row = table.rows.get(k);
if (row != null)
row = new PdfPRow(row);
rows.add(row);
}
}
/**
* Makes a shallow copy of a table (format without content).
*
* @param table the PdfTable to copy
* @return a shallow copy of the table
*/
public static PdfPTable shallowCopy(PdfPTable table) {
PdfPTable nt = new PdfPTable();
nt.copyFormat(table);
return nt;
}
/**
* Copies the format of the sourceTable without copying the content.
*
* @param sourceTable the PdfTable to copy the format of
* @since 2.1.6 private is now protected
*/
protected void copyFormat(PdfPTable sourceTable) {
relativeWidths = new float[sourceTable.getNumberOfColumns()];
absoluteWidths = new float[sourceTable.getNumberOfColumns()];
System.arraycopy(sourceTable.relativeWidths, 0, relativeWidths, 0, getNumberOfColumns());
System.arraycopy(sourceTable.absoluteWidths, 0, absoluteWidths, 0, getNumberOfColumns());
totalWidth = sourceTable.totalWidth;
totalHeight = sourceTable.totalHeight;
currentRowIdx = 0;
tableEvent = sourceTable.tableEvent;
runDirection = sourceTable.runDirection;
defaultCell = new PdfPCell(sourceTable.defaultCell);
currentRow = new PdfPCell[sourceTable.currentRow.length];
isColspan = sourceTable.isColspan;
splitRows = sourceTable.splitRows;
spacingAfter = sourceTable.spacingAfter;
spacingBefore = sourceTable.spacingBefore;
headerRows = sourceTable.headerRows;
footerRows = sourceTable.footerRows;
lockedWidth = sourceTable.lockedWidth;
extendLastRow = sourceTable.extendLastRow;
headersInEvent = sourceTable.headersInEvent;
widthPercentage = sourceTable.widthPercentage;
splitLate = sourceTable.splitLate;
skipFirstHeader = sourceTable.skipFirstHeader;
skipLastFooter = sourceTable.skipLastFooter;
horizontalAlignment = sourceTable.horizontalAlignment;
keepTogether = sourceTable.keepTogether;
complete = sourceTable.complete;
}
/**
* Sets the relative widths of the table.
*
* @param relativeWidths the relative widths of the table.
* @throws DocumentException if the number of widths is different than the number
* of columns
*/
public void setWidths(float[] relativeWidths) throws DocumentException {
if (relativeWidths.length != getNumberOfColumns())
throw new DocumentException(MessageLocalization.getComposedMessage("wrong.number.of.columns"));
this.relativeWidths = new float[relativeWidths.length];
System.arraycopy(relativeWidths, 0, this.relativeWidths, 0, relativeWidths.length);
absoluteWidths = new float[relativeWidths.length];
totalHeight = 0;
calculateWidths();
calculateHeights(true);
}
/**
* Sets the relative widths of the table.
*
* @param relativeWidths the relative widths of the table.
* @throws DocumentException if the number of widths is different than the number
* of columns
*/
public void setWidths(int[] relativeWidths) throws DocumentException {
float[] tb = new float[relativeWidths.length];
for (int k = 0; k < relativeWidths.length; ++k)
tb[k] = relativeWidths[k];
setWidths(tb);
}
/**
* @since 2.1.6 private is now protected
*/
protected void calculateWidths() {
if (totalWidth <= 0)
return;
float total = 0;
int numCols = getNumberOfColumns();
for (int k = 0; k < numCols; ++k)
total += relativeWidths[k];
for (int k = 0; k < numCols; ++k)
absoluteWidths[k] = totalWidth * relativeWidths[k] / total;
}
/**
* Sets the full width of the table.
*
* @param totalWidth the full width of the table.
*/
public void setTotalWidth(float totalWidth) {
if (this.totalWidth == totalWidth)
return;
this.totalWidth = totalWidth;
totalHeight = 0;
calculateWidths();
calculateHeights(true);
}
/**
* Sets the full width of the table from the absolute column width.
*
* @param columnWidth the absolute width of each column
* @throws DocumentException if the number of widths is different than the number
* of columns
*/
public void setTotalWidth(float[] columnWidth) throws DocumentException {
if (columnWidth.length != getNumberOfColumns())
throw new DocumentException(MessageLocalization.getComposedMessage("wrong.number.of.columns"));
totalWidth = 0;
for (float v : columnWidth) totalWidth += v;
setWidths(columnWidth);
}
/**
* Sets the percentage width of the table from the absolute column width.
*
* @param columnWidth the absolute width of each column
* @param pageSize the page size
* @throws DocumentException on error
*/
public void setWidthPercentage(float[] columnWidth, Rectangle pageSize) throws DocumentException {
if (columnWidth.length != getNumberOfColumns())
throw new IllegalArgumentException(MessageLocalization.getComposedMessage("wrong.number.of.columns"));
float totalWidth = 0;
for (float v : columnWidth) totalWidth += v;
widthPercentage = totalWidth / (pageSize.getRight() - pageSize.getLeft()) * 100f;
setWidths(columnWidth);
}
/**
* Gets the full width of the table.
*
* @return the full width of the table
*/
public float getTotalWidth() {
return totalWidth;
}
/**
* Calculates the heights of the table.
*
* @param firsttime if true, the heights of the rows will be recalculated.
* This takes time; normally the heights of the rows are already calcultated,
* so in most cases, it's save to use false as parameter.
* @return the total height of the table. Note that it will be 0 if you didn't
* specify the width of the table with setTotalWidth().
* @since 2.1.5 added a parameter and a return type to an existing method,
* and made it public
*/
public float calculateHeights(boolean firsttime) {
if (totalWidth <= 0)
return 0;
totalHeight = 0;
for (int k = 0; k < rows.size(); ++k) {
totalHeight += getRowHeight(k, firsttime);
}
if(firsttime) {
// Redistribute row height for row span once
try {
this.redistributeRowspanHeight();
} catch (Exception err) {
// Exception redistributing rowspan height.
}
calculateHeights(false);
}
return totalHeight;
}
/**
* Calculates the heights of the table.
*/
public void calculateHeightsFast() {
calculateHeights(false);
}
/**
* Gets the default PdfPCell that will be used as
* reference for all the addCell methods except
* addCell(PdfPCell).
*
* @return default PdfPCell
*/
public PdfPCell getDefaultCell() {
return defaultCell;
}
/**
* Adds a cell element.
*
* @param cell the cell element
*/
public PdfPCell addCell(PdfPCell cell) {
rowCompleted = false;
PdfPCell ncell = new PdfPCell(cell);
int colspan = ncell.getColspan();
colspan = Math.max(colspan, 1);
colspan = Math.min(colspan, currentRow.length - currentRowIdx);
ncell.setColspan(colspan);
if (colspan != 1)
isColspan = true;
int rdir = ncell.getRunDirection();
if (rdir == PdfWriter.RUN_DIRECTION_DEFAULT)
ncell.setRunDirection(runDirection);
skipColsWithRowspanAbove();
boolean cellAdded = false;
if (currentRowIdx < currentRow.length) {
currentRow[currentRowIdx] = ncell;
currentRowIdx += colspan;
cellAdded = true;
}
skipColsWithRowspanAbove();
while (currentRowIdx >= currentRow.length) {
int numCols = getNumberOfColumns();
if (runDirection == PdfWriter.RUN_DIRECTION_RTL) {
PdfPCell[] rtlRow = new PdfPCell[numCols];
int rev = currentRow.length;
for (int k = 0; k < currentRow.length; ++k) {
PdfPCell rcell = currentRow[k];
int cspan = rcell.getColspan();
rev -= cspan;
rtlRow[rev] = rcell;
k += cspan - 1;
}
currentRow = rtlRow;
}
PdfPRow row = new PdfPRow(currentRow);
if (totalWidth > 0) {
row.setWidths(absoluteWidths);
totalHeight += row.getMaxHeights();
}
rows.add(row);
currentRow = new PdfPCell[numCols];
currentRowIdx = 0;
skipColsWithRowspanAbove();
rowCompleted = true;
}
if (!cellAdded) {
currentRow[currentRowIdx] = ncell;
currentRowIdx += colspan;
}
return ncell;
}
/**
* When updating the row index, cells with rowspan should be taken into account.
* This is what happens in this method.
* @since 2.1.6
*/
private void skipColsWithRowspanAbove() {
int direction = 1;
if (runDirection == PdfWriter.RUN_DIRECTION_RTL)
direction = -1;
while (rowSpanAbove(rows.size(), currentRowIdx))
currentRowIdx += direction;
}
PdfPCell obtainCell(final int row, final int col) {
PdfPCell[] cells = rows.get(row).getCells();
for (int i = 0; i < cells.length; i++) {
if (cells[i] != null) {
if (col >= i && col < (i + cells[i].getColspan())) {
return cells[i];
}
}
}
return null;
}
/**
* Checks if there are rows above belonging to a rowspan.
* @param currRow the current row to check
* @param currCol the current column to check
* @return true if there's a cell above that belongs to a rowspan
* @since 2.1.6
*/
boolean rowSpanAbove(int currRow, int currCol) {
if ((currCol >= getNumberOfColumns())
|| (currCol < 0)
|| (currRow < 1))
return false;
int row = currRow - 1;
PdfPRow aboveRow = rows.get(row);
if (aboveRow == null)
return false;
PdfPCell aboveCell = obtainCell(row,currCol);
while ((aboveCell == null) && (row > 0)) {
aboveRow = rows.get(--row);
if (aboveRow == null)
return false;
aboveCell = obtainCell(row,currCol);
}
int distance = currRow - row;
if (aboveCell == null) {
int col = currCol - 1;
aboveCell = obtainCell(row,col);
while ((aboveCell == null) && (row > 0))
aboveCell = obtainCell(row,--col);
return aboveCell != null && aboveCell.getRowspan() > distance;
}
if ((aboveCell.getRowspan() == 1) && (distance > 1)) {
int col = currCol - 1;
aboveRow = rows.get(row + 1);
distance--;
aboveCell = aboveRow.getCells()[col];
while ((aboveCell == null) && (col > 0))
aboveCell = aboveRow.getCells()[--col];
}
return aboveCell != null && aboveCell.getRowspan() > distance;
}
/**
* Adds a cell element.
*
* @param text the text for the cell
*/
public PdfPCell addCell(String text) {
return addCell(new Phrase(text));
}
/**
* Adds a nested table.
*
* @param table the table to be added to the cell
*/
public PdfPCell addCell(PdfPTable table) {
defaultCell.setTable(table);
addCell(defaultCell);
defaultCell.setTable(null);
return defaultCell;
}
/**
* Adds an Image as Cell.
*
* @param image the Image to add to the table.
* This image will fit in the cell
*/
public PdfPCell addCell(Image image) {
defaultCell.setImage(image);
addCell(defaultCell);
defaultCell.setImage(null);
return defaultCell;
}
/**
* Adds a cell element.
*
* @param phrase the Phrase to be added to the cell
*/
public PdfPCell addCell(Phrase phrase) {
defaultCell.setPhrase(phrase);
addCell(defaultCell);
defaultCell.setPhrase(null);
return defaultCell;
}
/**
* Writes the selected rows to the document.
* canvases is obtained from beginWritingRows().
*
* @param rowStart the first row to be written, zero index
* @param rowEnd the last row to be written + 1. If it is -1 all the
* rows to the end are written
* @param xPos the x write coordinate
* @param yPos the y write coordinate
* @param canvases an array of 4 PdfContentByte obtained from
* beginWrittingRows()
* @return the y coordinate position of the bottom of the last row
* @see #beginWritingRows(com.lowagie.text.pdf.PdfContentByte)
*/
public float writeSelectedRows(int rowStart, int rowEnd, float xPos, float yPos, PdfContentByte[] canvases) {
return writeSelectedRows(0, -1, rowStart, rowEnd, xPos, yPos, canvases);
}
/**
* Writes the selected rows and columns to the document.
* This method does not clip the columns; this is only important
* if there are columns with colspan at boundaries.
* canvases is obtained from beginWritingRows().
* The table event is only fired for complete rows.
*
* @param colStart the first column to be written, zero index
* @param colEnd the last column to be written + 1. If it is -1 all the
* columns to the end are written
* @param rowStart the first row to be written, zero index
* @param rowEnd the last row to be written + 1. If it is -1 all the
* rows to the end are written
* @param xPos the x write coordinate
* @param yPos the y write coordinate
* @param canvases an array of 4 PdfContentByte obtained from
* beginWritingRows()
* @return the y coordinate position of the bottom of the last row
* @see #beginWritingRows(com.lowagie.text.pdf.PdfContentByte)
*/
public float writeSelectedRows(int colStart, int colEnd, int rowStart, int rowEnd, float xPos, float yPos, PdfContentByte[] canvases) {
if (totalWidth <= 0)
throw new RuntimeException(MessageLocalization.getComposedMessage("the.table.width.must.be.greater.than.zero"));
int totalRows = rows.size();
if (rowStart < 0)
rowStart = 0;
if (rowEnd < 0)
rowEnd = totalRows;
else
rowEnd = Math.min(rowEnd, totalRows);
if (rowStart >= rowEnd)
return yPos;
int totalCols = getNumberOfColumns();
if (colStart < 0)
colStart = 0;
else
colStart = Math.min(colStart, totalCols);
if (colEnd < 0)
colEnd = totalCols;
else
colEnd = Math.min(colEnd, totalCols);
float yPosStart = yPos;
for (int k = rowStart; k < rowEnd; ++k) {
PdfPRow row = rows.get(k);
if (row != null) {
row.writeCells(colStart, colEnd, xPos, yPos, canvases);
yPos -= row.getMaxHeights();
}
}
if (tableEvent != null && colStart == 0 && colEnd == totalCols) {
float[] heights = new float[rowEnd - rowStart + 1];
heights[0] = yPosStart;
for (int k = rowStart; k < rowEnd; ++k) {
PdfPRow row = rows.get(k);
float hr = 0;
if (row != null)
hr = row.getMaxHeights();
heights[k - rowStart + 1] = heights[k - rowStart] - hr;
}
tableEvent.tableLayout(this, getEventWidths(xPos, rowStart, rowEnd, headersInEvent), heights, headersInEvent ? headerRows : 0, rowStart, canvases);
}
return yPos;
}
/**
* Writes the selected rows to the document.
*
* @param rowStart the first row to be written, zero index
* @param rowEnd the last row to be written + 1. If it is -1 all the
* rows to the end are written
* @param xPos the x write coordinate
* @param yPos the y write coordinate
* @param canvas the PdfContentByte where the rows will
* be written to
* @return the y coordinate position of the bottom of the last row
*/
public float writeSelectedRows(int rowStart, int rowEnd, float xPos, float yPos, PdfContentByte canvas) {
return writeSelectedRows(0, -1, rowStart, rowEnd, xPos, yPos, canvas);
}
/**
* Writes the selected rows and columns to the document.
* This method clips the columns; this is only important
* if there are columns with colspan at boundaries.
* The table event is only fired for complete rows.
*
* @param colStart the first column to be written, zero index
* @param colEnd the last column to be written + 1. If it is -1 all the
* columns to the end are written
* @param rowStart the first row to be written, zero index
* @param rowEnd the last row to be written + 1. If it is -1 all the
* rows to the end are written
* @param xPos the x write coordinate
* @param yPos the y write coordinate
* @param canvas the PdfContentByte where the rows will
* be written to
* @return the y coordinate position of the bottom of the last row
*/
public float writeSelectedRows(int colStart, int colEnd, int rowStart, int rowEnd, float xPos, float yPos, PdfContentByte canvas) {
int totalCols = getNumberOfColumns();
if (colStart < 0)
colStart = 0;
else
colStart = Math.min(colStart, totalCols);
if (colEnd < 0)
colEnd = totalCols;
else
colEnd = Math.min(colEnd, totalCols);
boolean clip = (colStart != 0 || colEnd != totalCols);
if (clip) {
float w = 0;
for (int k = colStart; k < colEnd; ++k)
w += absoluteWidths[k];
canvas.saveState();
float lx = (colStart == 0) ? 10000 : 0;
float rx = (colEnd == totalCols) ? 10000 : 0;
canvas.rectangle(xPos - lx, -10000, w + lx + rx, PdfPRow.RIGHT_LIMIT);
canvas.clip();
canvas.newPath();
}
PdfContentByte[] canvases = beginWritingRows(canvas);
float y = writeSelectedRows(colStart, colEnd, rowStart, rowEnd, xPos, yPos, canvases);
endWritingRows(canvases);
if (clip)
canvas.restoreState();
return y;
}
/**
* Gets and initializes the 4 layers where the table is written to. The text or graphics are added to
* one of the 4 PdfContentByte returned with the following order:
*
* PdfPtable.BASECANVAS - the original PdfContentByte. Anything placed here
* will be under the table.
* PdfPtable.BACKGROUNDCANVAS - the layer where the background goes to.
* PdfPtable.LINECANVAS - the layer where the lines go to.
* PdfPtable.TEXTCANVAS - the layer where the text go to. Anything placed here
* will be over the table.
*
* The layers are placed in sequence on top of each other.
*
* @param canvas the PdfContentByte where the rows will
* be written to
* @return an array of 4 PdfContentByte
* @see #writeSelectedRows(int, int, float, float, PdfContentByte[])
*/
public static PdfContentByte[] beginWritingRows(PdfContentByte canvas) {
return new PdfContentByte[]{
canvas,
canvas.getDuplicate(),
canvas.getDuplicate(),
canvas.getDuplicate(),
};
}
/**
* Finishes writing the table.
*
* @param canvases the array returned by beginWritingRows()
*/
public static void endWritingRows(PdfContentByte[] canvases) {
PdfContentByte canvas = canvases[BASECANVAS];
canvas.saveState();
canvas.add(canvases[BACKGROUNDCANVAS]);
canvas.restoreState();
canvas.saveState();
canvas.setLineCap(2);
canvas.resetRGBColorStroke();
canvas.add(canvases[LINECANVAS]);
canvas.restoreState();
canvas.add(canvases[TEXTCANVAS]);
}
/**
* Gets the number of rows in this table.
*
* @return the number of rows in this table
*/
public int size() {
return rows.size();
}
/**
* Gets the total height of the table.
*
* @return the total height of the table
*/
public float getTotalHeight() {
return totalHeight;
}
/**
* Gets the height of a particular row.
*
* @param idx the row index (starts at 0)
* @return the height of a particular row
*/
public float getRowHeight(int idx) {
return getRowHeight(idx, false);
}
private void redistributeRowspanHeight() {
float delta = 0.001f;
if (rows == null) return;
for (int rowIdx = 0; rowIdx < rows.size(); rowIdx++) {
PdfPRow row = rows.get(rowIdx);
if (row == null) continue;
PdfPCell[] cells = row.getCells();
for (PdfPCell cell : cells) {
if (cell != null && cell.getRowspan() > 1) {
float existingHeights = 0;
for (int r = rowIdx; r < rows.size() && r < rowIdx + cell.getRowspan(); r++) {
PdfPRow currentRow = rows.get(r);
if (currentRow == null) continue;
existingHeights += currentRow.getMaxHeights();
}
float heightToDistribute = cell.getMaxHeight() - existingHeights;
if (heightToDistribute > delta) {
ArrayList rowsByHeight = new ArrayList<>(cell.getRowspan());
for (int r = rowIdx; r < rows.size() && r < rowIdx + cell.getRowspan(); r++) {
if(rows.get(r) == null) continue;
rowsByHeight.add(r);
}
rowsByHeight.sort(Comparator.comparing(r -> rows.get(r).getMaxHeights()));
for (int i = 0; i < rowsByHeight.size(); i++) {
if (heightToDistribute < delta) break;
float additionalHeightPerRow = heightToDistribute / (i + 1);
if (i + 1 < rowsByHeight.size()) {
float currentRowHeight = rows.get(rowsByHeight.get(i)).getMaxHeights();
float nextRowHeight = rows.get(rowsByHeight.get(i + 1)).getMaxHeights();
if (Math.abs(currentRowHeight - nextRowHeight) < delta) {
continue;
} else {
additionalHeightPerRow = Math.min(additionalHeightPerRow, nextRowHeight - currentRowHeight);
}
}
for (int j = 0; j <= i; j++) {
int r = rowsByHeight.get(j);
PdfPRow smallerRow = rows.get(r);
smallerRow.setMaxHeights(smallerRow.getMaxHeights() + additionalHeightPerRow);
heightToDistribute -= additionalHeightPerRow;
}
}
}
}
}
}
}
/**
* Gets the height of a particular row.
*
* @param idx the row index (starts at 0)
* @param firsttime is this the first time the row heigh is calculated?
* @return the height of a particular row
* @since 5.0.0
*/
public float getRowHeight(int idx, boolean firsttime) {
if (totalWidth <= 0 || idx < 0 || idx >= rows.size())
return 0;
PdfPRow row = rows.get(idx);
if (row == null)
return 0;
if (firsttime) {
row.setWidths(absoluteWidths);
row.calculateHeights();
}
return row.getMaxHeights();
}
/**
* Gets the maximum height of a cell in a particular row (will only be different
* from getRowHeight is one of the cells in the row has a rowspan {@literal >} 1).
*
* @param rowIndex the row index
* @param cellIndex the cell index
* @return the height of a particular row including rowspan
* @since 2.1.6
*/
public float getRowspanHeight(int rowIndex, int cellIndex) {
if (totalWidth <= 0 || rowIndex < 0 || rowIndex >= rows.size())
return 0;
PdfPRow row = rows.get(rowIndex);
if (row == null || cellIndex >= row.getCells().length)
return 0;
PdfPCell cell = row.getCells()[cellIndex];
if (cell == null)
return 0;
float rowspanHeight = 0;
for (int j = 0; j < cell.getRowspan(); j++) {
rowspanHeight += getRowHeight(rowIndex + j);
}
return rowspanHeight;
}
/**
* Gets the height of the rows that constitute the header as defined by
* setHeaderRows().
*
* @return the height of the rows that constitute the header and footer
*/
public float getHeaderHeight() {
float total = 0;
int size = Math.min(rows.size(), headerRows);
for (int k = 0; k < size; ++k) {
PdfPRow row = rows.get(k);
if (row != null)
total += row.getMaxHeights();
}
return total;
}
/**
* Gets the height of the rows that constitute the footer as defined by
* setFooterRows().
*
* @return the height of the rows that constitute the footer
* @since 2.1.1
*/
public float getFooterHeight() {
float total = 0;
int start = Math.max(0, headerRows - footerRows);
int size = Math.min(rows.size(), headerRows);
for (int k = start; k < size; ++k) {
PdfPRow row = rows.get(k);
if (row != null)
total += row.getMaxHeights();
}
return total;
}
/**
* Deletes a row from the table.
*
* @param rowNumber the row to be deleted
* @return true if the row was deleted
*/
public boolean deleteRow(int rowNumber) {
if (rowNumber < 0 || rowNumber >= rows.size())
return false;
if (totalWidth > 0) {
PdfPRow row = rows.get(rowNumber);
if (row != null)
totalHeight -= row.getMaxHeights();
}
rows.remove(rowNumber);
if (rowNumber < headerRows) {
--headerRows;
if (rowNumber >= (headerRows - footerRows))
--footerRows;
}
return true;
}
/**
* Deletes the last row in the table.
*
* @return true if the last row was deleted
*/
public boolean deleteLastRow() {
return deleteRow(rows.size() - 1);
}
/**
* Removes all of the rows except headers
*/
public void deleteBodyRows() {
ArrayList rows2 = new ArrayList<>();
for (int k = 0; k < headerRows; ++k)
rows2.add(rows.get(k));
rows = rows2;
totalHeight = 0;
if (totalWidth > 0)
totalHeight = getHeaderHeight();
}
/**
* Returns the number of columns.
*
* @return the number of columns.
* @since 2.1.1
*/
public int getNumberOfColumns() {
return relativeWidths.length;
}
/**
* Gets the number of the rows that constitute the header.
*
* @return the number of the rows that constitute the header
*/
public int getHeaderRows() {
return headerRows;
}
/**
* Sets the number of the top rows that constitute the header.
* This header has only meaning if the table is added to Document
* and the table crosses pages.
*
* @param headerRows the number of the top rows that constitute the header
*/
public void setHeaderRows(int headerRows) {
if (headerRows < 0)
headerRows = 0;
this.headerRows = headerRows;
}
/**
* Gets all the chunks in this element.
*
* @return an ArrayList
*/
public ArrayList getChunks() {
return new ArrayList<>();
}
/**
* Gets the type of the text element.
*
* @return a type
*/
public int type() {
return Element.PTABLE;
}
/**
* @see com.lowagie.text.Element#isContent()
* @since iText 2.0.8
*/
public boolean isContent() {
return true;
}
/**
* @see com.lowagie.text.Element#isNestable()
* @since iText 2.0.8
*/
public boolean isNestable() {
return true;
}
/**
* Processes the element by adding it (or the different parts) to an
* ElementListener.
*
* @param listener an ElementListener
* @return true if the element was processed successfully
*/
public boolean process(ElementListener listener) {
try {
return listener.add(this);
}
catch(DocumentException de) {
return false;
}
}
/**
* Gets the width percentage that the table will occupy in the page.
*
* @return the width percentage that the table will occupy in the page
*/
public float getWidthPercentage() {
return widthPercentage;
}
/**
* Sets the width percentage that the table will occupy in the page.
*
* @param widthPercentage the width percentage that the table will occupy in the page
*/
public void setWidthPercentage(float widthPercentage) {
this.widthPercentage = widthPercentage;
}
/**
* Gets the horizontal alignment of the table relative to the page.
*
* @return the horizontal alignment of the table relative to the page
*/
public int getHorizontalAlignment() {
return horizontalAlignment;
}
/**
* Sets the horizontal alignment of the table relative to the page.
* It only has meaning if the width percentage is less than 100%.
*
* @param horizontalAlignment the horizontal alignment of the table
* relative to the page
*/
public void setHorizontalAlignment(int horizontalAlignment) {
this.horizontalAlignment = horizontalAlignment;
}
/**
* Gets a row with a given index
* (added by Jin-Hsia Yang).
*
* @param idx the position of the row to get
* @return the row at position idx
*/
public PdfPRow getRow(int idx) {
return rows.get(idx);
}
/**
* Gets an arraylist with all the rows in the table.
*
* @return an arraylist
*/
public ArrayList getRows() {
return rows;
}
/**
* Gets an arraylist with a selection of rows.
* @param start the first row in the selection
* @param end the first row that isn't part of the selection
* @return a selection of rows
* @since 2.1.6
*/
public ArrayList getRows(int start, int end) {
ArrayList list = new ArrayList<>();
if (start < 0 || end > size()) {
return list;
}
PdfPRow firstRow = adjustCellsInRow(start, end);
int colIndex = 0;
PdfPCell cell;
while (colIndex < getNumberOfColumns()) {
int rowIndex = start;
while (rowSpanAbove(rowIndex--, colIndex)) {
PdfPRow row = getRow(rowIndex);
if (row != null) {
PdfPCell replaceCell = row.getCells()[colIndex];
if (replaceCell != null && firstRow != null) {
firstRow.getCells()[colIndex] = new PdfPCell(replaceCell);
float extra = 0;
int stop = Math.min(rowIndex + replaceCell.getRowspan(), end);
for (int j = start + 1; j < stop; j++) {
extra += getRowHeight(j);
}
firstRow.setExtraHeight(colIndex, extra);
float diff = getRowspanHeight(rowIndex, colIndex)
- getRowHeight(start) - extra;
firstRow.getCells()[colIndex].consumeHeight(diff);
}
}
}
if(firstRow != null) {
cell = firstRow.getCells()[colIndex];
if (cell == null)
colIndex++;
else
colIndex += cell.getColspan();
}
}
list.add(firstRow);
for (int i = start + 1; i < end; i++) {
list.add(adjustCellsInRow(i, end));
}
return list;
}
/**
* Calculates the extra height needed in a row because of rowspans.
* @param start the index of the start row (the one to adjust)
* @param end the index of the end row on the page
* @since 2.1.6
* @return a PdfRow
*/
protected PdfPRow adjustCellsInRow(int start, int end) {
PdfPRow sourceRow = getRow(start);
if(sourceRow == null) return null;
PdfPRow row = new PdfPRow(sourceRow);
row.initExtraHeights();
PdfPCell cell;
PdfPCell[] cells = row.getCells();
for (int i = 0; i < cells.length; i++) {
cell = cells[i];
if (cell == null || cell.getRowspan() == 1)
continue;
int stop = Math.min(end, start + cell.getRowspan());
float extra = 0;
for (int k = start + 1; k < stop; k++) {
extra += getRowHeight(k);
}
row.setExtraHeight(i, extra);
}
return row;
}
/** Sets the table event for this table.
* @param event the table event for this table
*/
public void setTableEvent(PdfPTableEvent event) {
if (event == null)
this.tableEvent = null;
else if (this.tableEvent == null)
this.tableEvent = event;
else if (this.tableEvent instanceof PdfPTableEventForwarder)
((PdfPTableEventForwarder)this.tableEvent).addTableEvent(event);
else {
PdfPTableEventForwarder forward = new PdfPTableEventForwarder();
forward.addTableEvent(this.tableEvent);
forward.addTableEvent(event);
this.tableEvent = forward;
}
}
/**
* Gets the table event for this page.
*
* @return the table event for this page
*/
public PdfPTableEvent getTableEvent() {
return tableEvent;
}
/**
* Gets the absolute sizes of each column width.
*
* @return he absolute sizes of each column width
*/
public float[] getAbsoluteWidths() {
return absoluteWidths;
}
float [][] getEventWidths(float xPos, int firstRow, int lastRow, boolean includeHeaders) {
if (includeHeaders) {
firstRow = Math.max(firstRow, headerRows);
lastRow = Math.max(lastRow, headerRows);
}
float[][] widths = new float[(includeHeaders ? headerRows : 0) + lastRow - firstRow][];
if (isColspan) {
int n = 0;
if (includeHeaders) {
for (int k = 0; k < headerRows; ++k) {
PdfPRow row = rows.get(k);
if (row == null)
++n;
else
widths[n++] = row.getEventWidth(xPos);
}
}
for (; firstRow < lastRow; ++firstRow) {
PdfPRow row = rows.get(firstRow);
if (row == null)
++n;
else
widths[n++] = row.getEventWidth(xPos);
}
}
else {
int numCols = getNumberOfColumns();
float[] width = new float[numCols + 1];
width[0] = xPos;
for (int k = 0; k < numCols; ++k)
width[k + 1] = width[k] + absoluteWidths[k];
for (int k = 0; k < widths.length; ++k)
widths[k] = width;
}
return widths;
}
/**
* Tells you if the first header needs to be skipped
* (for instance if the header says "continued from the previous page").
*
* @return Value of property skipFirstHeader.
*/
public boolean isSkipFirstHeader() {
return skipFirstHeader;
}
/**
* Tells you if the last footer needs to be skipped
* (for instance if the footer says "continued on the next page")
*
* @return Value of property skipLastFooter.
* @since 2.1.6
*/
public boolean isSkipLastFooter() {
return skipLastFooter;
}
/**
* Skips the printing of the first header. Used when printing
* tables in succession belonging to the same printed table aspect.
*
* @param skipFirstHeader New value of property skipFirstHeader.
*/
public void setSkipFirstHeader(boolean skipFirstHeader) {
this.skipFirstHeader = skipFirstHeader;
}
/**
* Skips the printing of the last footer. Used when printing
* tables in succession belonging to the same printed table aspect.
*
* @param skipLastFooter New value of property skipLastFooter.
* @since 2.1.6
*/
public void setSkipLastFooter(boolean skipLastFooter) {
this.skipLastFooter = skipLastFooter;
}
/**
* Sets the run direction of the contents of the table.
*
* @param runDirection One of the following values:
* PdfWriter.RUN_DIRECTION_DEFAULT, PdfWriter.RUN_DIRECTION_NO_BIDI,
* PdfWriter.RUN_DIRECTION_LTR or PdfWriter.RUN_DIRECTION_RTL.
*/
public void setRunDirection(int runDirection) {
switch (runDirection) {
case PdfWriter.RUN_DIRECTION_DEFAULT:
case PdfWriter.RUN_DIRECTION_NO_BIDI:
case PdfWriter.RUN_DIRECTION_LTR:
case PdfWriter.RUN_DIRECTION_RTL:
this.runDirection = runDirection;
break;
default:
throw new RuntimeException(MessageLocalization.getComposedMessage("invalid.run.direction.1", runDirection));
}
}
/**
* Returns the run direction of the contents in the table.
*
* @return One of the following values:
* PdfWriter.RUN_DIRECTION_DEFAULT, PdfWriter.RUN_DIRECTION_NO_BIDI,
* PdfWriter.RUN_DIRECTION_LTR or PdfWriter.RUN_DIRECTION_RTL.
*/
public int getRunDirection() {
return runDirection;
}
/**
* Getter for property lockedWidth.
*
* @return Value of property lockedWidth.
*/
public boolean isLockedWidth() {
return this.lockedWidth;
}
/**
* Uses the value in setTotalWidth() in Document.add().
*
* @param lockedWidth true to use the value in setTotalWidth() in Document.add()
*/
public void setLockedWidth(boolean lockedWidth) {
this.lockedWidth = lockedWidth;
}
/**
* Gets the split value.
*
* @return true to split; false otherwise
*/
public boolean isSplitRows() {
return this.splitRows;
}
/**
* When set the rows that won't fit in the page will be split.
* Note that it takes at least twice the memory to handle a split table row
* than a normal table. true by default.
*
* @param splitRows true to split; false otherwise
*/
public void setSplitRows(boolean splitRows) {
this.splitRows = splitRows;
}
/**
* Sets the spacing before this table.
*
* @param spacing the new spacing
*/
public void setSpacingBefore(float spacing) {
this.spacingBefore = spacing;
}
/**
* Sets the spacing after this table.
*
* @param spacing the new spacing
*/
public void setSpacingAfter(float spacing) {
this.spacingAfter = spacing;
}
/**
* Gets the spacing before this table.
*
* @return the spacing
*/
public float spacingBefore() {
return spacingBefore;
}
/**
* Gets the spacing after this table.
*
* @return the spacing
*/
public float spacingAfter() {
return spacingAfter;
}
/**
* Gets the value of the last row extension.
*
* @return true if the last row will extend; false otherwise
*/
public boolean isExtendLastRow() {
return extendLastRow[0];
}
/**
* When set the last row on every page will be extended to fill
* all the remaining space to the bottom boundary.
*
* @param extendLastRows true to extend the last row; false otherwise
*/
public void setExtendLastRow(boolean extendLastRows) {
extendLastRow[0] = extendLastRows;
extendLastRow[1] = extendLastRows;
}
/**
* When set the last row on every page will be extended to fill
* all the remaining space to the bottom boundary; except maybe the
* final row.
*
* @param extendLastRows true to extend the last row on each page; false otherwise
* @param extendFinalRow false if you don't want to extend the final row of the complete table
* @since iText 5.0.0
*/
public void setExtendLastRow(boolean extendLastRows, boolean extendFinalRow) {
extendLastRow[0] = extendLastRows;
extendLastRow[1] = extendFinalRow;
}
/**
* Gets the value of the last row extension, taking into account
* if the final row is reached or not.
*
* @param newPageFollows true if a new page follows, false otherwise
* @return true if the last row will extend; false otherwise
* @since iText 5.0.0
*/
public boolean isExtendLastRow(boolean newPageFollows) {
if (newPageFollows) {
return extendLastRow[0];
}
return extendLastRow[1];
}
/**
* Gets the header status inclusion in PdfPTableEvent.
*
* @return true if the headers are included; false otherwise
*/
public boolean isHeadersInEvent() {
return headersInEvent;
}
/**
* When set the PdfPTableEvent will include the headers.
*
* @param headersInEvent true to include the headers; false otherwise
*/
public void setHeadersInEvent(boolean headersInEvent) {
this.headersInEvent = headersInEvent;
}
/**
* Gets the property splitLate.
*
* @return the property splitLate
*/
public boolean isSplitLate() {
return splitLate;
}
/**
* If true the row will only split if it's the first one in an empty page.
* It's true by default.
* It's only meaningful if setSplitRows(true).
*
* @param splitLate the property value
*/
public void setSplitLate(boolean splitLate) {
this.splitLate = splitLate;
}
/**
* If true the table will be kept on one page if it fits, by forcing a
* new page if it doesn't fit on the current page. The default is to
* split the table over multiple pages.
*
* @param keepTogether whether to try to keep the table on one page
*/
public void setKeepTogether(boolean keepTogether) {
this.keepTogether = keepTogether;
}
/**
* Getter for property keepTogether
*
* @return true if it is tried to keep the table on one page;
* false otherwise
*/
public boolean getKeepTogether() {
return keepTogether;
}
/**
* Gets the number of rows in the footer.
*
* @return the number of rows in the footer
*/
public int getFooterRows() {
return this.footerRows;
}
/**
* Sets the number of rows to be used for the footer. The number
* of footer rows are subtracted from the header rows. For
* example, for a table with two header rows and one footer row the
* code would be:
*
* table.setHeaderRows(3);
* table.setFooterRows(1);
*
* Row 0 and 1 will be the header rows and row 2 will be the footer row.
*
* @param footerRows the number of rows to be used for the footer
*/
public void setFooterRows(int footerRows) {
if (footerRows < 0)
footerRows = 0;
this.footerRows = footerRows;
}
/**
* Completes the current row with the default cell. An incomplete row will
* be dropped but calling this method will make sure that it will be
* present in the table.
*/
public void completeRow() {
while (!rowCompleted) {
addCell(defaultCell);
}
}
/**
* @since iText 2.0.8
* @see com.lowagie.text.LargeElement#flushContent()
*/
public void flushContent() {
deleteBodyRows();
setSkipFirstHeader(true);
}
/**
* @since iText 2.0.8
* @see com.lowagie.text.LargeElement#isComplete()
*/
public boolean isComplete() {
return complete;
}
/**
* @since iText 2.0.8
* @see com.lowagie.text.LargeElement#setComplete(boolean)
*/
public void setComplete(boolean complete) {
this.complete = complete;
}
}