com.spire.pdf.graphics
Class PdfTemplate

java.lang.Object
  com.spire.pdf.graphics.PdfGraphicsWidget
      com.spire.pdf.graphics.PdfLayoutWidget
          com.spire.pdf.graphics.PdfShapeWidget
              com.spire.pdf.graphics.PdfTemplate

All Implemented Interfaces:

IPdfWrapper

public class PdfTemplate
extends PdfShapeWidget
implements IPdfWrapper

Represents Pdf Template object.

Field Summary

Fields inherited from class com.spire.pdf.graphics.PdfLayoutWidget

beginPageLayout

Constructor Summary

PdfTemplate(java.awt.geom.Dimension2D size)
Initializes a new instance of the class.

PdfTemplate(java.awt.geom.Dimension2D size, boolean writeTransformation)

PdfTemplate(double width, double height)
Initializes a new instance of the class.

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

PdfTemplate(float width, float height, boolean isPdfAppearance)
Initializes a new instance of the class.

PdfTemplate(PdfAnnotation annotation)

PdfTemplate(java.awt.geom.Rectangle2D cropBox)

PdfTemplate(java.awt.geom.Rectangle2D cropBox, java.awt.geom.Rectangle2D mediaBox)
Initializes a new instance of the class.

Method Summary

PdfCanvas	getGraphics() Gets graphics context of the template.
float	getHeight() Gets the height of the template.
boolean	getReadOnly() Gets a value indicating whether the template is read-only.
java.awt.geom.Dimension2D	getSize() Gets the size of the template.
float	getWidth() Gets the width of the template.
void	reset() Resets an instance.
void	reset(java.awt.geom.Dimension2D size) Resets the template and sets the specified size.

Methods inherited from class com.spire.pdf.graphics.PdfShapeWidget

getBounds

Methods inherited from class com.spire.pdf.graphics.PdfLayoutWidget

draw, draw, draw, draw, draw, draw

Methods inherited from class com.spire.pdf.graphics.PdfGraphicsWidget

draw, draw, draw

Constructor Detail

PdfTemplate

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

Initializes a new instance of the class.

Parameters:

size - The size.

PdfTemplate

public PdfTemplate(PdfAnnotation annotation)

PdfTemplate

public PdfTemplate(java.awt.geom.Dimension2D size,
                   boolean writeTransformation)

PdfTemplate

public PdfTemplate(float width,
                   float height)

Initializes a new instance of the class.

Parameters:

width - The width.

height - The height.

PdfTemplate

public PdfTemplate(double width,
                   double height)

Initializes a new instance of the class.

Parameters:

width - The width.

height - The height.

PdfTemplate

public PdfTemplate(float width,
                   float height,
                   boolean isPdfAppearance)

Initializes a new instance of the class.

Parameters:

width - The width.

height - The height.

isPdfAppearance - Indicates if the template is used for PdfAppearance.

PdfTemplate

public PdfTemplate(java.awt.geom.Rectangle2D cropBox)

PdfTemplate

public PdfTemplate(java.awt.geom.Rectangle2D cropBox,
                   java.awt.geom.Rectangle2D mediaBox)

Initializes a new instance of the class.

Parameters:

cropBox - RectangleF cropBox

mediaBox - RectangleF mediaBox

Method Detail

getGraphics

public PdfCanvas getGraphics()

Gets graphics context of the template.

See Also:

It will return null, if the template is read-only.

getSize

public java.awt.geom.Dimension2D getSize()

Gets the size of the template.

getWidth

public float getWidth()

Gets the width of the template.

getHeight

public float getHeight()

Gets the height of the template.

getReadOnly

public boolean getReadOnly()

Gets a value indicating whether the template is read-only.

See Also:

Read-only templates does not expose graphics. They just return null.

reset

public void reset(java.awt.geom.Dimension2D size)

Resets the template and sets the specified size.

Parameters:

size - The size.

reset

public void reset()

Resets an instance.