com.cete.dynamicpdf
Class HeaderFooterTemplate

java.lang.Object
  com.cete.dynamicpdf.Template
      com.cete.dynamicpdf.HeaderFooterTemplate

public class HeaderFooterTemplate
extends Template

This class can be used to place Header Footer Template on a page.

Licensing:
This class is a DynamicPDF Generator Community Edition feature.

View Example

Field Summary

static int

HeaderFooterId

Constructor Summary

HeaderFooterTemplate()
Initializes a new instance of the HeaderFooterTemplate class.

HeaderFooterTemplate(java.lang.String footerText)
Initializes a new instance of the HeaderFooterTemplate class.

HeaderFooterTemplate(java.lang.String headerText, java.lang.String footerText)
Initializes a new instance of the HeaderFooterTemplate class.

HeaderFooterTemplate(java.lang.String headerText, java.lang.String footerText, Font font, float fontsize)
Initializes a new instance of the HeaderFooterTemplate class.

Method Summary

void	draw(PageWriter writer) Draws the header footer template's page elements to the given PageWriter object.
HeaderFooterText	getFooterCenter() Gets the center footer text for the page.
HeaderFooterText	getFooterLeft() Gets the left footer text for the page.
HeaderFooterText	getFooterRight() Gets the right footer text for the page.
HeaderFooterText	getHeaderCenter() Gets the center header footer text for the page.
HeaderFooterText	getHeaderLeft() Gets the left header text for the page.
HeaderFooterText	getHeaderRight() Gets the right header text for the page.
void	setFooterCenter(HeaderFooterText value) Sets the center footer text for the page.
void	setFooterLeft(HeaderFooterText value) Sets the center footer text for the page.
void	setFooterRight(HeaderFooterText value) Sets the right footer text for the page.
void	setHeaderCenter(HeaderFooterText value) Sets the center header footer text for the page.
void	setHeaderLeft(HeaderFooterText value) Sets the left header text for the page.
void	setHeaderRight(HeaderFooterText value) Sets the right header text for the page.

Methods inherited from class com.cete.dynamicpdf.Template

getElements

Methods inherited from class java.lang.Object

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

Field Detail

HeaderFooterId

public static int HeaderFooterId

Constructor Detail

HeaderFooterTemplate

public HeaderFooterTemplate()

Initializes a new instance of the HeaderFooterTemplate class.

HeaderFooterTemplate

public HeaderFooterTemplate(java.lang.String footerText)

Initializes a new instance of the HeaderFooterTemplate class.

Parameters:

footerText - Specifies the footer text of the page.

HeaderFooterTemplate

public HeaderFooterTemplate(java.lang.String headerText,
                            java.lang.String footerText)

Initializes a new instance of the HeaderFooterTemplate class.

Parameters:

headerText - Specifies the header text of the page.

footerText - Specifies the footer text of the page.

HeaderFooterTemplate

public HeaderFooterTemplate(java.lang.String headerText,
                            java.lang.String footerText,
                            Font font,
                            float fontsize)

Initializes a new instance of the HeaderFooterTemplate class.

Parameters:

headerText - Specifies the header text of the page.

footerText - Specifies the footer text of the page.

font - Font Specifies font of the header footer text.

fontsize - Specifies font size of the header footer text.

Method Detail

getHeaderCenter

public HeaderFooterText getHeaderCenter()

Gets the center header footer text for the page.

Returns:

the center header footer text for the page.

setHeaderCenter

public void setHeaderCenter(HeaderFooterText value)

Sets the center header footer text for the page.

Parameters:

value - the center header footer text for the page.

getHeaderLeft

public HeaderFooterText getHeaderLeft()

Gets the left header text for the page.

Returns:

the left header text for the page.

setHeaderLeft

public void setHeaderLeft(HeaderFooterText value)

Sets the left header text for the page.

Parameters:

value - the left header text for the page.

getHeaderRight

public HeaderFooterText getHeaderRight()

Gets the right header text for the page.

Returns:

the right header text for the page.

setHeaderRight

public void setHeaderRight(HeaderFooterText value)

Sets the right header text for the page.

Parameters:

value - the right header text for the page.

getFooterCenter

public HeaderFooterText getFooterCenter()

Gets the center footer text for the page.

Returns:

the center footer text for the page.

setFooterCenter

public void setFooterCenter(HeaderFooterText value)

Sets the center footer text for the page.

Parameters:

value - the center footer text for the page.

getFooterLeft

public HeaderFooterText getFooterLeft()

Gets the left footer text for the page.

Returns:

the left footer text for the page.

setFooterLeft

public void setFooterLeft(HeaderFooterText value)

Sets the center footer text for the page.

Parameters:

value - the center footer text for the page.

getFooterRight

public HeaderFooterText getFooterRight()

Gets the right footer text for the page.

Returns:

the right footer text for the page.

setFooterRight

public void setFooterRight(HeaderFooterText value)

Sets the right footer text for the page.

Parameters:

value - the right footer text for the page.

draw

public void draw(PageWriter writer)

Draws the header footer template's page elements to the given PageWriter object.

Overrides:

draw in class Template

Parameters:

writer - PageWriter object to receive the template's output.

See Also:

PageWriter