com.github.timrs2998.pdfbuilder

Class Document

Element

com.github.timrs2998.pdfbuilder.Document

public class Document
extends Element

Represents a pdf document. The document is the outer container for all elements belonging to a pdf. Once rendered, it cannot be modified.

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
Document() Represents a pdf document. The document is the outer container for all elements belonging to a pdf. Once rendered, it cannot be modified.

Method Summary

Modifier and Type	Method and Description
float	adjustStartYForPaging(float startY, float endY) If startY and endY cross a page (or page margin) boundary, returns a new startY for rendering. Otherwise returns the original startY.
java.util.List<com.github.timrs2998.pdfbuilder.Element>	getChildren()
kotlin.jvm.functions.Function2<java.lang.Integer,java.lang.Integer,com.github.timrs2998.pdfbuilder.Element>	getFooterFactory()
Orientation	getOrientation()
float	getPageHeight()
float	getPageWidth()
org.apache.pdfbox.pdmodel.common.PDRectangle	getPdRectangle()
float	instanceHeight(float width, float startY) Determines the innermost height of the element, excluding margins and padding.
org.apache.pdfbox.pdmodel.PDDocument	render() Forces one-time evaluation of lazy properties and renders object model to a PDDocument. Once called, document can no longer be modified.
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	setFooterFactory(kotlin.jvm.functions.Function2<? super java.lang.Integer,? super java.lang.Integer,? extends com.github.timrs2998.pdfbuilder.Element> p)
void	setOrientation(Orientation p)

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

Document

public Document()

Represents a pdf document. The document is the outer container for all elements belonging to a pdf. Once rendered, it cannot be modified.

Method Detail

getChildren

public java.util.List<com.github.timrs2998.pdfbuilder.Element> getChildren()

getFooterFactory

public kotlin.jvm.functions.Function2<java.lang.Integer,java.lang.Integer,com.github.timrs2998.pdfbuilder.Element> getFooterFactory()

setFooterFactory

public void setFooterFactory(kotlin.jvm.functions.Function2<? super java.lang.Integer,? super java.lang.Integer,? extends com.github.timrs2998.pdfbuilder.Element> p)

getOrientation

public Orientation getOrientation()

setOrientation

public void setOrientation(Orientation p)

getPdRectangle

public org.apache.pdfbox.pdmodel.common.PDRectangle getPdRectangle()

getPageWidth

public float getPageWidth()

getPageHeight

public float getPageHeight()

instanceHeight

public float instanceHeight(float width,
                            float startY)

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

render

public org.apache.pdfbox.pdmodel.PDDocument render()

Forces one-time evaluation of lazy properties and renders object model to a PDDocument. Once called, document can no longer be modified.

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.

adjustStartYForPaging

public float adjustStartYForPaging(float startY,
                                   float endY)

If startY and endY cross a page (or page margin) boundary, returns a new startY for rendering. Otherwise returns the original startY.

TODO: also consider padding