org.openlowcode.tools.pdf

Class BulletText

java.lang.Object

org.openlowcode.tools.pdf.BulletText

All Implemented Interfaces:

PDFPageBandSection

public class BulletText
extends java.lang.Object
implements PDFPageBandSection

A paragraph with a bullet point. 3 levels are managed

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
BulletText(java.lang.String text, int level) Creates a bullet text with normal layout (not compact)
BulletText(java.lang.String text, int level, boolean compactprint) Create a bullet text with specified layout

Method Summary

Modifier and Type	Method and Description
boolean	breakableSection() This method specifies if the section can be broken (and so printed across several pages.
java.lang.String	dropContentSample() this class drops a content sample for logging purposes.
float	getSectionHeight(float leftinmm, float rightinmm) the height of section that needs to be printed
void	initialize() This method allows sections to initialize themselves knowning the full reference of the document before the page number is calculated
void	print(PDFPageBand pageband, PDFPage currentpage, float mmfromtopforsection, float leftinmm, float rightinmm)
PDFPageBand.PartialPrintFeedback	printPartial(PDFPageBand pageband, float spaceleft, PDFPage currentpage, float mmfromtopforsection, float leftinmm, float rightinmm)
void	setParentDocument(PDFDocument document) Provides automatically the PDFDocument to the PDFPageBandSection.

Methods inherited from class java.lang.Object

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

Constructor Detail

BulletText

public BulletText(java.lang.String text,
                  int level,
                  boolean compactprint)

Create a bullet text with specified layout

Parameters:

text - Text to display. The text should not have big carriage return (\n), but can have small carriage return (\r)

level - an integer from 1 to 3 for the level of bullet

compactprint - if true, compact display, if false, use normal paragraph spacing around bullets

BulletText

public BulletText(java.lang.String text,
                  int level)

Creates a bullet text with normal layout (not compact)

Parameters:

text - Text to display. The text should not have big carriage return (\n), but can have small carriage return (\r)

level - an integer from 1 to 3 for the level of bullet

Method Detail

print

public void print(PDFPageBand pageband,
                  PDFPage currentpage,
                  float mmfromtopforsection,
                  float leftinmm,
                  float rightinmm)
           throws java.io.IOException

Specified by:

print in interface PDFPageBandSection

Parameters:

pageband - pageband calling the method. That allows for recursive calling

currentpage - the page to print into

mmfromtopforsection - the cursor location to start printing at

leftinmm - the index of the left most printable space of the printing section

rightinmm - the index of the right most printable space of the printing section

Throws:

java.io.IOException

getSectionHeight

public float getSectionHeight(float leftinmm,
                              float rightinmm)
                       throws java.io.IOException

Description copied from interface: PDFPageBandSection

the height of section that needs to be printed

Specified by:

getSectionHeight in interface PDFPageBandSection

Parameters:

leftinmm - the index of the left most printable space of the printing section

rightinmm - the index of the right most printable space of the printing section

Returns:

the positive value in mm

Throws:

java.io.IOException

breakableSection

public boolean breakableSection()

Description copied from interface: PDFPageBandSection

This method specifies if the section can be broken (and so printed across several pages.

Specified by:

breakableSection in interface PDFPageBandSection

Returns:

true if section is breakable, false else

printPartial

public PDFPageBand.PartialPrintFeedback printPartial(PDFPageBand pageband,
                                                     float spaceleft,
                                                     PDFPage currentpage,
                                                     float mmfromtopforsection,
                                                     float leftinmm,
                                                     float rightinmm)
                                              throws java.io.IOException

Specified by:

printPartial in interface PDFPageBandSection

Parameters:

pageband - pageband calling the method. That allows for recursive calling

spaceleft - the space (height) in mm

currentpage - the page to print into

mmfromtopforsection - the cursor location to start printing at

leftinmm - the index of the left most printable space of the printing section

rightinmm - the index of the right most printable space of the printing section

Returns:

a status of if print is finished and the space consumed (new cursor is sent back)

Throws:

java.io.IOException

dropContentSample

public java.lang.String dropContentSample()

Description copied from interface: PDFPageBandSection

this class drops a content sample for logging purposes.

Specified by:

dropContentSample in interface PDFPageBandSection

Returns:

a string sample of around 100 characters

setParentDocument

public void setParentDocument(PDFDocument document)

Description copied from interface: PDFPageBandSection

Provides automatically the PDFDocument to the PDFPageBandSection. This is useful for sections that need full access to the whole document (today, only the DocumentTableOfContent needs it)

Specified by:

setParentDocument in interface PDFPageBandSection

Parameters:

document - the parent document to the PDFPageBand.

initialize

public void initialize()

Description copied from interface: PDFPageBandSection

This method allows sections to initialize themselves knowning the full reference of the document before the page number is calculated

Specified by:

initialize in interface PDFPageBandSection