com.spire.pdf
Class PdfPageTemplateElement

java.lang.Object
  com.spire.pdf.PdfPageTemplateElement

public class PdfPageTemplateElement
extends java.lang.Object

Describes a page template object that can be used as header/footer, watermark or stamp.

Constructor Summary

PdfPageTemplateElement(java.awt.geom.Dimension2D size)
Creates new page template object.

PdfPageTemplateElement(double width, double height)

PdfPageTemplateElement(double x, double y, double width, double height)

PdfPageTemplateElement(double x, double y, double width, double height, PdfNewPage page)

PdfPageTemplateElement(double width, double height, PdfNewPage page)

PdfPageTemplateElement(float width, float height)
Creates a new page template.

PdfPageTemplateElement(float x, float y, float width, float height)
Creates a new page template.

PdfPageTemplateElement(float x, float y, float width, float height, PdfNewPage page)
Creates a new page template.

PdfPageTemplateElement(float width, float height, PdfNewPage page)
Creates a new page template.

PdfPageTemplateElement(java.awt.geom.Point2D location, java.awt.geom.Dimension2D size)
Creates a new page template.

PdfPageTemplateElement(java.awt.geom.Point2D location, java.awt.geom.Dimension2D size, PdfNewPage page)
Initializes a new instance of the class.

PdfPageTemplateElement(java.awt.geom.Rectangle2D bounds)
Creates a new page template.

PdfPageTemplateElement(java.awt.geom.Rectangle2D bounds, PdfNewPage page)
Initializes a new instance of the class.

Method Summary

PdfAlignmentStyle	getAlignment() Gets alignment of the page template element.
boolean	getBackground() Gets the background to Indicate whether the page template is located behind of the page layers or in front of it.
java.awt.geom.Rectangle2D	getBounds() Gets the bounds of the page template element.
PdfDockStyle	getDock() Gets the dock style of the page template element.
boolean	getForeground() Gets the foreground to indicate whether the page template is located in front of the page layers or behind of it.
PdfCanvas	getGraphics() Gets graphics context of the page template element.
float	getHeight() Gets the height of the page template element.
java.awt.geom.Point2D	getLocation() Gets location of the page template element.
java.awt.geom.Dimension2D	getSize() Gets the size of the page template element.
PdfTemplate	getTemplate()
TemplateType	getType() Gets the type of the usage of this page template.
void	setAlignment(PdfAlignmentStyle value) Sets alignment of the page template element.
void	setBackground(boolean value) Sets the background to Indicate whether the page template is located behind of the page layers or in front of it.
void	setBounds(java.awt.geom.Rectangle2D value)
void	setDock(PdfDockStyle value) Sets the dock style of the page template element.
void	setForeground(boolean value) Sets the foreground to indicate whether the page template is located in front of the page layers or behind of it.
void	setHeight(float value) Sets the height of the page template element.
void	setLocation(java.awt.geom.Point2D value)
void	setSize(java.awt.geom.Dimension2D value) Sets the size of the page template element.
void	setType(TemplateType value) Sets the type of the usage of this page template.

Constructor Detail

PdfPageTemplateElement

public PdfPageTemplateElement(java.awt.geom.Rectangle2D bounds)

Creates a new page template.

Parameters:

bounds - Bounds of the template.

PdfPageTemplateElement

public PdfPageTemplateElement(java.awt.geom.Rectangle2D bounds,
                              PdfNewPage page)

Initializes a new instance of the class.

Parameters:

bounds - The bounds.

page - The page.

PdfPageTemplateElement

public PdfPageTemplateElement(java.awt.geom.Point2D location,
                              java.awt.geom.Dimension2D size)

Creates a new page template.

Parameters:

location - Location of the template.

size - Size of the template.

PdfPageTemplateElement

public PdfPageTemplateElement(java.awt.geom.Point2D location,
                              java.awt.geom.Dimension2D size,
                              PdfNewPage page)

Initializes a new instance of the class.

Parameters:

location - The location.

size - The size.

page - The page.

PdfPageTemplateElement

public PdfPageTemplateElement(java.awt.geom.Dimension2D size)

Creates new page template object.

Parameters:

size - Size of the template.

PdfPageTemplateElement

public PdfPageTemplateElement(float width,
                              float height)

Creates a new page template.

Parameters:

width - Width of the template.

height - Height of the template.

PdfPageTemplateElement

public PdfPageTemplateElement(double width,
                              double height)

PdfPageTemplateElement

public PdfPageTemplateElement(float width,
                              float height,
                              PdfNewPage page)

Creates a new page template.

Parameters:

width - Width of the template.

height - Height of the template.

page - The Current Page object.

PdfPageTemplateElement

public PdfPageTemplateElement(double width,
                              double height,
                              PdfNewPage page)

PdfPageTemplateElement

public PdfPageTemplateElement(float x,
                              float y,
                              float width,
                              float height)

Creates a new page template.

Parameters:

x - X co-ordinate of the template.

y - Y co-ordinate of the template.

width - Width of the template.

height - Height of the template.

PdfPageTemplateElement

public PdfPageTemplateElement(double x,
                              double y,
                              double width,
                              double height)

PdfPageTemplateElement

public PdfPageTemplateElement(float x,
                              float y,
                              float width,
                              float height,
                              PdfNewPage page)

Creates a new page template.

Parameters:

x - X co-ordinate of the template.

y - Y co-ordinate of the template.

width - Width of the template.

height - Height of the template.

page - The Current Page object.

PdfPageTemplateElement

public PdfPageTemplateElement(double x,
                              double y,
                              double width,
                              double height,
                              PdfNewPage page)

Method Detail

getDock

public PdfDockStyle getDock()

Gets the dock style of the page template element.

setDock

public void setDock(PdfDockStyle value)

Sets the dock style of the page template element.

getAlignment

public PdfAlignmentStyle getAlignment()

Gets alignment of the page template element.

setAlignment

public void setAlignment(PdfAlignmentStyle value)

Sets alignment of the page template element.

getForeground

public boolean getForeground()

Gets the foreground to indicate whether the page template is located in front of the page layers or behind of it.

setForeground

public void setForeground(boolean value)

Sets the foreground to indicate whether the page template is located in front of the page layers or behind of it.

Parameters:

value -

getBackground

public boolean getBackground()

Gets the background to Indicate whether the page template is located behind of the page layers or in front of it.

setBackground

public void setBackground(boolean value)

Sets the background to Indicate whether the page template is located behind of the page layers or in front of it.

getLocation

public java.awt.geom.Point2D getLocation()

Gets location of the page template element.

setLocation

public void setLocation(java.awt.geom.Point2D value)

getSize

public java.awt.geom.Dimension2D getSize()

Gets the size of the page template element.

setSize

public void setSize(java.awt.geom.Dimension2D value)

Sets the size of the page template element.

getHeight

public float getHeight()

Gets the height of the page template element.

setHeight

public void setHeight(float value)

Sets the height of the page template element.

Parameters:

value -

getBounds

public java.awt.geom.Rectangle2D getBounds()

Gets the bounds of the page template element.

setBounds

public void setBounds(java.awt.geom.Rectangle2D value)

getGraphics

public PdfCanvas getGraphics()

Gets graphics context of the page template element.

getTemplate

public PdfTemplate getTemplate()

getType

public TemplateType getType()

Gets the type of the usage of this page template.

setType

public void setType(TemplateType value)

Sets the type of the usage of this page template.