Package com.itextpdf.text.pdf.events
Class FieldPositioningEvents
- java.lang.Object
-
- com.itextpdf.text.pdf.PdfPageEventHelper
-
- com.itextpdf.text.pdf.events.FieldPositioningEvents
-
- All Implemented Interfaces:
PdfPageEvent
,PdfPCellEvent
public class FieldPositioningEvents extends PdfPageEventHelper implements PdfPCellEvent
Class that can be used to position AcroForm fields.
-
-
Field Summary
Fields Modifier and Type Field Description protected PdfFormField
cellField
Keeps the form field that is to be positioned in a cellLayout event.protected PdfWriter
fieldWriter
The PdfWriter to use when a field has to added in a cell event.protected java.util.HashMap<java.lang.String,PdfFormField>
genericChunkFields
Keeps a map with fields that are to be positioned in inGenericTag.float
padding
Some extra padding that will be taken into account when defining the widget.protected PdfFormField
parent
The PdfFormField that is the parent of the field added in a cell event.
-
Constructor Summary
Constructors Constructor Description FieldPositioningEvents()
Creates a new event.FieldPositioningEvents(PdfFormField parent, PdfFormField field)
Creates a new event.FieldPositioningEvents(PdfWriter writer, PdfFormField field)
Creates a new event.FieldPositioningEvents(PdfWriter writer, PdfFormField parent, java.lang.String text)
Creates a new event.FieldPositioningEvents(PdfWriter writer, java.lang.String text)
Creates a new event.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addField(java.lang.String text, PdfFormField field)
Add a PdfFormField that has to be tied to a generic Chunk.void
cellLayout(PdfPCell cell, Rectangle rect, PdfContentByte[] canvases)
This method is called at the end of the cell rendering.void
onGenericTag(PdfWriter writer, Document document, Rectangle rect, java.lang.String text)
Called when aChunk
with a generic tag is written.void
setPadding(float padding)
void
setParent(PdfFormField parent)
-
Methods inherited from class com.itextpdf.text.pdf.PdfPageEventHelper
onChapter, onChapterEnd, onCloseDocument, onEndPage, onOpenDocument, onParagraph, onParagraphEnd, onSection, onSectionEnd, onStartPage
-
-
-
-
Field Detail
-
genericChunkFields
protected java.util.HashMap<java.lang.String,PdfFormField> genericChunkFields
Keeps a map with fields that are to be positioned in inGenericTag.
-
cellField
protected PdfFormField cellField
Keeps the form field that is to be positioned in a cellLayout event.
-
fieldWriter
protected PdfWriter fieldWriter
The PdfWriter to use when a field has to added in a cell event.
-
parent
protected PdfFormField parent
The PdfFormField that is the parent of the field added in a cell event.
-
padding
public float padding
Some extra padding that will be taken into account when defining the widget.
-
-
Constructor Detail
-
FieldPositioningEvents
public FieldPositioningEvents()
Creates a new event. This constructor will be used if you need to position fields with Chunk objects.
-
FieldPositioningEvents
public FieldPositioningEvents(PdfWriter writer, PdfFormField field)
Creates a new event. This constructor will be used if you need to position fields with a Cell Event.
-
FieldPositioningEvents
public FieldPositioningEvents(PdfFormField parent, PdfFormField field)
Creates a new event. This constructor will be used if you need to position fields with a Cell Event.
-
FieldPositioningEvents
public FieldPositioningEvents(PdfWriter writer, java.lang.String text) throws java.io.IOException, DocumentException
Creates a new event. This constructor will be used if you need to position fields with a Cell Event.- Throws:
DocumentException
java.io.IOException
-
FieldPositioningEvents
public FieldPositioningEvents(PdfWriter writer, PdfFormField parent, java.lang.String text) throws java.io.IOException, DocumentException
Creates a new event. This constructor will be used if you need to position fields with a Cell Event.- Throws:
DocumentException
java.io.IOException
-
-
Method Detail
-
addField
public void addField(java.lang.String text, PdfFormField field)
Add a PdfFormField that has to be tied to a generic Chunk.
-
setPadding
public void setPadding(float padding)
- Parameters:
padding
- The padding to set.
-
setParent
public void setParent(PdfFormField parent)
- Parameters:
parent
- The parent to set.
-
onGenericTag
public void onGenericTag(PdfWriter writer, Document document, Rectangle rect, java.lang.String text)
Description copied from class:PdfPageEventHelper
Called when aChunk
with a generic tag is written.It is useful to pinpoint the
Chunk
location to generate bookmarks, for example.- Specified by:
onGenericTag
in interfacePdfPageEvent
- Overrides:
onGenericTag
in classPdfPageEventHelper
- Parameters:
writer
- thePdfWriter
for this documentdocument
- the documentrect
- theRectangle
containing theChunk
text
- the text of the tag- See Also:
PdfPageEvent.onGenericTag(com.itextpdf.text.pdf.PdfWriter, com.itextpdf.text.Document, com.itextpdf.text.Rectangle, java.lang.String)
-
cellLayout
public void cellLayout(PdfPCell cell, Rectangle rect, PdfContentByte[] canvases)
Description copied from interface:PdfPCellEvent
This method is called at the end of the cell rendering. The text or graphics are added to one of the 4PdfContentByte
contained incanvases
.
The indexes tocanvases
are:PdfPTable.BASECANVAS
- the originalPdfContentByte
. Anything placed here will be under the cell.PdfPTable.BACKGROUNDCANVAS
- the layer where the background goes to.PdfPTable.LINECANVAS
- the layer where the lines go to.PdfPTable.TEXTCANVAS
- the layer where the text go to. Anything placed here will be over the cell.
- Specified by:
cellLayout
in interfacePdfPCellEvent
- Parameters:
cell
- the cellrect
- the coordinates of the cellcanvases
- an array ofPdfContentByte
- See Also:
PdfPCellEvent.cellLayout(com.itextpdf.text.pdf.PdfPCell, com.itextpdf.text.Rectangle, com.itextpdf.text.pdf.PdfContentByte[])
-
-