Class Table

java.lang.Object
com.aowagie.text.Rectangle
com.aowagie.text.Table
All Implemented Interfaces:
Element, LargeElement
public class Table extends Rectangle implements LargeElement
A Table is a Rectangle that contains Cells, 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: 

// 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");
The result of this code is a table: <TABLE ALIGN="Center" BORDER="1" BORDERCOLOR="#0000ff" CELLPADDING="5" CELLSPACING="5"> <TR ALIGN="Left" VALIGN="Left"> <TH ALIGN="Left" COLSPAN="3" VALIGN="Left"> header </TH> </TR> <TR ALIGN="Left" VALIGN="Left"> <TD ALIGN="Left" BORDERCOLOR="#ff0000" ROWSPAN="2" VALIGN="Left"> example cell with colspan 1 and rowspan 2 </TD> <TD ALIGN="Left" VALIGN="Left"> 1.1 </TD> <TD ALIGN="Left" VALIGN="Left"> 2.1 </TD> </TR> <TR ALIGN="Left" VALIGN="Left"> <TD ALIGN="Left" VALIGN="Left"> 1.2 </TD> <TD ALIGN="Left" VALIGN="Left"> 2.2 </TD> </TR> <TR ALIGN="Left" VALIGN="Left"> <TD ALIGN="Left" VALIGN="Left"> cell test1 </TD> <TD ALIGN="Left" COLSPAN="2" ROWSPAN="2" VALIGN="Left"> big cell </TD> </TR> <TR ALIGN="Left" VALIGN="Left"> <TD ALIGN="Left" VALIGN="Left"> cell test2 </TD> </TR> </TABLE>
See Also:

  • Field Details

    • columns

      private int columns
      This is the number of columns in the Table.

    • rows

      private ArrayList rows
      This is the list of Rows.

    • curPosition

      private Point curPosition
      The current Position in the table.

    • defaultCell

      private Cell defaultCell
      This Empty Cell contains the DEFAULT layout of each Cell added with the method addCell(String content).

    • lastHeaderRow

      private int lastHeaderRow
      This is the number of the last row of the table headers.

    • alignment

      private int alignment
      This is the horizontal alignment.

    • cellpadding

      private float cellpadding
      This is cellpadding.

    • cellspacing

      private float cellspacing
      This is cellspacing.

    • width

      private float width
      This is the width of the table (in percent of the available space).

    • locked

      private boolean locked
      Is the width a percentage (false) or an absolute width (true)?

    • widths

      private float[] widths
      This is an array containing the widths (in percentages) of every column.

    • mTableInserted

      private boolean mTableInserted
      Boolean to track if a table was inserted (to avoid unnecessary computations afterwards)

    • autoFillEmptyCells

      private boolean autoFillEmptyCells
      Boolean to automatically fill empty cells before a table is rendered (takes CPU so may be set to false in case of certainty)

    • tableFitsPage

      private boolean tableFitsPage
      If true this table may not be split over two pages.

    • cellsFitPage

      private boolean cellsFitPage
      If true cells may not be split over two pages.

    • offset

      private float offset
      This is the offset of the table.

    • convert2pdfptable

      private boolean convert2pdfptable
      if you want to generate tables the old way, set this value to false.

    • notAddedYet

      private boolean notAddedYet
      Indicates if this is the first time the section was added.
      Since:
      iText 2.0.8

    • complete

      private boolean complete
      Indicates if the PdfPTable is complete once added to the document.
      Since:
      iText 2.0.8

  • Constructor Details

    • Table

      public Table(int columns) throws BadElementException
      Constructs a Table 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

      private Table(int columns, int rows) throws BadElementException
      Constructs a Table with a certain number of columns and a certain number of Rows.
      Parameters:
      columns - The number of columns in the table
      rows - The number of rows
      Throws:
      BadElementException - if the creator was called with less than 1 column

  • Method Details

    • process

      public boolean process(ElementListener listener)
      Processes the element by adding it (or the different parts) to an ElementListener.
      Specified by:
      process in interface Element
      Overrides:
      process in class Rectangle
      Parameters:
      listener - an ElementListener
      Returns:
      true if the element was processed successfully

    • type

      public int type()
      Gets the type of the text element.
      Specified by:
      type in interface Element
      Overrides:
      type in class Rectangle
      Returns:
      a type

    • getChunks

      public ArrayList getChunks()
      Gets all the chunks in this element.
      Specified by:
      getChunks in interface Element
      Overrides:
      getChunks in class Rectangle
      Returns:
      an ArrayList

    • isNestable

      public boolean isNestable()
      Description copied from interface: Element
      Checks if this element is nestable.
      Specified by:
      isNestable in interface Element
      Overrides:
      isNestable in class Rectangle
      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 this Table.
      Returns:
      the number of rows in this Table

    • getDimension

      public Dimension getDimension()
      Gets the dimension of this table
      Returns:
      dimension

    • getDefaultCell

      public Cell getDefaultCell()
      Gets the default layout of the Table.
      Returns:
      a cell with all the defaults
      Since:
      2.0.7

    • setDefaultCell

      public void setDefaultCell(Cell value)
      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

    • getAlignment

      public int getAlignment()
      Gets the horizontal alignment.
      Returns:
      a value

    • setAlignment

      public void setAlignment(int value)
      Sets the horizontal alignment.
      Parameters:
      value - the new value

    • setAlignment

      public void setAlignment(String alignment)
      Sets the alignment of this paragraph.
      Parameters:
      alignment - the new alignment as a String

    • 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).
      Overrides:
      getWidth in class Rectangle
      Returns:
      the table width

    • 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 this Table.
      Returns:
      the proportional widths of the columns in this Table

    • setWidths

      public void setWidths(float[] widths) throws BadElementException
      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: 

      float[] widths = {2, 1, 1};
table.setWidths(widths)
      The widths will be: a width of 50% for the first column, 25% for the second and third column.
      Parameters:
      widths - an array with values
      Throws:
      BadElementException - Exception with information about the error

    • setWidths

      public void setWidths(int[] widths) throws DocumentException
      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 - Exception with information about the error

    • isTableFitsPage

      public boolean isTableFitsPage()
      Checks if this Table 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 this Table 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

    • 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.

    • getOffset

      public float getOffset()
      Gets the offset of this table.
      Returns:
      the space between this table and the previous element.

    • 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

      private void addCell(Cell aCell, Point aLocation) throws BadElementException
      Adds a Cell to the Table at a certain location.
      Parameters:
      aCell - The Cell to add
      aLocation - The location where the Cell will be added
      Throws:
      BadElementException

    • addCell

      public void addCell(Cell cell)
      Adds a Cell to the Table.
      Parameters:
      cell - a Cell

    • addCell

      private void addCell(Phrase content, Point location) throws BadElementException
      Adds a Cell to the Table.

      This is a shortcut for addCell(Cell cell, Point location). The Phrase will be converted to a Cell.

      Parameters:
      content - a Phrase
      location - a Point
      Throws:
      BadElementException - this should never happen

    • insertTable

      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.
      Parameters:
      aTable - the table you want to insert

    • insertTable

      private 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.
      Parameters:
      aTable - the table you want to insert
      aLocation - a Point

    • addColumns

      public void addColumns(int aColumns)
      Gives you the possibility to add columns.
      Parameters:
      aColumns - the number of columns to add

    • complete

      public void complete()
      Will fill empty cells with valid blank Cells

    • getElement

      private Object getElement(int row, int column)
      returns the element at the position row, column (Cast to Cell or Table)
      Parameters:
      row -
      column -
      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

      private boolean isValidLocation(Cell aCell, Point aLocation)
      check if Cell 'fits' the table.

      • rowspan/colspan not beyond borders
      • spanned cell don't overlap existing cells
      Parameters:
      aCell - the cell that has to be checked
      aLocation - the location where the cell has to be placed
      Returns:
      true if the location was valid

    • assumeTableDefaults

      private void assumeTableDefaults(Cell aCell)
      Sets the unset cell properties to be the table defaults.
      Parameters:
      aCell - The cell to set to table defaults as necessary.

    • placeCell

      private void placeCell(ArrayList someRows, Cell aCell, Point aPosition)
      Inserts a Cell in a cell-array and reserves cells defined by row-/colspan.
      Parameters:
      someRows - some rows
      aCell - the cell that has to be inserted
      aPosition - the position where the cell has to be placed

    • setCurrentLocationToNextValidPosition

      private void setCurrentLocationToNextValidPosition(Point aLocation)
      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

      public Iterator iterator()
      Gets an Iterator of all the Rows.
      Returns:
      an Iterator

    • createPdfPTable

      public PdfPTable createPdfPTable() throws BadElementException
      Create a PdfPTable based on this Table object.
      Returns:
      a PdfPTable object
      Throws:
      BadElementException - Exception with information about the 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 - Indication that will be set
      Since:
      iText2.0.8

    • flushContent

      public void flushContent()
      Description copied from interface: LargeElement
      Flushes the content that has been added.
      Specified by:
      flushContent in interface LargeElement
      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 interface LargeElement
      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 interface LargeElement
      Parameters:
      complete - false if you'll be adding more data after adding the object to the document.
      Since:
      iText 2.0.8
      See Also:

    • getDefaultLayout

      @Deprecated public Cell getDefaultLayout()
      Deprecated.
      As of iText 2.0.7, replaced by getDefaultCell(), scheduled for removal at 2.2.0
      Gets the default layout of the Table.
      Returns:
      a cell with all the defaults

    • setDefaultLayout

      @Deprecated public void setDefaultLayout(Cell value)
      Deprecated.
      As of iText 2.0.7, replaced by setDefaultCell(Cell), scheduled for removal at 2.2.0
      Sets the default layout of the Table to the provided Cell
      Parameters:
      value - a cell with all the defaults