closes #2 closes #3

Author: openlowcode

src/org/openlowcode/tools/pdf/PDFMultiPageTable.java

@@ -25,12 +25,28 @@
  */
 public class PDFMultiPageTable implements PDFPageBandSection {
 
-	private class CellText {
+	/**
+	 * Holds information about a single cell display
+	 * 
+	 * @author <a href="https://openlowcode.com/">Open Lowcode SAS</a>
+	 *
+	 */
+	protected class CellText {
+
+		/**
+		 * A cell with text not displayed as number
+		 * 
+		 * @param text the text content
+		 */
 		public CellText(String text) {
 			this.text = text;
 			this.displayasNumber = false;
 		}
 
+		/**
+		 * @param text            the text to display
+		 * @param displayasNumber true to display the cell as number
+		 */
 		public CellText(String text, boolean displayasNumber) {
 			this.text = text;
 			this.displayasNumber = displayasNumber;
@@ -39,20 +55,49 @@ public CellText(String text, boolean displayasNumber) {
 		private boolean displayasNumber;
 		private String text;
 
+		/**
+		 * @return true if the text should be displayed as number
+		 */
+		public boolean isDisplayasNumber() {
+			return displayasNumber;
+		}
+
+		/**
+		 * @return the text of the cell
+		 */
+		public String getText() {
+			return text;
+		}
+
 	}
 
 	@SuppressWarnings("unused")
 	private static Logger logger = Logger.getLogger(PDFPageTable.class.getName());
 	private float leftmargin;
 	private float rightmargin;
-	private boolean[] richtextcolumn;
 	private float[] columnrelativewidth;
 	private String[] headertexts;
 	private ArrayList<CellText[]> cellscontent;
-	private float[] columnwidthinmm;
+	protected float[] columnwidthinmm;
 	private int columnnumber;
 	private int indexlastlineprinted;
 
+	/**
+	 * @return the number of columns in the table
+	 */
+	public int getColumnNumber() {
+		return columnnumber;
+	}
+
+	/**
+	 * @param row    index of row, starting by 0
+	 * @param column index of column, starting by 0
+	 * @return
+	 */
+	public CellText getCellContent(int row, int column) {
+		return cellscontent.get(row)[column];
+	}
+
 	/**
 	 * Creates a table of columns with similar width taking the full page width
 	 * 
@@ -120,19 +165,11 @@ private void constructorcontent(float leftmargin, float rightmargin, float[] col
 		this.columnnumber = columnrelativewidth.length;
 		this.cellscontent = new ArrayList<CellText[]>();
 		this.indexlastlineprinted = -1;
-		this.richtextcolumn = new boolean[columnrelativewidth.length];
-		for (int i = 0; i < richtextcolumn.length; i++)
-			richtextcolumn[i] = false;
-	}
 
-	public void setColumnRichText(int columnindex) {
-		if (columnindex < 0)
-			throw new RuntimeException("columnindex need to be positive");
-		if (columnindex >= this.richtextcolumn.length)
-			throw new RuntimeException("Index out of range " + columnindex + ">=" + this.richtextcolumn.length);
-		this.richtextcolumn[columnindex] = true;
 	}
 
+	
+
 	/**
 	 * @param headertexts the list of header texts (should be consistent with the
 	 *                    column number)
@@ -201,7 +238,8 @@ public void setCellContent(String cellcontent, int columnindex) {
 	}
 
 	private float getHeadersHeight(float leftinmm, float rightinmm) throws IOException {
-		if (this.columnwidthinmm==null) initColumnWidthInMm(leftinmm,rightinmm);
+		if (this.columnwidthinmm == null)
+			initColumnWidthInMm(leftinmm, rightinmm);
 		float maxheight = 0;
 		for (int i = 0; i < this.columnnumber; i++) {
 			float columnwidth = this.columnwidthinmm[i];
@@ -225,27 +263,39 @@ private void initColumnWidthInMm(float leftinmm, float rightinmm) {
 			this.columnwidthinmm[i] = (rightinmm - leftinmm - this.leftmargin - this.rightmargin)
 					* columnrelativewidth[i] / totalrelativewidth;
 		}
-		
+
 	}
 
-	protected float getLineHeight(float leftinmm, float rightinmm, int lineindex) throws IOException {
+	private float getLineHeight(float leftinmm, float rightinmm, int lineindex) throws IOException {
 		float maxheight = 0;
-		
+
 		for (int i = 0; i < this.columnnumber; i++) {
 			float columnwidth = this.columnwidthinmm[i];
 			String text = this.cellscontent.get(lineindex)[i].text;
-			float cellheight = 0;
-
-			cellheight = PDFPage
-					.calculateBoxAndMaybeWriteText(0, 0, columnwidth, text, false, null, PDFPage.TEXTTYPE_PLAIN)
-					.getHeightWithoutFinalSpacing();
-
+			float cellheight = getCellHeight(columnwidth, lineindex, i);
 			if (cellheight > maxheight)
 				maxheight = cellheight;
 		}
 		return maxheight;
 	}
 
+	/**
+	 * calculates the height of the cell. This method can be overloaded by
+	 * subclasses with specific layout (rich-text...)
+	 * 
+	 * @param columnwidth width of the table column
+	 * @param lineindex   line index starting with 0
+	 * @param columnindex column index starting with 0
+	 * @return the height of the cell
+	 * @throws IOException
+	 */
+	protected float getCellHeight(float columnwidth, int lineindex, int columnindex) throws IOException {
+		String text = this.cellscontent.get(lineindex)[columnindex].text;
+		return PDFPage.calculateBoxAndMaybeWriteText(0, 0, columnwidth, text, false, null, PDFPage.TEXTTYPE_PLAIN)
+				.getHeightWithoutFinalSpacing();
+
+	}
+
 	/**
 	 * @param currentpage
 	 * @param pagenumber
@@ -282,32 +332,50 @@ private float printHeader(PDFPage currentpage, float mmfromtopforsection, float
 	 * @return the new top for printing the next element
 	 * @throws IOException
 	 */
-	protected float printOneRow(PDFPage currentpage, int rowindex, float mmfromtopforsection, float leftinmm,
+	private float printOneRow(PDFPage currentpage, int rowindex, float mmfromtopforsection, float leftinmm,
 			float rightinmm) throws IOException {
-	
+
 		float rowheight = this.getLineHeight(leftinmm, rightinmm, rowindex);
 		float currentleft = leftinmm;
 		for (int i = 0; i < columnwidthinmm.length; i++) {
 			float currentcolumnwidth = columnwidthinmm[i];
-
 			currentpage.drawBoxWithWidthAndHeight(false, currentleft, mmfromtopforsection, currentcolumnwidth,
 					rowheight);
-			CellText currenttextcell = this.cellscontent.get(rowindex)[i];
-			if (!currenttextcell.displayasNumber) {
-				currentpage.drawTextInBox(currentleft, mmfromtopforsection, currentleft + currentcolumnwidth,
-						this.cellscontent.get(rowindex)[i].text, PDFPage.TEXTTYPE_PLAIN);
-			} else {
-				currentpage.drawFixWidthRightAlignedTextAt(currentleft + currentcolumnwidth, mmfromtopforsection, 0, 0,
-						currenttextcell.text);
-			}
-
+			printOneCell(currentpage, rowindex, i, mmfromtopforsection, currentleft, currentcolumnwidth);
 			currentleft += currentcolumnwidth;
 
 		}
 		// add spacing if last column
 		return (mmfromtopforsection + rowheight);
 	}
 
+	/**
+	 * This method prints the content of one row of a table. It can be overriden by
+	 * subclasses wishing to add their own formatting
+	 * 
+	 * @param currentpage         page to print in
+	 * @param rowindex            index of the row (starting with 0)
+	 * @param columnindex         index of the column (starting with 0)
+	 * @param mmfromtopforsection vertical position for printing as per pageband
+	 *                            mechanism
+	 * @param currentleft         left of the cell
+	 * @param currentcolumnwidth  with of the cell
+	 * @throws IOException if any exception is raised regarding printing of the
+	 *                     content
+	 */
+	protected void printOneCell(PDFPage currentpage, int rowindex, int columnindex, float mmfromtopforsection,
+			float currentleft, float currentcolumnwidth) throws IOException {
+		CellText currenttextcell = this.cellscontent.get(rowindex)[columnindex];
+		
+		if (!currenttextcell.displayasNumber) {
+			currentpage.drawTextInBox(currentleft, mmfromtopforsection, currentleft + currentcolumnwidth,
+					currenttextcell.text, PDFPage.TEXTTYPE_PLAIN);
+		} else {
+			currentpage.drawFixWidthRightAlignedTextAt(currentleft + currentcolumnwidth, mmfromtopforsection, 0, 0,
+					currenttextcell.text);
+		}
+	}
+
 	@Override
 	public void print(PDFPageBand pageband, PDFPage currentpage, float mmfromtopforsection, float leftinmm,
 			float rightinmm) throws IOException {

src/org/openlowcode/tools/pdf/PDFPage.java

@@ -1074,20 +1074,20 @@ public float getPageRight() {
 	}
 
 	/**
-	 * @param left
-	 * @param top
-	 * @param right
-	 * @param remainingheight
-	 * @param text
-	 * @param page
-	 * @param texttype
+	 * @param left				left of the printing zone in mm
+	 * @param top				top of the prining zone in mm
+	 * @param right				right of the printing zone in mm
+	 * @param remainingheight	the maximum height to print
+	 * @param text				 the full text to write
+	 * @param page				page to print in
+	 * @param texttype			text type as defined in PDFPage constant
 	 * @param                 splitparagraph: true if this is the non-first part of
 	 *                        a split paragraph. Typically, widget does not have to
 	 *                        be printed
 	 * @return
 	 * @throws IOException
 	 */
-	static BoxTextContent writeAsMuchTextAsPossible(float left, float top, float right, float remainingheight,
+	public static BoxTextContent writeAsMuchTextAsPossible(float left, float top, float right, float remainingheight,
 			String text, PDFPage page, int texttype, boolean splitparagraph) throws IOException {
 		return calculateBoxAndMaybeWriteText(left, top, right, text, true, true, remainingheight, page, texttype,
 				splitparagraph);
@@ -1100,24 +1100,25 @@ static BoxTextContent writeAsMuchTextAsPossible(float left, float top, float rig
 	 * @param remainingheight the maximum height to print
 	 * @param text            the full text to write
 	 * @param page            page to print in
+	 * @param write			  true to write the text, false just to calculate
 	 * @param texttype        text type as defined in PDFPage constant
 	 * @return the remaining text that could not be printed
 	 * @throws IOException
 	 */
-	static BoxTextContent calculateBoxAndMaybeWriteText(float left, float top, float right, String text, boolean write,
+	public static BoxTextContent calculateBoxAndMaybeWriteText(float left, float top, float right, String text, boolean write,
 			PDFPage page, int texttype) throws IOException {
 		return calculateBoxAndMaybeWriteText(left, top, right, text, write, false, 0, page, texttype, false);
 	}
 
 	/**
-	 * @param left
-	 * @param top
-	 * @param right
-	 * @param text
-	 * @param write
-	 * @param partial
-	 * @param maxheight
-	 * @param page
+	 * @param left 			left of the printing zone in mm
+	 * @param top			top of the prining zone in mm
+	 * @param right			right of the printing zone in mm
+	 * @param text			the full text to write
+	 * @param write         true to write the text, false just to calculate
+	 * @param partial       true to write only partial content within the maximum height limit specified
+	 * @param maxheight		max height to print partial content
+	 * @param page           page to print in
 	 * @param texttype       one of the constants prefixed by 'TEXTTYPE_' in the
 	 *                       class
 	 * @param splitparagraph : true if this is the non-first part of a section split
@@ -1126,7 +1127,7 @@ static BoxTextContent calculateBoxAndMaybeWriteText(float left, float top, float
 	 * @return
 	 * @throws IOException
 	 */
-	static BoxTextContent calculateBoxAndMaybeWriteText(float left, float top, float right, String text, boolean write,
+	public static BoxTextContent calculateBoxAndMaybeWriteText(float left, float top, float right, String text, boolean write,
 			boolean partial, float maxheight, PDFPage page, int texttype, boolean splitparagraph) throws IOException {
 		boolean currentsplitparagraph = splitparagraph;
 		if (write)