Package com.itextpdf.text.pdf
Class PdfTemplate
java.lang.Object
com.itextpdf.text.pdf.PdfContentByte
com.itextpdf.text.pdf.PdfTemplate
- All Implemented Interfaces:
IAccessibleElement
- Direct Known Subclasses:
PdfAppearance
,PdfImportedPage
,PdfPatternPainter
,PdfPSXObject
Implements the form XObject.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.itextpdf.text.pdf.PdfContentByte
PdfContentByte.GraphicState, PdfContentByte.UncoloredPattern
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate PdfDictionary
A dictionary with additional informationprotected Rectangle
The bounding box of this templateprotected boolean
protected PdfTransparencyGroup
private AccessibleElementId
protected PdfOCG
protected PdfArray
protected PdfIndirectReference
protected PageResources
The resources used by this templateprotected PdfName
protected PdfIndirectReference
The indirect reference to this templateprotected int
static final int
static final int
static final int
Fields inherited from class com.itextpdf.text.pdf.PdfContentByte
ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, content, duplicatedFrom, layerDepth, LINE_CAP_BUTT, LINE_CAP_PROJECTING_SQUARE, LINE_CAP_ROUND, LINE_JOIN_BEVEL, LINE_JOIN_MITER, LINE_JOIN_ROUND, markedContentSize, pdf, separator, state, stateList, TEXT_RENDER_MODE_CLIP, TEXT_RENDER_MODE_FILL, TEXT_RENDER_MODE_FILL_CLIP, TEXT_RENDER_MODE_FILL_STROKE, TEXT_RENDER_MODE_FILL_STROKE_CLIP, TEXT_RENDER_MODE_INVISIBLE, TEXT_RENDER_MODE_STROKE, TEXT_RENDER_MODE_STROKE_CLIP, writer
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Creates aPdfTemplate
.(package private)
PdfTemplate
(PdfWriter wr) Creates new PdfTemplate -
Method Summary
Modifier and TypeMethodDescriptionvoid
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
Get the attribute of accessible element (everything inA
dictionary +Lang
,Alt
,ActualText
,E
).Gets all the properties of accessible element.Getter for the dictionary with additional information.Gets a duplicate of thisPdfTemplate
.getFormXObject
(int compressionLevel) Gets the stream representing this template.getGroup()
Getter for property group.float
Gets the bounding height of this template.getId()
Gets the indirect reference to this template.getLayer()
Gets the layer this template belongs to.(package private) PdfArray
(package private) PageResources
(package private) PdfObject
Constructs the resources used by this template.getRole()
Gets the role of the accessible element.int
getType()
float
getWidth()
Gets the bounding width of this template.boolean
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 inA
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
void
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
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
-
Field Details
-
TYPE_TEMPLATE
public static final int TYPE_TEMPLATE- See Also:
-
TYPE_IMPORTED
public static final int TYPE_IMPORTED- See Also:
-
TYPE_PATTERN
public static final int TYPE_PATTERN- See Also:
-
type
protected int type -
thisReference
The indirect reference to this template -
pageResources
The resources used by this template -
bBox
The bounding box of this template -
matrix
-
group
-
layer
-
pageReference
-
contentTagged
protected boolean contentTagged -
additional
A dictionary with additional information- Since:
- 5.1.0
-
role
-
accessibleAttributes
-
id
-
-
Constructor Details
-
PdfTemplate
protected PdfTemplate()Creates aPdfTemplate
. -
PdfTemplate
PdfTemplate(PdfWriter wr) Creates new PdfTemplate- Parameters:
wr
- thePdfWriter
-
-
Method Details
-
createTemplate
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 usewidth
- the bounding box widthheight
- the bounding box height- Returns:
- the created template
-
createTemplate
-
isTagged
public boolean isTagged()Description copied from class:PdfContentByte
Checks if the content needs to be tagged.- Overrides:
isTagged
in classPdfContentByte
- 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
-
setBoundingBox
-
setLayer
Sets the layer this template belongs to.- Parameters:
layer
- the layer this template belongs to
-
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
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
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
Gets a duplicate of thisPdfTemplate
. All the members are copied by reference but the buffer stays different.- Overrides:
getDuplicate
in classPdfContentByte
- Returns:
- a copy of this
PdfTemplate
-
getType
public int getType() -
getPageResources
PageResources getPageResources()- Overrides:
getPageResources
in classPdfContentByte
-
getGroup
Getter for property group.- Returns:
- Value of property group.
-
setGroup
Setter for property group.- Parameters:
group
- New value of property group.
-
getAdditional
Getter for the dictionary with additional information.- Returns:
- a PdfDictionary with additional information.
- Since:
- 5.1.0
-
setAdditional
Sets a dictionary with extra entries, for instance /Measure.- Parameters:
additional
- a PdfDictionary with additional information.- Since:
- 5.1.0
-
getCurrentPage
- Overrides:
getCurrentPage
in classPdfContentByte
-
getPageReference
-
setPageReference
-
isContentTagged
public boolean isContentTagged() -
setContentTagged
public void setContentTagged(boolean contentTagged) -
getAccessibleAttribute
Description copied from interface:IAccessibleElement
Get the attribute of accessible element (everything inA
dictionary +Lang
,Alt
,ActualText
,E
).- Specified by:
getAccessibleAttribute
in interfaceIAccessibleElement
- Parameters:
key
-- Returns:
-
setAccessibleAttribute
Description copied from interface:IAccessibleElement
Set the attribute of accessible element (everything inA
dictionary +Lang
,Alt
,ActualText
,E
).- Specified by:
setAccessibleAttribute
in interfaceIAccessibleElement
- Parameters:
key
-value
-
-
getAccessibleAttributes
Description copied from interface:IAccessibleElement
Gets all the properties of accessible element.- Specified by:
getAccessibleAttributes
in interfaceIAccessibleElement
- Returns:
-
getRole
Description copied from interface:IAccessibleElement
Gets the role of the accessible element.- Specified by:
getRole
in interfaceIAccessibleElement
- Returns:
-
setRole
Description copied from interface:IAccessibleElement
Sets the role of the accessiblee element. Set role tonull
if you don't want to tag this element. Note that all child elements won't also be tagged.- Specified by:
setRole
in interfaceIAccessibleElement
- Parameters:
role
-
-
getId
- Specified by:
getId
in interfaceIAccessibleElement
-
setId
- Specified by:
setId
in interfaceIAccessibleElement
-
isInline
public boolean isInline()- Specified by:
isInline
in interfaceIAccessibleElement
-