rst.pdfbox.layout.elements.render

Class RenderContext

java.lang.Object

rst.pdfbox.layout.elements.render.RenderContext

All Implemented Interfaces:

Closeable, AutoCloseable, Renderer, DrawContext, DrawListener

public class RenderContext
extends Object
implements Renderer, Closeable, DrawContext, DrawListener

The render context is a container providing all state of the current rendering process.

Constructor Summary

Constructors

Constructor and Description
RenderContext(Document document, org.apache.pdfbox.pdmodel.PDDocument pdDocument) Creates a render context.

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	closePage() Closes the current page.
void	drawn(Object drawnObject, Position upperLeft, float width, float height) Indicates that an object has been drawn.
org.apache.pdfbox.pdmodel.PDPageContentStream	getContentStream()
org.apache.pdfbox.pdmodel.PDPage	getCurrentPage()
org.apache.pdfbox.pdmodel.PDPageContentStream	getCurrentPageContentStream()
Position	getCurrentPosition()
Document	getDocument()
float	getHeight()
Layout	getLayout()
Position	getLowerRight()
Position	getMarkedPosition()
protected Position	getMaxPositionOnPage()
org.apache.pdfbox.pdmodel.common.PDRectangle	getMediaBox() Deprecated. use getPageFormat() instead.
Orientation	getOrientation() Deprecated. use getPageFormat() instead.
org.apache.pdfbox.pdmodel.PDPage	getPage() Deprecated.
PageFormat	getPageFormat()
float	getPageHeight()
int	getPageIndex()
protected Orientation	getPageOrientation()
float	getPageWidth()
org.apache.pdfbox.pdmodel.PDDocument	getPdDocument()
float	getRemainingHeight()
Position	getUpperLeft()
float	getWidth()
boolean	isPageTilted()
void	movePositionBy(float x, float y) Moves the current position relatively by the given offset.
void	newPage() Triggers a new page.
protected boolean	render(PositionControl positionControl)
boolean	render(RenderContext renderContext, Element element, LayoutHint layoutHint) Renders an element.
protected void	resetMaxPositionOnPage() Resets the maximumn position to upper left.
void	resetPositionToLeft() Resets the position to the x of getUpperLeft() while keeping the current y.
protected void	resetPositionToLeftEndOfPage() Resets the position to the x of getUpperLeft() and the y of getMaxPositionOnPage().
void	resetPositionToUpperLeft() Resets the position to getUpperLeft().
void	setLayout(Layout layout) Sets the current Layout used for rendering.
protected void	setMarkedPosition(Position markedPosition)
void	setPageFormat(PageFormat pageFormat)
protected void	updateMaxPositionOnPage(Position upperLeft, float width, float height) Updates the maximum right resp.

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderContext

public RenderContext(Document document,
                     org.apache.pdfbox.pdmodel.PDDocument pdDocument)
              throws IOException

Creates a render context.

Parameters:

document - the document to render.

pdDocument - the underlying pdfbox document.

Throws:

IOException - by pdfbox.

Method Detail

getLayout

public Layout getLayout()

Returns:

the current Layout used for rendering.

setLayout

public void setLayout(Layout layout)

Sets the current Layout used for rendering.

Parameters:

layout - the new layout.

getOrientation

@Deprecated
public Orientation getOrientation()

Deprecated. use getPageFormat() instead.

Returns:

the orientation to use for the page. If no special page format is set, the document orientation is used.

getMediaBox

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

Deprecated. use getPageFormat() instead.

Returns:

the media box to use for the page. If no special page format is set, the document media box is used.

setPageFormat

public void setPageFormat(PageFormat pageFormat)

getPageFormat

public PageFormat getPageFormat()

getUpperLeft

public Position getUpperLeft()

Returns:

the upper left position in the document respecting the document margins.

getLowerRight

public Position getLowerRight()

Returns:

the lower right position in the document respecting the document margins.

getCurrentPosition

public Position getCurrentPosition()

Returns:

the current rendering position in pdf coord space (origin in lower left corner).

getMarkedPosition

public Position getMarkedPosition()

Returns:

the PositionControl.MARKED_POSITION.

setMarkedPosition

protected void setMarkedPosition(Position markedPosition)

movePositionBy

public void movePositionBy(float x,
                           float y)

Moves the current position relatively by the given offset.

Parameters:

x - to move horizontally.

y - to move vertically.

resetPositionToUpperLeft

public void resetPositionToUpperLeft()

Resets the position to getUpperLeft().

resetPositionToLeft

public void resetPositionToLeft()

Resets the position to the x of getUpperLeft() while keeping the current y.

resetPositionToLeftEndOfPage

protected void resetPositionToLeftEndOfPage()

Resets the position to the x of getUpperLeft() and the y of getMaxPositionOnPage().

getPageOrientation

protected Orientation getPageOrientation()

Returns:

the orientation of the current page

isPageTilted

public boolean isPageTilted()

Returns:

true if the page is rotated by 90/270 degrees.

getPageWidth

public float getPageWidth()

Returns:

the page' width, or - if rotated - the height.

getPageHeight

public float getPageHeight()

Returns:

the page' height, or - if rotated - the width.

getWidth

public float getWidth()

Returns:

the width of the page respecting the margins.

getHeight

public float getHeight()

Returns:

the height of the page respecting the margins.

getRemainingHeight

public float getRemainingHeight()

Returns:

the remaining height on the page.

getDocument

public Document getDocument()

Returns:

the document.

getPdDocument

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

Specified by:

getPdDocument in interface DrawContext

Returns:

the PDDocument.

getCurrentPage

public org.apache.pdfbox.pdmodel.PDPage getCurrentPage()

Specified by:

getCurrentPage in interface DrawContext

Returns:

the current page to draw to.

getCurrentPageContentStream

public org.apache.pdfbox.pdmodel.PDPageContentStream getCurrentPageContentStream()

Specified by:

getCurrentPageContentStream in interface DrawContext

Returns:

the current page content stream.

getPage

@Deprecated
public org.apache.pdfbox.pdmodel.PDPage getPage()

Deprecated.

Returns:

the current PDPage.

getContentStream

public org.apache.pdfbox.pdmodel.PDPageContentStream getContentStream()

Returns:

the current PDPageContentStream.

getPageIndex

public int getPageIndex()

Returns:

the current page index (starting from 0).

render

public boolean render(RenderContext renderContext,
                      Element element,
                      LayoutHint layoutHint)
               throws IOException

Description copied from interface: Renderer

Renders an element.

Specified by:

render in interface Renderer

Parameters:

renderContext - the render context.

element - the element to draw.

layoutHint - the associated layout hint

Returns:

true if the layout is able to render the element.

Throws:

IOException - by pdfbox

render

protected boolean render(PositionControl positionControl)

newPage

public void newPage()
             throws IOException

Triggers a new page.

Throws:

IOException - by pdfbox

closePage

public boolean closePage()
                  throws IOException

Closes the current page.

Returns:

true if the current page has not been closed before.

Throws:

IOException - by pdfbox

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

drawn

public void drawn(Object drawnObject,
                  Position upperLeft,
                  float width,
                  float height)

Description copied from interface: DrawListener

Indicates that an object has been drawn.

Specified by:

drawn in interface DrawListener

Parameters:

drawnObject - the drawn object.

upperLeft - the upper left position.

width - the width of the drawn object.

height - the height of the drawn object.

updateMaxPositionOnPage

protected void updateMaxPositionOnPage(Position upperLeft,
                                       float width,
                                       float height)

Updates the maximum right resp. bottom position on the page.

Parameters:

upperLeft -

width -

height -

resetMaxPositionOnPage

protected void resetMaxPositionOnPage()

Resets the maximumn position to upper left.

getMaxPositionOnPage

protected Position getMaxPositionOnPage()

Returns:

the maximum right and bottom position of all objects rendered on this page so far.