com.github.timrs2998.pdfbuilder

Class TableElement

Element

com.github.timrs2998.pdfbuilder.TableElement

public class TableElement
extends Element

A class TableElement is a special container class Element for class RowElement. Unlike other class Element, a class TableElement can span multiple pages and therfore handles rendering differently than other class Element.

See Also:

class TableElement, class Element, class RowElement, class Element, class TableElement, class Element

Nested Class Summary

Nested classes/interfaces inherited from class com.github.timrs2998.pdfbuilder.Element

Element.Companion

Field Summary

Fields inherited from class com.github.timrs2998.pdfbuilder.Element

Companion

Constructor Summary

Constructors

Constructor and Description
TableElement(Document parent) A class TableElement is a special container class Element for class RowElement. Unlike other class Element, a class TableElement can span multiple pages and therfore handles rendering differently than other class Element.

Method Summary

Modifier and Type	Method and Description
RowElement	getHeader() A sticky header that will be repeated on top of each page.
Document	getParent()
java.util.List<com.github.timrs2998.pdfbuilder.RowElement>	getRows()
float	instanceHeight(float width, float startY) Determines the innermost height of the element, excluding margins and padding.
void	render(org.apache.pdfbox.pdmodel.PDDocument pdDocument, float startX, float endX, float startY, float minHeight) Renders the entire element including margins, padding, borders, and background. Unless overridden, assumes the element being rendered will fit on the page. Multi-page elements (ie: class TableElement) must handle paging themselves.
void	renderInstance(org.apache.pdfbox.pdmodel.PDDocument pdDocument, float startX, float endX, float startY, float minHeight) Renders the innermost element, excluding margins, padding, borders, and background.
void	setHeader(RowElement p) A sticky header that will be repeated on top of each page.

Methods inherited from class com.github.timrs2998.pdfbuilder.Element

getBackgroundColor, getBorder, getDocument, getFontColor, getFontSize, getHorizontalAlignment, getMargin, getPadding, getParent, getPdFont, height, instanceHeight, render, renderInstance, setBackgroundColor, setBorder, setFontColor, setFontSize, setHorizontalAlignment, setMargin, setPadding, setPdFont

Constructor Detail

TableElement

public TableElement(Document parent)

A class TableElement is a special container class Element for class RowElement. Unlike other class Element, a class TableElement can span multiple pages and therfore handles rendering differently than other class Element.

See Also:

class TableElement, class Element, class RowElement, class Element, class TableElement, class Element

Method Detail

getHeader

public RowElement getHeader()

A sticky header that will be repeated on top of each page.

setHeader

public void setHeader(RowElement p)

A sticky header that will be repeated on top of each page.

getRows

public java.util.List<com.github.timrs2998.pdfbuilder.RowElement> getRows()

instanceHeight

public float instanceHeight(float width,
                            float startY)

Determines the innermost height of the element, excluding margins and padding.

render

public void render(org.apache.pdfbox.pdmodel.PDDocument pdDocument,
                   float startX,
                   float endX,
                   float startY,
                   float minHeight)

Renders the entire element including margins, padding, borders, and background. Unless overridden, assumes the element being rendered will fit on the page. Multi-page elements (ie: class TableElement) must handle paging themselves.

See Also:

class TableElement

renderInstance

public void renderInstance(org.apache.pdfbox.pdmodel.PDDocument pdDocument,
                           float startX,
                           float endX,
                           float startY,
                           float minHeight)

Renders the innermost element, excluding margins, padding, borders, and background.

getParent

public Document getParent()