com.itextpdf.text.pdf
Class PdfTemplate

java.lang.Object
  extended by com.itextpdf.text.pdf.PdfContentByte
      extended by 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.


Field Summary
protected  HashMap<PdfName,PdfObject> accessibleAttributes
           
protected  Rectangle bBox
          The bounding box of this template
protected  boolean contentTagged
           
protected  PdfTransparencyGroup group
           
protected  PdfOCG layer
           
protected  PdfArray matrix
           
protected  PdfIndirectReference pageReference
           
protected  com.itextpdf.text.pdf.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
           
 
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
protected PdfTemplate()
          Creates a PdfTemplate.
 
Method Summary
 void beginVariableText()
           
static PdfTemplate createTemplate(PdfWriter writer, float width, float height)
          Creates a new template.
 void endVariableText()
           
 PdfObject getAccessibleAttribute(PdfName key)
          Get the attribute of accessible element (everything in A dictionary + Lang, Alt, ActualText, E).
 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.
 UUID getId()
           
 PdfIndirectReference getIndirectReference()
          Gets the indirect reference to this template.
 PdfOCG getLayer()
          Gets the layer this template belongs to.
 PdfIndirectReference getPageReference()
           
 PdfName getRole()
          Gets the role of the accessible element.
 int getType()
           
 float getWidth()
          Gets the bounding width of this template.
 boolean isContentTagged()
           
 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(UUID 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, addImage, addImage, addImage, addImage, addImage, addImage, addOutline, addPSXObject, addTemplate, addTemplate, addTemplate, addTemplate, addTemplate, addTemplate, addTemplate, arc, beginLayer, beginMarkedContentSequence, beginMarkedContentSequence, beginMarkedContentSequence, beginText, beginText, bezierArc, checkWriter, circle, clip, closeMCBlock, closePath, closePathEoFillStroke, closePathFillStroke, closePathStroke, concatCTM, concatCTM, concatCTM, createAppearance, createGraphics, createGraphics, createGraphics, createGraphics, createGraphicsShapes, createGraphicsShapes, createPattern, createPattern, createPattern, createPattern, createPrinterGraphics, createPrinterGraphics, createPrinterGraphics, createPrinterGraphics, createPrinterGraphicsShapes, createPrinterGraphicsShapes, createTemplate, curveFromTo, curveTo, curveTo, drawButton, drawRadioField, drawTextField, 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, lineTo, localDestination, localGoto, moveText, moveTextWithLeading, moveTo, newlineShowText, newlineShowText, newlineText, newPath, openMCBlock, paintShading, paintShading, rectangle, rectangle, remoteGoto, remoteGoto, reset, reset, resetCMYKColorFill, resetCMYKColorStroke, resetGrayFill, resetGrayStroke, resetRGBColorFill, resetRGBColorStroke, restoreMCBlocks, restoreState, roundRectangle, sanityCheck, saveMCBlocks, saveState, setAction, setCharacterSpacing, setCMYKColorFill, setCMYKColorFillF, setCMYKColorStroke, setCMYKColorStrokeF, setColorFill, setColorFill, setColorStroke, setColorStroke, setDefaultColorspace, setFlatness, setFontAndSize, setGrayFill, setGrayStroke, setGState, setHorizontalScaling, setLeading, setLineCap, setLineDash, setLineDash, setLineDash, setLineDash, setLineJoin, setLineWidth, setLiteral, setLiteral, setLiteral, setMcDepth, setMcElements, setMiterLimit, setPatternFill, setPatternFill, setPatternFill, setPatternStroke, setPatternStroke, setPatternStroke, setRGBColorFill, setRGBColorFillF, setRGBColorStroke, setRGBColorStrokeF, setShadingFill, setShadingStroke, setTextMatrix, setTextMatrix, setTextMatrix, setTextMatrix, setTextRenderingMode, setTextRise, setWordSpacing, showText, showText, showTextAligned, showTextAlignedKerned, showTextKerned, 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 com.itextpdf.text.pdf.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

role

protected PdfName role

accessibleAttributes

protected HashMap<PdfName,PdfObject> accessibleAttributes
Constructor Detail

PdfTemplate

protected PdfTemplate()
Creates a PdfTemplate.

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

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)

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()

getFormXObject

public 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()

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 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 UUID getId()
Specified by:
getId in interface IAccessibleElement

setId

public void setId(UUID id)
Specified by:
setId in interface IAccessibleElement


Copyright © 2013. All Rights Reserved.