Package com.itextpdf.forms.fields
Class PdfFormAnnotation
java.lang.Object
com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>
com.itextpdf.forms.fields.AbstractPdfFormField
com.itextpdf.forms.fields.PdfFormAnnotation
This class represents a single annotation in form fields hierarchy in an
AcroForm
.
To be able to be wrapped with this PdfObjectWrapper
the PdfObject
must be indirect.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Color
protected Color
protected float
private static final float
private IFormField
static final int
static final int
private static final String
private static final org.slf4j.Logger
static final String
Value which represents "off" state of form field.static final String
Value which represents "on" state of form field.static final int
static final int
Fields inherited from class com.itextpdf.forms.fields.AbstractPdfFormField
color, DEFAULT_FONT_SIZE, font, fontSize, MIN_FONT_SIZE, parent, pdfConformance
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
PdfFormAnnotation
(PdfWidgetAnnotation widget, PdfDocument pdfDocument) Creates a form field annotation as a wrapper of aPdfWidgetAnnotation
.protected
PdfFormAnnotation
(PdfDictionary pdfObject) Creates a form field annotation as a wrapper object around aPdfDictionary
. -
Method Summary
Modifier and TypeMethodDescriptionprivate static String
appearancePropToCaption
(PdfDictionary appearanceCharacteristics) private static Color
appearancePropToColor
(PdfDictionary appearanceCharacteristics, PdfName property) private Rectangle
applyRotation
(int fieldRotation, Rectangle rectangle) private void
(package private) void
private PdfFormXObject
createN0Layer
(float width, float height) The background layer that is present when creating the signature field.private PdfFormXObject
createN2Layer
(float width, float height) The signature appearance layer that contains information about the signature, e.g.(package private) void
private PdfFormXObject
createTopLayer
(float width, float height) Signature appearance is assembled with the top-level and second-level XObjects and the standard layers.protected void
drawBorder
(PdfCanvas canvas, PdfFormXObject xObject, float width, float height) Draws a border using the borderWidth and borderColor of the form field.protected void
drawCheckBoxAndSaveAppearance
(String onStateName) Draw a checkbox and save its appearance.protected void
Draws the appearance of a Combo box form field and saves it into an appearance stream.protected void
Draws the appearance of a list box form field and saves it into an appearance stream.protected void
Draws the appearance of a push button and saves it into an appearance stream.protected void
Draws the appearance of a radio button with a specified value and saves it into an appearance stream.protected void
Draws the appearance of a signature field and saves it into an appearance stream.protected void
Draws the appearance of a text form field and saves it into an appearance stream.private boolean
String[]
Gets the appearance state names.Get border object specified in the widget annotation dictionary.float
Gets the border width for the field.private String
Gets default appearance string containing a sequence of valid page-content graphics or text state operators that define such properties as the field's text size and color.(package private) float
getFontSize
(PdfArray bBox, String value) private String
protected Rectangle
getRect
(PdfDictionary field) Gets aRectangle
that matches the current size and position of this form field.int
Get rotation property specified in this form annotation.private static PdfArray
getRotationMatrix
(int rotation, float height, float width) GetsPdfWidgetAnnotation
that this form field refers to.private boolean
private boolean
private static boolean
isFieldInvisible
(Rectangle rect) Gets the visibility status of the signature.static PdfFormAnnotation
makeFormAnnotation
(PdfObject pdfObject, PdfDocument document) Creates aPdfFormAnnotation
object.private void
prepareComboBoxFieldWithCorrectOptionsAndValues
(ComboBoxField comboBoxField) private void
boolean
This method regenerates appearance stream of the field.(package private) boolean
(package private) void
Sets the action onwidget
of this annotation form field.setAppearance
(PdfName appearanceType, String appearanceState, PdfStream appearanceStream) Sets an appearance for (the widgets related to) the form field.setBackgroundColor
(Color backgroundColor) Basic setter for thebackgroundColor
property.setBorderColor
(Color color) Sets the Border Color.setBorderStyle
(PdfDictionary style) Sets the border style for the field.setBorderWidth
(float borderWidth) Sets the border width for the field.setCaption
(String caption) Basic setter for the push button caption.setCaption
(String caption, boolean regenerateField) Basic setter for the push button caption.setCheckBoxAppearanceOnStateName
(String onStateName) Sets on state name for the checkbox annotation normal appearance and regenerates widget.setFormFieldElement
(IFormField element) This method sets the model element associated with the current annotation and can be useful to take into account when drawing those properties that the annotation does not have.(package private) static void
setMetaInfoToCanvas
(Canvas canvas) private void
setModelElementProperties
(Rectangle rectangle) setPage
(int pageNum) Specifies on which page the form field's widget must be shown.setRotation
(int degRotation) Basic setter for thedegRotation
property.setVisibility
(int visibility) Set the visibility flags of the form field annotation.Methods inherited from class com.itextpdf.forms.fields.AbstractPdfFormField
disableCurrentFieldRegeneration, disableFieldRegeneration, enableCurrentFieldRegeneration, enableFieldRegeneration, equals, getAcroFormObject, getColor, getDocument, getFieldName, getFont, getFontSize, getParent, getParentField, getPdfConformance, getPdfObject, hashCode, isFieldRegenerationEnabled, isTerminalFormField, isWrappedObjectMustBeIndirect, put, release, remove, setColor, setColorNoRegenerate, setFont, setFontAndSize, setFontSize, setFontSize, setFontSizeAutoScale, setParent, updateFontAndFontSize
Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper
ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, flush, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease
-
Field Details
-
HIDDEN
public static final int HIDDEN- See Also:
-
VISIBLE_BUT_DOES_NOT_PRINT
public static final int VISIBLE_BUT_DOES_NOT_PRINT- See Also:
-
HIDDEN_BUT_PRINTABLE
public static final int HIDDEN_BUT_PRINTABLE- See Also:
-
VISIBLE
public static final int VISIBLE- See Also:
-
OFF_STATE_VALUE
Value which represents "off" state of form field.- See Also:
-
ON_STATE_VALUE
Value which represents "on" state of form field.- See Also:
-
LOGGER
private static final org.slf4j.Logger LOGGER -
LINE_ENDINGS_REGEXP
- See Also:
-
EPS
private static final float EPS- See Also:
-
borderWidth
protected float borderWidth -
backgroundColor
-
borderColor
-
formFieldElement
-
-
Constructor Details
-
PdfFormAnnotation
Creates a form field annotation as a wrapper of aPdfWidgetAnnotation
.- Parameters:
widget
- The widget which will be a kid of thePdfFormField
pdfDocument
- ThePdfDocument
instance.
-
PdfFormAnnotation
Creates a form field annotation as a wrapper object around aPdfDictionary
. ThisPdfDictionary
must be an indirect object.- Parameters:
pdfObject
- the dictionary to be wrapped, must have an indirect reference.
-
-
Method Details
-
makeFormAnnotation
Creates aPdfFormAnnotation
object.- Parameters:
pdfObject
- assumed to be either aPdfDictionary
, or aPdfIndirectReference
to aPdfDictionary
.document
- thePdfDocument
to create the field in.- Returns:
- a new
PdfFormAnnotation
, ornull
ifpdfObject
is not a widget annotation.
-
getWidget
GetsPdfWidgetAnnotation
that this form field refers to.- Returns:
PdfWidgetAnnotation
.
-
getDefaultAppearance
Gets default appearance string containing a sequence of valid page-content graphics or text state operators that define such properties as the field's text size and color.- Specified by:
getDefaultAppearance
in classAbstractPdfFormField
- Returns:
- the default appearance graphics, as a
PdfString
.
-
regenerateField
public boolean regenerateField()This method regenerates appearance stream of the field. Use it if you changed any field parameters and didn't use setValue method which generates appearance by itself.- Specified by:
regenerateField
in classAbstractPdfFormField
- Returns:
- whether or not the regeneration was successful.
-
getAppearanceStates
Gets the appearance state names.- Specified by:
getAppearanceStates
in classAbstractPdfFormField
- Returns:
- an array of Strings containing the names of the appearance states.
-
retrieveStyles
void retrieveStyles()- Overrides:
retrieveStyles
in classAbstractPdfFormField
-
setBackgroundColor
Basic setter for thebackgroundColor
property. Regenerates the field appearance after setting the new value.- Parameters:
backgroundColor
- The new color to be set ornull
if no background needed.- Returns:
- The edited
PdfFormAnnotation
.
-
setCaption
Basic setter for the push button caption. Regenerates the field appearance after setting the new caption.- Parameters:
caption
- button caption to be set.- Returns:
- The edited
PdfFormAnnotation
.
-
setCaption
Basic setter for the push button caption. Regenerates the field appearance after setting the new caption if corresponding parameter is specified.- Parameters:
caption
- button caption to be set.regenerateField
- true if field should be regenerated, false otherwise.- Returns:
- The edited
PdfFormAnnotation
.
-
getRotation
public int getRotation()Get rotation property specified in this form annotation.- Returns:
int
value which represents field's rotation
-
setRotation
Basic setter for thedegRotation
property. Regenerates the field appearance after setting the new value.- Parameters:
degRotation
- The new degRotation to be set- Returns:
- The edited
PdfFormAnnotation
.
-
setAction
Sets the action onwidget
of this annotation form field.- Parameters:
action
- The action.- Returns:
- The edited
PdfFormAnnotation
.
-
setVisibility
Set the visibility flags of the form field annotation. Options are: HIDDEN, HIDDEN_BUT_PRINTABLE, VISIBLE, VISIBLE_BUT_DOES_NOT_PRINT.- Parameters:
visibility
- visibility option.- Returns:
- The edited
PdfFormAnnotation
.
-
getBorderWidth
public float getBorderWidth()Gets the border width for the field.- Returns:
- the current border width.
-
setBorderWidth
Sets the border width for the field.- Parameters:
borderWidth
- The new border width.- Returns:
- The edited
PdfFormAnnotation
.
-
getBorder
Get border object specified in the widget annotation dictionary.- Returns:
Border
specified in the widget annotation dictionary
-
setBorderStyle
Sets the border style for the field.- Parameters:
style
- the new border style.- Returns:
- The edited
PdfFormAnnotation
.
-
setBorderColor
Sets the Border Color.- Parameters:
color
- the new value for the Border Color.- Returns:
- The edited
PdfFormAnnotation
.
-
setPage
Specifies on which page the form field's widget must be shown.- Parameters:
pageNum
- the page number.- Returns:
- The edited
PdfFormAnnotation
.
-
setFormFieldElement
This method sets the model element associated with the current annotation and can be useful to take into account when drawing those properties that the annotation does not have. Note that annotation properties will take precedence, so such properties cannot be overridden by using this method (e.g. background, text color, etc.).Also note that the model element won't be used for annotations for choice form field.
- Parameters:
element
- model element to set- Returns:
- this
PdfFormAnnotation
-
setAppearance
public PdfFormAnnotation setAppearance(PdfName appearanceType, String appearanceState, PdfStream appearanceStream) Sets an appearance for (the widgets related to) the form field.- Parameters:
appearanceType
- the type of appearance stream to be added- PdfName.N: normal appearance
- PdfName.R: rollover appearance
- PdfName.D: down appearance
appearanceState
- the state of the form field that needs to be true for the appearance to be used. Differentiates between several streams of the same type.appearanceStream
- the appearance instructions, as aPdfStream
.- Returns:
- The edited
PdfFormAnnotation
.
-
setCheckBoxAppearanceOnStateName
Sets on state name for the checkbox annotation normal appearance and regenerates widget.- Parameters:
onStateName
- the new appearance name representing on state.- Returns:
- The edited
PdfFormAnnotation
.
-
getRect
Gets aRectangle
that matches the current size and position of this form field.- Parameters:
field
- current form field.- Returns:
- a
Rectangle
that matches the current size and position of this form field annotation.
-
drawBorder
Draws a border using the borderWidth and borderColor of the form field.- Parameters:
canvas
- ThePdfCanvas
on which to drawxObject
- The PdfFormXObjectwidth
- The width of the rectangle to drawheight
- The height of the rectangle to draw
-
drawPushButtonFieldAndSaveAppearance
protected void drawPushButtonFieldAndSaveAppearance()Draws the appearance of a push button and saves it into an appearance stream. -
drawSignatureFormFieldAndSaveAppearance
protected void drawSignatureFormFieldAndSaveAppearance()Draws the appearance of a signature field and saves it into an appearance stream. -
drawRadioButtonAndSaveAppearance
Draws the appearance of a radio button with a specified value and saves it into an appearance stream.- Parameters:
value
- the value of the radio button.
-
drawListFormFieldAndSaveAppearance
protected void drawListFormFieldAndSaveAppearance()Draws the appearance of a list box form field and saves it into an appearance stream. -
drawTextFormFieldAndSaveAppearance
protected void drawTextFormFieldAndSaveAppearance()Draws the appearance of a text form field and saves it into an appearance stream. -
drawComboBoxAndSaveAppearance
protected void drawComboBoxAndSaveAppearance()Draws the appearance of a Combo box form field and saves it into an appearance stream. -
prepareComboBoxFieldWithCorrectOptionsAndValues
-
drawCheckBoxAndSaveAppearance
Draw a checkbox and save its appearance.- Parameters:
onStateName
- the name of the appearance state for the checked state
-
setMetaInfoToCanvas
-
regenerateWidget
boolean regenerateWidget() -
fontRequiredForRegeneration
private boolean fontRequiredForRegeneration() -
createInputButton
void createInputButton() -
createSigField
void createSigField() -
getFontSize
-
isCombTextFormField
private boolean isCombTextFormField() -
getRadioButtonValue
-
getCheckBoxValue
-
reconstructCheckBoxType
private void reconstructCheckBoxType() -
createCheckBox
private void createCheckBox() -
setModelElementProperties
-
getRotationMatrix
-
appearancePropToColor
private static Color appearancePropToColor(PdfDictionary appearanceCharacteristics, PdfName property) -
appearancePropToCaption
-
isCheckBox
private boolean isCheckBox() -
isFieldInvisible
Gets the visibility status of the signature.- Returns:
- the visibility status of the signature
-
createTopLayer
Signature appearance is assembled with the top-level and second-level XObjects and the standard layers. The AP dictionary’s N attribute references a top-level XObject. This top-level XObject is necessary to properly resize signature appearances when these appearances are referred to by more than one signature field. The top-level XObject performs a Do on the second-level XObjects (n0 and n2 painted in sequence). The matrix may change if the signature is resized.- Parameters:
width
- the width of the annotation rectangle.height
- the height of the annotation rectangle.- Returns:
- top layer xObject (/FRM).
- See Also:
-
createN0Layer
The background layer that is present when creating the signature field. This layer renders the background and border of the annotation. The Matrix of this XObject is unity and the BBox is that of the original annotation.In the default itext implementation n0 layer is either a blank xObject or normal appearance of the existed field (in case signature field was created but not signed) when reuseAppearance property is true, but user can modify n0 layer manually.
- Parameters:
width
- the width of the annotation rectangle.height
- the height of the annotation rectangle.- Returns:
- n0 layer xObject.
-
createN2Layer
The signature appearance layer that contains information about the signature, e.g. the line art for the handwritten signature, the text giving the signer’s name, date, reason, location and so on. The content of this layer can be dynamically created when the signature is created, but thereafter it remains static. Specifically, it remains static when the validity state is changed. All appearance handlers that render text honor the font type and color defaults that were set for the signature annotation. So, this layer is the main layer where signature appearance should be drawn in the current itext implementation.- Parameters:
width
- the width of the annotation rectangle.height
- the height of the annotation rectangle.- Returns:
- n2 layer xObject.
-
applyRotation
-