rst.pdfbox.layout.elements

Class Document

java.lang.Object

rst.pdfbox.layout.elements.Document

All Implemented Interfaces:

RenderListener

public class Document
extends Object
implements RenderListener

The central class for creating a document.

Field Summary

Fields

Modifier and Type	Field and Description
static PageFormat	DEFAULT_PAGE_FORMAT A4 portrait without margins.

Constructor Summary

Constructors

Constructor and Description
Document() Creates a Document using the DEFAULT_PAGE_FORMAT.
Document(float marginLeft, float marginRight, float marginTop, float marginBottom) Creates a Document in A4 with orientation portrait and the given margins.
Document(PageFormat pageFormat) Creates a Document based on the given page format.
Document(org.apache.pdfbox.pdmodel.common.PDRectangle mediaBox) Deprecated. use Document(PageFormat) instead.
Document(org.apache.pdfbox.pdmodel.common.PDRectangle mediaBox, float marginLeft, float marginRight, float marginTop, float marginBottom) Deprecated. use Document(PageFormat) instead.

Method Summary

Modifier and Type	Method and Description
void	add(Element element) Adds an element to the document using a VerticalLayoutHint.
void	add(Element element, LayoutHint layoutHint) Adds an element with the given layout hint.
void	addRenderer(Renderer renderer) Adds a (custom) Renderer that may handle the rendering of an element.
void	addRenderListener(RenderListener listener) Adds a RenderListener that will be notified during rendering.
void	afterPage(RenderContext renderContext) Called after any rendering is performed to the page.
void	beforePage(RenderContext renderContext) Called before any rendering is performed to the page.
float	getMarginBottom() Deprecated. use getPageFormat() instead.
float	getMarginLeft() Deprecated. use getPageFormat() instead.
float	getMarginRight() Deprecated. use getPageFormat() instead.
float	getMarginTop() Deprecated. use getPageFormat() instead.
org.apache.pdfbox.pdmodel.common.PDRectangle	getMediaBox() Deprecated. use getPageFormat() instead.
Orientation	getOrientation() Deprecated. use getPageFormat() instead.
PageFormat	getPageFormat()
float	getPageHeight()
float	getPageWidth()
org.apache.pdfbox.pdmodel.PDDocument	getPDDocument() Returns the PDDocument to be created by method render().
void	remove(Element element) Removes the given element.
void	removeRenderer(Renderer renderer) Removes a Renderer .
void	removeRenderListener(RenderListener listener) Removes a RenderListener .
org.apache.pdfbox.pdmodel.PDDocument	render() Renders all elements and returns the resulting PDDocument.
protected void	resetPDDocument() Called after render() in order to release the current document.
void	save(File file) Renders the document and saves it to the given file.
void	save(OutputStream output) Renders the document and saves it to the given output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_PAGE_FORMAT

public static final PageFormat DEFAULT_PAGE_FORMAT

A4 portrait without margins.

Constructor Detail

Document

public Document()

Creates a Document using the DEFAULT_PAGE_FORMAT.

Document

public Document(float marginLeft,
                float marginRight,
                float marginTop,
                float marginBottom)

Creates a Document in A4 with orientation portrait and the given margins. By default, a VerticalLayout is used.

Parameters:

marginLeft - the left margin

marginRight - the right margin

marginTop - the top margin

marginBottom - the bottom margin

Document

@Deprecated
public Document(org.apache.pdfbox.pdmodel.common.PDRectangle mediaBox)

Deprecated. use Document(PageFormat) instead.

Creates a Document based on the given media box. By default, a VerticalLayout is used.

Parameters:

mediaBox - the media box to use.

Document

@Deprecated
public Document(org.apache.pdfbox.pdmodel.common.PDRectangle mediaBox,
                             float marginLeft,
                             float marginRight,
                             float marginTop,
                             float marginBottom)

Deprecated. use Document(PageFormat) instead.

Creates a Document based on the given media box and margins. By default, a VerticalLayout is used.

Parameters:

mediaBox - the media box to use.

marginLeft - the left margin

marginRight - the right margin

marginTop - the top margin

marginBottom - the bottom margin

Document

public Document(PageFormat pageFormat)

Creates a Document based on the given page format. By default, a VerticalLayout is used.

Parameters:

pageFormat - the page format box to use.

Method Detail

add

public void add(Element element)

Adds an element to the document using a VerticalLayoutHint.

Parameters:

element - the element to add

add

public void add(Element element,
                LayoutHint layoutHint)

Adds an element with the given layout hint.

Parameters:

element - the element to add

layoutHint - the hint for the Layout.

remove

public void remove(Element element)

Removes the given element.

Parameters:

element - the element to remove.

getPageFormat

public PageFormat getPageFormat()

Returns:

the page format to use as default.

getMarginLeft

@Deprecated
public float getMarginLeft()

Deprecated. use getPageFormat() instead.

Returns:

the left document margin.

getMarginRight

@Deprecated
public float getMarginRight()

Deprecated. use getPageFormat() instead.

Returns:

the right document margin.

getMarginTop

@Deprecated
public float getMarginTop()

Deprecated. use getPageFormat() instead.

Returns:

the top document margin.

getMarginBottom

@Deprecated
public float getMarginBottom()

Deprecated. use getPageFormat() instead.

Returns:

the bottom document margin.

getMediaBox

@Deprecated
public org.apache.pdfbox.pdmodel.common.PDRectangle getMediaBox()

Deprecated. use getPageFormat() instead.

Returns:

the media box to use.

getOrientation

@Deprecated
public Orientation getOrientation()

Deprecated. use getPageFormat() instead.

Returns:

the orientation to use.

getPageWidth

public float getPageWidth()

Returns:

the media box width minus margins.

getPageHeight

public float getPageHeight()

Returns:

the media box height minus margins.

getPDDocument

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

Returns the PDDocument to be created by method render(). Beware that this PDDocument is released after rendering. This means each rendering process creates a new PDDocument.

Returns:

the PDDocument to be used on the next call to render().

resetPDDocument

protected void resetPDDocument()

Called after render() in order to release the current document.

addRenderer

public void addRenderer(Renderer renderer)

Adds a (custom) Renderer that may handle the rendering of an element. All renderers will be asked to render the current element in the order they have been added. If no renderer is capable, the default renderer will be asked.

Parameters:

renderer - the renderer to add.

removeRenderer

public void removeRenderer(Renderer renderer)

Removes a Renderer .

Parameters:

renderer - the renderer to remove.

render

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

Renders all elements and returns the resulting PDDocument.

Returns:

the resulting PDDocument

Throws:

IOException - by pdfbox

save

public void save(File file)
          throws IOException

Renders the document and saves it to the given file.

Parameters:

file - the file to save to.

Throws:

IOException - by pdfbox

save

public void save(OutputStream output)
          throws IOException

Renders the document and saves it to the given output stream.

Parameters:

output - the stream to save to.

Throws:

IOException - by pdfbox

addRenderListener

public void addRenderListener(RenderListener listener)

Adds a RenderListener that will be notified during rendering.

Parameters:

listener - the listener to add.

removeRenderListener

public void removeRenderListener(RenderListener listener)

Removes a RenderListener .

Parameters:

listener - the listener to remove.

beforePage

public void beforePage(RenderContext renderContext)
                throws IOException

Description copied from interface: RenderListener

Called before any rendering is performed to the page.

Specified by:

beforePage in interface RenderListener

Parameters:

renderContext - the context providing all rendering state.

Throws:

IOException - by pdfbox.

afterPage

public void afterPage(RenderContext renderContext)
               throws IOException

Description copied from interface: RenderListener

Called after any rendering is performed to the page.

Specified by:

afterPage in interface RenderListener

Parameters:

renderContext - the context providing all rendering state.

Throws:

IOException - by pdfbox.