com.cete.dynamicpdf
Class Page

java.lang.Object
  |
  +--com.cete.dynamicpdf.Page

Direct Known Subclasses:

AppendedPage, ImportedPage

public class Page

extends java.lang.Object

This class can be used to create pages to add to your Document.

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

View Example

Constructor Summary

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

Page(float width, float height)
Initializes a new instance of the Page class.

Page(float width, float height, float margins)
Construtor Initializes a new instance of the Page class.

Page(PageDimensions dimensions)
Initializes a new instance of the Page class.

Page(PageSize size)
Initializes a new instance of the Page class.

Page(PageSize size, float margins)
Initializes a new instance of the Page class.

Page(PageSize size, PageOrientation orientation)
Initializes a new instance of the Page class.

Page(PageSize size, PageOrientation orientation, float margins)
Initializes a new instance of the Page class.

Method Summary

void	draw(DocumentWriter writer, int parentObject, int pageNumber, int sectionPageNumber) Draws the page to the given DocumentWriter object.
boolean	getApplyDocumentTemplate() Gets a value indicating if this page uses the documents template.
boolean	getApplySectionTemplate() Gets a value indicating if this page uses the sections template.
PageDimensions	getDimensions() Gets the dimensions of the page.
Group	getElements() Gets a collection of page elements.
int	getRotate() Gets the rotation of the page.
void	setApplyDocumentTemplate(boolean value) Sets a value indicating if this page uses the documents template.
void	setApplySectionTemplate(boolean value) Sets a value indicating if this page uses the sections template.
void	setDimensions(PageDimensions value) Sets the dimensions of the page.
void	setRotate(int value) Sets the rotation of the page.

Methods inherited from class java.lang.Object

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

Constructor Detail

Page

public Page()

Initializes a new instance of the Page class.

See Also:

Page

Page

public Page(PageSize size)

Initializes a new instance of the Page class.

Parameters:

size - represents the dimensions of the page.

See Also:

Page, PageSize

Page

public Page(PageSize size,
            PageOrientation orientation)

Initializes a new instance of the Page class.

Parameters:

size - represents the dimensions of the page.

orientation - The PageOrientation of the page.

See Also:

Page, PageSize, PageOrientation

Page

public Page(PageSize size,
            float margins)

Initializes a new instance of the Page class.

Parameters:

size - represents the dimensions of the page.

margins - The margins of the page.

See Also:

Page, PageSize

Page

public Page(PageSize size,
            PageOrientation orientation,
            float margins)

Initializes a new instance of the Page class.

Parameters:

size - represents the dimensions of the page.

orientation - The PageOrientation of the page.

margins - The margins of the page.

See Also:

Page, PageSize, PageOrientation

Page

public Page(float width,
            float height)

Initializes a new instance of the Page class.

Parameters:

width - The width of the page.

height - The height of the page.

See Also:

Page

Page

public Page(float width,
            float height,
            float margins)

Construtor Initializes a new instance of the Page class.

Parameters:

width - The width of the page.

height - The height of the page.

margins - The margins of the page.

See Also:

Page

Page

public Page(PageDimensions dimensions)

Initializes a new instance of the Page class.

Parameters:

dimensions - The PageDimensions of the page.

See Also:

Page, PageDimensions

Method Detail

getElements

public Group getElements()

Gets a collection of page elements.

getDimensions

public PageDimensions getDimensions()

Gets the dimensions of the page.

setDimensions

public void setDimensions(PageDimensions value)

Sets the dimensions of the page.

getRotate

public int getRotate()

Gets the rotation of the page.

setRotate

public void setRotate(int value)

Sets the rotation of the page.

getApplyDocumentTemplate

public boolean getApplyDocumentTemplate()

Gets a value indicating if this page uses the documents template.

setApplyDocumentTemplate

public void setApplyDocumentTemplate(boolean value)

Sets a value indicating if this page uses the documents template.

getApplySectionTemplate

public boolean getApplySectionTemplate()

Gets a value indicating if this page uses the sections template.

setApplySectionTemplate

public void setApplySectionTemplate(boolean value)

Sets a value indicating if this page uses the sections template.

draw

public void draw(DocumentWriter writer,
                 int parentObject,
                 int pageNumber,
                 int sectionPageNumber)

Draws the page to the given DocumentWriter object.

Throws:

GeneratorException - If the page rotation is not in multiple of 90.

Parameters:

writer - DocumentWriter object to receive the output.