DynamicPDF by ceTe Software

com.cete.dynamicpdf
Class Page

java.lang.Object
  |
  +--com.cete.dynamicpdf.Page
Direct Known Subclasses:
ImportedPage

public class Page
extends java.lang.Object

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

View Example


Constructor Summary
Page()
          Initializes a new instance of the class.
Page(float width, float height)
          Initializes a new instance of the class.
Page(float width, float height, float margins)
          Construtor Initializes a new instance of the class.
Page(PageDimensions dimensions)
          Initializes a new instance of the class.
Page(PageSize size)
          Initializes a new instance of the class.
Page(PageSize size, float margins)
          Construtor Initializes a new instance of the class.
Page(PageSize size, PageOrientation orientation)
          Initializes a new instance of the class.
Page(PageSize size, PageOrientation orientation, float margins)
          Initializes a new instance of the class.
 
Method Summary
protected  void drawAnnotations(DocumentWriter writer)
          Draws the annotations to the given DocumentWriter object.
protected  void drawAppend(PageWriter writer)
          Draws the appended output to the given DocumentWriter object.
protected  void drawContents(DocumentWriter writer)
          Draws the contents to the given DocumentWriter object.
protected  void drawDimensions(DocumentWriter writer)
          Draws the dimensions to the given DocumentWriter object.
protected  void drawPrepend(PageWriter writer)
          Draws the prepended output to the given DocumentWriter object.
protected  void drawResources(DocumentWriter writer, PageResources resources)
          Draws the resources 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.
protected  int getContentObjects()
           
 PageDimensions getDimensions()
          Gets the dimensions of the page.
 Group getElements()
          Gets a collection of page elements.
 int getRequiredLicenseLevel()
          Gets the required license level for this page.
 int getRotate()
          Gets the rotation of the page.
protected  boolean hasPageElements(DocumentWriter writer, int pageNumber)
           
 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.
protected  void setRequiredLicenseLevel(int level)
          Sets the license level required by 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 class.

See Also:
Page

Page

public Page(PageSize size)
Initializes a new instance of the 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 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)
Construtor Initializes a new instance of the 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 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 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 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 class.

Parameters:
dimensions - The PageDimensions of the page.
See Also:
Page, PageDimensions
Method Detail

getContentObjects

protected int getContentObjects()

hasPageElements

protected boolean hasPageElements(DocumentWriter writer,
                                  int pageNumber)

getRequiredLicenseLevel

public int getRequiredLicenseLevel()
Gets the required license level for this page.


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.


drawDimensions

protected void drawDimensions(DocumentWriter writer)
Draws the dimensions to the given DocumentWriter object.

Parameters:
writer - DocumentWriter to receive the output.
See Also:
DocumentWriter

drawContents

protected void drawContents(DocumentWriter writer)
Draws the contents to the given DocumentWriter object.

Parameters:
writer - DocumentWriter to receive the output.
See Also:
DocumentWriter

drawAnnotations

protected void drawAnnotations(DocumentWriter writer)
Draws the annotations to the given DocumentWriter object.

Parameters:
writer - DocumentWriter to receive the output.
See Also:
DocumentWriter

drawResources

protected void drawResources(DocumentWriter writer,
                             PageResources resources)
Draws the resources to the given DocumentWriter object.

Parameters:
writer - DocumentWriter to receive the output.
resources - The pages resources.
See Also:
DocumentWriter

setRequiredLicenseLevel

protected void setRequiredLicenseLevel(int level)
Sets the license level required by the page.

Parameters:
level - Required license level.

drawPrepend

protected void drawPrepend(PageWriter writer)
Draws the prepended output to the given DocumentWriter object.

Parameters:
writer - DocumentWriter to receive the output.
See Also:
DocumentWriter

drawAppend

protected void drawAppend(PageWriter writer)
Draws the appended output to the given DocumentWriter object.

Parameters:
writer - DocumentWriter to receive the output.
See Also:
DocumentWriter

DynamicPDF by ceTe Software

API Reference for DynamicPDF™ for Java generated on December 20, 2005
© Copyright 2005, ceTe Software