li.netcat.print.util
Interface PageDecorator

public interface PageDecorator

The PageDecorator defines header and / or footer to decorate a Print.

Author:

Arthur Marxer

Method Summary

Print	createFooter(PageNumber pageNumber) Factory callback that creates a footer print for the given page number.
Print	createHeader(PageNumber pageNumber) Factory method that creates a header print for the given page number.
int	getFooterGap(PageNumber pageNumber) Returns the gap between the footer and the body.
int	getHeaderGap(PageNumber pageNumber) Returns the gap between the header and the body.

Method Detail

createHeader

public Print createHeader(PageNumber pageNumber)

Factory method that creates a header print for the given page number. If the returned Print does not depend on the page number, this method can always return the same instance.

Parameters:

pageNumber - The pageNumber for which the Print should be produced.

Returns:

The print that represents the header or null if no header exists.

getHeaderGap

public int getHeaderGap(PageNumber pageNumber)

Returns the gap between the header and the body.

Returns:

The gap between the header and the body.

createFooter

public Print createFooter(PageNumber pageNumber)

Factory callback that creates a footer print for the given page number. If the returned Print does not depend on the page number, this method can always return the same instance.

Parameters:

pageNumber - The pageNumber for which the Print should be produced.

Returns:

The print that represents the footer or null if no footer exists.

getFooterGap

public int getFooterGap(PageNumber pageNumber)

Returns the gap between the footer and the body.

Returns:

The gap between the footer and the body.