A B C D E G H I K M O P R S T W

A

adjustStartYForPaging(startY, endY) - Method in class com.github.timrs2998.pdfbuilder.Document

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

Alignment - Enum in com.github.timrs2998.pdfbuilder.style

Alignment() - Constructor for enum com.github.timrs2998.pdfbuilder.style.Alignment

B

Border - Class in com.github.timrs2998.pdfbuilder.style

Border(top, right, bottom, left, topColor, rightColor, bottomColor, leftColor) - Constructor for class com.github.timrs2998.pdfbuilder.style.Border

Border() - Constructor for class com.github.timrs2998.pdfbuilder.style.Border

Border(top, right, bottom, left, color) - Constructor for class com.github.timrs2998.pdfbuilder.style.Border

Border(width, color) - Constructor for class com.github.timrs2998.pdfbuilder.style.Border

Border.Companion - Class in com.github.timrs2998.pdfbuilder.style

C

com.github.timrs2998.pdfbuilder - package com.github.timrs2998.pdfbuilder

com.github.timrs2998.pdfbuilder.examples - package com.github.timrs2998.pdfbuilder.examples

com.github.timrs2998.pdfbuilder.style - package com.github.timrs2998.pdfbuilder.style

Companion - Static variable in class com.github.timrs2998.pdfbuilder.Element

Companion - Static variable in class com.github.timrs2998.pdfbuilder.style.Border

Companion - Static variable in class com.github.timrs2998.pdfbuilder.style.Margin

Companion - Static variable in class com.github.timrs2998.pdfbuilder.style.Padding

component1() - Method in class com.github.timrs2998.pdfbuilder.style.Border

component1() - Method in class com.github.timrs2998.pdfbuilder.style.Margin

component1() - Method in class com.github.timrs2998.pdfbuilder.style.Padding

component2() - Method in class com.github.timrs2998.pdfbuilder.style.Border

component2() - Method in class com.github.timrs2998.pdfbuilder.style.Margin

component2() - Method in class com.github.timrs2998.pdfbuilder.style.Padding

component3() - Method in class com.github.timrs2998.pdfbuilder.style.Border

component3() - Method in class com.github.timrs2998.pdfbuilder.style.Margin

component3() - Method in class com.github.timrs2998.pdfbuilder.style.Padding

component4() - Method in class com.github.timrs2998.pdfbuilder.style.Border

component4() - Method in class com.github.timrs2998.pdfbuilder.style.Margin

component4() - Method in class com.github.timrs2998.pdfbuilder.style.Padding

component5() - Method in class com.github.timrs2998.pdfbuilder.style.Border

component6() - Method in class com.github.timrs2998.pdfbuilder.style.Border

component7() - Method in class com.github.timrs2998.pdfbuilder.style.Border

component8() - Method in class com.github.timrs2998.pdfbuilder.style.Border

copy(top, right, bottom, left, topColor, rightColor, bottomColor, leftColor) - Method in class com.github.timrs2998.pdfbuilder.style.Border

copy(top, right, bottom, left) - Method in class com.github.timrs2998.pdfbuilder.style.Margin

copy(top, right, bottom, left) - Method in class com.github.timrs2998.pdfbuilder.style.Padding

D

Document - Class in com.github.timrs2998.pdfbuilder

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

Document() - Constructor for class com.github.timrs2998.pdfbuilder.Document

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

document(init) - Static method in class com.github.timrs2998.pdfbuilder.KotlinBuilderKt

Creates the outermost Documentclass Element representing the pdf, and returns the rendered PDDocument that can be saved to a java.io.File or java.io.OutputStream.

DocumentMarker - Interface in com.github.timrs2998.pdfbuilder

A DSL for Kotlin, Groovy or Java 8 consumers of this API.

drawBorder(document, pdDocument, startX, endX, startY, endY) - Method in class com.github.timrs2998.pdfbuilder.style.Border

Given a box defined by the opposite corners (startX, startY) and (endX, endY), draws the surrounding border.

drawBox(document, pdDocument, startX, endX, startY, endY, color) - Static method in class com.github.timrs2998.pdfbuilder.RenderUtilKt

Draws the box whose opposite corners are (startX, startY) and (endX, endY). The box must not cross page boundaries.

drawLine(document, pdDocument, startX, startY, endX, endY, width, color) - Static method in class com.github.timrs2998.pdfbuilder.RenderUtilKt

Draws a line from (startX, startY) to (endX, endY) with given color and width. The line must not cross page boundaries.

E

Element - Class in com.github.timrs2998.pdfbuilder

Everything belonging to a class Document extends from class Element, including class Document itself. An class Element knows its Element.height and how to Element.render itself.

Element(parent) - Constructor for class com.github.timrs2998.pdfbuilder.Element

Everything belonging to a class Document extends from class Element, including class Document itself. An class Element knows its Element.height and how to Element.render itself.

Element.Companion - Class in com.github.timrs2998.pdfbuilder

equals(p) - Method in class com.github.timrs2998.pdfbuilder.style.Border

equals(p) - Method in class com.github.timrs2998.pdfbuilder.style.Margin

equals(p) - Method in class com.github.timrs2998.pdfbuilder.style.Padding

G

getBackgroundColor() - Method in class com.github.timrs2998.pdfbuilder.Element

getBorder() - Method in class com.github.timrs2998.pdfbuilder.Element

getBottom() - Method in class com.github.timrs2998.pdfbuilder.style.Border

getBottom() - Method in class com.github.timrs2998.pdfbuilder.style.Margin

getBottom() - Method in class com.github.timrs2998.pdfbuilder.style.Padding

getBottomColor() - Method in class com.github.timrs2998.pdfbuilder.style.Border

getChildren() - Method in class com.github.timrs2998.pdfbuilder.Document

getColumns() - Method in class com.github.timrs2998.pdfbuilder.RowElement

getDocument() - Method in class com.github.timrs2998.pdfbuilder.Element

getFontColor() - Method in class com.github.timrs2998.pdfbuilder.Element

getFontSize() - Method in class com.github.timrs2998.pdfbuilder.Element

getFooterFactory() - Method in class com.github.timrs2998.pdfbuilder.Document

getHALF() - Method in class com.github.timrs2998.pdfbuilder.style.Border.Companion

getHALF() - Static method in class com.github.timrs2998.pdfbuilder.style.Border

getHeader() - Method in class com.github.timrs2998.pdfbuilder.TableElement

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

getHorizontalAlignment() - Method in class com.github.timrs2998.pdfbuilder.Element

getImgHeight() - Method in class com.github.timrs2998.pdfbuilder.ImageElement

getImgWidth() - Method in class com.github.timrs2998.pdfbuilder.ImageElement

getLeft() - Method in class com.github.timrs2998.pdfbuilder.style.Border

getLeft() - Method in class com.github.timrs2998.pdfbuilder.style.Margin

getLeft() - Method in class com.github.timrs2998.pdfbuilder.style.Padding

getLeftColor() - Method in class com.github.timrs2998.pdfbuilder.style.Border

getMargin() - Method in class com.github.timrs2998.pdfbuilder.Element

getMinHeight() - Method in class com.github.timrs2998.pdfbuilder.RowElement

getONE() - Method in class com.github.timrs2998.pdfbuilder.style.Border.Companion

getONE() - Static method in class com.github.timrs2998.pdfbuilder.style.Border

getOrientation() - Method in class com.github.timrs2998.pdfbuilder.Document

getPadding() - Method in class com.github.timrs2998.pdfbuilder.Element

getPage(document, pdDocument, endY) - Static method in class com.github.timrs2998.pdfbuilder.RenderUtilKt

Safely gets (or creates) the page containing endY

getPageHeight() - Method in class com.github.timrs2998.pdfbuilder.Document

getPageIndex(pageHeight, y) - Static method in class com.github.timrs2998.pdfbuilder.RenderUtilKt

getPageWidth() - Method in class com.github.timrs2998.pdfbuilder.Document

getParent() - Method in class com.github.timrs2998.pdfbuilder.Element

getParent() - Method in class com.github.timrs2998.pdfbuilder.RowElement

getParent() - Method in class com.github.timrs2998.pdfbuilder.TableElement

getPdFont() - Method in class com.github.timrs2998.pdfbuilder.Element

getPdRectangle() - Method in class com.github.timrs2998.pdfbuilder.Document

getRight() - Method in class com.github.timrs2998.pdfbuilder.style.Border

getRight() - Method in class com.github.timrs2998.pdfbuilder.style.Margin

getRight() - Method in class com.github.timrs2998.pdfbuilder.style.Padding

getRightColor() - Method in class com.github.timrs2998.pdfbuilder.style.Border

getRows() - Method in class com.github.timrs2998.pdfbuilder.TableElement

getTop() - Method in class com.github.timrs2998.pdfbuilder.style.Border

getTop() - Method in class com.github.timrs2998.pdfbuilder.style.Margin

getTop() - Method in class com.github.timrs2998.pdfbuilder.style.Padding

getTopColor() - Method in class com.github.timrs2998.pdfbuilder.style.Border

getValue() - Method in class com.github.timrs2998.pdfbuilder.TextElement

getWeights() - Method in class com.github.timrs2998.pdfbuilder.RowElement

getZERO() - Method in class com.github.timrs2998.pdfbuilder.style.Border.Companion

getZERO() - Static method in class com.github.timrs2998.pdfbuilder.style.Border

getZERO() - Method in class com.github.timrs2998.pdfbuilder.style.Margin.Companion

getZERO() - Static method in class com.github.timrs2998.pdfbuilder.style.Margin

getZERO() - Method in class com.github.timrs2998.pdfbuilder.style.Padding.Companion

getZERO() - Static method in class com.github.timrs2998.pdfbuilder.style.Padding

H

hashCode() - Method in class com.github.timrs2998.pdfbuilder.style.Border

hashCode() - Method in class com.github.timrs2998.pdfbuilder.style.Margin

hashCode() - Method in class com.github.timrs2998.pdfbuilder.style.Padding

header($receiver, init) - Static method in class com.github.timrs2998.pdfbuilder.KotlinBuilderKt

height(width, startY, minHeight) - Method in class com.github.timrs2998.pdfbuilder.Element

Determines the height considered by this element, including margins and padding.

I

image($receiver, imagePath) - Static method in class com.github.timrs2998.pdfbuilder.KotlinBuilderKt

image($receiver, imagePath, init) - Static method in class com.github.timrs2998.pdfbuilder.KotlinBuilderKt

image($receiver, bufferedImage) - Static method in class com.github.timrs2998.pdfbuilder.KotlinBuilderKt

image($receiver, bufferedImage, init) - Static method in class com.github.timrs2998.pdfbuilder.KotlinBuilderKt

ImageElement - Class in com.github.timrs2998.pdfbuilder

ImageElement(parent, imagePath, bufferedImage) - Constructor for class com.github.timrs2998.pdfbuilder.ImageElement

ImperativeExample - Class in com.github.timrs2998.pdfbuilder.examples

Class containing main method demonstrate creation of a sample "output.pdf" in an imperative, Java style.

INSTANCE - Static variable in class com.github.timrs2998.pdfbuilder.examples.ImperativeExample

Class containing main method demonstrate creation of a sample "output.pdf" in an imperative, Java style.

INSTANCE - Static variable in class com.github.timrs2998.pdfbuilder.examples.KotlinDslExample

Class containing main method to demonstrate creation of a sample "output.pdf" using a Kotlin-specific DSL. This approach is more declarative, but is less portable between languages.

instanceHeight(width, startY) - Method in class com.github.timrs2998.pdfbuilder.Document

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

instanceHeight(width, startY) - Method in class com.github.timrs2998.pdfbuilder.Element

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

instanceHeight(width, startY) - Method in class com.github.timrs2998.pdfbuilder.ImageElement

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

instanceHeight(width, startY) - Method in class com.github.timrs2998.pdfbuilder.RowElement

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

instanceHeight(width, startY) - Method in class com.github.timrs2998.pdfbuilder.TableElement

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

instanceHeight(width, startY) - Method in class com.github.timrs2998.pdfbuilder.TextElement

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

K

KotlinBuilderKt - Class in com.github.timrs2998.pdfbuilder

KotlinDslExample - Class in com.github.timrs2998.pdfbuilder.examples

Class containing main method to demonstrate creation of a sample "output.pdf" using a Kotlin-specific DSL. This approach is more declarative, but is less portable between languages.

M

main(args) - Static method in class com.github.timrs2998.pdfbuilder.examples.ImperativeExample

main(args) - Static method in class com.github.timrs2998.pdfbuilder.examples.KotlinDslExample

Margin - Class in com.github.timrs2998.pdfbuilder.style

Margin(top, right, bottom, left) - Constructor for class com.github.timrs2998.pdfbuilder.style.Margin

Margin() - Constructor for class com.github.timrs2998.pdfbuilder.style.Margin

Margin.Companion - Class in com.github.timrs2998.pdfbuilder.style

O

Orientation - Enum in com.github.timrs2998.pdfbuilder.style

Orientation() - Constructor for enum com.github.timrs2998.pdfbuilder.style.Orientation

P

Padding - Class in com.github.timrs2998.pdfbuilder.style

Padding(top, right, bottom, left) - Constructor for class com.github.timrs2998.pdfbuilder.style.Padding

Padding() - Constructor for class com.github.timrs2998.pdfbuilder.style.Padding

Padding.Companion - Class in com.github.timrs2998.pdfbuilder.style

R

render() - Method in class com.github.timrs2998.pdfbuilder.Document

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

render(pdDocument, startX, endX, startY, minHeight) - Method in class com.github.timrs2998.pdfbuilder.Element

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.

render(pdDocument, startX, endX, startY, minHeight) - Method in class com.github.timrs2998.pdfbuilder.TableElement

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.

renderInstance(pdDocument, startX, endX, startY, minHeight) - Method in class com.github.timrs2998.pdfbuilder.Document

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

renderInstance(pdDocument, startX, endX, startY, minHeight) - Method in class com.github.timrs2998.pdfbuilder.Element

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

renderInstance(pdDocument, startX, endX, startY, minHeight) - Method in class com.github.timrs2998.pdfbuilder.ImageElement

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

renderInstance(pdDocument, startX, endX, startY, minHeight) - Method in class com.github.timrs2998.pdfbuilder.RowElement

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

renderInstance(pdDocument, startX, endX, startY, minHeight) - Method in class com.github.timrs2998.pdfbuilder.TableElement

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

renderInstance(pdDocument, startX, endX, startY, minHeight) - Method in class com.github.timrs2998.pdfbuilder.TextElement

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

RenderUtilKt - Class in com.github.timrs2998.pdfbuilder

row($receiver, init) - Static method in class com.github.timrs2998.pdfbuilder.KotlinBuilderKt

RowElement - Class in com.github.timrs2998.pdfbuilder

RowElement(parent) - Constructor for class com.github.timrs2998.pdfbuilder.RowElement

RowMarker - Interface in com.github.timrs2998.pdfbuilder

S

setBackgroundColor(p) - Method in class com.github.timrs2998.pdfbuilder.Element

setBorder(p) - Method in class com.github.timrs2998.pdfbuilder.Element

setFontColor(p) - Method in class com.github.timrs2998.pdfbuilder.Element

setFontSize(p) - Method in class com.github.timrs2998.pdfbuilder.Element

setFooterFactory(p) - Method in class com.github.timrs2998.pdfbuilder.Document

setHeader(p) - Method in class com.github.timrs2998.pdfbuilder.TableElement

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

setHorizontalAlignment(p) - Method in class com.github.timrs2998.pdfbuilder.Element

setImgHeight(p) - Method in class com.github.timrs2998.pdfbuilder.ImageElement

setImgWidth(p) - Method in class com.github.timrs2998.pdfbuilder.ImageElement

setMargin(p) - Method in class com.github.timrs2998.pdfbuilder.Element

setMinHeight(p) - Method in class com.github.timrs2998.pdfbuilder.RowElement

setOrientation(p) - Method in class com.github.timrs2998.pdfbuilder.Document

setPadding(p) - Method in class com.github.timrs2998.pdfbuilder.Element

setPdFont(p) - Method in class com.github.timrs2998.pdfbuilder.Element

setWeights(p) - Method in class com.github.timrs2998.pdfbuilder.RowElement

T

table($receiver, init) - Static method in class com.github.timrs2998.pdfbuilder.KotlinBuilderKt

TableElement - Class in com.github.timrs2998.pdfbuilder

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.

TableElement(parent) - Constructor for class com.github.timrs2998.pdfbuilder.TableElement

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.

TableMarker - Interface in com.github.timrs2998.pdfbuilder

text($receiver, value) - Static method in class com.github.timrs2998.pdfbuilder.KotlinBuilderKt

text($receiver, value, init) - Static method in class com.github.timrs2998.pdfbuilder.KotlinBuilderKt

text($receiver, value) - Static method in class com.github.timrs2998.pdfbuilder.KotlinBuilderKt

text($receiver, value, init) - Static method in class com.github.timrs2998.pdfbuilder.KotlinBuilderKt

TextElement - Class in com.github.timrs2998.pdfbuilder

TextElement(parent, value) - Constructor for class com.github.timrs2998.pdfbuilder.TextElement

toString() - Method in class com.github.timrs2998.pdfbuilder.style.Border

toString() - Method in class com.github.timrs2998.pdfbuilder.style.Margin

toString() - Method in class com.github.timrs2998.pdfbuilder.style.Padding

transformY(document, y) - Static method in class com.github.timrs2998.pdfbuilder.RenderUtilKt

Transforms endY from pdf-builder space to Apache pdf-box space (relative to bottom of current page).

W

Wrap - Enum in com.github.timrs2998.pdfbuilder.style

Wrap() - Constructor for enum com.github.timrs2998.pdfbuilder.style.Wrap

wrapText(width) - Method in class com.github.timrs2998.pdfbuilder.TextElement

A B C D E G H I K M O P R S T W