com.goldencode.p2j.admin.server.reports

Class AbstractReportBuilder.PageCanvas

java.lang.Object

com.goldencode.p2j.admin.server.reports.AbstractReportBuilder.PageCanvas

All Implemented Interfaces:

AbstractReportBuilder.IPageCanvas

Enclosing class:

AbstractReportBuilder<THeaderObject extends AbstractReportBuilder.Header,TRowObject,TFooterObject extends AbstractReportBuilder.Footer>

class AbstractReportBuilder.PageCanvas
extends java.lang.Object
implements AbstractReportBuilder.IPageCanvas

Implements IPageCanvas based on the PDFBox API

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.LinkedList<AbstractReportBuilder.ColumnInfo<?>>	columnRange The column range.
private org.apache.pdfbox.pdmodel.PDDocument	doc The doc.
private org.apache.pdfbox.pdmodel.PDPage	page The page.
private int	pageNumber The page number.
private AbstractReportBuilder.PageState	state The state.

Constructor Summary

Constructors

Constructor and Description
PageCanvas(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, int pageNumber, AbstractReportBuilder.PageState state) Instantiates a new page canvas.

Method Summary

Modifier and Type	Method and Description
private org.apache.pdfbox.pdmodel.PDPageContentStream	createContentStream() Creates the content stream.
AbstractReportBuilder.PageCanvas	drawTextAtLeftTopCorner(java.lang.String text, org.apache.pdfbox.pdmodel.font.PDFont font, float fontSize, float lineWidth, float x, float y) Draw the provided text at (x, y) upper left corner
AbstractReportBuilder.PageCanvas	drawTextAtRightTopCorner(java.lang.String text, org.apache.pdfbox.pdmodel.font.PDFont font, float fontSize, float lineWidth, float x, float y) Draw the provided text aligned right at y upper level
AbstractReportBuilder.PageCanvas	drawTextCentered(java.lang.String text, org.apache.pdfbox.pdmodel.font.PDFont font, float fontSize, float lineWidth, float width, float x, float y) Draw the provided text centered at y upper level
java.util.LinkedList<AbstractReportBuilder.ColumnInfo<?>>	getColumnRange() Gets the current column range that have been drawn on this page canvas already
org.apache.pdfbox.pdmodel.PDDocument	getDoc() Gets the doc.
org.apache.pdfbox.pdmodel.PDPage	getPage() Gets the page.
int	getPageNumber() Gets the page number.
AbstractReportBuilder.PageState	getState() Gets the current page state.
AbstractReportBuilder.PageCanvas	strokeHorizontal(float x, float y, float width, float lineWidth) Draws the horizontal starting at (x, y) upper left corner provided with its width and its line width.
AbstractReportBuilder.PageCanvas	strokeRectangle(float x, float y, float width, float height) Draws the shape of a rectangle provided by its (x, y) upper left corner and its size.
AbstractReportBuilder.PageCanvas	strokeVertical(float x, float y, float height, float lineWidth) Draws the vertical starting at (x, y) upper left corner provided with its height and its line width.

Methods inherited from class java.lang.Object

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

Field Detail

doc

private org.apache.pdfbox.pdmodel.PDDocument doc

The doc.

page

private org.apache.pdfbox.pdmodel.PDPage page

The page.

pageNumber

private int pageNumber

The page number.

state

private AbstractReportBuilder.PageState state

The state.

columnRange

private java.util.LinkedList<AbstractReportBuilder.ColumnInfo<?>> columnRange

The column range.

Constructor Detail

PageCanvas

PageCanvas(org.apache.pdfbox.pdmodel.PDDocument doc,
           org.apache.pdfbox.pdmodel.PDPage page,
           int pageNumber,
           AbstractReportBuilder.PageState state)

Instantiates a new page canvas.

Parameters:

doc - The current doc

page - The page

pageNumber - The page number

state - The state

Method Detail

getDoc

public org.apache.pdfbox.pdmodel.PDDocument getDoc()

Gets the doc.

Returns:

The doc

getPage

public org.apache.pdfbox.pdmodel.PDPage getPage()

Gets the page.

Returns:

The page

getPageNumber

public int getPageNumber()

Gets the page number.

Specified by:

getPageNumber in interface AbstractReportBuilder.IPageCanvas

Returns:

The page number

See Also:

AbstractReportBuilder.IPageCanvas.getPageNumber()

getState

public AbstractReportBuilder.PageState getState()

Gets the current page state.

Specified by:

getState in interface AbstractReportBuilder.IPageCanvas

Returns:

The current page state

See Also:

AbstractReportBuilder.IPageCanvas.getState()

getColumnRange

public java.util.LinkedList<AbstractReportBuilder.ColumnInfo<?>> getColumnRange()

Gets the current column range that have been drawn on this page canvas already

Specified by:

getColumnRange in interface AbstractReportBuilder.IPageCanvas

Returns:

The current column range

See Also:

AbstractReportBuilder.IPageCanvas.getColumnRange()

createContentStream

private org.apache.pdfbox.pdmodel.PDPageContentStream createContentStream()
                                                                   throws java.io.IOException

Creates the content stream.

Returns:

The PD page content stream

Throws:

java.io.IOException - The IO exception if there is a failed output operation

strokeRectangle

public AbstractReportBuilder.PageCanvas strokeRectangle(float x,
                                                        float y,
                                                        float width,
                                                        float height)
                                                 throws java.io.IOException

Draws the shape of a rectangle provided by its (x, y) upper left corner and its size.

Specified by:

strokeRectangle in interface AbstractReportBuilder.IPageCanvas

Parameters:

x - The rectangle's left side coordinate

y - The rectangle's top side coordinate

width - The rectangle's width

height - The rectangle's height

Returns:

The current page canvas

Throws:

java.io.IOException - The IO exception if there is a failed output operation

strokeVertical

public AbstractReportBuilder.PageCanvas strokeVertical(float x,
                                                       float y,
                                                       float height,
                                                       float lineWidth)
                                                throws java.io.IOException

Draws the vertical starting at (x, y) upper left corner provided with its height and its line width.

Specified by:

strokeVertical in interface AbstractReportBuilder.IPageCanvas

Parameters:

x - The vertical's left side coordinate

y - The vertical's top side coordinate

height - The height of the vertical

lineWidth - The line width

Returns:

The current page canvas

Throws:

java.io.IOException - The IO exception if there is a failed output operation

strokeHorizontal

public AbstractReportBuilder.PageCanvas strokeHorizontal(float x,
                                                         float y,
                                                         float width,
                                                         float lineWidth)
                                                  throws java.io.IOException

Draws the horizontal starting at (x, y) upper left corner provided with its width and its line width.

Specified by:

strokeHorizontal in interface AbstractReportBuilder.IPageCanvas

Parameters:

x - The horizontal's left side coordinate

y - The horizontal's top side coordinate

width - The width of the horizontal

lineWidth - The line width

Returns:

The current page canvas

Throws:

java.io.IOException - The IO exception if there is a failed output operation

drawTextAtLeftTopCorner

public AbstractReportBuilder.PageCanvas drawTextAtLeftTopCorner(java.lang.String text,
                                                                org.apache.pdfbox.pdmodel.font.PDFont font,
                                                                float fontSize,
                                                                float lineWidth,
                                                                float x,
                                                                float y)
                                                         throws java.io.IOException

Draw the provided text at (x, y) upper left corner

Specified by:

drawTextAtLeftTopCorner in interface AbstractReportBuilder.IPageCanvas

Parameters:

text - The text

font - The font

fontSize - The font size

lineWidth - The line width

x - The left side text position

y - The top side text position

Returns:

The current page canvas

Throws:

java.io.IOException - The IO exception if there is a failed output operation

drawTextCentered

public AbstractReportBuilder.PageCanvas drawTextCentered(java.lang.String text,
                                                         org.apache.pdfbox.pdmodel.font.PDFont font,
                                                         float fontSize,
                                                         float lineWidth,
                                                         float width,
                                                         float x,
                                                         float y)
                                                  throws java.io.IOException

Draw the provided text centered at y upper level

Specified by:

drawTextCentered in interface AbstractReportBuilder.IPageCanvas

Parameters:

text - The text

font - The font

fontSize - The font size

lineWidth - The line width

width - The width of the rectangle for text drawing

x - The left side of the rectangle for text drawing

y - The top side of the rectangle for text drawing

Returns:

The current page canvas

Throws:

java.io.IOException - The IO exception if there is a failed output operation

drawTextAtRightTopCorner

public AbstractReportBuilder.PageCanvas drawTextAtRightTopCorner(java.lang.String text,
                                                                 org.apache.pdfbox.pdmodel.font.PDFont font,
                                                                 float fontSize,
                                                                 float lineWidth,
                                                                 float x,
                                                                 float y)
                                                          throws java.io.IOException

Draw the provided text aligned right at y upper level

Specified by:

drawTextAtRightTopCorner in interface AbstractReportBuilder.IPageCanvas

Parameters:

text - The text

font - The font

fontSize - The font size

lineWidth - The line width

x - The left side text position

y - The top side text position

Returns:

The current page canvas

Throws:

java.io.IOException - The IO exception if there is a failed output operation