Package org.nuxeo.ecm.platform.pdf

Class PDFPageNumbering

java.lang.Object

org.nuxeo.ecm.platform.pdf.PDFPageNumbering

public class PDFPageNumbering
extends Object

Add page numbers to a PDF, with misc parameters (font, size, color, position).

Since:

8.10

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PDFPageNumbering.PAGE_NUMBER_POSITION

Field Summary

Fields

Modifier and Type	Field	Description
static float	DEFAULT_FONT_SIZE

Constructor Summary

Constructors

Constructor	Description
PDFPageNumbering(Blob inBlob)
PDFPageNumbering(DocumentModel inDoc, String inXPath)

Method Summary

Modifier and Type	Method	Description
Blob	addPageNumbers(int inStartAtPage, int inStartAtNumber, String inFontName, float inFontSize, String inHex255Color, PDFPageNumbering.PAGE_NUMBER_POSITION inPosition)	Adds page numbers and returns a new Blob.
void	setPassword(String password)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FONT_SIZE

public static final float DEFAULT_FONT_SIZE

See Also:

Constant Field Values

Constructor Detail

PDFPageNumbering

public PDFPageNumbering(Blob inBlob)

PDFPageNumbering

public PDFPageNumbering(DocumentModel inDoc,
                        String inXPath)

Method Detail

addPageNumbers

public Blob addPageNumbers(int inStartAtPage,
                           int inStartAtNumber,
                           String inFontName,
                           float inFontSize,
                           String inHex255Color,
                           PDFPageNumbering.PAGE_NUMBER_POSITION inPosition)
                    throws NuxeoException

Adds page numbers and returns a new Blob. Original blob is not modified. This code assumes:

• There is no page numbers already (it will always draw the numbers).
• The PDF is not rotated.
• Default values apply:
  • inStartAtPage and inStartAtNumber are set to 1 if they are passed as < 1.
  • inStartAtPage is set to 1 if it is > number of pages.
  • inFontName is set to "Helvetica" if "" or null.
  • inFontSize is set to 16 if it is <= 0.
  • inHex255Color is set to black if "", null or if its length is < 6. Expected format is 0xrrggbb, #rrggbb or just rrggbb.
  • inPosition is set to BOTTOM_RIGHT if null.

Parameters:

inStartAtPage - Number of the first page to be numbered.

inStartAtNumber - Starting number for the page numbering.

inFontName - Name of the font to be used in the numbering.

inFontSize - Size of the font to be used in the numbering.

inHex255Color - Color of the font to be used in the numbering.

inPosition - Page positioning of the numbering.

Returns:

Blob

Throws:

NuxeoException

setPassword

public void setPassword(String password)