Class PdfTemplate

java.lang.Object
com.lowagie.text.pdf.PdfContentByte
com.lowagie.text.pdf.PdfTemplate
Direct Known Subclasses:
PdfAppearance, PdfImportedPage, PdfPatternPainter, PdfPSXObject

public class PdfTemplate extends PdfContentByte
Implements the form XObject.
  • Field Details

  • Constructor Details

    • PdfTemplate

      protected PdfTemplate()
      Creates a PdfTemplate.
    • PdfTemplate

      PdfTemplate(PdfWriter wr)
      Creates new PdfTemplate
      Parameters:
      wr - the PdfWriter
  • Method Details

    • createTemplate

      public static PdfTemplate createTemplate(PdfWriter writer, float width, float height)
      Creates a new template.

      Creates a new template that is nothing more than a form XObject. This template can be included in this template or in another template. Templates are only written to the output when the document is closed permitting things like showing text in the first page that is only defined in the last page.

      Parameters:
      writer - the PdfWriter to use
      width - the bounding box width
      height - the bounding box height
      Returns:
      the created template
    • createTemplate

      static PdfTemplate createTemplate(PdfWriter writer, float width, float height, PdfName forcedName)
    • getWidth

      public float getWidth()
      Gets the bounding width of this template.
      Returns:
      width the bounding width
    • setWidth

      public void setWidth(float width)
      Sets the bounding width of this template.
      Parameters:
      width - the bounding width
    • getHeight

      public float getHeight()
      Gets the bounding height of this template.
      Returns:
      height the bounding height
    • setHeight

      public void setHeight(float height)
      Sets the bounding height of this template.
      Parameters:
      height - the bounding height
    • getBoundingBox

      public Rectangle getBoundingBox()
    • setBoundingBox

      public void setBoundingBox(Rectangle bBox)
    • getLayer

      public PdfOCG getLayer()
      Gets the layer this template belongs to.
      Returns:
      the layer this template belongs to or null for no layer defined
    • setLayer

      public void setLayer(PdfOCG layer)
      Sets the layer this template belongs to.
      Parameters:
      layer - the layer this template belongs to
    • setMatrix

      public void setMatrix(float a, float b, float c, float d, float e, float f)
    • getMatrix

      PdfArray getMatrix()
    • getIndirectReference

      public PdfIndirectReference getIndirectReference()
      Gets the indirect reference to this template.
      Returns:
      the indirect reference to this template
    • beginVariableText

      public void beginVariableText()
    • endVariableText

      public void endVariableText()
    • getResources

      PdfObject getResources()
      Constructs the resources used by this template.
      Returns:
      the resources used by this template
    • getFormXObject

      PdfStream getFormXObject(int compressionLevel) throws IOException
      Gets the stream representing this template.
      Parameters:
      compressionLevel - the compressionLevel
      Returns:
      the stream representing this template
      Throws:
      IOException
      Since:
      2.1.3 (replacing the method without param compressionLevel)
    • getDuplicate

      public PdfContentByte getDuplicate()
      Gets a duplicate of this PdfTemplate. All the members are copied by reference but the buffer stays different.
      Overrides:
      getDuplicate in class PdfContentByte
      Returns:
      a copy of this PdfTemplate
    • getType

      public int getType()
    • getPageResources

      PageResources getPageResources()
      Overrides:
      getPageResources in class PdfContentByte
    • getGroup

      public PdfTransparencyGroup getGroup()
      Getter for property group.
      Returns:
      Value of property group.
    • setGroup

      public void setGroup(PdfTransparencyGroup group)
      Setter for property group.
      Parameters:
      group - New value of property group.