com.cete.dynamicpdf
Class HtmlLayout

java.lang.Object
  com.cete.dynamicpdf.HtmlLayout

public class HtmlLayout
extends java.lang.Object

This class can be used to place html layout on a document. View Example

Constructor Summary

HtmlLayout(java.lang.String text, PageInfo pageInfo)
Initializes a new instance of the HtmlLayout class.

HtmlLayout(java.lang.String text, java.net.URI baseRef, PageInfo pageInfo)
Initializes a new instance of the HtmlLayout class.

HtmlLayout(java.net.URI uri, PageInfo pageInfo)
Initializes a new instance of the HtmlLayout class.

HtmlLayout(java.net.URI uri, java.net.URI baseRef, PageInfo pageInfo)
Initializes a new instance of the HtmlLayout class.

Method Summary

java.net.URI	getBaseRef() Gets the base ref of the Html Layout.
float	getBottomMargin() Gets the bottom margin of the Html Layout.
FooterHtmlLayout	getFooter() Gets a FooterHtmlLayout object that represents the footer properties.
HeaderHtmlLayout	getHeader() Gets a HeaderHtmlLayout object that represents the the header properties.
float	getLeftMargin() Gets the left margin of the Html Layout.
float	getRightMargin() Gets the right margin of the Html Layout.
float	getTopMargin() Gets the top margin of the Html Layout.
Document	layout() Gets a Document containing the paginated pages.
void	layout(Document document) Adds the paginated pages to the supplied Document.
void	setBaseRef(java.net.URI value) Sets the base ref of the Html Layout.
void	setBottomMargin(float value) Sets the bottom margin of the Html Layout.
void	setLeftMargin(float value) Sets the left margin of the Html Layout.
void	setRightMargin(float value) Sets the right margin of the Html Layout.
void	setTopMargin(float value) Sets the top margin of the Html Layout.

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlLayout

public HtmlLayout(java.net.URI uri,
                  PageInfo pageInfo)

Initializes a new instance of the HtmlLayout class.

Parameters:

uri - Physical Html file path of the Html Layout.

pageInfo - The PageInfo representing the size of the page.

HtmlLayout

public HtmlLayout(java.lang.String text,
                  PageInfo pageInfo)

Initializes a new instance of the HtmlLayout class.

Parameters:

text - Html text to display in the Html Layout.

pageInfo - The PageInfo representing the size of the page.

HtmlLayout

public HtmlLayout(java.net.URI uri,
                  java.net.URI baseRef,
                  PageInfo pageInfo)

Initializes a new instance of the HtmlLayout class.

Parameters:

uri - Physical Html file path of the Html Layout.

baseRef - Physical file path of the Html resources.

pageInfo - The PageInfo representing the size of the page.

HtmlLayout

public HtmlLayout(java.lang.String text,
                  java.net.URI baseRef,
                  PageInfo pageInfo)

Initializes a new instance of the HtmlLayout class.

Parameters:

text - Html text to display in the Html Layout.

baseRef - Physical file path of the Html resources.

pageInfo - The PageInfo representing the size of the page.

Method Detail

getHeader

public HeaderHtmlLayout getHeader()

Gets a HeaderHtmlLayout object that represents the the header properties.

Returns:

a HeaderHtmlLayout object that represents the the header properties.

getFooter

public FooterHtmlLayout getFooter()

Gets a FooterHtmlLayout object that represents the footer properties.

Returns:

a FooterHtmlLayout object that represents the footer properties.

getBaseRef

public java.net.URI getBaseRef()

Gets the base ref of the Html Layout.

Returns:

the base ref of the Html Layout.

setBaseRef

public void setBaseRef(java.net.URI value)

Sets the base ref of the Html Layout.

Parameters:

value - the base ref of the Html Layout.

getTopMargin

public float getTopMargin()

Gets the top margin of the Html Layout.

Returns:

the top margin of the Html Layout.

setTopMargin

public void setTopMargin(float value)

Sets the top margin of the Html Layout.

Parameters:

value - the top margin of the Html Layout.

getRightMargin

public float getRightMargin()

Gets the right margin of the Html Layout.

Returns:

the right margin of the Html Layout.

setRightMargin

public void setRightMargin(float value)

Sets the right margin of the Html Layout.

Parameters:

value - the right margin of the Html Layout.

getBottomMargin

public float getBottomMargin()

Gets the bottom margin of the Html Layout.

Returns:

the bottom margin of the Html Layout.

setBottomMargin

public void setBottomMargin(float value)

Sets the bottom margin of the Html Layout.

Parameters:

value - the bottom margin of the Html Layout.

getLeftMargin

public float getLeftMargin()

Gets the left margin of the Html Layout.

Returns:

the left margin of the Html Layout.

setLeftMargin

public void setLeftMargin(float value)

Sets the left margin of the Html Layout.

Parameters:

value - the left margin of the Html Layout.

layout

public Document layout()

Gets a Document containing the paginated pages.

Returns:

a Document containing the paginated pages.

layout

public void layout(Document document)

Adds the paginated pages to the supplied Document.

Parameters:

document - A document to layout.