rst.pdfbox.layout.text.annotations

Class HyperlinkAnnotationProcessor

java.lang.Object

rst.pdfbox.layout.text.annotations.HyperlinkAnnotationProcessor

All Implemented Interfaces:

AnnotationProcessor

public class HyperlinkAnnotationProcessor
extends Object
implements AnnotationProcessor

This annotation processor handles both Annotations.HyperlinkAnnotations and Annotations.AnchorAnnotations, and adds the needed hyperlink metadata to the PDF document.

Constructor Summary

Constructors

Constructor and Description
HyperlinkAnnotationProcessor()

Method Summary

Modifier and Type	Method and Description
void	afterPage(DrawContext drawContext) Called after a page is drawn.
void	afterRender(org.apache.pdfbox.pdmodel.PDDocument document) Called after all rendering has been performed.
void	annotatedObjectDrawn(Annotated drawnObject, DrawContext drawContext, Position upperLeft, float width, float height) Called if an annotated object has been drawn.
void	beforePage(DrawContext drawContext) Called before a page is drawn.
protected void	handleAnchorAnnotations(AnnotatedStyledText annotatedText, DrawContext drawContext, Position upperLeft)
protected void	handleHyperlinkAnnotations(AnnotatedStyledText annotatedText, DrawContext drawContext, Position upperLeft, float width, float height)

Methods inherited from class java.lang.Object

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

Constructor Detail

HyperlinkAnnotationProcessor

public HyperlinkAnnotationProcessor()

Method Detail

annotatedObjectDrawn

public void annotatedObjectDrawn(Annotated drawnObject,
                                 DrawContext drawContext,
                                 Position upperLeft,
                                 float width,
                                 float height)
                          throws IOException

Description copied from interface: AnnotationProcessor

Called if an annotated object has been drawn.

Specified by:

annotatedObjectDrawn in interface AnnotationProcessor

Parameters:

drawnObject - the drawn object.

drawContext - the drawing context.

upperLeft - the upper left position the object has been drawn to.

width - the width of the drawn object.

height - the height of the drawn object.

Throws:

IOException - by pdfbox.

handleAnchorAnnotations

protected void handleAnchorAnnotations(AnnotatedStyledText annotatedText,
                                       DrawContext drawContext,
                                       Position upperLeft)

handleHyperlinkAnnotations

protected void handleHyperlinkAnnotations(AnnotatedStyledText annotatedText,
                                          DrawContext drawContext,
                                          Position upperLeft,
                                          float width,
                                          float height)

beforePage

public void beforePage(DrawContext drawContext)

Description copied from interface: AnnotationProcessor

Called before a page is drawn.

Specified by:

beforePage in interface AnnotationProcessor

Parameters:

drawContext - the drawing context.

afterPage

public void afterPage(DrawContext drawContext)

Description copied from interface: AnnotationProcessor

Called after a page is drawn.

Specified by:

afterPage in interface AnnotationProcessor

Parameters:

drawContext - the drawing context.

afterRender

public void afterRender(org.apache.pdfbox.pdmodel.PDDocument document)
                 throws IOException

Description copied from interface: AnnotationProcessor

Called after all rendering has been performed.

Specified by:

afterRender in interface AnnotationProcessor

Parameters:

document - the document.

Throws:

IOException - by pdfbox.