org.openlowcode.tools.richtext

Class PDFPageWithRichText

java.lang.Object

org.openlowcode.tools.pdf.PDFPart

org.openlowcode.tools.pdf.PDFPage

org.openlowcode.tools.richtext.PDFPageWithRichText

public class PDFPageWithRichText
extends PDFPage

This is an extension of PDFPage, adding a method to write rich text in a box.

Author:

Open Lowcode SAS

Nested Class Summary

Nested classes/interfaces inherited from class org.openlowcode.tools.pdf.PDFPage

PDFPage.BoxTextContent, PDFPage.FontAndSize

Field Summary

Fields inherited from class org.openlowcode.tools.pdf.PDFPage

A4_LONGSIDE_IN_MM, A4_SHORTSIDE_IN_MM, TEXTTYPE_BULLET_L1, TEXTTYPE_BULLET_L2, TEXTTYPE_BULLET_L3, TEXTTYPE_LABEL, TEXTTYPE_PARAGRAPH_HEADER, TEXTTYPE_PLAIN, TEXTTYPE_PLAIN_BOLD, TEXTTYPE_PLAIN_BOLD_ITALIC, TEXTTYPE_PLAIN_ITALIC, TEXTTYPE_SECTION_HEADER, TEXTTYPE_TITLE

Constructor Summary

Constructors

Constructor and Description
PDFPageWithRichText(boolean portrait, float leftrightmargin, float topbottommargin) creates a PDF page allowing rich text in default A4 format.
PDFPageWithRichText(boolean portrait, float leftrightmargin, float topbottommargin, boolean topatzero) creates a PDF page with Rich Text in A4
PDFPageWithRichText(float customwidth, float customheight, float leftrightmargin, float topbottommargin, boolean topatzero) creates a PDF Page with Rich text of custom dimensions

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<PDFPage.BoxTextContent>	drawRichTextInBox(float left, float top, float right, java.lang.String richtext) draw rich text in a box
float	drawRichTextInBoxAndGetHeight(float left, float top, float right, java.lang.String richtext) draw rich text in a box

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

addHeader, calculateBoxAndMaybeWriteText, calculateBoxAndMaybeWriteText, calculateBoxAndMaybeWriteText, calculateBoxAndMaybeWriteText, calculateTextSize, closepage, drawBox, drawBox, drawBox, drawBoxWithLineNumber, drawBoxWithLineNumber, drawBoxWithWidthAndHeight, drawBoxWithWidthAndHeight, drawCalculatedText, drawCalculatedText, drawCenteredTextAt, drawCircle, drawFixWidthRightAlignedTextAt, drawFreeFontTextAt, drawImageAt, drawImageAt, drawImageInsideBox, drawLeftPaddedTextAt, drawLeftPaddedTextAt, drawLeftPaddedTextAt, drawLine, drawParagraphHeaderAt, drawSimpleTextAt, drawSimpleTextAt, drawTextInBox, drawTextInBox, drawTextInBox, drawTextWidget, drawTextWithLabelInBox, fillBox, fillBoxWithLineNumber, getHeight, getNumberOfLinesAvailableForParagraph, getPageBottom, getPageIndex, getPageLeft, getPageNumber, getPageRight, getPagetop, getParagraphHeaderTextWidth, getTextSize, getTextWidth, getTextWidth, getWidth, initialize, isTopAtZero, isValid, layoutPages, print, remove, securedShowText, writeAsMuchTextAsPossible, writeAsMuchTextAsPossible

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

Constructor Detail

PDFPageWithRichText

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

creates a PDF page allowing rich text in default A4 format.

Parameters:

portrait - if true, page is portrait, if false, page is landscape

leftrightmargin - margin at left and right in mm

topbottommargin - margin at top and bottom in mm

Throws:

java.io.IOException

PDFPageWithRichText

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

creates a PDF page with Rich Text in A4

Parameters:

portrait - if true, page is portrait, if false, page is landscape

leftrightmargin - margin at left and right in mm

topbottommargin - margin at top and bottom in mm

topatzeroif - true, top coordinates are zero (natural), if false, top is at bottom (PDF)

Throws:

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

PDFPageWithRichText

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

creates a PDF Page with Rich text of custom dimensions

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 - if true, top coordinates are zero (natural), if false, top is at bottom (PDF)

Throws:

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

Method Detail

drawRichTextInBox

public java.util.ArrayList<PDFPage.BoxTextContent> drawRichTextInBox(float left,
                                                                     float top,
                                                                     float right,
                                                                     java.lang.String richtext)
                                                              throws java.io.IOException

draw rich text in a box

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)

richtext - the Open Lowcode richtext to print

Returns:

a list of BoxTextContent with number of lines and paragraphs written

Throws:

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

drawRichTextInBoxAndGetHeight

public float drawRichTextInBoxAndGetHeight(float left,
                                           float top,
                                           float right,
                                           java.lang.String richtext)
                                    throws java.io.IOException

draw rich text in a box

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)

richtext - the Open Lowcode richtext to print

Returns:

the height of the section in mm

Throws:

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