rst.pdfbox.layout.text.annotations

Class AnnotationDrawListener

java.lang.Object

rst.pdfbox.layout.text.annotations.AnnotationDrawListener

All Implemented Interfaces:

RenderListener, DrawListener

public class AnnotationDrawListener
extends Object
implements DrawListener, RenderListener

This listener has to be passed to all draw() methods, in order collect all annotation metadata. After all drawing is done, you have to call finalizeAnnotations() which creates all necessary annotations and sets them to the corresponding pages. This listener is used by the the rendering API, but you may also use it with the low-level text API.

Constructor Summary

Constructors

Constructor and Description
AnnotationDrawListener(DrawContext drawContext) Creates an AnnotationDrawListener with the given DrawContext.

Method Summary

Modifier and Type	Method and Description
void	afterPage(RenderContext renderContext) Called after any rendering is performed to the page.
void	afterRender()
void	beforePage(RenderContext renderContext) Called before any rendering is performed to the page.
void	drawn(Object drawnObject, Position upperLeft, float width, float height) Indicates that an object has been drawn.
void	finalizeAnnotations() Deprecated. user afterRender() instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationDrawListener

public AnnotationDrawListener(DrawContext drawContext)

Creates an AnnotationDrawListener with the given DrawContext.

Parameters:

drawContext - the context which provides the PDDocument and the PDPage currently drawn to.

Method Detail

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.

finalizeAnnotations

@Deprecated
public void finalizeAnnotations()
                                      throws IOException

Deprecated. user afterRender() instead.

Throws:

IOException - by pdfbox.

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.

afterRender

public void afterRender()
                 throws IOException

Throws:

IOException