com.goldencode.p2j.admin.server.reports

Interface AbstractReportBuilder.IPageCanvas

All Known Implementing Classes:

AbstractReportBuilder.PageCanvas

Enclosing class:

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

public static interface AbstractReportBuilder.IPageCanvas

Defines the page canvas.

Method Summary

Modifier and Type	Method and Description
AbstractReportBuilder.IPageCanvas	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.IPageCanvas	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.IPageCanvas	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
int	getPageNumber() Gets the page number.
AbstractReportBuilder.PageState	getState() Gets the current page state.
AbstractReportBuilder.IPageCanvas	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.IPageCanvas	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.IPageCanvas	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.

Method Detail

getPageNumber

int getPageNumber()

Gets the page number.

Returns:

The page number

getState

AbstractReportBuilder.PageState getState()

Gets the current page state.

Returns:

The current page state

getColumnRange

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

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

Returns:

The current column range

strokeRectangle

AbstractReportBuilder.IPageCanvas 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.

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

AbstractReportBuilder.IPageCanvas 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.

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

AbstractReportBuilder.IPageCanvas 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.

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

AbstractReportBuilder.IPageCanvas 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

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

AbstractReportBuilder.IPageCanvas 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

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

AbstractReportBuilder.IPageCanvas 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

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