rst.pdfbox.layout.util

Class CompatibilityHelper

java.lang.Object

rst.pdfbox.layout.util.CompatibilityHelper

public class CompatibilityHelper
extends Object

Provide compatible methods for API changes from pdfbox 1x to 2x.

Constructor Summary

Constructors

Constructor and Description
CompatibilityHelper()

Method Summary

Modifier and Type	Method and Description
static void	clip(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream)
static org.apache.pdfbox.pdmodel.PDPageContentStream	createAppendablePDPageContentStream(org.apache.pdfbox.pdmodel.PDDocument pdDocument, org.apache.pdfbox.pdmodel.PDPage page)
static BufferedImage	createImageFromPage(org.apache.pdfbox.pdmodel.PDDocument document, int pageIndex, int resolution) Renders the given page as an RGB image.
static org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink	createLink(org.apache.pdfbox.pdmodel.PDPage page, org.apache.pdfbox.pdmodel.common.PDRectangle rect, Color color, Annotations.HyperlinkAnnotation.LinkStyle linkStyle, org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination destination)
static org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink	createLink(org.apache.pdfbox.pdmodel.PDPage page, org.apache.pdfbox.pdmodel.common.PDRectangle rect, Color color, Annotations.HyperlinkAnnotation.LinkStyle linkStyle, String uri)
static void	curveTo(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream, float x1, float y1, float x2, float y2, float x3, float y3)
static void	curveTo1(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream, float x1, float y1, float x3, float y3)
static void	drawImage(BufferedImage image, org.apache.pdfbox.pdmodel.PDDocument document, org.apache.pdfbox.pdmodel.PDPageContentStream contentStream, Position upperLeft, float width, float height)
static void	fillNonZero(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream)
static String	getBulletCharacter(int level) Returns the bullet character for the given level.
static int	getPageRotation(org.apache.pdfbox.pdmodel.PDPage page)
static void	moveTextPosition(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream, float x, float y)
static void	setAnnotationColor(org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation annotation, Color color) Sets the color in the annotation.
static void	setTextTranslation(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream, float x, float y)
static void	showText(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream, String text)
static float[]	toQuadPoints(org.apache.pdfbox.pdmodel.common.PDRectangle rect) Return the quad points representation of the given rect.
static float[]	toQuadPoints(org.apache.pdfbox.pdmodel.common.PDRectangle rect, float xOffset, float yOffset) Return the quad points representation of the given rect.
static void	transform(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream, float a, float b, float c, float d, float e, float f)
static float[]	transformToPageRotation(float[] quadPoints, org.apache.pdfbox.pdmodel.PDPage page) Transform the quad points in order to match the page rotation
static org.apache.pdfbox.pdmodel.common.PDRectangle	transformToPageRotation(org.apache.pdfbox.pdmodel.common.PDRectangle rect, org.apache.pdfbox.pdmodel.PDPage page) Transform the rectangle in order to match the page rotation

Methods inherited from class java.lang.Object

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

Constructor Detail

CompatibilityHelper

public CompatibilityHelper()

Method Detail

getBulletCharacter

public static String getBulletCharacter(int level)

Returns the bullet character for the given level. Actually only two bullets are used for odd and even levels. For odd levels the bullet character is used, for even it is the double angle. You may customize this by setting the system properties pdfbox.layout.bullet.odd and/or pdfbox.layout.bullet.even.

Parameters:

level - the level to return the bullet for.

Returns:

the bullet character for the leve.

clip

public static void clip(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream)
                 throws IOException

Throws:

IOException

transform

public static void transform(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream,
                             float a,
                             float b,
                             float c,
                             float d,
                             float e,
                             float f)
                      throws IOException

Throws:

IOException

curveTo

public static void curveTo(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream,
                           float x1,
                           float y1,
                           float x2,
                           float y2,
                           float x3,
                           float y3)
                    throws IOException

Throws:

IOException

curveTo1

public static void curveTo1(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream,
                            float x1,
                            float y1,
                            float x3,
                            float y3)
                     throws IOException

Throws:

IOException

fillNonZero

public static void fillNonZero(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream)
                        throws IOException

Throws:

IOException

showText

public static void showText(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream,
                            String text)
                     throws IOException

Throws:

IOException

setTextTranslation

public static void setTextTranslation(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream,
                                      float x,
                                      float y)
                               throws IOException

Throws:

IOException

moveTextPosition

public static void moveTextPosition(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream,
                                    float x,
                                    float y)
                             throws IOException

Throws:

IOException

createAppendablePDPageContentStream

public static org.apache.pdfbox.pdmodel.PDPageContentStream createAppendablePDPageContentStream(org.apache.pdfbox.pdmodel.PDDocument pdDocument,
                                                                                                org.apache.pdfbox.pdmodel.PDPage page)
                                                                                         throws IOException

Throws:

IOException

drawImage

public static void drawImage(BufferedImage image,
                             org.apache.pdfbox.pdmodel.PDDocument document,
                             org.apache.pdfbox.pdmodel.PDPageContentStream contentStream,
                             Position upperLeft,
                             float width,
                             float height)
                      throws IOException

Throws:

IOException

getPageRotation

public static int getPageRotation(org.apache.pdfbox.pdmodel.PDPage page)

createImageFromPage

public static BufferedImage createImageFromPage(org.apache.pdfbox.pdmodel.PDDocument document,
                                                int pageIndex,
                                                int resolution)
                                         throws IOException

Renders the given page as an RGB image.

Parameters:

document - the document containing the page.

pageIndex - the index of the page to render.

resolution - the image resolution.

Returns:

the rendered image

Throws:

IOException - by pdfbox

createLink

public static org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink createLink(org.apache.pdfbox.pdmodel.PDPage page,
                                                                                           org.apache.pdfbox.pdmodel.common.PDRectangle rect,
                                                                                           Color color,
                                                                                           Annotations.HyperlinkAnnotation.LinkStyle linkStyle,
                                                                                           String uri)

createLink

public static org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink createLink(org.apache.pdfbox.pdmodel.PDPage page,
                                                                                           org.apache.pdfbox.pdmodel.common.PDRectangle rect,
                                                                                           Color color,
                                                                                           Annotations.HyperlinkAnnotation.LinkStyle linkStyle,
                                                                                           org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination destination)

setAnnotationColor

public static void setAnnotationColor(org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation annotation,
                                      Color color)

Sets the color in the annotation.

Parameters:

annotation - the annotation.

color - the color to set.

toQuadPoints

public static float[] toQuadPoints(org.apache.pdfbox.pdmodel.common.PDRectangle rect)

Return the quad points representation of the given rect.

Parameters:

rect - the rectangle.

Returns:

the quad points.

toQuadPoints

public static float[] toQuadPoints(org.apache.pdfbox.pdmodel.common.PDRectangle rect,
                                   float xOffset,
                                   float yOffset)

Return the quad points representation of the given rect.

Parameters:

rect - the rectangle.

xOffset - the offset in x-direction to add.

yOffset - the offset in y-direction to add.

Returns:

the quad points.

transformToPageRotation

public static float[] transformToPageRotation(float[] quadPoints,
                                              org.apache.pdfbox.pdmodel.PDPage page)

Transform the quad points in order to match the page rotation

Parameters:

quadPoints - the quad points.

page - the page.

Returns:

the transformed quad points.

transformToPageRotation

public static org.apache.pdfbox.pdmodel.common.PDRectangle transformToPageRotation(org.apache.pdfbox.pdmodel.common.PDRectangle rect,
                                                                                   org.apache.pdfbox.pdmodel.PDPage page)

Transform the rectangle in order to match the page rotation

Parameters:

rect - the rectangle.

page - the page.

Returns:

the transformed rectangle.