org.openlowcode.tools.pdf

Class PDFPage

java.lang.Object

org.openlowcode.tools.pdf.PDFPart

org.openlowcode.tools.pdf.PDFPage

Direct Known Subclasses:

PDFPageWithRichText

public class PDFPage
extends PDFPart

A framework to generate pdfpages. This uses Apache PDFBOX. All dimensions are in mm.

Author:

Open Lowcode SAS

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PDFPage.BoxTextContent This class stores the way a text was calculated or printed inside a box.
static class	PDFPage.FontAndSize An utility class allowing to store font and font size in a same object

Field Summary

Fields

Modifier and Type	Field and Description
static float	A4_LONGSIDE_IN_MM
static float	A4_SHORTSIDE_IN_MM
static int	TEXTTYPE_BULLET_L1
static int	TEXTTYPE_BULLET_L2
static int	TEXTTYPE_BULLET_L3
static int	TEXTTYPE_LABEL
static int	TEXTTYPE_PARAGRAPH_HEADER
static int	TEXTTYPE_PLAIN
static int	TEXTTYPE_PLAIN_BOLD
static int	TEXTTYPE_PLAIN_BOLD_ITALIC
static int	TEXTTYPE_PLAIN_ITALIC
static int	TEXTTYPE_SECTION_HEADER
static int	TEXTTYPE_TITLE

Constructor Summary

Constructors

Constructor and Description
PDFPage(boolean portrait, float leftrightmargin, float topbottommargin) generates an A4 page with margin size indicated in mm, with topatzero = true
PDFPage(boolean portrait, float leftrightmargin, float topbottommargin, boolean topatzero) Generates an A4 format page with dimensions indicated in mm
PDFPage(float customwidth, float customheight, float leftrightmargin, float topbottommargin, boolean topatzero)

Method Summary

Modifier and Type	Method and Description
void	addHeader(PDFPageBandHeaders header)
static PDFPage.BoxTextContent	calculateBoxAndMaybeWriteText(float left, float top, float right, java.lang.String text, boolean write, boolean partial, float maxheight, PDFPage page, int texttype, boolean splitparagraph)
static PDFPage.BoxTextContent	calculateBoxAndMaybeWriteText(float left, float top, float right, java.lang.String text, boolean write, boolean partial, float maxheight, PDFPage page, int texttype, boolean splitparagraph, boolean compactprint)
static PDFPage.BoxTextContent	calculateBoxAndMaybeWriteText(float left, float top, float right, java.lang.String text, boolean write, boolean partial, float maxheight, PDFPage page, int texttype, boolean splitparagraph, boolean compactprint, java.awt.Color color, float startfirstlineoffset, int startatline, int startatparagraph)
static PDFPage.BoxTextContent	calculateBoxAndMaybeWriteText(float left, float top, float right, java.lang.String text, boolean write, PDFPage page, int texttype)
PDFPage.BoxTextContent	calculateTextSize(float left, float right, java.lang.String text)
void	closepage() this needs to be called at the end the work on the page.
void	drawBox(boolean fatline, float left, float top, float right, float bottom) Draws a rectangular box
void	drawBox(boolean fatline, float left, float top, float right, float bottom, java.awt.Color color)
void	drawBox(boolean fatline, float left, float top, float right, float bottom, java.awt.Color color, boolean drawtop, boolean drawbottom, boolean drawleft, boolean drawright)
float	drawBoxWithLineNumber(boolean fatline, float left, float top, float right, int numberoflines)
float	drawBoxWithLineNumber(boolean fatline, float left, float top, float right, int numberoflines, int numberofparagraphs)
void	drawBoxWithWidthAndHeight(boolean fatline, float left, float top, float width, float height)
void	drawBoxWithWidthAndHeight(boolean fatline, float left, float top, float width, float height, boolean drawtop, boolean drawbottom, boolean drawleft, boolean drawright)
void	drawCalculatedText(boolean label, float xcoordinates, float top, int linenumber, int paragraphnumber, boolean alignleft, TextAfterLayout calculatedtext)
void	drawCalculatedText(float xcoordinates, float top, int linenumber, int paragraphnumber, boolean alignleft, TextAfterLayout calculatedtext)
void	drawCenteredTextAt(boolean title, float top, int paragraphnumber, java.lang.String text)
void	drawCircle(java.awt.Color bordercolor, java.awt.Color fillcolor, float centerx, float centery, float radius)
void	drawFixWidthRightAlignedTextAt(float rightForColumn, float topofline, int lineindex, int paragraphindex, java.lang.String text) This method will write with current HELVETICA font a fix width per character text (typically number) padded on the right considering usual margins.
void	drawFreeFontTextAt(float left, float top, java.awt.Color color, boolean bold, boolean italic, boolean serif, float fontinpoint, java.lang.String text)
void	drawImageAt(float left, float top, byte[] filecontent, java.lang.String filename, float targetwidth)
void	drawImageAt(float left, float top, java.lang.String imagepath, float targetwidth)
void	drawImageInsideBox(float left, float top, float right, float bottom, byte[] filecontent, java.lang.String filename) will automatically scale the image respecting aspect ratio to fit inside the box.
float	drawLeftPaddedTextAt(int texttype, float left, float top, int linenumber, int paragraphnumber, java.lang.String text)
float	drawLeftPaddedTextAt(int texttype, float left, float top, int linenumber, int paragraphnumber, java.lang.String text, boolean compactprint)
float	drawLeftPaddedTextAt(int texttype, float left, float top, int linenumber, int paragraphnumber, java.lang.String text, boolean compactprint, java.awt.Color color)
void	drawLine(boolean fatline, float startx, float starty, float endx, float endy, java.awt.Color color)
void	drawParagraphHeaderAt(float left, float top, int linenumber, int paragraphnumber, java.lang.String text)
void	drawSimpleTextAt(boolean label, float left, float top, int linenumber, int paragraphnumber, java.lang.String text) Draws a single text from the point of origin (adding necessary margins).
void	drawSimpleTextAt(boolean label, float left, float top, int linenumber, int paragraphnumber, java.lang.String text, boolean horizontalparagraphmargin) Draws a single text from the point of origin (adding necessary margins).
PDFPage.BoxTextContent	drawTextInBox(float left, float top, float right, java.lang.String text)
PDFPage.BoxTextContent	drawTextInBox(float left, float top, float right, java.lang.String text, int texttype)
PDFPage.BoxTextContent	drawTextInBox(float left, float top, float right, java.lang.String text, int texttype, int maxline)
void	drawTextWidget(int texttype, float left, float top, float newleft, int linenumber, int paragraphnumber, boolean newparagraph, boolean compactprint, java.awt.Color color)
PDFPage.BoxTextContent	drawTextWithLabelInBox(float left, float top, float right, java.lang.String label, java.lang.String text, int maxline) This method writes on the left a label (with label type of text), and the text content on the right, making sure not to get outside of the specified box. Note: this will align on the bottom the label line with the first line
void	fillBox(java.awt.Color color, float left, float top, float right, float bottom)
float	fillBoxWithLineNumber(java.awt.Color color, float left, float top, float right, int numberoflines, int numberofparagraphs)
float	getHeight()
static int	getNumberOfLinesAvailableForParagraph(float spaceinmm)
float	getPageBottom()
int	getPageIndex() This method should only be called during the final layout.
float	getPageLeft()
protected int	getPageNumber() This method should be called at the end of the layout phase or during the printing.
float	getPageRight()
float	getPagetop()
float	getParagraphHeaderTextWidth(java.lang.String[] lines) returns the maximum length of the lines provided with paragraphheaderfont
static float	getTextSize(java.lang.String[] lines, int texttype)
static float	getTextWidth(boolean label, java.lang.String line)
static float	getTextWidth(boolean label, java.lang.String line, boolean paragraphspacing)
float	getWidth()
protected void	initialize() This method is called just before the actual printing in order to initialize widgets that depend from the content of the full document.
boolean	isTopAtZero()
static boolean	isValid(char currentchar)
protected void	layoutPages(int pagesbefore) This method is called just after initalize and before print.
protected void	print(org.apache.pdfbox.pdmodel.PDDocument document) This method actually prints the document.
static java.lang.String	remove(java.lang.String text) Removes all non win-ansi characters.
static void	securedShowText(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream, java.lang.String text)
static PDFPage.BoxTextContent	writeAsMuchTextAsPossible(float left, float top, float right, float remainingheight, java.lang.String text, PDFPage page, int texttype, boolean splitparagraph)
static PDFPage.BoxTextContent	writeAsMuchTextAsPossible(float left, float top, float right, float remainingheight, java.lang.String text, PDFPage page, int texttype, boolean splitparagraph, boolean compactprint)

Methods inherited from class org.openlowcode.tools.pdf.PDFPart

getParent, setParentPDFDocument

Methods inherited from class java.lang.Object

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

Field Detail

A4_LONGSIDE_IN_MM

public static final float A4_LONGSIDE_IN_MM

See Also:

Constant Field Values

A4_SHORTSIDE_IN_MM

public static final float A4_SHORTSIDE_IN_MM

See Also:

Constant Field Values

TEXTTYPE_PLAIN

public static final int TEXTTYPE_PLAIN

See Also:

Constant Field Values

TEXTTYPE_LABEL

public static final int TEXTTYPE_LABEL

See Also:

Constant Field Values

TEXTTYPE_SECTION_HEADER

public static final int TEXTTYPE_SECTION_HEADER

See Also:

Constant Field Values

TEXTTYPE_TITLE

public static final int TEXTTYPE_TITLE

See Also:

Constant Field Values

TEXTTYPE_BULLET_L1

public static final int TEXTTYPE_BULLET_L1

See Also:

Constant Field Values

TEXTTYPE_BULLET_L2

public static final int TEXTTYPE_BULLET_L2

See Also:

Constant Field Values

TEXTTYPE_BULLET_L3

public static final int TEXTTYPE_BULLET_L3

See Also:

Constant Field Values

TEXTTYPE_PARAGRAPH_HEADER

public static final int TEXTTYPE_PARAGRAPH_HEADER

See Also:

Constant Field Values

TEXTTYPE_PLAIN_ITALIC

public static final int TEXTTYPE_PLAIN_ITALIC

See Also:

Constant Field Values

TEXTTYPE_PLAIN_BOLD

public static final int TEXTTYPE_PLAIN_BOLD

See Also:

Constant Field Values

TEXTTYPE_PLAIN_BOLD_ITALIC

public static final int TEXTTYPE_PLAIN_BOLD_ITALIC

See Also:

Constant Field Values

Constructor Detail

PDFPage

public PDFPage(boolean portrait,
               float leftrightmargin,
               float topbottommargin,
               boolean topatzero)
        throws java.io.IOException

Generates an A4 format page with dimensions indicated in mm

Parameters:

portrait -

leftrightmargin - margin at left and right in mm

topbottommargin - margin at top and bottom in mm

topatzero -

Throws:

java.io.IOException

PDFPage

public PDFPage(float customwidth,
               float customheight,
               float leftrightmargin,
               float topbottommargin,
               boolean topatzero)
        throws java.io.IOException

Parameters:

customwidth - custom width in mm

customheight - custom height in mm

leftrightmargin - margin at left and right in mm

topbottommargin - margin at top and bottom in mm

topatzero -

Throws:

java.io.IOException - if any issue related to file system happens creating the PDF page

PDFPage

public PDFPage(boolean portrait,
               float leftrightmargin,
               float topbottommargin)
        throws java.io.IOException

generates an A4 page with margin size indicated in mm, with topatzero = true

Parameters:

portrait - true if portrait, false is landscape

leftrightmargin - margin at left and right in mm

topbottommargin - margin at top and bottom in mm

Throws:

java.io.IOException

Method Detail

getPageIndex

public int getPageIndex()

This method should only be called during the final layout. Please use the method PDFPage.drawCalculatedText

Returns:

the index of pages, starting at 1

getHeight

public float getHeight()

Returns:

getWidth

public float getWidth()

Returns:

getTextSize

public static float getTextSize(java.lang.String[] lines,
                                int texttype)
                         throws java.io.IOException

Parameters:

lines - lines of text, the function returns the maximum of text sizes

texttype - texttype as defined in PDFBox

Returns:

Throws:

java.io.IOException

isTopAtZero

public boolean isTopAtZero()

Returns:

true if top of page is zero, and bottom of page is positive height of page in milimeter

addHeader

public void addHeader(PDFPageBandHeaders header)
               throws java.io.IOException

Throws:

java.io.IOException

closepage

public void closepage()
               throws java.io.IOException

this needs to be called at the end the work on the page. Else, at execution, an exception is thrown.

Throws:

java.io.IOException

print

protected void print(org.apache.pdfbox.pdmodel.PDDocument document)
              throws java.io.IOException

Description copied from class: PDFPart

This method actually prints the document. It is called after initialize and layoutPages for the whole document

Specified by:

print in class PDFPart

Throws:

java.io.IOException

drawBoxWithWidthAndHeight

public void drawBoxWithWidthAndHeight(boolean fatline,
                                      float left,
                                      float top,
                                      float width,
                                      float height,
                                      boolean drawtop,
                                      boolean drawbottom,
                                      boolean drawleft,
                                      boolean drawright)
                               throws java.io.IOException

Parameters:

fatline - fatline true if line is fat, false if line is standard (thinner)

left - left coordinates in mm (note: in PDF, left starts at zero)

top - top coordinates in mm (note: in PDF, bottom starts at zero except if topatzero is set)

width - width in mm, a positive number

height - height in mm, a positive number

drawtop - if true, draw the top line

drawbottom - if true, draw the bottom line

drawleft - if true, draw the left line

drawright - if true, draw the right line

Throws:

java.io.IOException

drawBoxWithWidthAndHeight

public void drawBoxWithWidthAndHeight(boolean fatline,
                                      float left,
                                      float top,
                                      float width,
                                      float height)
                               throws java.io.IOException

Parameters:

fatline - fatline true if line is fat, false if line is standard (thinner)

left - left coordinates in mm (note: in PDF, left starts at zero)

top - top coordinates in mm (note: in PDF, bottom starts at zero except if topatzero is set)

width - width in mm, a positive number

height - height in mm, a positive number

Throws:

java.io.IOException

drawCircle

public void drawCircle(java.awt.Color bordercolor,
                       java.awt.Color fillcolor,
                       float centerx,
                       float centery,
                       float radius)
                throws java.io.IOException

Parameters:

bordercolor -

fillcolor -

centerx -

centery -

radius -

Throws:

java.io.IOException

drawBox

public void drawBox(boolean fatline,
                    float left,
                    float top,
                    float right,
                    float bottom,
                    java.awt.Color color,
                    boolean drawtop,
                    boolean drawbottom,
                    boolean drawleft,
                    boolean drawright)
             throws java.io.IOException

Parameters:

fatline - true if line is fat, false if line is standard (thinner)

left - left coordinates in mm (note: in PDF, left starts at zero)

top - top coordinates in mm (note: in PDF, bottom starts at zero except if topatzero is set)

right - right coordinates in mm (note: in PDF, left starts at zero)

bottom - bottom coordinates in mm (note: in PDF, bottom starts at zero except if topatzero is set)

color - color of the box.

drawtop - if true, draw the top line of the box

drawbottom - if bottom, draw the bottom line of the box

drawleft - if left ... well, draw the left line of the box

drawright - if right (I think you got it) draw the right line of the box

Throws:

java.io.IOException - if anything bad happens with the file being printed

drawBox

public void drawBox(boolean fatline,
                    float left,
                    float top,
                    float right,
                    float bottom,
                    java.awt.Color color)
             throws java.io.IOException

Parameters:

fatline - true if line is fat, false if line is standard (thinner)

left - left coordinates in mm (note: in PDF, left starts at zero)

top - top coordinates in mm (note: in PDF, bottom starts at zero except if topatzero is set)

right - right coordinates in mm (note: in PDF, left starts at zero)

bottom - bottom coordinates in mm (note: in PDF, bottom starts at zero except if topatzero is set)

color - color of the box.

Throws:

java.io.IOException

drawBox

public void drawBox(boolean fatline,
                    float left,
                    float top,
                    float right,
                    float bottom)
             throws java.io.IOException

Draws a rectangular box

Parameters:

fatline - true if line is fat, false if line is standard (thinner)

left - left coordinates in mm (note: in PDF, left starts at zero)

top - top coordinates in mm (note: in PDF, bottom starts at zero except if topatzero is set)

right - right coordinates in mm (note: in PDF, left starts at zero)

bottom - bottom coordinates in mm (note: in PDF, bottom starts at zero except if topatzero is set)

Throws:

java.io.IOException

drawLine

public void drawLine(boolean fatline,
                     float startx,
                     float starty,
                     float endx,
                     float endy,
                     java.awt.Color color)
              throws java.io.IOException

Parameters:

fatline -

startx -

starty -

endx -

endy -

color -

Throws:

java.io.IOException

getTextWidth

public static float getTextWidth(boolean label,
                                 java.lang.String line)
                          throws java.io.IOException

Parameters:

label - true if shown as label, false if shown as normal text

line - the line of text

Returns:

the text width.

Throws:

java.io.IOException

getTextWidth

public static float getTextWidth(boolean label,
                                 java.lang.String line,
                                 boolean paragraphspacing)
                          throws java.io.IOException

Parameters:

label - true if shown as label, false if shown as normal text

line - the line of text

paragraphspacing - if true, 2 times the paragraph left margin will be added.

Returns:

the text width.

Throws:

java.io.IOException

getParagraphHeaderTextWidth

public float getParagraphHeaderTextWidth(java.lang.String[] lines)
                                  throws java.io.IOException

returns the maximum length of the lines provided with paragraphheaderfont

Parameters:

lines - the lines of text

Returns:

the lines of text

Throws:

java.io.IOException

drawBoxWithLineNumber

public float drawBoxWithLineNumber(boolean fatline,
                                   float left,
                                   float top,
                                   float right,
                                   int numberoflines)
                            throws java.io.IOException

Parameters:

fatline -

left -

top -

right -

numberoflines -

Returns:

the mm position of bottom of the box. You can use it to draw a box below that will touch this box

Throws:

java.io.IOException

drawBoxWithLineNumber

public float drawBoxWithLineNumber(boolean fatline,
                                   float left,
                                   float top,
                                   float right,
                                   int numberoflines,
                                   int numberofparagraphs)
                            throws java.io.IOException

Parameters:

fatline -

left -

top -

right -

numberoflines -

numberofparagraphs -

Returns:

Throws:

java.io.IOException

fillBoxWithLineNumber

public float fillBoxWithLineNumber(java.awt.Color color,
                                   float left,
                                   float top,
                                   float right,
                                   int numberoflines,
                                   int numberofparagraphs)
                            throws java.io.IOException

Throws:

java.io.IOException

fillBox

public void fillBox(java.awt.Color color,
                    float left,
                    float top,
                    float right,
                    float bottom)
             throws java.io.IOException

Throws:

java.io.IOException

drawFreeFontTextAt

public void drawFreeFontTextAt(float left,
                               float top,
                               java.awt.Color color,
                               boolean bold,
                               boolean italic,
                               boolean serif,
                               float fontinpoint,
                               java.lang.String text)
                        throws java.io.IOException

Parameters:

left - left coordinates for the text (left of the margin)

top - top coordinates for the text (top of the margin)

color - Color expressed as java.awt.Color

bold - true if bold

italic - true if italic

serif - if true, police is times, if false, police is helvetica

fontinpoint - the font size in point

text - Text

Throws:

java.io.IOException

drawParagraphHeaderAt

public void drawParagraphHeaderAt(float left,
                                  float top,
                                  int linenumber,
                                  int paragraphnumber,
                                  java.lang.String text)
                           throws java.io.IOException

Throws:

java.io.IOException

drawCalculatedText

public void drawCalculatedText(boolean label,
                               float xcoordinates,
                               float top,
                               int linenumber,
                               int paragraphnumber,
                               boolean alignleft,
                               TextAfterLayout calculatedtext)
                        throws java.io.IOException

Parameters:

label -

xcoordinates - leftcoordinates if alignleft = true, else right coordinates

top - top of the box

linenumber - line number of text (starting at 0)

paragraphnumber - paragraph number of text (starting at 0)

alignleft - if true, align on left, if false, align on right

calculatedtext - text to write

Throws:

java.io.IOException

drawCalculatedText

public void drawCalculatedText(float xcoordinates,
                               float top,
                               int linenumber,
                               int paragraphnumber,
                               boolean alignleft,
                               TextAfterLayout calculatedtext)
                        throws java.io.IOException

Parameters:

xcoordinates - leftcoordinates if alignleft = true, else right coordinates

top - top of the box

linenumber - line number of text (starting at 0)

paragraphnumber - paragraph number of text (starting at 0)

alignleft - if true, align on left, if false, align on right

calculatedtext - text to write

Throws:

java.io.IOException

getNumberOfLinesAvailableForParagraph

public static int getNumberOfLinesAvailableForParagraph(float spaceinmm)

drawSimpleTextAt

public void drawSimpleTextAt(boolean label,
                             float left,
                             float top,
                             int linenumber,
                             int paragraphnumber,
                             java.lang.String text)
                      throws java.io.IOException

Draws a single text from the point of origin (adding necessary margins). Typically, the function is used entering directly in left and top the left-top of a box. The margins will adjust correctly

Parameters:

label - true of label, right if normal text

left - left coordinates for the text (left of the margin)

top - top coordinates for the text (top of the margin)

linenumber - line number of text (starting at 0)

paragraphnumber - paragraph number of text (starting at 0)

text - the text to write

Throws:

java.io.IOException

drawSimpleTextAt

public void drawSimpleTextAt(boolean label,
                             float left,
                             float top,
                             int linenumber,
                             int paragraphnumber,
                             java.lang.String text,
                             boolean horizontalparagraphmargin)
                      throws java.io.IOException

Draws a single text from the point of origin (adding necessary margins). Typically, the function is used entering directly in left and top the left-top of a box. The margins will adjust correctly

Parameters:

label - true of label, right if normal text

left - left coordinates for the text (left of the margin)

top - top coordinates for the text (top of the margin)

linenumber - line number of text (starting at 0)

paragraphnumber - paragraph number of text (starting at 0)

text - the text to write

horizontalparagraphmargin - if true, write with normal margin, if false, write text exactly at point specified. The false option is especially suitable for diagram axis

Throws:

java.io.IOException

drawTextWidget

public void drawTextWidget(int texttype,
                           float left,
                           float top,
                           float newleft,
                           int linenumber,
                           int paragraphnumber,
                           boolean newparagraph,
                           boolean compactprint,
                           java.awt.Color color)
                    throws java.io.IOException

Parameters:

texttype -

left -

top -

linenumber -

paragraphnumber -

newparagraph -

compactprint -

color -

Throws:

java.io.IOException

Since:

1.3

drawLeftPaddedTextAt

public float drawLeftPaddedTextAt(int texttype,
                                  float left,
                                  float top,
                                  int linenumber,
                                  int paragraphnumber,
                                  java.lang.String text)
                           throws java.io.IOException

Parameters:

texttype -

left -

top -

linenumber -

paragraphnumber -

text -

Returns:

the size of the text in mm

Throws:

java.io.IOException

drawLeftPaddedTextAt

public float drawLeftPaddedTextAt(int texttype,
                                  float left,
                                  float top,
                                  int linenumber,
                                  int paragraphnumber,
                                  java.lang.String text,
                                  boolean compactprint,
                                  java.awt.Color color)
                           throws java.io.IOException

Parameters:

texttype -

left -

top -

linenumber -

paragraphnumber -

text -

compactprint -

color -

Returns:

Throws:

java.io.IOException

Since:

1.3

drawLeftPaddedTextAt

public float drawLeftPaddedTextAt(int texttype,
                                  float left,
                                  float top,
                                  int linenumber,
                                  int paragraphnumber,
                                  java.lang.String text,
                                  boolean compactprint)
                           throws java.io.IOException

Parameters:

texttype - type of text as a constant integer declared in this class

left - left coordinates in mm from the border of the page

top - top coordinates in mm (either from top or bottom)

linenumber - number of lines already written

paragraphnumber - number of paragraphes already written

text - text to write

Returns:

the size of the text in mm

Throws:

java.io.IOException

drawCenteredTextAt

public void drawCenteredTextAt(boolean title,
                               float top,
                               int paragraphnumber,
                               java.lang.String text)
                        throws java.io.IOException

Parameters:

title - if true, write big title text, false writes normal text

top - top coordinated (top of the margin)

paragraphnumber - starts with 0, and allows to write several lines without calculating coordinates

text - the text to write

Throws:

java.io.IOException

getPagetop

public float getPagetop()

Returns:

page top usable coordinates, leaving out page margin

getPageBottom

public float getPageBottom()

Returns:

page bottom usable coordinates, leaving out page margin

getPageLeft

public float getPageLeft()

Returns:

page left coordinates, leaving out page margin

getPageRight

public float getPageRight()

Returns:

page right coordinates, leaving out page margin

writeAsMuchTextAsPossible

public static PDFPage.BoxTextContent writeAsMuchTextAsPossible(float left,
                                                               float top,
                                                               float right,
                                                               float remainingheight,
                                                               java.lang.String text,
                                                               PDFPage page,
                                                               int texttype,
                                                               boolean splitparagraph)
                                                        throws java.io.IOException

Parameters:

left - left of the printing zone in mm

top - top of the prining zone in mm

right - right of the printing zone in mm

remainingheight - the maximum height to print

text - the full text to write

page - page to print in

texttype - text type as defined in PDFPage constant

splitparagraph: - true if this is the non-first part of a split paragraph. Typically, widget does not have to be printed

Returns:

Throws:

java.io.IOException

writeAsMuchTextAsPossible

public static PDFPage.BoxTextContent writeAsMuchTextAsPossible(float left,
                                                               float top,
                                                               float right,
                                                               float remainingheight,
                                                               java.lang.String text,
                                                               PDFPage page,
                                                               int texttype,
                                                               boolean splitparagraph,
                                                               boolean compactprint)
                                                        throws java.io.IOException

Parameters:

left - left of the printing zone in mm

top - top of the prining zone in mm

right - right of the printing zone in mm

remainingheight - the maximum height to print

text - the full text to write

page - page to print in

texttype - text type as defined in PDFPage constant

splitparagraph: - true if this is the non-first part of a split paragraph. Typically, widget does not have to be printed

Returns:

Throws:

java.io.IOException

calculateBoxAndMaybeWriteText

public static PDFPage.BoxTextContent calculateBoxAndMaybeWriteText(float left,
                                                                   float top,
                                                                   float right,
                                                                   java.lang.String text,
                                                                   boolean write,
                                                                   PDFPage page,
                                                                   int texttype)
                                                            throws java.io.IOException

Parameters:

left - left of the printing zone in mm

top - top of the prining zone in mm

right - right of the printing zone in mm

remainingheight - the maximum height to print

text - the full text to write

page - page to print in

write - true to write the text, false just to calculate

texttype - text type as defined in PDFPage constant

Returns:

the remaining text that could not be printed

Throws:

java.io.IOException

calculateBoxAndMaybeWriteText

public static PDFPage.BoxTextContent calculateBoxAndMaybeWriteText(float left,
                                                                   float top,
                                                                   float right,
                                                                   java.lang.String text,
                                                                   boolean write,
                                                                   boolean partial,
                                                                   float maxheight,
                                                                   PDFPage page,
                                                                   int texttype,
                                                                   boolean splitparagraph,
                                                                   boolean compactprint,
                                                                   java.awt.Color color,
                                                                   float startfirstlineoffset,
                                                                   int startatline,
                                                                   int startatparagraph)
                                                            throws java.io.IOException

Parameters:

left - left of the printing zone in mm

top - top of the prining zone in mm

right - right of the printing zone in mm

text - the full text to write

write - true to write the text, false just to calculate

partial - true to write only partial content within the maximum height limit specified

maxheight - max height to print partial content

page - page to print in

texttype - one of the constants prefixed by 'TEXTTYPE_' in the class

splitparagraph - : true if this is the non-first part of a section split across pages. Typically bullet character is not printed if this argument is true.

compactprint - if true, text is written without paragraphmargin

color - color of text

startfirstlineoffset - first line will be printed with the given offset in mm

startatline - start printing at line number (default is zero if first line)

startatparagraph - start at paragraph number (default is zero if first line)

Returns:

how many lines were printed

Throws:

java.io.IOException - if anything bad happened during the printing

Since:

1.3

calculateBoxAndMaybeWriteText

public static PDFPage.BoxTextContent calculateBoxAndMaybeWriteText(float left,
                                                                   float top,
                                                                   float right,
                                                                   java.lang.String text,
                                                                   boolean write,
                                                                   boolean partial,
                                                                   float maxheight,
                                                                   PDFPage page,
                                                                   int texttype,
                                                                   boolean splitparagraph,
                                                                   boolean compactprint)
                                                            throws java.io.IOException

Parameters:

left - left of the printing zone in mm

top - top of the prining zone in mm

right - right of the printing zone in mm

text - the full text to write

write - true to write the text, false just to calculate

partial - true to write only partial content within the maximum height limit specified

maxheight - max height to print partial content

page - page to print in

texttype - one of the constants prefixed by 'TEXTTYPE_' in the class

splitparagraph - : true if this is the non-first part of a section split across pages. Typically bullet character is not printed if this argument is true.

compactprint - if true, text is written without paragraphmargin

Returns:

Throws:

java.io.IOException - if anything bad happens

calculateBoxAndMaybeWriteText

public static PDFPage.BoxTextContent calculateBoxAndMaybeWriteText(float left,
                                                                   float top,
                                                                   float right,
                                                                   java.lang.String text,
                                                                   boolean write,
                                                                   boolean partial,
                                                                   float maxheight,
                                                                   PDFPage page,
                                                                   int texttype,
                                                                   boolean splitparagraph)
                                                            throws java.io.IOException

Parameters:

left - left of the printing zone in mm

top - top of the prining zone in mm

right - right of the printing zone in mm

text - the full text to write

write - true to write the text, false just to calculate

partial - true to write only partial content within the maximum height limit specified

maxheight - max height to print partial content

page - page to print in

texttype - one of the constants prefixed by 'TEXTTYPE_' in the class

splitparagraph - : true if this is the non-first part of a section split across pages. Typically bullet character is not printed if this argument is true.

Returns:

Throws:

java.io.IOException

drawTextInBox

public PDFPage.BoxTextContent drawTextInBox(float left,
                                            float top,
                                            float right,
                                            java.lang.String text)
                                     throws java.io.IOException

Parameters:

left - the left limit in mm (note: margins are inside)

top - the top of the box in mm (note: margins are inside)

right - the right limit in mm (note: margins are inside)

text - the text to print

Returns:

a BoxTextContent with number of lines and paragraphs written

Throws:

java.io.IOException

drawTextWithLabelInBox

public PDFPage.BoxTextContent drawTextWithLabelInBox(float left,
                                                     float top,
                                                     float right,
                                                     java.lang.String label,
                                                     java.lang.String text,
                                                     int maxline)
                                              throws java.io.IOException

This method writes on the left a label (with label type of text), and the text content on the right, making sure not to get outside of the specified box.
Note: this will align on the bottom the label line with the first line

Parameters:

left - the left limit in mm (note: margins are inside)

top - the top of the box in mm (note: margins are inside)

right - the right limit in mm (note: margins are inside)

label - label text

text - payload text

maxline - : zero if the number of lines of text should not be limited , or a strictly positive figure to limit the number of lines in total. If text is cut, it will get "..." in the end

Returns:

Throws:

java.io.IOException

drawTextInBox

public PDFPage.BoxTextContent drawTextInBox(float left,
                                            float top,
                                            float right,
                                            java.lang.String text,
                                            int texttype)
                                     throws java.io.IOException

Parameters:

left - the left limit in mm (note: margins are inside)

top - the top of the box in mm (note: margins are inside)

right - the right limit in mm (note: margins are inside)

text - the text to print

texttype - the text type as defined in PDFPAGE as TEXTTYPE...

Returns:

a BoxTextContent with number of lines and paragraphs written

Throws:

java.io.IOException

drawTextInBox

public PDFPage.BoxTextContent drawTextInBox(float left,
                                            float top,
                                            float right,
                                            java.lang.String text,
                                            int texttype,
                                            int maxline)
                                     throws java.io.IOException

Parameters:

left - the left limit in mm (note: margins are inside)

top - the top of the box in mm (note: margins are inside)

right - the right limit in mm (note: margins are inside)

text - the text to print

texttype - the text type as defined in PDFPAGE as TEXTTYPE...

maxline - the maximum number of lines to write, or zero if no limit.

Returns:

a BoxTextContent with number of lines and paragraphs written

Throws:

java.io.IOException

calculateTextSize

public PDFPage.BoxTextContent calculateTextSize(float left,
                                                float right,
                                                java.lang.String text)
                                         throws java.io.IOException

Parameters:

left - left the left limit in mm (note: margins are inside)

right - top the top of the box in mm (note: margins are inside)

text - the text to print

Returns:

a BoxTextContent with number of lines and paragraphs written

Throws:

java.io.IOException

drawImageAt

public void drawImageAt(float left,
                        float top,
                        java.lang.String imagepath,
                        float targetwidth)

Parameters:

left - in page coordinates. This attribute and next defines the top-left point for the image.

top - in page coordinates. This attribute and next defines the top-left point for the image.

imagepath - a valid path for server execution (either relative to classpath home, or absolute)

targetwidth - the width of the image in mm. Height will be scaled automatically to respect aspect ratio.

drawImageInsideBox

public void drawImageInsideBox(float left,
                               float top,
                               float right,
                               float bottom,
                               byte[] filecontent,
                               java.lang.String filename)

will automatically scale the image respecting aspect ratio to fit inside the box. The box is using the normal margins of the PDFPage printer.

Parameters:

left - in page coordinates. This attribute and next defines the top-left point for the image.

top - in page coordinates. This attribute and next defines the top-left point for the image.

right - in page coordinates (right reference for image in milimeter (0 is left of page)

bottom - in page coordinates (right reference for image in milimeter (0 is left of page)

filecontent - a byte array with the file content

filename - the name of the file with suffix

drawImageAt

public void drawImageAt(float left,
                        float top,
                        byte[] filecontent,
                        java.lang.String filename,
                        float targetwidth)

Parameters:

left - in page coordinates. This attribute and next defines the top-left point for the image.

top - in page coordinates. This attribute and next defines the top-left point for the image.

filecontent - a byte array with the file content

filename - the name of the file with suffix

targetwidth - the width the image will be scaled to, preserving aspect ratio

drawFixWidthRightAlignedTextAt

public void drawFixWidthRightAlignedTextAt(float rightForColumn,
                                           float topofline,
                                           int lineindex,
                                           int paragraphindex,
                                           java.lang.String text)
                                    throws java.io.IOException

This method will write with current HELVETICA font a fix width per character text (typically number) padded on the right considering usual margins.

Parameters:

rightForColumn -

topofline -

lineindex -

text -

Throws:

java.io.IOException

isValid

public static boolean isValid(char currentchar)

remove

public static java.lang.String remove(java.lang.String text)

Removes all non win-ansi characters. Note: this probably does not manage non-european unicode

Parameters:

text -

Returns:

securedShowText

public static void securedShowText(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream,
                                   java.lang.String text)

getPageNumber

protected int getPageNumber()

Description copied from class: PDFPart

This method should be called at the end of the layout phase or during the printing.

Specified by:

getPageNumber in class PDFPart

Returns:

initialize

protected void initialize()

Description copied from class: PDFPart

This method is called just before the actual printing in order to initialize widgets that depend from the content of the full document. This is typically needed for table of content. Please note that at this point, pages may not have been layout yet

Specified by:

initialize in class PDFPart

layoutPages

protected void layoutPages(int pagesbefore)

Description copied from class: PDFPart

This method is called just after initalize and before print. All PDFParts should perform their page layout at this point. At the end, all pages should be setup, and the index of each page should be known.

Specified by:

layoutPages in class PDFPart

Parameters:

pagesbefore - the number of pages layed-out before.