java.lang.Object
- com.itextpdf.text.pdf.PdfContentByte
- - com.itextpdf.text.pdf.PdfTemplate

All Implemented Interfaces:

IAccessibleElement

Direct Known Subclasses:

PdfAppearance, PdfImportedPage, PdfPatternPainter, PdfPSXObject
```
public class PdfTemplate
extends PdfContentByte
implements IAccessibleElement
```
Implements the form XObject.

Nested Class Summary
- Nested classes/interfaces inherited from class com.itextpdf.text.pdf.PdfContentByte
  PdfContentByte.GraphicState, PdfContentByte.UncoloredPattern

Field Summary

Fields
Modifier and Type	Field	Description
`protected java.util.HashMap<PdfName,PdfObject>`	`accessibleAttributes`
`private PdfDictionary`	`additional`	A dictionary with additional information
`protected Rectangle`	`bBox`	The bounding box of this template
`protected boolean`	`contentTagged`
`protected PdfTransparencyGroup`	`group`
`private AccessibleElementId`	`id`
`protected PdfOCG`	`layer`
`protected PdfArray`	`matrix`
`protected PdfIndirectReference`	`pageReference`
`protected PageResources`	`pageResources`	The resources used by this template
`protected PdfName`	`role`
`protected PdfIndirectReference`	`thisReference`	The indirect reference to this template
`protected int`	`type`
`static int`	`TYPE_IMPORTED`
`static int`	`TYPE_PATTERN`
`static int`	`TYPE_TEMPLATE`

Constructor Summary

Constructors
Modifier Constructor Description

protected PdfTemplate()
Creates a PdfTemplate.

(package private) PdfTemplate(PdfWriter wr)
Creates new PdfTemplate

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`beginVariableText()`
`static PdfTemplate`	`createTemplate(PdfWriter writer, float width, float height)`	Creates a new template.
`(package private) static PdfTemplate`	`createTemplate(PdfWriter writer, float width, float height, PdfName forcedName)`
`void`	`endVariableText()`
`PdfObject`	`getAccessibleAttribute(PdfName key)`	Get the attribute of accessible element (everything in `A` dictionary + `Lang`, `Alt`, `ActualText`, `E`).
`java.util.HashMap<PdfName,PdfObject>`	`getAccessibleAttributes()`	Gets all the properties of accessible element.
`PdfDictionary`	`getAdditional()`	Getter for the dictionary with additional information.
`Rectangle`	`getBoundingBox()`
`PdfIndirectReference`	`getCurrentPage()`
`PdfContentByte`	`getDuplicate()`	Gets a duplicate of this `PdfTemplate`.
`PdfStream`	`getFormXObject(int compressionLevel)`	Gets the stream representing this template.
`PdfTransparencyGroup`	`getGroup()`	Getter for property group.
`float`	`getHeight()`	Gets the bounding height of this template.
`AccessibleElementId`	`getId()`
`PdfIndirectReference`	`getIndirectReference()`	Gets the indirect reference to this template.
`PdfOCG`	`getLayer()`	Gets the layer this template belongs to.
`(package private) PdfArray`	`getMatrix()`
`PdfIndirectReference`	`getPageReference()`
`(package private) PageResources`	`getPageResources()`
`(package private) PdfObject`	`getResources()`	Constructs the resources used by this template.
`PdfName`	`getRole()`	Gets the role of the accessible element.
`int`	`getType()`
`float`	`getWidth()`	Gets the bounding width of this template.
`boolean`	`isContentTagged()`
`boolean`	`isInline()`
`boolean`	`isTagged()`	Checks if the content needs to be tagged.
`void`	`setAccessibleAttribute(PdfName key, PdfObject value)`	Set the attribute of accessible element (everything in `A` dictionary + `Lang`, `Alt`, `ActualText`, `E`).
`void`	`setAdditional(PdfDictionary additional)`	Sets a dictionary with extra entries, for instance /Measure.
`void`	`setBoundingBox(Rectangle bBox)`
`void`	`setContentTagged(boolean contentTagged)`
`void`	`setGroup(PdfTransparencyGroup group)`	Setter for property group.
`void`	`setHeight(float height)`	Sets the bounding height of this template.
`void`	`setId(AccessibleElementId id)`
`void`	`setLayer(PdfOCG layer)`	Sets the layer this template belongs to.
`void`	`setMatrix(float a, float b, float c, float d, float e, float f)`
`void`	`setPageReference(PdfIndirectReference pageReference)`
`void`	`setRole(PdfName role)`	Sets the role of the accessiblee element.
`void`	`setWidth(float width)`	Sets the bounding width of this template.

Methods inherited from class com.itextpdf.text.pdf.PdfContentByte
add, addAnnotation, addAnnotation, addFormXObj, addFormXObj, addImage, addImage, addImage, addImage, addImage, addImage, addImage, addImage, addImage, addOutline, addPSXObject, addTemplate, addTemplate, addTemplate, addTemplate, addTemplate, addTemplate, addTemplate, addTemplate, addTemplate, addTemplate, addTemplate, addTemplateReference, addTemplateReference, arc, arc, beginLayer, beginMarkedContentSequence, beginMarkedContentSequence, beginMarkedContentSequence, beginText, beginText, bezierArc, bezierArc, checkNoPattern, checkState, checkWriter, circle, circle, clip, closeMCBlock, closePath, closePathEoFillStroke, closePathFillStroke, closePathStroke, concatCTM, concatCTM, concatCTM, concatCTM, createAppearance, createAppearance, createGraphics, createGraphics, createGraphics, createGraphics, createGraphicsShapes, createGraphicsShapes, createPattern, createPattern, createPattern, createPattern, createPrinterGraphics, createPrinterGraphics, createPrinterGraphics, createPrinterGraphics, createPrinterGraphicsShapes, createPrinterGraphicsShapes, createTemplate, createTemplate, curveFromTo, curveFromTo, curveTo, curveTo, curveTo, curveTo, drawButton, drawButton, drawRadioField, drawRadioField, drawTextField, drawTextField, ellipse, ellipse, endLayer, endMarkedContentSequence, endText, eoClip, eoFill, eoFillStroke, fill, fillStroke, getCharacterSpacing, getDuplicate, getEffectiveStringWidth, getHorizontalScaling, getInternalBuffer, getInText, getKernArray, getLeading, getMcDepth, getMcElements, getPdfDocument, getPdfWriter, getRootOutline, getWordSpacing, getXTLM, getYTLM, inheritGraphicState, isTaggingSuppressed, lineTo, lineTo, localDestination, localGoto, moveText, moveTextWithLeading, moveTo, moveTo, newlineShowText, newlineShowText, newlineText, newPath, openMCBlock, outputColorNumbers, paintShading, paintShading, rectangle, rectangle, rectangle, remoteGoto, remoteGoto, reset, reset, resetCMYKColorFill, resetCMYKColorStroke, resetGrayFill, resetGrayStroke, resetRGBColorFill, resetRGBColorStroke, restoreMCBlocks, restoreState, roundRectangle, roundRectangle, sanityCheck, saveMCBlocks, saveState, setAction, setCharacterSpacing, setCMYKColorFill, setCMYKColorFillF, setCMYKColorStroke, setCMYKColorStrokeF, setColorFill, setColorFill, setColorFill, setColorFill, setColorStroke, setColorStroke, setColorStroke, setColorStroke, setDefaultColorspace, setFlatness, setFlatness, setFontAndSize, setGrayFill, setGrayStroke, setGState, setHorizontalScaling, setLeading, setLineCap, setLineDash, setLineDash, setLineDash, setLineDash, setLineDash, setLineDash, setLineDash, setLineDash, setLineJoin, setLineWidth, setLineWidth, setLiteral, setLiteral, setLiteral, setMcDepth, setMcElements, setMiterLimit, setMiterLimit, setPatternFill, setPatternFill, setPatternFill, setPatternStroke, setPatternStroke, setPatternStroke, setRenderingIntent, setRGBColorFill, setRGBColorFillF, setRGBColorStroke, setRGBColorStrokeF, setShadingFill, setShadingStroke, setSuppressTagging, setTextMatrix, setTextMatrix, setTextMatrix, setTextMatrix, setTextRenderingMode, setTextRise, setTextRise, setWordSpacing, showText, showText, showTextAligned, showTextAlignedKerned, showTextGid, showTextKerned, size, size, stroke, toPdf, toString, transform, transform, updateTx, variableRectangle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - TYPE_TEMPLATE
```
public static final int TYPE_TEMPLATE
```
    See Also:
    
    Constant Field Values
  - TYPE_IMPORTED
```
public static final int TYPE_IMPORTED
```
    See Also:
    
    Constant Field Values
  - TYPE_PATTERN
```
public static final int TYPE_PATTERN
```
    See Also:
    
    Constant Field Values
  - type
```
protected int type
```
  - thisReference
```
protected PdfIndirectReference thisReference
```
    The indirect reference to this template
  - pageResources
```
protected PageResources pageResources
```
    The resources used by this template
  - bBox
```
protected Rectangle bBox
```
    The bounding box of this template
  - matrix
```
protected PdfArray matrix
```
  - group
```
protected PdfTransparencyGroup group
```
  - layer
```
protected PdfOCG layer
```
  - pageReference
```
protected PdfIndirectReference pageReference
```
  - contentTagged
```
protected boolean contentTagged
```
  - additional
```
private PdfDictionary additional
```
    A dictionary with additional information
    
    Since:
    
    5.1.0
  - role
```
protected PdfName role
```
  - accessibleAttributes
```
protected java.util.HashMap<PdfName,PdfObject> accessibleAttributes
```
  - id
```
private AccessibleElementId id
```
- Constructor Detail
  - PdfTemplate
```
protected PdfTemplate()
```
    Creates a PdfTemplate.
  - PdfTemplate
```
PdfTemplate(PdfWriter wr)
```
    Creates new PdfTemplate
    
    Parameters:
    
    wr - the PdfWriter
- Method Detail
  - 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)
```
  - isTagged
```
public boolean isTagged()
```
    Description copied from class: PdfContentByte
    
    Checks if the content needs to be tagged.
    
    Overrides:
    
    isTagged in class PdfContentByte
    
    Returns:
    
    false if no tags need to be added
  - setWidth
```
public void setWidth(float width)
```
    Sets the bounding width of this template.
    
    Parameters:
    
    width - the bounding width
  - setHeight
```
public void setHeight(float height)
```
    Sets the bounding height of this template.
    
    Parameters:
    
    height - the bounding height
  - getWidth
```
public float getWidth()
```
    Gets the bounding width of this template.
    
    Returns:
    
    width the bounding width
  - getHeight
```
public float getHeight()
```
    Gets the bounding height of this template.
    
    Returns:
    
    height the bounding height
  - getBoundingBox
```
public Rectangle getBoundingBox()
```
  - setBoundingBox
```
public void setBoundingBox(Rectangle bBox)
```
  - setLayer
```
public void setLayer(PdfOCG layer)
```
    Sets the layer this template belongs to.
    
    Parameters:
    
    layer - the layer this template belongs to
  - getLayer
```
public PdfOCG getLayer()
```
    Gets the layer this template belongs to.
    
    Returns:
    
    the layer this template belongs to or null for no layer defined
  - 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
```
public PdfStream getFormXObject(int compressionLevel)
                         throws java.io.IOException
```
    Gets the stream representing this template.
    
    Parameters:
    
    compressionLevel - the compressionLevel
    
    Returns:
    
    the stream representing this template
    
    Throws:
    
    java.io.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.
  - getAdditional
```
public PdfDictionary getAdditional()
```
    Getter for the dictionary with additional information.
    
    Returns:
    
    a PdfDictionary with additional information.
    
    Since:
    
    5.1.0
  - setAdditional
```
public void setAdditional(PdfDictionary additional)
```
    Sets a dictionary with extra entries, for instance /Measure.
    
    Parameters:
    
    additional - a PdfDictionary with additional information.
    
    Since:
    
    5.1.0
  - getCurrentPage
```
public PdfIndirectReference getCurrentPage()
```
    Overrides:
    
    getCurrentPage in class PdfContentByte
  - getPageReference
```
public PdfIndirectReference getPageReference()
```
  - setPageReference
```
public void setPageReference(PdfIndirectReference pageReference)
```
  - isContentTagged
```
public boolean isContentTagged()
```
  - setContentTagged
```
public void setContentTagged(boolean contentTagged)
```
  - getAccessibleAttribute
```
public PdfObject getAccessibleAttribute(PdfName key)
```
    Description copied from interface: IAccessibleElement
    
    Get the attribute of accessible element (everything in A dictionary + Lang, Alt, ActualText, E).
    
    Specified by:
    
    getAccessibleAttribute in interface IAccessibleElement
    
    Returns:
  - setAccessibleAttribute
```
public void setAccessibleAttribute(PdfName key,
                                   PdfObject value)
```
    Description copied from interface: IAccessibleElement
    
    Set the attribute of accessible element (everything in A dictionary + Lang, Alt, ActualText, E).
    
    Specified by:
    
    setAccessibleAttribute in interface IAccessibleElement
  - getAccessibleAttributes
```
public java.util.HashMap<PdfName,PdfObject> getAccessibleAttributes()
```
    Description copied from interface: IAccessibleElement
    
    Gets all the properties of accessible element.
    
    Specified by:
    
    getAccessibleAttributes in interface IAccessibleElement
    
    Returns:
  - getRole
```
public PdfName getRole()
```
    Description copied from interface: IAccessibleElement
    
    Gets the role of the accessible element.
    
    Specified by:
    
    getRole in interface IAccessibleElement
    
    Returns:
  - setRole
```
public void setRole(PdfName role)
```
    Description copied from interface: IAccessibleElement
    
    Sets the role of the accessiblee element. Set role to null if you don't want to tag this element. Note that all child elements won't also be tagged.
    
    Specified by:
    
    setRole in interface IAccessibleElement
  - getId
```
public AccessibleElementId getId()
```
    Specified by:
    
    getId in interface IAccessibleElement
  - setId
```
public void setId(AccessibleElementId id)
```
    Specified by:
    
    setId in interface IAccessibleElement
  - isInline
```
public boolean isInline()
```
    Specified by:
    
    isInline in interface IAccessibleElement

Modifier	Constructor	Description
`protected`	`PdfTemplate()`	Creates a `PdfTemplate`.
`(package private)`	`PdfTemplate(PdfWriter wr)`	Creates new PdfTemplate

Class PdfTemplate

Nested Class Summary

Nested classes/interfaces inherited from class com.itextpdf.text.pdf.PdfContentByte

Field Summary

Fields inherited from class com.itextpdf.text.pdf.PdfContentByte

Constructor Summary

Method Summary

Methods inherited from class com.itextpdf.text.pdf.PdfContentByte

Methods inherited from class java.lang.Object

Field Detail

TYPE_TEMPLATE

TYPE_IMPORTED

TYPE_PATTERN

type

thisReference

pageResources

bBox

matrix

group

layer

pageReference

contentTagged

additional

role

accessibleAttributes

id

Constructor Detail

PdfTemplate

PdfTemplate

Method Detail

createTemplate

createTemplate

isTagged

setWidth

setHeight

getWidth

getHeight

getBoundingBox

setBoundingBox

setLayer

getLayer

setMatrix

getMatrix

getIndirectReference

beginVariableText

endVariableText

getResources

getFormXObject

getDuplicate

getType

getPageResources

getGroup

setGroup

getAdditional

setAdditional

getCurrentPage

getPageReference

setPageReference

isContentTagged

setContentTagged

getAccessibleAttribute

setAccessibleAttribute

getAccessibleAttributes

getRole

setRole

getId

setId

isInline