itext.forms
This class represents iText exception that should be thrown when the attribute with given name
is not found in the object attributes list.
The exception thrown when the attribute with given name is not found in the object attributes list.
the name of missing attribute.
Class that bundles all the error message templates as constants.
This class represents iText exception that should be thrown when some errors occur while working with
XFDF objects (XFDF file is XML-based Acrobat Forms Data Format).
The exception thrown when some errors occur while working with XFDF objects.
exception message.
Message in case one tries to add attribute with null name or value.
Message in case one tries to add annotation without indicating the page it belongs to.
This class represents a single field or field group in an
AcroForm.
This class represents a single field or field group in an
AcroForm.
To be able to be wrapped with this
the
must be indirect.
Size of text in form fields when font size is not explicitly set.
Minimal size of text in form fields.
Index of font value in default appearance element.
Index of font size value in default appearance element.
Index of color value in default appearance element.
Parent form field.
Indicates if the form field appearance stream regeneration is enabled.
Creates a form field as a wrapper object around a
.
Creates a form field as a wrapper object around a
.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference.
Gets the wrapped dictionary.
the wrapped dictionary.
Sets a parent
for the current object.
another form field that this field belongs to, usually a group field.
Gets the parent dictionary.
another form field that this field belongs to.
Gets the parent field.
another form field that this field belongs to.
Gets the current field name.
the current field name, as a
.
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.
the default appearance graphics, as a
.
Gets the current fontSize of the form field.
the current fontSize.
Gets the current font of the form field.
the current
font
Gets the current color of the form field.
the current
color
Gets the declared conformance.
the
This method regenerates appearance stream of the field.
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.
whether or not the regeneration was successful.
This method disables regeneration of the field and its children appearance stream.
This method disables regeneration of the field and its children appearance stream. So all of its children
in the hierarchy will also not be regenerated.
Note that after this method is called field will be regenerated
only during
call.
This method enables regeneration of the field appearance stream.
This method enables regeneration of the field appearance stream. Please note that this method enables
regeneration for the children of the field. Also, appearance will be regenerated during this method call.
Should be called after
method call.
This method disables regeneration of the current field appearance stream.
This method enables regeneration of the current field appearance stream and regenerates it.
This method checks if field appearance stream regeneration is enabled.
true if regeneration is enabled for this field (and all of its ancestors), false otherwise.
Sets the text color and does not regenerate appearance stream.
the new value for the Color.
the edited field.
Gets the appearance state names.
an array of Strings containing the names of the appearance states.
Inserts the value into the
of this field and associates it with the specified key.
Inserts the value into the
of this field and associates it with the specified key.
If the key is already present in this field dictionary,
this method will override the old value with the specified one.
key to insert or to override.
the value to associate with the specified key.
the edited field.
Removes the specified key from the
of this field.
key to be removed.
the edited field.
Releases underlying pdf object and other pdf entities used by wrapper.
Releases underlying pdf object and other pdf entities used by wrapper.
This method should be called instead of direct call to
if the wrapper is used.
Gets the
that owns that form field.
the
that owns that form field.
Sets the text color and regenerates appearance stream.
the new value for the Color.
the edited
.
Basic setter for the font property.
Basic setter for the font property. Regenerates the field
appearance after setting the new value.
Note that the font will be added to the document so ensure that the font is embedded
if it's a pdf/a document.
The new font to be set.
The edited
.
Basic setter for the fontSize property.
Basic setter for the fontSize property. Regenerates the
field appearance after setting the new value.
The new font size to be set.
The edited
.
Basic setter for the fontSize property.
Basic setter for the fontSize property. Regenerates the
field appearance after setting the new value.
The new font size to be set.
The edited
.
Sets zero font size which will be interpreted as auto-size according to ISO 32000-1, 12.7.3.3.
the edited
.
Combined setter for the font and fontSize
properties.
Combined setter for the font and fontSize
properties. Regenerates the field appearance after setting the new value.
The new font to be set.
The new font size to be set.
The edited
.
Determines whether current form field is terminal or not.
true if this form field is a terminal one, false otherwise.
Gets the current field name.
list of visited parents which is used to determine cycle references
the current field name, as a
.
Indicate whether some other object is "equal to" this one.
Indicate whether some other object is "equal to" this one. Compares wrapped objects.
Generate a hash code for this object.
The form underline border.
The form beveled border.
The form inset border.
A factory for creating
implementations.
Returns
for specific borderStyle.
border style dictionary. ISO 32000-1 12.5.4
width of the border
color of the border
element background color. This param used for drawing beveled border type
implementation or
Builder for checkbox form field.
Creates builder for
creation.
document to be used for form field creation
name of the form field
Gets check type for checkbox form field.
check type to be set for checkbox form field
Sets check type for checkbox form field.
Sets check type for checkbox form field. Default value is
.
check type to be set for checkbox form field
this builder
Creates checkbox form field based on provided parameters.
new
instance
Builder for choice form field.
Creates builder for
creation.
document to be used for form field creation
name of the form field
Gets options for choice form field.
of choice form field options
Sets options for choice form field.
of choice form field options
this builder
Sets options for choice form field.
array of
options
this builder
Sets options for choice form field.
two-dimensional array of
options. Every inner array shall have two elements.
this builder
Creates list form field based on provided parameters.
new
instance
Creates combobox form field base on provided parameters.
new
instance
Convert
multidimensional array of combo box or list options to
.
Two-dimensional array of options.
a
that contains all the options.
Convert
array of combo box or list options to
.
array of options.
a
that contains all the options.
Builder for form field.
specific form field builder which extends this class.
Document to be used for form field creation.
Name of the form field.
Conformance of the form field.
Creates builder for
creation.
document to be used for form field creation
name of the form field
Gets document to be used for form field creation.
instance
Gets name of the form field.
name to be used for form field creation
Gets conformance for form field creation.
instance of
to be used for form field creation
Sets conformance for form field creation.
Instance of
to be used for form field creation.
this builder
Returns this builder object.
Returns this builder object. Required for superclass methods.
this builder
Class to store meta info that will be used in forms module in static context.
Sets meta info related to forms into static context, executes the action and then cleans meta info.
Sets meta info related to forms into static context, executes the action and then cleans meta info.
Keep in mind that this instance will only be accessible from the same thread.
instance to be set.
action which will be executed while meta info is set to static context.
Gets meta info which was set previously.
Gets meta info which was set previously.
Keep in mind that this operation will return meta info instance which was set previously from the same thread.
meta info instance.
A
implementation that adds an index to the field name of the second field
Creates a new
instance.
the separator that will be used to separate the original field name and the index
Renames the second field by adding an index to its name.
the first field
the second field
if true, an exception will be thrown
returns
value, since
never merges fields.
A
implementation that throws an exception if the second field has the same
name as the first field.
Creates an instance of
executes the strategy.
the first field
the second field
if true, an exception will be thrown
true if the second field was renamed successfully, false otherwise
A
implementation that merges the second field into the first field if the
second field has the same name as the first field.
A
implementation that merges the second field into the first field if the
second field has the same name as the first field.
This strategy is used by default.
Creates an instance of
executes the strategy.
the first field
the second field
if true, an exception will be thrown
true if the second field was merged successfully, false otherwise
A
implementation that throws an exception if the second field has the same
name as the first field.
executes the strategy.
the first field
the second field
if true, an exception will be thrown
true if the second field was merged successfully, false otherwise
Builder for non-terminal form field.
Creates builder for non-terminal
creation.
document to be used for form field creation
name of the form field
Creates non-terminal form field based on provided parameters.
new
instance
An interactive control on the screen that raises events and/or can retain data.
If true, clicking the selected button deselects it, leaving no button selected.
If true, clicking the selected button deselects it, leaving no button selected.
If false, exactly one radio button shall be selected at all times.
If true, the field is a set of radio buttons.
If true, the field is a set of radio buttons.
If false, the field is a check box.
This flag should be set only if the
flag is set to false.
If true, the field is a push button that does not retain a permanent value.
If true, a group of radio buttons within a radio button field,
that use the same value for the on state will turn on and off in unison.
If true, a group of radio buttons within a radio button field,
that use the same value for the on state will turn on and off in unison.
That is if one is checked, they are all checked.
If false, the buttons are mutually exclusive.
Creates a minimal
.
The
instance.
Creates a button form field as a parent of a
.
The widget which will be a kid of the
.
The
instance.
Creates a button form field as a wrapper object around a
.
Creates a button form field as a wrapper object around a
.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference.
Returns Btn, the form type for choice form fields.
the form type, as a
If true, the field is a set of radio buttons; if false, the field is a
check box.
If true, the field is a set of radio buttons; if false, the field is a
check box. This flag only works if the Pushbutton flag is set to false.
whether the field is currently radio buttons or a checkbox
If true, the field is a set of radio buttons; if false, the field is a
check box.
If true, the field is a set of radio buttons; if false, the field is a
check box. This flag should be set only if the Pushbutton flag is set to false.
whether the field should be radio buttons or a checkbox
current
If true, clicking the selected button deselects it, leaving no button
selected.
If true, clicking the selected button deselects it, leaving no button
selected. If false, exactly one radio button shall be selected at all
times. Only valid for radio buttons.
whether a radio button currently allows to choose no options
If true, clicking the selected button deselects it, leaving no button selected.
If true, clicking the selected button deselects it, leaving no button selected.
If false, exactly one radio button shall be selected at all times.
whether a radio button may allow to choose no options
current
If true, the field is a pushbutton that does not retain a permanent value.
whether or not the field is currently a pushbutton
If true, the field is a pushbutton that does not retain a permanent value.
whether or not to set the field to a pushbutton
current
If true, a group of radio buttons within a radio button field that use
the same value for the on state will turn on and off in unison;
that is if one is checked, they are all checked.
If true, a group of radio buttons within a radio button field that use
the same value for the on state will turn on and off in unison;
that is if one is checked, they are all checked.
If false, the buttons are mutually exclusive
whether or not buttons are turned off in unison
If true, a group of radio buttons within a radio button field that use
the same value for the on state will turn on and off in unison; that is
if one is checked, they are all checked.
If true, a group of radio buttons within a radio button field that use
the same value for the on state will turn on and off in unison; that is
if one is checked, they are all checked.
If false, the buttons are mutually exclusive
whether or not buttons should turn off in unison
current
Set image to be used as a background content in a push button.
path to the image to be used.
this
Set image to be used as a background content in a push button as
.
to be used as an image
this
An AcroForm field type representing any type of choice field.
An AcroForm field type representing any type of choice field. Choice fields
are to be represented by a viewer as a list box or a combo box.
If true, the field is a combo box.
If true, the field is a combo box.
If false, the field is a list box.
If true, the combo box shall include an editable text box as well as a drop-down list.
If true, the combo box shall include an editable text box as well as a drop-down list.
If false, it shall include only a drop-down list.
This flag shall be used only if the Combo flag is true.
If true, the field's option items shall be sorted alphabetically.
If true, the field's option items shall be sorted alphabetically.
This flag is intended for use by writers, not by readers.
If true, more than one of the field's option items may be selected simultaneously.
If true, more than one of the field's option items may be selected simultaneously.
If false, at most one item shall be selected.
If true, text entered in the field shall be spell-checked.
If true, the new value shall be committed as soon as a selection is made (commonly with the pointing device).
Creates a minimal
.
The
instance.
Creates a choice form field as a parent of a
.
The widget which will be a kid of the
.
The
instance.
Creates a choice form field as a wrapper object around a
.
Creates a choice form field as a wrapper object around a
.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference.
Returns Ch, the form type for choice form fields.
the form type, as a
Sets the index of the first visible option in a scrollable list.
the index of the first option
current
Gets the current index of the first option in a scrollable list.
the index of the first option, as a
Sets the selected items in the field.
a sorted array of indices representing selected items in the field
current
Highlights the options.
Highlights the options. If this method is used for Combo box, the first value in input array
will be the field value.
Array of display values to be highlighted.
current
.
Highlights the options and generates field appearance if needed.
Highlights the options and generates field appearance if needed. If this method is used for Combo box,
the first value in input array will be the field value
Array of options to be highlighted
if false, appearance won't be regenerated
current
Highlights the options.
Highlights the options. If this method is used for Combo box, the first value in input array
will be the field value
The option numbers
The edited
Gets the currently selected items in the field
a sorted array of indices representing the currently selected items in the field
If true, the field is a combo box; if false, the field is a list box.
whether or not the field should be a combo box
current
If true, the field is a combo box; if false, the field is a list box.
whether or not the field is now a combo box.
If true, the combo box shall include an editable text box as well as a
drop-down list; if false, it shall include only a drop-down list.
If true, the combo box shall include an editable text box as well as a
drop-down list; if false, it shall include only a drop-down list.
This flag shall be used only if the Combo flag is true.
whether or not to add an editable text box
current
If true, the combo box shall include an editable text box as well as a
drop-down list; if false, it shall include only a drop-down list.
If true, the combo box shall include an editable text box as well as a
drop-down list; if false, it shall include only a drop-down list.
This flag shall be used only if the Combo flag is true.
whether or not there is currently an editable text box
If true, the field's option items shall be sorted alphabetically.
If true, the field's option items shall be sorted alphabetically.
This flag is intended for use by writers, not by readers.
whether or not to sort the items
current
If true, the field's option items shall be sorted alphabetically.
If true, the field's option items shall be sorted alphabetically.
This flag is intended for use by writers, not by readers.
whether or not the items are currently sorted
If true, more than one of the field's option items may be selected
simultaneously; if false, at most one item shall be selected.
whether or not to allow multiple selection
current
If true, more than one of the field's option items may be selected simultaneously; if false, at most one item
shall be selected.
whether or not multiple selection is currently allowed
If true, text entered in the field shall be spell-checked.
whether or not to require the PDF viewer to perform a spell check
current
If true, text entered in the field shall be spell-checked..
whether or not PDF viewer must perform a spell check
If true, the new value shall be committed as soon as a selection is made (commonly with the pointing device).
whether or not to save changes immediately
current
If true, the new value shall be committed as soon as a selection is made (commonly with the pointing device).
whether or not to save changes immediately
This class represents a single annotation in form fields hierarchy in an
AcroForm.
This class represents a single annotation in form fields hierarchy in an
AcroForm.
To be able to be wrapped with this
the
must be indirect.
Value which represents "off" state of form field.
Value which represents "on" state of form field.
Creates a form field annotation as a wrapper of a
.
The widget which will be a kid of the
The
instance.
Creates a form field annotation as a wrapper object around a
.
Creates a form field annotation as a wrapper object around a
.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference.
Creates a
object.
assumed to be either a
, or a
to a
.
the
to create the field in.
a new
, or null if
pdfObject is not a widget annotation.
Gets
that this form field refers to.
.
Gets the appearance state names.
an array of Strings containing the names of the appearance states.
Basic setter for the backgroundColor property.
Basic setter for the backgroundColor property. Regenerates
the field appearance after setting the new value.
The new color to be set or
if no background needed.
The edited
.
Basic setter for the push button caption.
Basic setter for the push button caption. Regenerates the field appearance after setting the new caption.
button caption to be set.
The edited
.
Basic setter for the push button caption.
Basic setter for the push button caption. Regenerates the field appearance after setting the new caption
if corresponding parameter is specified.
button caption to be set.
true if field should be regenerated, false otherwise.
The edited
.
Get rotation property specified in this form annotation.
int
value which represents field's rotation
Basic setter for the degRotation property.
Basic setter for the degRotation property. Regenerates
the field appearance after setting the new value.
The new degRotation to be set
The edited
.
Sets the action on
widget
of this annotation form field.
The action.
The edited
.
Set the visibility flags of the form field annotation.
Set the visibility flags of the form field annotation.
Options are: HIDDEN, HIDDEN_BUT_PRINTABLE, VISIBLE, VISIBLE_BUT_DOES_NOT_PRINT.
visibility option.
The edited
.
Gets the border width for the field.
the current border width.
Sets the border width for the field.
The new border width.
The edited
.
Get border object specified in the widget annotation dictionary.
specified in the widget annotation dictionary
Sets the border style for the field.
the new border style.
The edited
.
Sets the Border Color.
the new value for the Border Color.
The edited
.
Specifies on which page the form field's widget must be shown.
the page number.
The edited
.
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.
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.
model element to set
this
Sets an appearance for (the widgets related to) the form field.
the type of appearance stream to be added
- PdfName.N: normal appearance
- PdfName.R: rollover appearance
- PdfName.D: down appearance
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.
the appearance instructions, as a
.
The edited
.
Sets on state name for the checkbox annotation normal appearance and regenerates widget.
the new appearance name representing on state.
The edited
.
Changes the alternative description of the annotation to the specified value.
string to be used as alternative description.
The edited
.
Gets the current alternative description.
the current alternative description.
Gets a
that matches the current size and position of this form field.
current form field.
a
that matches the current size and position of this form field
annotation.
Draws a border using the borderWidth and borderColor of the form field.
The
on which to draw
The PdfFormXObject
The width of the rectangle to draw
The height of the rectangle to draw
Draws the appearance of a push button and saves it into an appearance stream.
Draws the appearance of a signature field and saves it into an appearance stream.
Draws the appearance of a radio button with a specified value and saves it into an appearance stream.
the value of the radio button.
Draws the appearance of a list box form field and saves it into an appearance stream.
Draws the appearance of a text form field and saves it into an appearance stream.
Draws the appearance of a Combo box form field and saves it into an appearance stream.
Draw a checkbox and save its appearance.
the name of the appearance state for the checked state
Gets the visibility status of the signature.
the visibility status of the signature
Signature appearance is assembled with the top-level and second-level XObjects and the standard layers.
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.
the width of the annotation rectangle.
the height of the annotation rectangle.
top layer xObject (/FRM).
Adobe Pdf
* Digital Signature Appearances
The background layer that is present when creating the signature field.
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.
the width of the annotation rectangle.
the height of the annotation rectangle.
n0 layer xObject.
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 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.
the width of the annotation rectangle.
the height of the annotation rectangle.
n2 layer xObject.
Utility class to work with widget annotations
and its dictionaries.
Check that <PdfDictionary> object is widget annotation or merged field.
field dictionary to check.
true if passed dictionary is a widget or merged field, false otherwise.
Check that <PdfDictionary> object is pure widget annotation.
field dictionary to check.
true if passed dictionary is a widget, false otherwise.
Add widget annotation to the specified page.
to which annotation should be added.
widget annotation to add.
Add widget annotation to the specified page.
to which annotation should be added.
widget annotation to add.
the index at which specified annotation will be added. If
-1
then annotation
will be added to the end of an array.
Merge single widget annotation with its parent field.
parent field.
Separate merged field to form field and pure widget annotation.
Separate merged field to form field and pure widget annotation.
Do nothing if the incoming field is not merged field.
to separate.
Creator which shall be used in order to create all form related instances.
Creator which shall be used in order to create all form related instances. By default
is used.
Set
to be used for form related instances creation.
to set
Create a minimal, empty
using provided factory.
The
instance.
created
Creates a form field as a wrapper object around a
using provided factory.
Creates a form field as a wrapper object around a
using provided factory.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference.
created
Creates a form field as a parent of a
using provided factory.
The widget which will be a kid of the
.
The
instance.
created
Create a minimal, empty
using provided factory.
The
instance.
created
Creates a text form field as a wrapper object around a
using provided factory.
Creates a text form field as a wrapper object around a
using provided factory.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference.
created
Creates a text form field as a parent of a
using provided factory.
The widget which will be a kid of the
.
The
instance.
created
Create a minimal, empty
using provided factory.
The
instance.
created
Creates a button form field as a wrapper object around a
using provided factory.
Creates a button form field as a wrapper object around a
using provided factory.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference.
created
Creates a button form field as a parent of a
using provided factory.
The widget which will be a kid of the
.
The
instance.
created
Create a minimal, empty
using provided factory.
The
instance.
created
Creates a choice form field as a wrapper object around a
using provided factory.
Creates a choice form field as a wrapper object around a
using provided factory.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference.
created
Creates a choice form field as a parent of a
using provided factory.
The widget which will be a kid of the
.
The
instance.
created
Create a minimal, empty
using provided factory.
The
instance.
created
Creates a signature form field as a wrapper object around a
using provided factory.
Creates a signature form field as a wrapper object around a
using provided factory.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference.
created
Creates a signature form field as a parent of a
using provided factory.
The widget which will be a kid of the
.
The
instance.
created
Creates a form field annotation as a wrapper object around a
using provided factory.
Creates a form field annotation as a wrapper object around a
using provided factory.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference.
created
Creates a form field annotation as a wrapper of a
using provided factory.
The widget which will be a kid of the
The
instance.
created
Retrieves AcroForm from the document using provided factory.
Retrieves AcroForm from the document using provided factory. If there is no AcroForm in the
document Catalog and createIfNotExist flag is true then the AcroForm
dictionary will be created and added to the document.
the document to retrieve the
from
when true, this method will create a
if none exists for this document
the
document
's AcroForm, or a new one provided that createIfNotExist
parameter is true, otherwise null.
Default factory for form related instances creation.
Create
instance.
Create a minimal, empty
.
The
instance.
created
Creates a form field as a wrapper object around a
.
Creates a form field as a wrapper object around a
.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference.
created
Creates a form field as a parent of a
.
The widget which will be a kid of the
.
The
instance.
created
Create a minimal, empty
.
The
instance.
created
Creates a text form field as a wrapper object around a
.
Creates a text form field as a wrapper object around a
.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference.
created
Creates a text form field as a parent of a
.
The widget which will be a kid of the
.
The
instance.
created
Create a minimal, empty
.
The
instance.
created
Creates a button form field as a wrapper object around a
.
Creates a button form field as a wrapper object around a
.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference.
created
Creates a button form field as a parent of a
.
The widget which will be a kid of the
.
The
instance.
created
Create a minimal, empty
.
The
instance.
created
Creates a choice form field as a wrapper object around a
.
Creates a choice form field as a wrapper object around a
.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference.
created
Creates a choice form field as a parent of a
.
The widget which will be a kid of the
.
The
instance.
created
Create a minimal, empty
.
The
instance.
created
Creates a signature form field as a wrapper object around a
.
Creates a signature form field as a wrapper object around a
.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference.
created
Creates a signature form field as a parent of a
.
The widget which will be a kid of the
.
The
instance.
created
Creates a form field annotation as a wrapper object around a
.
Creates a form field annotation as a wrapper object around a
.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference.
created
Creates a form field annotation as a wrapper of a
.
The widget which will be a kid of the
The
instance.
created
Retrieves AcroForm from the document.
Retrieves AcroForm from the document. If there is no AcroForm in the
document Catalog and createIfNotExist flag is true then the AcroForm
dictionary will be created and added to the document.
the document to retrieve the
from
when true, this method will create a
if none exists for this document
the
document
's AcroForm, or a new one provided that createIfNotExist
parameter is true, otherwise null.
This class represents a single field or field group in an
AcroForm.
This class represents a single field or field group in an
AcroForm.
To be able to be wrapped with this
the
must be indirect.
Flag that designates, if set, that the field can contain multiple lines
of text.
Flag that designates, if set, that the field's contents must be obfuscated.
The ReadOnly flag, which specifies whether the field can be changed.
The Required flag, which specifies whether the field must be filled in.
The NoExport flag, which specifies whether exporting is forbidden.
List of all allowable keys in form fields.
Creates a form field as a wrapper object around a
.
Creates a form field as a wrapper object around a
.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference
Creates a minimal
.
The
instance
Creates a form field as a parent of a
.
The widget which will be a kid of the
The
instance
Creates a (subtype of)
object.
Creates a (subtype of)
object. The type of the object
depends on the FT entry in the pdfObject parameter.
assumed to be either a
,
or a
to a
the
to create the field in
a new
, or null if pdfObject is not a form field
Creates a (subtype of)
or
object depending on
pdfObject.
assumed to be either a
,
or a
to a
the
to create the field in
a new
, or null if
pdfObject is not a form field and is not a widget annotation
Makes a field flag by bit position.
Makes a field flag by bit position. Bit positions are numbered 1 to 32.
But position 0 corresponds to flag 1, position 3 corresponds to flag 4 etc.
a bit position of a flag in range 1 to 32 from the pdf specification
corresponding field flag
Checks if dictionary contains any of the form field keys.
field dictionary to check
true if it is a form field dictionary, false otherwise
Gets a set of all possible form field keys except
PdfName.Parent.
a set of form field keys
Returns the type of the form field dictionary, or of the parent
<PdfDictionary> object.
field dictionary to get its type
the form type, as a
Retrieves string value from
representing text string or text stream.
representing text string or text stream
value
Applies
for provided form field and its annotation children.
the form field to which the accessibility properties should be applied
the form field layout element with accessibility properties
the document to which the form field belongs
Returns the type of the parent form field, or of the wrapped <PdfDictionary> object.
the form type, as a
Sets a value to the field and generating field appearance if needed.
of the field
the field
Sets a value to the field (and fields with the same names) and generates field appearance if needed.
of the field
if false, appearance won't be regenerated
the field
Set text field value with given font and size.
text value
a
the size of the font
the edited field
Sets the field value and the display string.
Sets the field value and the display string. The display string
is used to build the appearance.
the field value
the string that is used for the appearance. If null
the value parameter will be used
the edited field
Removes the childField object of this field.
a
, that needs to be removed from form field children
Removes all children from the current field.
Gets the kids of this object.
contents of the dictionary's Kids property, as a
Gets the childFields of this object.
the children of the current field
Gets all child form fields of this form field.
Gets all child form fields of this form field. Annotations are not returned.
a list of
Gets all childFields of this object, including the children of the children
but not annotations.
the children of the current field and their children
Gets all childFields of this object, including the children of the children.
the children of the current field and their children
Gets the child field of form field.
Gets the child field of form field. If there is no child field with such name,
is returned.
a
, name of the received field
the child of the current field as a
Adds a new kid to the Kids array property from a
.
Adds a new kid to the Kids array property from a
. Also sets the kid's Parent property to this object.
a new
entry for the field's Kids array property
the edited
Adds a new kid to the Kids array property from a
.
Adds a new kid to the Kids array property from a
. Also sets the kid's Parent property to this object.
a new
entry for the field's Kids array property
define whether exception (true) or log (false) is expected in case kid with
the same name exists and merge of two kids failed
the edited
Adds a new kid to the Kids array property from a
.
Adds a new kid to the Kids array property from a
. Also sets the kid's Parent property to this object.
a new
entry for the field's Kids array property
the edited
Changes the name of the field to the specified value.
the new field name, as a String
the edited
Gets the current field partial name.
the current field partial name, as a
. If the field has no partial name,
an empty
is returned
Changes the alternate name of the field to the specified value.
Changes the alternate name of the field to the specified value. The
alternate is a descriptive name to be used by status messages etc.
the new alternate name, as a String
the edited
Gets the current alternate name.
Gets the current alternate name. The alternate is a descriptive name to
be used by status messages etc.
the current alternate name, as a
Changes the mapping name of the field to the specified value.
Changes the mapping name of the field to the specified value. The
mapping name can be used when exporting the form data in the document.
the new alternate name, as a String
the edited field
Gets the current mapping name.
Gets the current mapping name. The mapping name can be used when
exporting the form data in the document.
the current mapping name, as a
Checks whether a certain flag, or any of a combination of flags, is set
for this form field.
an int interpreted as a series of a binary flags
true if any of the flags specified in the parameter is also set
in the form field
Adds a flag, or combination of flags, for the form field.
Adds a flag, or combination of flags, for the form field. This method is
intended to be used one flag at a time, but this is not technically
enforced. To replace the current value, use
.
an int interpreted as a series of a binary flags
the edited
Adds or removes a flag, or combination of flags, for the form field.
Adds or removes a flag, or combination of flags, for the form field. This
method is intended to be used one flag at a time, but this is not
technically enforced. To replace the current value, use
.
an int interpreted as a series of a binary flags
if true, adds the flag(s). if false,
removes the flag(s)
the edited
If true, the field can contain multiple lines of text; if false, the field's text is restricted to a single line.
whether the field can span over multiple lines
If true, the field is intended for entering a secure password that should not be echoed visibly to the screen.
If true, the field is intended for entering a secure password that should not be echoed visibly to the screen.
Characters typed from the keyboard should instead be echoed in some unreadable form, such as asterisks
or bullet characters.
whether the contents of the field must be obfuscated
Sets a flag, or combination of flags, for the form field.
Sets a flag, or combination of flags, for the form field. This method
replaces the previous value. Compare with
which adds a flag to the existing flags.
an int interpreted as a series of a binary flags
the edited
Gets the current list of PDF form field flags.
the current list of flags, encoded as an int
Gets the current value contained in the form field.
the current value, as a
Gets the current value contained in the form field.
the current value, as a
Gets the current display value of the form field.
the current display value, as a
, if it exists.
If not, returns the value as a
Sets the default fallback value for the form field.
the default value
the edited
Gets the default fallback value for the form field.
the default value
Sets an additional action for the form field.
the dictionary key to use for storing the action
the action
the edited
Gets the currently additional action dictionary for the form field.
the additional action dictionary
Sets options for the form field.
Sets options for the form field. Only to be used for checkboxes and radio buttons.
an array of
objects that each represent
the 'on' state of one of the choices
the edited
Gets options for the form field.
Gets options for the form field. Should only return usable values for
checkboxes and radio buttons.
the options, as an
of
objects
Gets all
that its children refer to.
a list of
Gets all child form field's annotations
of this form field.
a list of
Gets a single child form field's annotation
.
or null if there are no child annotations
Updates DA for Variable text, Push button and choice form fields.
Updates DA for Variable text, Push button and choice form fields.
The resources required for DA will be put to AcroForm's DR.
Note, for other form field types DA will be removed.
Gets a code specifying the form of quadding (justification) to be used in displaying the text:
0 Left-justified
1 Centered
2 Right-justified
the current justification attribute
Sets a code specifying the form of quadding (justification) to be used in displaying the text:
0 Left-justified
1 Centered
2 Right-justified
the value to set the justification attribute to
the edited
Gets a default style string, as described in "Rich Text Strings" section of Pdf spec.
the default style, as a
Sets a default style string, as described in "Rich Text Strings" section of Pdf spec.
a new default style for the form field
the edited
Gets a rich text string, as described in "Rich Text Strings" section of Pdf spec.
Gets a rich text string, as described in "Rich Text Strings" section of Pdf spec.
It may be either
or
.
the current rich text value
Sets a rich text string, as described in "Rich Text Strings" section of Pdf spec.
Sets a rich text string, as described in "Rich Text Strings" section of Pdf spec.
It may be either
or
.
a new rich text value
the edited
Changes the type of graphical marker used to mark a checkbox as 'on'.
Changes the type of graphical marker used to mark a checkbox as 'on'.
Notice that in order to complete the change one should call
regenerateField
method.
the new checkbox marker
the edited
Sets the ReadOnly flag, specifying whether the field can be changed.
if true, then the field cannot be changed
the edited
Gets the ReadOnly flag, specifying whether the field can be changed.
true if the field cannot be changed
Sets the Required flag, specifying whether the field must be filled in.
if true, then the field must be filled in
the edited
.
Gets the Required flag, specifying whether the field must be filled in.
true if the field must be filled in
Sets the NoExport flag, specifying whether exporting is forbidden.
if true, then exporting is forbidden
the edited
Gets the NoExport attribute.
whether exporting the value following a form action is forbidden
Checks if the document that contains the field is created in reading mode.
true if reading mode is used, false otherwise
Adds a field to the children of the current field.
the field, which should become a child
the kid itself
Replaces /Kids value with passed kids dictionaries, and keeps old flashed fields there.
Replaces /Kids value with passed kids dictionaries, and keeps old flashed fields there.
Also updates childFields array for
.
collection of new kids
Distinguish mutually exclusive and regular checkboxes: check all the on states of the widgets, if they are
not all equal, then consider that this checkbox is mutually exclusive and do nothing, otherwise regenerate
normal appearance with value as on appearance state for all the widgets.
not empty value different from "Off"
boolean value indicating whether checkbox appearance was generated
Puts object directly to AcroForm dictionary.
Puts object directly to AcroForm dictionary.
It works much faster than consequent invocation of
and
.
Note, this method assume that Catalog already has AcroForm object.
should be called explicitly.
the key of the object
the object to add
Utility class to merge form fields
with the same names.
This method merges all kids with the same names for the given parent field dictionary (recursively).
a field whose kids should be checked and merged in case of same partial names.
true if the exception is expected after the merge failed, false if log is expected.
This method merges different values from two field dictionaries into the first one and combines kids.
a field into which dictionary all values will be merged.
a field whose values should be merged into the first dictionary.
true if the exception is expected after the merge failed, false if log is expected.
true if fields is successfully merged, false otherwise.
Gets partial name for the field dictionary.
field to get name from.
field partial name. Also, null if passed dictionary is a pure widget,
empty string in case it is a field with no /T entry.
Sometimes widgets contain field related keys, and they are the same as these field keys at parent.
Sometimes widgets contain field related keys, and they are the same as these field keys at parent.
During merge process we get something like: ParentField
(/DA <DA1> /Ft <Tx> /T <test> /Kids <Field>) ->
Field
(/DA <DA1> /Kids <Annotation>) ->
Annotation (without any form fields)
This method combines ParentField with Field.
a field whose form field kids should be checked and merged with parent in case
all their dictionary values (except Parent and Kids) are the same
or parent is a radio button.
true if the exception is expected after the merge failed, false if log is expected.
This method combines two form fields.
first form field to be merged
second form field to be merged
define whether exception (true) or log (false) is expected in case kid with
the same name exists and merge of two kids failed.
An AcroForm field containing signature data.
Indicates if we need to reuse the existing appearance as a background layer.
Indicates if we need to ignore page rotation for the signature field annotation.
Background level of the signature appearance.
Signature appearance layer that contains information about the signature.
Creates a minimal
.
The
instance.
Creates a signature form field as a parent of a
.
The widget which will be a kid of the
.
The
instance.
Creates a signature form field as a wrapper object around a
.
Creates a signature form field as a wrapper object around a
.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference.
Returns Sig, the form type for signature form fields.
the form type, as a
Adds the signature to the signature field.
the signature to be contained in the signature field, or an indirect reference to it
the edited field
Gets the
, which contains fields that
must be locked if the document is signed.
a dictionary containing locked fields.
Sets the background layer that is present when creating the signature field.
layer xObject.
this same
instance.
Sets 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.
layer xObject.
this same
instance.
Indicates that the existing appearances needs to be reused as a background.
is an appearances reusing flag value to set.
this same
instance.
Sets the boolean value which indicates if page rotation should be ignored for the signature appearance.
Sets the boolean value which indicates if page rotation should be ignored for the signature appearance.
Default value is
.
boolean value to set.
this same
instance.
Gets the background layer that is present when creating the signature field if it was set.
n0 layer xObject.
Gets the signature appearance layer that contains information about the signature if it was set.
n2 layer xObject.
Indicates if the existing appearances needs to be reused as a background.
appearances reusing flag value.
Indicates if page rotation should be ignored for the signature appearance.
the boolean value which indicates if we need to ignore page rotation for the signature appearance.
An AcroForm field containing textual data.
constant which determines whether field currently represents a path.
constant which determines whether spell-checking is currently enabled
constant which determines whether longer texts are currently allowed.
constant which determines maximum length of the field's text.
constant which determines whether text is currently represented as rich text.
Creates a minimal
.
The
instance.
Creates a text form field as a parent of a
.
The widget which will be a kid of the
.
The
instance.
Creates a text form field as a wrapper object around a
.
Creates a text form field as a wrapper object around a
.
This
must be an indirect object.
the dictionary to be wrapped, must have an indirect reference.
Returns Tx, the form type for textual form fields.
the form type, as a
If true, the field can contain multiple lines of text; if false, the field?s text is restricted to a single line.
whether or not the file can contain multiple lines of text
current
If true, the field is intended for entering a secure password that should not be echoed visibly to the screen.
If true, the field is intended for entering a secure password that should not be echoed visibly to the screen.
Characters typed from the keyboard should instead be echoed in some unreadable form, such as asterisks or bullet characters.
whether or not to obscure the typed characters
current
If true, the text entered in the field represents the pathname of a file
whose contents are to be submitted as the value of the field.
whether or not this field currently represents a path
If true, the text entered in the field represents the pathname of a file
whose contents are to be submitted as the value of the field.
whether or not this field should represent a path
current
If true, text entered in the field is spell-checked.
whether or not spell-checking is currently enabled
If true, text entered in the field is spell-checked.
whether or not to spell-check
current
If true, the field scrolls (horizontally for single-line fields, vertically for multiple-line fields)
to accommodate more text than fits within its annotation rectangle.
If true, the field scrolls (horizontally for single-line fields, vertically for multiple-line fields)
to accommodate more text than fits within its annotation rectangle.
Once the field is full, no further text is accepted.
whether or not longer texts are currently allowed
If true, the field scrolls (horizontally for single-line fields, vertically for multiple-line fields)
to accommodate more text than fits within its annotation rectangle.
If true, the field scrolls (horizontally for single-line fields, vertically for multiple-line fields)
to accommodate more text than fits within its annotation rectangle.
Once the field is full, no further text is accepted.
whether or not to allow longer texts
current
Meaningful only if the MaxLen entry is present in the text field dictionary
and if the Multiline, Password, and FileSelect flags are clear.
Meaningful only if the MaxLen entry is present in the text field dictionary
and if the Multiline, Password, and FileSelect flags are clear.
If true, the field is automatically divided into as many equally spaced positions,
or combs, as the value of MaxLen, and the text is laid out into those combs.
if combing is enabled,
otherwise
Meaningful only if the MaxLen entry is present in the text field dictionary
and if the Multiline, Password, and FileSelect flags are clear.
Meaningful only if the MaxLen entry is present in the text field dictionary
and if the Multiline, Password, and FileSelect flags are clear.
If true, the field is automatically divided into as many equally spaced positions,
or combs, as the value of MaxLen, and the text is laid out into those combs.
whether or not to enable combing
current
If true, the value of this field should be represented as a rich text string.
If true, the value of this field should be represented as a rich text string.
If the field has a value, the RV entry of the field dictionary specifies the rich text string.
whether or not text is currently represented as rich text
If true, the value of this field should be represented as a rich text string.
If true, the value of this field should be represented as a rich text string.
If the field has a value, the RV entry of the field dictionary specifies the rich text string.
whether or not to represent text as rich text
current
Gets the maximum length of the field's text, in characters.
Gets the maximum length of the field's text, in characters.
This is an optional parameter, so if it is not specified, 0 value will be returned.
the current maximum text length
Sets the maximum length of the field's text, in characters.
the maximum text length
current
Enum representing possible values for check box mark drawing.
Class representing the signature text identifying the signer.
The reason for signing.
Holds value of property location.
The name of the signer from the certificate.
Holds value of property signDate.
Creates a new
instance.
Returns the signing reason.
reason for signing.
Sets the signing reason.
Sets the signing reason.
Note, that this reason won't be passed to the signature dictionary. If none is set, value set by
PdfSigner#setReason
will be used.
signing reason.
this same
instance.
Returns the signing location.
signing location.
Sets the signing location.
Sets the signing location.
Note, that this location won't be passed to the signature dictionary. If none is set, value set by
PdfSigner#setLocation
will be used.
new signing location
this same
instance
Sets the name of the signer from the certificate.
Sets the name of the signer from the certificate.
Note, that the signer name will be replaced by the one from the signing certificate during the actual signing.
name of the signer
this same
instance
Gets the name of the signer from the certificate.
signedBy name of the signer
Returns the signature date.
the signature date
Sets the signature date.
Sets the signature date.
Note, that the signing date will be replaced by the one from the
PdfSigner
during the signing.
new signature date
this same
instance
Generates the signature description text based on the provided parameters.
signature description
Builder for push button form field.
Creates builder for
creation.
document to be used for form field creation
name of the form field
Gets caption for button form field creation.
caption value to be used for form field creation
Sets caption for button form field creation.
caption value to be used for form field creation
this builder
Creates push button form field base on provided parameters.
new
instance
Builder for radio form field.
Creates builder for radio form field creation.
document to be used for form field creation
name of the form field
Creates radio group form field instance based on provided parameters.
new
instance
Creates radio button form field instance based on provided parameters.
name of the "on" appearance state.
the place where the widget should be placed.
new radio button instance
Builder for signature form field.
Creates builder for
creation.
document to be used for form field creation
name of the form field
Creates signature form field based on provided parameters.
new
instance.
Builder for terminal form field.
specific terminal form field builder which extends this class.
Rectangle which defines widget placement.
Page number to place widget at.
Creates builder for terminal form field creation.
document to be used for form field creation
name of the form field
Gets rectangle which defines widget's placement.
instance of
for widget placement
Gets page to be used for widget creation.
number of page to place widget at
Sets page to be used for widget creation.
instance of
. Shall belong to already provided
this builder
Sets page to be used for widget creation.
number of page to place widget at
this builder
Sets rectangle which defines widget's placement.
instance of
for widget placement
this builder
Set font to be used for form field creation.
instance of
.
this builder
Get font to be used for form field creation.
instance of
.
Builder for text form field.
Creates builder for
creation.
document to be used for form field creation
name of the form field
Creates text form field based on provided parameters.
new
instance
Creates multiline text form field based on provided parameters.
new
instance
The
class is used to create a specific forms related instance of the
class.
Represents the role: radio.
Represents the role: Checkbox.
Represents the role: PushButton.
Represents the role: ListBox.
Represents the role: Text.
Represents the role: Text. This can be passwords, text areas, etc.
Instantiates a new
instance based on structure element role.
the type of the formField
Updates the checked value of the form field based on the
property.
Updates the checked value of the form field based on the
property.
If no such property is found, the checked value is set to "off".
The element which contains a
property.
An abstract class for fields that represents a control for selecting one or several of the provided options.
Instantiates a new
instance.
the id of the field
Add an option to the element.
a
Add an option to the element.
a
is the option if selected,
otherwise
Get a list of
.
a list of options.
Gets the total amount of options available.
the number of options in the element.
Checks if the element has any options.
true if the element has options, false otherwise.
Get an option
by its string value.
string value to find an option by
a
.
Checks if the field has options with export and display values.
if the field has options with export and display values,
otherwise.
Extension of the
class representing a button in html.
Indicates if it's the button with only single line caption.
Creates a new
instance.
the id
Adds any block element to the div's contents.
a
this Element
Adds an image to the div's contents.
an
this Element
Indicates if this element represents an input with type button in html.
true if it's the button with only one line caption.
Sets passed string value to the single line button caption.
Sets passed string value to the single line button caption.
Value will be clipped if it is not fit into single line. For multiple line value
use
. Note that when adding other elements to the button
after this method is called, this added value can be multiline.
string value to be set as caption.
this same
instance.
Adds passed string value as paragraph to the button.
Adds passed string value as paragraph to the button.
Value can be multiline if it is not fit into single line. For single line value
use
. Note that the new value will replace all already added elements.
string value to be added into button.
Extension of the
class representing a checkbox so that
a
is used instead of the default renderer for fields.
Creates a new
instance.
the id
Sets the checked state of the checkbox.
the checked state to set
this checkbox instance
Sets the conformance for the checkbox.
The PDF conformance to set.
this checkbox instance
Sets the icon of the checkbox.
the type of the checkbox to set
this checkbox instance
Sets the size of the checkbox.
the size of the checkbox to set, in points
this checkbox instance
A field that represents a control for selecting one of the provided options.
Creates a new select field box.
the id
Gets the export value of the selected option.
the export value of the selected option. This may be null if no value has been selected.
Selects an option by its index.
Selects an option by its index. The index is zero-based.
the index of the option to select.
this
instance.
Selects an option by its export value.
the export value of the option to select.
this
instance.
Selects an option by its value.
Selects an option by its value. This will use the export value of the
option to match it to existing options.
the option to select.
this
instance.
Add an option to the element.
a
.
Gets the selected option.
the selected option. This may be null if no option has been selected.
Implementation of the
class for form fields.
the generic type of the form field (e.g. input field, button, text area)
The id.
The tag properties.
Instantiates a new
instance.
the id
Sets the form field's width and height.
form field's width and height.
this same
element.
Sets the form field's alternative description.
form field's alternative description.
this same
element.
Common interface for HTML form elements.
Sets the
property.
string value of the property to be set
this same
instance
Set the form field to be interactive and added into Acroform instead of drawing it on a page.
if the form field element shall be added into Acroform,
otherwise.
By default, the form field element is not interactive and drawn on a page
this same
instance
Gets the id.
the id
Set the form field's width.
form field's width
this
element
Set the form field's height.
form field's height
this
element
Extension of the
class representing a button so that
a
is used.
Default padding X offset.
The placeholder paragraph.
Field rotation, counterclockwise.
Field rotation, counterclockwise. Must be a multiple of 90 degrees.
Creates a new input field.
the id
Determines, whether the input field will be password.
Determines, whether the input field will be password.
Usually means that instead of glyphs '*' will be shown in case of flatten field.
If the field is not flatten, value will be ignored.
is this field shall be considered as password,
otherwise
this input field
Get rotation.
rotation value.
Set rotation of the input field.
new rotation value, counterclockwise. Must be a multiple of 90 degrees.
It has sense only in interactive mode, see
the edited
Sets
Comb
flag for the text field.
Sets
Comb
flag for the text field. Meaningful only if the MaxLen entry is present in the text field
dictionary and if the Multiline, Password and FileSelect flags are clear.
If true, the field is automatically divided into as many equally spaced positions, or combs,
as the value of MaxLen, and the text is laid out into those combs.
boolean value specifying whether to enable combing
this
instance
Sets the maximum length of the field's text, in characters.
the current maximum text length
this
instance
A marker interface that specifies that the layout object has placeholder.
Gets the placeholder paragraph.
the placeholder paragraph
Sets the placeholder paragraph.
the paragraph to be used as placeholder
A field that represents a control for selecting one or several of the provided options.
Create a new list box field.
the size of the list box, which will define the height of visible properties,
shall be greater than zero
a boolean flag that defines whether multiple options are allowed
to be selected at once
the id
Add an option for
.
Add an option for
. The option is not selected.
string representation of the option.
this
.
Add an option for
.
string representation of the option.
is the option if selected,
otherwise.
this
.
Get a list of selected options.
a list of display values of selected options.
Sets the index of the first visible option in a scrollable list.
the index of the first option
this
instance
Extension of the
class representing a radio button so that
a
is used instead of the default renderer for fields.
Creates a new
instance.
the id.
Creates a new
instance.
the id.
the name of the radio group the radio button belongs to. It has sense only in case
this Radio element will not be rendered but Acroform field will be created instead.
Sets the state of the radio button.
if the radio button shall be checked,
otherwise.
By default, the radio button is unchecked.
this same
button.
A field that represents a control for selecting one of the provided options.
A field that represents a control for selecting one of the provided options.
It is used in the
class.
The export value of the item.
The export value of the item.
this is the value of the form which will be submitted. If the display value is not set, the export value will be
used as display value.
The display value of the item.
The display value of the item.
This is the value which will be displayed in the dropdown.
The option element of the item.
The option element of the item.
This is the element which will be displayed in the dropdown.
It allows for customization
Create a new
.
the export value of the item.
the display value of the item.
Create a new
.
the export value of the item.
Create a new
.
the export value of the item.
the option element of the item.
Create a new
.
the export value of the item.
the display value of the item.
the option element of the item.
Get the export value of the item.
export value.
Get the display value of the item.
Get the display value of the item.
If the display value is not set, the export value will be used as display value.
display value.
Get the option element of the item.
Get the option element of the item.
This is the element which will be displayed in the dropdown.
It allows for customization.
option element.
Check if the item has a display value.
Check if the item has a display value. and export value.
if the item has both export and display values,
otherwise.
Extension of the
class representing a signature field in PDF.
Default paddings for the signature field.
Collection of the layout elements which will be rendered as a signature content.
We should support signing of existing fields with dots in name, but dots are now allowed in model element id.
We should support signing of existing fields with dots in name, but dots are now allowed in model element id.
So it is a placeholder for such cases.
Creates a new
instance.
signature field name if you use this
in pure layout for the new
interactive signature field creation. ID will be ignored if this
is used for signing or for existing signature field
Sets the content for this signature.
instance representing the signature text identifying the signer.
this same
instance.
Sets the content for this signature.
the signature text identifying the signer.
this same
instance.
Sets the content for this signature.
instance representing the signature text identifying the signer.
the Image object to render.
this same
instance.
Sets the content for this signature.
the signature text identifying the signer.
the Image object to render.
this same
instance.
Sets the content for this signature.
the Image object to render.
this same
instance.
Sets the content for this signature.
the name of the signer from the certificate.
instance representing the signature text identifying the signer.
this same
instance.
Sets the content for this signature.
the name of the signer from the certificate.
the signature text identifying the signer.
this same
instance.
Sets the content for this signature.
the custom signature data which will be rendered.
this same
instance.
Gets the final content for this signature.
collection of the layout elements which will be rendered as a signature content.
Gets the
instance for this signature.
instance if it was set by
, null otherwise.
Replaces the signer name for this signature if it was set by
.
signer name to set.
Extension of the
class representing a button so that
a
is used instead of the default renderer for fields.
Default padding X offset.
The placeholder paragraph.
Creates a new
instance.
the id
Set of constants that will be used as keys to get and set properties.
The Constant PROPERTY_START.
The Constant FORM_FIELD_FLATTEN for form related properties.
The Constant FORM_FIELD_SIZE.
The Constant FORM_FIELD_VALUE.
The Constant FORM_FIELD_PASSWORD_FLAG.
The Constant FORM_FIELD_COLS.
The Constant FORM_FIELD_ROWS.
The Constant FORM_FIELD_CHECKED.
The Constant FORM_FIELD_MULTIPLE.
The Constant FORM_FIELD_SELECTED.
The Constant FORM_FIELD_LABEL.
The Constant FORM_FIELD_RADIO_GROUP_NAME.
The Constant FORM_FIELD_RADIO_BORDER_CIRCLE.
The Constant FORM_CHECKBOX_TYPE.
The Constant FORM_CONFORMANCE_LEVEL.
The Constant LIST_BOX_TOP_INDEX representing the index of the first visible option in a scrollable list.
The Constant TEXT_FIELD_COMB_FLAG representing
Comb
flag for the text field.
The Constant TEXT_FIELD_MAX_LEN representing the maximum length of the field's text, in characters.
Abstract
for form fields.
The flat renderer.
Creates a new
instance.
the model element
Checks if form fields need to be flattened.
true, if fields need to be flattened.
Gets the default value of the form field.
the default value of the form field.
Applies the accessibility properties to the form field.
the form field to which the accessibility properties should be applied
the document to which the form field belongs
Adjusts the field layout.
layout context
Creates the flat renderer instance.
the renderer instance.
Applies the AcroField widget.
the draw context
Gets the model id.
the model id.
Checks if the renderer fits a certain width and height.
the available width
the available height
true, if the renderer fits.
Gets the accessibility language using
.
the accessibility language.
Gets the conformance.
Gets the conformance. If the conformance is not set, the conformance of the document is used.
the document
the conformance or null if the conformance is not set.
Determines, whether the layout is based in the renderer itself or flat renderer.
if layout is based on flat renderer, false otherwise.
Sets the form accessibility language identifier of the form element in case the document is tagged.
the document which contains form field
Abstract
for a single line of text content in a form field.
Creates a new
instance.
the model element
Crops the content lines.
a list of lines
the bounding box
Updates the paragraph height.
Sets the content height.
the flat renderer
the height
Abstract
for select form fields.
Creates a new
instance.
the model element
Gets the accessibility language using
.
the accessibility language.
Sets the form accessibility language identifier of the form element in case the document is tagged.
the document which contains form field.
Applies the accessibility properties to the form field.
the form field to which the accessibility properties should be applied
the document to which the form field belongs
Creates the flat renderer instance.
instance.
Applies the AcroField widget.
the draw context
Checks if form fields need to be flattened.
true, if fields need to be flattened.
Gets the model id.
the model id.
Retrieve the options from select field (can be combo box or list box field) and set them
to the form field builder.
to set options to
to retrieve the options from
Returns final height of the select field.
available height of the layout area
actual occupied height of the select field
indicates whether the layout area's height is clipped or not
final height of the select field.
Gets the conformance.
Gets the conformance. If the conformance is not set, the conformance of the document is used.
the document
the conformance or null if the conformance is not set.
Gets options that are marked as selected from the select field options subtree.
options subtree to get selected options
selected options list.
Abstract
for form fields with text content.
The font to be used for the text.
Creates a new
instance.
the model element
Creates a paragraph renderer.
the default value
the renderer
Applies the default field properties.
the input field
Updates the font.
the renderer
Approximates font size to fit occupied area if width anf height are specified.
layout context that specifies layout area.
minimal font size value.
maximum font size value.
fitting font size or -1 in case it shouldn't be approximated.
Adjust number of content lines.
the lines that need to be rendered
the bounding box
the desired number of lines
Adjust number of content lines.
the lines that need to be rendered
the bounding box
the desired height of content
Gets the value of the lowest bottom coordinate for all field's children recursively.
the lowest child bottom.
The
implementation for buttons.
Default padding Y offset for an input button.
Relative value is quite big in order to preserve visible padding on small field sizes.
Relative value is quite big in order to preserve visible padding on small field sizes.
This constant is taken arbitrary, based on visual similarity to Acrobat behaviour.
Indicates if the one line caption was split.
Creates a new
instance.
the model element
Gets the default value of the form field.
the default value of the form field.
This class is used to draw a checkBox icon in HTML mode.
Creates a new
instance.
This interface is used to draw a checkBox icon.
Draws a check box icon.
the draw context
the checkBox renderer
the rectangle where the icon should be drawn
This class is used to draw a checkBox icon in PDF/A mode.
Creates a new
instance.
This class is used to draw a checkBox icon in PDF mode this is the default strategy for drawing a checkBox.
Creates a new
instance.
The
implementation for checkboxes.
Creates a new
instance.
the model element
Gets the rendering mode of the checkbox.
the rendering mode of the checkbox
Gets the checkBoxType.
the checkBoxType
creates a ICheckBoxRenderingStrategy based on the current settings.
the ICheckBoxRenderingStrategy
Defines whether the box is checked or not.
the default value of the checkbox field
Adjusts the field layout.
layout context
Applies given paddings to the given rectangle.
Applies given paddings to the given rectangle.
Checkboxes don't support setting of paddings as they are always centered.
So that this method returns the rectangle as is.
a rectangle paddings will be applied on.
the paddings to be applied on the given rectangle
indicates whether paddings will be applied
inside (in case of false) or outside (in case of true) the rectangle.
The rectangle NOT modified by the paddings.
Creates a flat renderer for the checkbox.
an IRenderer object for the flat renderer
A flat renderer for the checkbox.
Creates a new
instance.
the model element
Custom implementation for rendering form field values.
Custom implementation for rendering form field values. It makes sure that text value
trimming strategy matches Acrobat's behavior
The
implementation for input fields.
Creates a new
instance.
the model element
Gets the size of the input field.
the input field size
Checks if the input field is a password field.
true, if the input field is a password field
Checks if the input field is a comb field.
true, if the input field is a comb field
Gets the maximum length of the field's text, in characters.
the current maximum text length
Obfuscates the content of a password input field.
the password
a string consisting of '*' characters.
The
implementation for radio buttons.
Creates a new
instance.
the model element
Defines whether the radio is checked or not.
the default value of the radio field
The
implementation for select field renderer.
Creates a new
instance.
the model element
The
implementation for select field renderer.
Creates a new
instance.
the model element
The `select` tag has default color css property,
therefore it makes sense to explicitly override this property to all children,
otherwise it will be not applied due to the css resolving mechanism.
The
implementation for SigFields.
Extra space at the top.
Creates a new
instance.
the model element
Gets the default value of the form field.
the default value of the form field.
Signature display options.
The display option is just the description.
The display option is the name of the signer and the description.
The display option is an image and the description.
The display option is just an image.
The display option is div.
The
implementation for text area fields.
Creates a new
instance.
the model element
Gets the number of columns.
the cols value of the text area field
Gets the number of rows.
the rows value of the text area field
Class containing constants to be used in logging in forms module.
This class represents the static form technology AcroForm on a PDF file.
To be used with
.
To be used with
.
If set, the document contains at least one signature field. This flag
allows a conforming reader to enable user interface items (such as menu
items or pushbuttons) related to signature processing without having to
scan the entire document for the presence of signature fields.
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
To be used with
.
To be used with
.
If set, the document contains signatures that may be invalidated if the
file is saved (written) in a way that alters its previous contents, as
opposed to an incremental update. Merely updating the file by appending
new information to the end of the previous version is safe. Conforming
readers may use this flag to inform a user requesting a full save that
signatures will be invalidated and require explicit confirmation before
continuing with the operation.
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
Keeps track of whether or not appearances must be generated by the form
fields themselves, or by the PDF viewer application.
Keeps track of whether or not appearances must be generated by the form
fields themselves, or by the PDF viewer application. Default is
true.
A map of field names and their associated
form field
objects.
The PdfDocument to which the PdfAcroForm belongs.
Creates a PdfAcroForm as a wrapper of a dictionary.
Creates a PdfAcroForm as a wrapper of a dictionary.
Also initializes an XFA form if an /XFA entry is present in
the dictionary.
the PdfDictionary to be wrapped
Creates a PdfAcroForm from a
of fields.
Creates a PdfAcroForm from a
of fields.
Also initializes an empty XFA form.
a
of
objects
Retrieves AcroForm from the document.
Retrieves AcroForm from the document. If there is no AcroForm in the
document Catalog and createIfNotExist flag is true then the AcroForm
dictionary will be created and added to the document.
the document to retrieve the
from
when true, this method will create a
if none exists
for this document
the
document
's AcroForm,
or a new one provided that createIfNotExist parameter is true, otherwise
null.
Retrieves AcroForm from the document.
Retrieves AcroForm from the document. If there is no AcroForm in the
document Catalog and createIfNotExist flag is true then the AcroForm
dictionary will be created and added to the document.
the document to retrieve the
from
when true, this method will create a
if none
exists for
this document
the strategy to be used when a field with the same name already exists
the
document
's AcroForm,
or a new one provided that createIfNotExist parameter is true, otherwise
null.
This method adds the field to the last page in the document.
This method adds the field to the last page in the document.
If there's no pages, creates a new one.
the
to be added to the form
This method adds the field to a specific page.
the
to be added to the form
the
on which to add the field
This method adds the field to a specific page.
the
to be added to the form
the
on which to add the field
true if the exception is expected to be thrown in case of error.
This method merges field with its annotation and places it on the given
page.
This method merges field with its annotation and places it on the given
page. This method also work if the field has more than one widget
annotation, but doesn't work with no annotations.
the
to be added to the form
the
on which to add the field
Gets root fields (i.e. direct children of Acroform dictionary).
a map of field names and their associated
form field
objects
Gets all
form field
s as a
including fields kids.
a map of field names and their associated
form field
objects
Gets all
form field
s as a
including fields kids and nameless fields.
a set of
form field
objects.
Gets a collection of
form field
s, prepared for flattening using
method.
Gets a collection of
form field
s, prepared for flattening using
method.
If returned collection is empty, all form fields will be flattened on
flattenFields
call.
a collection of
form field
s for flattening
Gets the
this
belongs to.
the document of this form
Sets the NeedAppearances boolean property on the AcroForm.
Sets the NeedAppearances boolean property on the AcroForm.
NeedAppearances has been deprecated in PDF 2.0.
NeedAppearances is a flag specifying whether to construct appearance
streams and appearance dictionaries for all widget annotations in the
document.
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
a boolean. Default value is false
current AcroForm.
Gets the NeedAppearances boolean property on the AcroForm.
Gets the NeedAppearances boolean property on the AcroForm.
NeedAppearances has been deprecated in PDF 2.0.
NeedAppearances is a flag specifying whether to construct appearance
streams and appearance dictionaries for all widget annotations in the
document.
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
the NeedAppearances property as a
. Default value is false
Sets the SigFlags integer property on the AcroForm.
Sets the SigFlags integer property on the AcroForm.
SigFlags is a set of flags specifying various document-level
characteristics related to signature fields.
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
an integer. Use
and/or
.
Use bitwise OR operator to combine these values. Default value is 0
current AcroForm.
Changes the SigFlags integer property on the AcroForm.
Changes the SigFlags integer property on the AcroForm.
This method allows only to add flags, not to remove them.
SigFlags is a set of flags specifying various document-level
characteristics related to signature fields.
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
an integer. Use
and/or
.
Use bitwise OR operator to combine these values. Default is 0
current AcroForm.
Gets the SigFlags integer property on the AcroForm.
Gets the SigFlags integer property on the AcroForm.
SigFlags is a set of flags specifying various document-level
characteristics related to signature fields
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
current value for SigFlags.
Sets the CO array property on the AcroForm.
Sets the CO array property on the AcroForm.
CO, Calculation Order, is an array of indirect references to
field dictionaries with calculation actions, defining the calculation
order in which their values will be recalculated when the value of any
field changes
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
an array of indirect references
current AcroForm
Gets the CO array property on the AcroForm.
Gets the CO array property on the AcroForm.
CO, Calculation Order, is an array of indirect references to
field dictionaries with calculation actions, defining the calculation
order in which their values will be recalculated when the value of any
field changes
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
an array of indirect references
Sets the DR dictionary property on the AcroForm.
Sets the DR dictionary property on the AcroForm.
DR is a resource dictionary containing default resources
(such as fonts, patterns, or colour spaces) that shall be used by form
field appearance streams. At a minimum, this dictionary shall contain a
Font entry specifying the resource name and font dictionary of the
default font for displaying text.
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
a resource dictionary
current AcroForm
Gets the DR dictionary property on the AcroForm.
Gets the DR dictionary property on the AcroForm.
DR is a resource dictionary containing default resources
(such as fonts, patterns, or colour spaces) that shall be used by form
field appearance streams. At a minimum, this dictionary shall contain a
Font entry specifying the resource name and font dictionary of the
default font for displaying text.
(ISO 32000-1, section 12.7.2 "Interactive Form Dictionary")
a resource dictionary
Sets the DA String property on the AcroForm.
Sets the DA String property on the AcroForm.
This method sets a default (fallback value) for the DA
attribute of variable text
form field
s.
a String containing a sequence of valid PDF syntax
current AcroForm
Gets the DA String property on the AcroForm.
Gets the DA String property on the AcroForm.
This method returns the default (fallback value) for the DA
attribute of variable text
form field
s.
the form-wide default appearance, as a String
Sets the Q integer property on the AcroForm.
Sets the Q integer property on the AcroForm.
This method sets a default (fallback value) for the Q
attribute of variable text
form field
s.
an integer representing a justification value
current AcroForm
Gets the Q integer property on the AcroForm.
Gets the Q integer property on the AcroForm.
This method gets the default (fallback value) for the Q
attribute of variable text
form field
s.
an integer representing a justification value
Sets the XFA property on the AcroForm.
Sets the XFA property on the AcroForm.
XFA can either be a
or a
.
Its contents must be valid XFA.
a stream containing the XDP
current AcroForm
Sets the XFA property on the AcroForm.
Sets the XFA property on the AcroForm.
XFA can either be a
or a
.
Its contents must be valid XFA.
an array of text string and stream pairs representing
the individual packets comprising the XML Data Package. (ISO 32000-1,
section 12.7.2 "Interactive Form Dictionary")
current AcroForm
Gets the XFA property on the AcroForm.
an object representing the entire XDP. It can either be a
or a
.
Gets a
form field
by its name.
the name of the
form field
to retrieve
the
form field
, or null if it
isn't present
Gets the attribute generateAppearance, which tells
to generate an appearance Stream for all
form field
s
that don't have one.
bolean value indicating if the appearances need to be generated
Sets the attribute generateAppearance, which tells
to generate an appearance Stream for all
form field
s
that don't have one.
Sets the attribute generateAppearance, which tells
to generate an appearance Stream for all
form field
s
that don't have one.
Not generating appearances will speed up form flattening but the results
can be unexpected in Acrobat. Don't use it unless your environment is
well controlled. The default is true.
If generateAppearance is set to true, then
NeedAppearances is set to false. This does not
apply vice versa.
Note, this method does not change default behaviour of
method.
a boolean
Flattens interactive
form field
s in the document.
Flattens interactive
form field
s in the document. If
no fields have been explicitly included via
,
then all fields are flattened. Otherwise only the included fields are
flattened.
Tries to remove the
form field
with the specified
name from the document.
the name of the
form field
to remove
a boolean representing whether or not the removal succeeded.
Adds a
form field
, identified by name, to the list of fields to be flattened.
Adds a
form field
, identified by name, to the list of fields to be flattened.
Does not perform a flattening operation in itself.
the name of the
form field
to be flattened
Changes the identifier of a
form field.
the current name of the field
the new name of the field. Must not be used currently.
Creates an in-memory copy of a
.
Creates an in-memory copy of a
. This new field is
not added to the document.
the name of the
form field
to be copied
a clone of the original
Replaces the
of a certain name with another
.
the name of the
form field
to be replaced
the new
Disables appearance stream regeneration for all the root fields in the Acroform, so all of its children
in the hierarchy will also not be regenerated.
Enables appearance stream regeneration for all the fields in the Acroform and regenerates them.
Gets all AcroForm fields in the document.
a
of field dictionaries
Determines whether the AcroForm contains XFA data.
a boolean
Gets the
atribute.
the XFA form object
Removes the XFA stream from the document.
Put a key/value pair in the dictionary and overwrite previous value if it already exists.
the key as pdf name
the value as pdf object
this
instance
Releases underlying pdf object and other pdf entities used by wrapper.
Releases underlying pdf object and other pdf entities used by wrapper.
This method should be called instead of direct call to
if the wrapper is used.
A sample implementation of the {#link IPdfPageExtraCopier} interface which
copies only AcroForm fields to a new page.
A sample implementation of the {#link IPdfPageExtraCopier} interface which
copies only AcroForm fields to a new page.
NOTE: While it's absolutely not necessary to use the same PdfPageFormCopier instance for copying operations,
it is still worth to know that PdfPageFormCopier uses some caching logic which can potentially improve performance
in case of the reusing of the same instance.
A signature field lock dictionary.
A signature field lock dictionary. Specifies a set of form
fields that shall be locked when this signature field is
signed.
Creates an instance of
.
Creates an instance of
.
the dictionary whose entries should be added to
the signature field lock dictionary
Sets the permissions granted for the document when the corresponding signature
field is signed.
Sets the permissions granted for the document when the corresponding signature
field is signed. See
for getting more info.
the permissions granted for the document
this
object.
Sets signature lock for specific fields in the document.
indicates the set of fields that should be locked after the actual
signing of the corresponding signature takes place
names indicating the fields
this
object.
Returns the specified action of a signature field lock as
value.
the action as
the specified action of a signature field lock as
.
Returns the specified level of access permissions granted for the document as
value.
the level of access permissions as
the specified level of access permissions as
.
Enumerates the different actions of a signature field lock.
Enumerates the different actions of a signature field lock.
Indicates the set of fields that should be locked when the
corresponding signature field is signed:
- all the fields in the document,
- all the fields specified in the /Fields array,
- all the fields except those specified in the /Fields array.
This file is a helper class for the internal usage only.
This file is a helper class for the internal usage only.
Be aware that its API and functionality may be changed in the future.
Applies the border property to the annotation.
property container to apply border properties from.
the annotation to set border characteristics to.
Utility class to draw form fields
.
Draws a PDF A compliant check mark in the specified rectangle.
the canvas to draw on
the width of the rectangle
the height of the rectangle
the x coordinate of the bottom left corner of the rectangle
the y coordinate of the bottom left corner of the rectangle
Draws a PDF A compliant check mark in the specified rectangle.
the canvas to draw on
the width of the rectangle
the height of the rectangle
Draws a PDF A compliant circle in the specified rectangle.
the canvas to draw on
the width of the rectangle
the height of the rectangle
the x coordinate of the bottom left corner of the rectangle
the y coordinate of the bottom left corner of the rectangle
Draws a PDF A compliant circle in the specified rectangle.
the canvas to draw on
the width of the rectangle
the height of the rectangle
Draws a PDF A compliant cross in the specified rectangle.
the canvas to draw on
the width of the rectangle
the height of the rectangle
the x coordinate of the bottom left corner of the rectangle
the y coordinate of the bottom left corner of the rectangle
Draws a PDF A compliant cross in the specified rectangle.
the canvas to draw on
the width of the rectangle
the height of the rectangle
Draws a PDF A compliant diamond in the specified rectangle.
the canvas to draw on
the width of the rectangle
the height of the rectangle
the x coordinate of the bottom left corner of the rectangle
the y coordinate of the bottom left corner of the rectangle
Draws a PDF A compliant diamond in the specified rectangle.
the canvas to draw on
the width of the rectangle
the height of the rectangle
Draws a PDF A compliant square in the specified rectangle.
the canvas to draw on
the width of the rectangle
the height of the rectangle
the x coordinate of the bottom left corner of the rectangle
the y coordinate of the bottom left corner of the rectangle
Draws a PDF A compliant square in the specified rectangle.
the canvas to draw on
the width of the rectangle
the height of the rectangle
Draws a PDF A compliant star in the specified rectangle.
the canvas to draw on
the width of the rectangle
the height of the rectangle
the x coordinate of the bottom left corner of the rectangle
the y coordinate of the bottom left corner of the rectangle
Draws a PDF A compliant star in the specified rectangle.
the canvas to draw on
the width of the rectangle
the height of the rectangle
Draws a cross with the specified width and height.
the canvas to draw on
the width of the rectangle
the height of the rectangle
the width of the border
Draws a circle with the specified radius.
the canvas to draw on
the x coordinate of the center of the circle
the y coordinate of the center of the circle
the radius of the circle
Utility class for font size calculations.
Calculates the font size that will fit the text in the given rectangle.
the font to be used
the bounding box of the field
the value of the field
the minimum font size
the border width of the field
the font size that will fit the text in the given rectangle
Utility class for centralized logic related to form field rendering.
Creates a new instance of
.
Removes properties that impact the lay outing of interactive form fields.
The model element to remove the properties from.
A map containing the removed properties.
Reapplies the properties
.
The model element to reapply the properties to.
The properties to reapply.
Registers a default instance for a dependency injection container.
Creates an instance of
.
A class to process "classic" fields.
Creates a new instance from a Collection with the full names.
the Collection
Gets the mapping from short names to long names.
Gets the mapping from short names to long names. A long
name may contain the #subform name part.
the mapping from short names to long names
Sets the mapping from short names to long names.
Sets the mapping from short names to long names. A long
name may contain the #subform name part.
the mapping from short names to long names
A structure to store each part of a SOM name and link it to the next part
beginning from the lower hierarchy.
Gets the full name by traversing the hierarchy using only the
index 0.
the full name
Search the current node for a similar name.
Search the current node for a similar name. A similar name starts
with the same name but has a different index. For example, "detail[3]"
is similar to "detail[9]". The main use is to discard names that
correspond to out of bounds records.
the name to search
true if a similitude was found
Processes XFA forms.
The URI for the XFA Data schema.
An empty constructor to build on.
Creates an XFA form by the stream containing all xml information
The InputStream
Creates an XFA form by the
containing all xml information
The document
A constructor from a
. It is assumed, but not
necessary for correct initialization, that the dictionary is actually a
. An entry in the dictionary with the XFA
key must contain correct XFA syntax. If the XFA key is
absent, then the constructor essentially does nothing.
the dictionary object to initialize from
A constructor from a PdfDocument.
A constructor from a PdfDocument. It basically does everything
from finding the XFA stream to the XML parsing.
the PdfDocument instance
Sets the XFA key from a byte array.
Sets the XFA key from a byte array. The old XFA is erased.
the data
pdfDocument
Sets the XFA key from a byte array.
Sets the XFA key from a byte array. The old XFA is erased.
the data
an AcroForm instance
Extracts DOM nodes from an XFA document.
an XFA file as a
DOM
document
a
of XFA packet names and their associated
DOM nodes
Write the XfaForm to the provided PdfDocument.
the PdfDocument to write the XFA Form to
Write the XfaForm to the provided PdfDocument.
the PdfAcroForm to write the XFA Form to
Changes a field value in the XFA form.
the name of the field to be changed
the new value
Gets the xfa field value.
the fully qualified field name
the field value
Returns true if it is a XFA form.
true if it is a XFA form
Finds the complete field name from a partial name.
the complete or partial name
the complete name or null if not found
Finds the complete SOM name contained in the datasets section from a
possibly partial name.
the complete or partial name
the complete name or null if not found
Finds the Node contained in the datasets section from a
possibly partial name.
the complete or partial name
the Node or null if not found
Gets all the text contained in the child nodes of this node.
the Node
the text found or "" if no text was found
Gets all the text contained in the child nodes of the node under the provided path.
path to the node to extract text in the format "some.path.to.node"
text found under the provided path or null if node or text wasn't found
Sets the text of this node.
Sets the text of this node. All the child's node are deleted and a new
child text node is created.
the Node to add the text to
the text to add
Gets the top level DOM document.
the top level DOM document
Sets the top DOM document.
the top DOM document
Gets the Node that corresponds to the datasets part.
the Node that corresponds to the datasets part
Replaces the XFA data under datasets/data.
Replaces the XFA data under datasets/data. Accepts a
file
object
to fill this object with XFA data. The resulting DOM document may
be modified.
the
Replaces the XFA data under datasets/data.
Replaces the XFA data under datasets/data. Accepts a
file
object
to fill this object with XFA data.
the
whether or not the resulting DOM document may be modified
Replaces the XFA data under datasets/data.
Replaces the XFA data under datasets/data. Accepts an
to fill this object with XFA data. The resulting DOM document may be
modified.
the
Replaces the XFA data under datasets/data.
Replaces the XFA data under datasets/data. Accepts an
to fill this object with XFA data.
the
whether or not the resulting DOM document may be modified
Replaces the XFA data under datasets/data.
Replaces the XFA data under datasets/data. Accepts an
XML reader
to fill this object with XFA data. The resulting DOM
document may be modified.
the
XML reader
Replaces the XFA data under datasets/data.
Replaces the XFA data under datasets/data. Accepts an
XML reader
to fill this object with XFA data.
the
XML reader
whether or not the resulting DOM document may be modified
Replaces the XFA data under datasets/data.
the input
Replaces the XFA data under datasets/data.
the input
whether or not the resulting DOM document may be modified
Return the XFA Object, could be an array, could be a Stream.
Return the XFA Object, could be an array, could be a Stream.
Returns null if no XFA Object is present.
a PdfDocument instance
the XFA object
Return the XFA Object, could be an array, could be a Stream.
Return the XFA Object, could be an array, could be a Stream.
Returns null if no XFA Object is present.
a PdfAcroForm instance
the XFA object
Serializes a XML document to a byte array.
the XML document
the serialized XML document
Extracts the nodes from the domDocument.
Some XFA forms don't have a datasets node.
Some XFA forms don't have a datasets node.
If this is the case, we have to add one.
A class for some basic SOM processing.
The order the names appear in the XML, depth first.
The mapping of full names to nodes.
The data to do a search from the bottom hierarchy.
A som parts list in LIFO order as encountered when parsing dataset.
A temporary store for the repetition count.
Escapes a SOM string fragment replacing "." with "\.".
the unescaped string
the escaped string
Unescapes a SOM string fragment replacing "\." with ".".
the escaped string
the unescaped string
Outputs the som parts list as the sequence of elements separated
by '.'.
the som name
Gets the name with the #subform removed.
the long name
the short name
Adds a SOM name to the search node chain.
the SOM name
Adds a SOM name to the search node chain.
the start point
the list with the separated SOM parts in LIFO order
the full name
Searches the SOM hierarchy from the bottom.
the SOM parts
the full name or null if not found
Splits a SOM name in the individual parts.
the full SOM name
the split name
Gets the order the names appear in the XML, depth first.
the order the names appear in the XML, depth first
Sets the order the names appear in the XML, depth first
the order the names appear in the XML, depth first
Gets the mapping of full names to nodes.
the mapping of full names to nodes
Sets the mapping of full names to nodes.
the mapping of full names to nodes
Gets the data to do a search from the bottom hierarchy.
the data to do a search from the bottom hierarchy
Sets the data to do a search from the bottom hierarchy.
the data to do a search from the bottom hierarchy
Processes the datasets section in the XFA form.
Creates a new instance from the datasets node.
Creates a new instance from the datasets node. This expects
not the datasets but the data node that comes below.
the datasets node
Inserts a new Node that will match the short name.
the datasets top Node
the short name
the new Node of the inserted name
Represent Action tag in xfdf document structure.
Represent Action tag in xfdf document structure.
Content model: ( URI | Launch | GoTo | GoToR | Named ).
Attributes: none.
For more details see paragraph 6.5.1 in Xfdf specification.
Type of inner action element.
Type of inner action element. Possible values:
,
,
,
,
.
Represents Name, required attribute of URI element.
Represents Name, required attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
Represents IsMap, optional attribute of URI element.
Represents IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
Represents Name, required attribute of Named element.
Represents Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.
Represents OriginalName required attribute of File inner element of GoToR or Launch element.
Represents OriginalName required attribute of File inner element of GoToR or Launch element.
Corresponds to F key in go-to action or launch dictionaries.
For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification.
Represents NewWindow, optional attribute of Launch element.
Represents NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
Represents Dest, inner element of link, GoTo, and GoToR elements.
Represents Dest, inner element of link, GoTo, and GoToR elements.
Corresponds to Dest key in link annotation dictionary.
For more details see paragraph 6.5.10 in Xfdf specification.
Creates an instance of
.
type of inner action element. Possible values:
,
,
,
,
Returns the type of inner action element.
Returns the type of inner action element. Possible values:
,
,
,
,
.
type of inner action element.
Sets the type of inner action element.
Sets the type of inner action element. Possible values:
,
,
,
,
.
type of inner action object
current
.
Gets the string value of URI elements.
Gets the string value of URI elements. Corresponds to Name, required attribute of URI element.
For more details see paragraph 6.5.30 in Xfdf specification.
value of URI element.
Sets the string value of URI element.
Sets the string value of URI element. Corresponds to Name, required attribute of URI element.
For more details see paragraph 6.5.30 in Xfdf specification.
value to be set to URI element
current
.
Gets IsMap, optional attribute of URI element.
Gets IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
boolean indicating if URI element is a map.
Sets IsMap, optional attribute of URI element.
Sets IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
boolean indicating if URI element is a map
current
.
Gets the value of Name, required attribute of Named element.
Gets the value of Name, required attribute of Named element.
For more details see paragraph 6.5.24 in Xfdf specification.
value of Name attribute of a named action element.
Sets the value of Name, required attribute of Named element.
Sets the value of Name, required attribute of Named element.
For more details see paragraph 6.5.24 in Xfdf specification.
value to be set to Name attribute of a named action element
current
.
Gets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element.
Gets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element.
Corresponds to F key in go-to action or launch dictionaries.
For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification.
value of OriginalName attribute of current action object.
Sets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element.
Sets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element.
Corresponds to F key in go-to action or launch dictionaries.
For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification.
value of OriginalName attribute of action object
current
.
Gets the boolean value of NewWindow, optional attribute of Launch element.
Gets the boolean value of NewWindow, optional attribute of Launch element.
For more details see paragraph 6.5.23 in Xfdf specification.
boolean indicating if current Launch action element should be opened in a new window.
Sets the boolean value of NewWindow, optional attribute of Launch element.
Sets the boolean value of NewWindow, optional attribute of Launch element.
For more details see paragraph 6.5.23 in Xfdf specification.
boolean indicating if current Launch action element should be opened in a new window
current
.
Gets Dest, inner element of link, GoTo, and GoToR elements.
Gets Dest, inner element of link, GoTo, and GoToR elements.
Corresponds to Dest key in link annotation dictionary.
For more details see paragraph 6.5.10 in Xfdf specification.
destination attribute of current action element.
Sets Dest, inner element of link, GoTo, and GoToR elements.
Sets Dest, inner element of link, GoTo, and GoToR elements.
Corresponds to Dest key in link annotation dictionary.
For more details see paragraph 6.5.10 in Xfdf specification.
destination attribute of the action element
current
.
Represents annotation, a child element of annots tag in Xfdf document structure.
Represents annotation, a child element of annots tag in Xfdf document structure.
For more details see part 6.4 in Xfdf specification.
Represents the type of annotation.
Represents the type of annotation. Possible values:
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
.
Represents a list of attributes of the annotation.
Represents contents tag in Xfdf document structure.
Represents contents tag in Xfdf document structure. Is a child of caret, circle, fileattachment, freetext,
highlight, ink, line, polygon, polyline, sound, square, squiggly, stamp, strikeout, text, and
underline elements.
Corresponds to Contents key in annotation dictionary.
Content model: a string or a rich text string.
For more details see paragraph 6.5.4 in Xfdf document specification.
Represents contents-richtext tag in Xfdf document structure.
Represents contents-richtext tag in Xfdf document structure. Is a child of caret, circle, fileattachment, freetext,
highlight, ink, line, polygon, polyline, sound, square, squiggly, stamp, strikeout, text, and
underline elements.
Corresponds to RC key in annotation dictionary.
Content model: text string.
For more details see paragraph 6.5.5 in Xfdf document specification.
A boolean, indicating if annotation has inner popup element.
Represents a popup annotation, an inner element of the annotation element.
Represents Action element, a child of OnActivation element of the link annotation.
Represents Action element, a child of OnActivation element of the link annotation.
Corresponds to the A key in the link annotation dictionary.
Represents Dest element, a child element of link, GoTo, GoToR elements.
Represents Dest element, a child element of link, GoTo, GoToR elements.
Corresponds to the Dest key in link annotation dictionary.
Represents appearance element, a child element of stamp element.
Represents appearance element, a child element of stamp element.
Corresponds to the AP key in the annotation dictionary.
Content model: Base64 encoded string.
For more details see paragraph 6.5.1 in Xfdf document specification.
Represents the defaultappearance element, a child of the caret and freetext elements.
Represents the defaultappearance element, a child of the caret and freetext elements.
Corresponds to the DA key in the free text annotation dictionary.
Content model: text string.
For more details see paragraph 6.5.7 in Xfdf document specification.
Represents defaultstyle element, a child of the freetext element.
Represents defaultstyle element, a child of the freetext element.
Corresponds to the DS key in the free text annotation dictionary.
Content model : a text string.
For more details see paragraph 6.5.9 in Xfdf document specification.
Represents the BorderStyleAlt element, a child of the link element.
Represents the BorderStyleAlt element, a child of the link element.
Corresponds to the Border key in the common annotation dictionary.
For more details see paragraph 6.5.3 in Xfdf document specification.
Represents the string, containing vertices element, a child of the polygon and polyline elements.
Represents the string, containing vertices element, a child of the polygon and polyline elements.
Corresponds to the Vertices key in the polygon or polyline annotation dictionary.
For more details see paragraph 6.5.31 in Xfdf document specification.
The reference to the source
.
The reference to the source
. Used for attaching popups in case of reading data from pdf file.
Creates an instance of
.
Gets the string value of the type of annotation.
Gets the string value of the type of annotation. Possible values:
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
.
value of the type of annotation.
Sets the string value of the type of annotation.
Sets the string value of the type of annotation. Possible values:
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
.
value of the type of annotation
annotation object
with set name.
Gets a list of all attributes of the annotation.
list
containing all
attribute objects
of the annotation.
Finds the attribute by name in attributes list.
the name of the attribute to look for
with the given name, or null, if no object with this name was found.
Finds the attribute by name in attributes list and return its string value.
the name of the attribute to look for
the value of the
with the given name,
or null, if no object with this name was found.
Gets the popup annotation, an inner element of the annotation element.
representing the inner popup annotation.
Sets the popup annotation, an inner element of the annotation element.
annotation object
representing inner popup annotation
current
annotation object.
Gets the boolean, indicating if annotation has an inner popup element.
true if annotation has an inner popup element, false otherwise.
Sets the boolean, indicating if annotation has inner popup element.
a boolean indicating if annotation has inner popup element
current
annotation object.
Gets the string value of contents tag in Xfdf document structure.
Gets the string value of contents tag in Xfdf document structure. Contents is a child of caret, circle,
fileattachment, freetext, highlight, ink, line, polygon, polyline, sound, square, squiggly, stamp, strikeout,
text, and underline elements.
Corresponds to Contents key in annotation dictionary.
Content model: a string or a rich text string.
For more details see paragraph 6.5.4 in Xfdf document specification.
value of inner contents element of current annotation object.
Sets the string value of contents tag in Xfdf document structure.
string
value of inner contents element
current
annotation object.
Gets the string value of contents-richtext tag in Xfdf document structure.
Gets the string value of contents-richtext tag in Xfdf document structure. It is a child of caret, circle, fileattachment,
freetext, highlight, ink, line, polygon, polyline, sound, square, squiggly, stamp, strikeout, text, and
underline elements.
Corresponds to RC key in annotation dictionary.
Content model: text string.
For more details see paragraph 6.5.5 in Xfdf document specification.
value of inner contents-richtext element of current annotation object.
Sets the string value of contents-richtext tag in xfdf document structure.
rich text string
value of inner contents-richtext element
current
annotation object.
Gets Action element, a child of OnActivation element of the link annotation.
Gets Action element, a child of OnActivation element of the link annotation.
Corresponds to the A key in the link annotation dictionary.
inner
action object
of annotation object.
Sets Action element, a child of OnActivation element of the link annotation.
Sets Action element, a child of OnActivation element of the link annotation.
Corresponds to the A key in the link annotation dictionary.
action object
, an inner element of annotation object
current
annotation object.
Adds new
to the list of annotation attributes.
attribute to be added.
Adds new attribute with given name and boolean value converted to string.
Adds new attribute by given name and value.
Adds new attribute by given name and value. If required attribute is present, value of the attribute can't be null.
attribute name
attribute value
boolean indicating if the attribute is required
Adds page, required attribute of every annotation.
Gets Dest element, a child element of link, GoTo, GoToR elements.
Gets Dest element, a child element of link, GoTo, GoToR elements.
Corresponds to the Dest key in link annotation dictionary.
inner
destination object
of annotation object
Sets Dest element, a child element of link, GoTo, GoToR elements.
Sets Dest element, a child element of link, GoTo, GoToR elements.
Corresponds to the Dest key in link annotation dictionary.
destination object
, an inner element of annotation object
current
annotation object.
Gets the string value of the appearance element, a child element of stamp element.
Gets the string value of the appearance element, a child element of stamp element.
Corresponds to the AP key in the annotation dictionary.
Content model: Base64 encoded string.
For more details see paragraph 6.5.1 in Xfdf document specification.
value of inner appearance element.
Gets the string value of the appearance element, a child element of stamp element.
Gets the string value of the appearance element, a child element of stamp element.
Corresponds to the AP key in the annotation dictionary.
Content model: Base64 encoded string.
value of inner appearance element of annotation object
current
annotation object.
Gets the string value of the defaultappearance element, a child of the caret and freetext elements.
Gets the string value of the defaultappearance element, a child of the caret and freetext elements.
Corresponds to the DA key in the free text annotation dictionary.
Content model: text string.
For more details see paragraph 6.5.7 in Xfdf document specification.
value of inner default appearance element.
Sets the string value of the defaultappearance element, a child of the caret and freetext elements.
Sets the string value of the defaultappearance element, a child of the caret and freetext elements.
Corresponds to the DA key in the free text annotation dictionary.
Content model: text string.
value of inner defaultappearance element of annotation object
current
annotation object.
Gets the string value of the defaultstyle element, a child of the freetext element.
Gets the string value of the defaultstyle element, a child of the freetext element.
Corresponds to the DS key in the free text annotation dictionary.
Content model : a text string.
For more details see paragraph 6.5.9 in Xfdf document specification.
value of inner defaultstyle element.
Sets the string value of the defaultstyle element, a child of the freetext element.
Sets the string value of the defaultstyle element, a child of the freetext element.
Corresponds to the DS key in the free text annotation dictionary.
Content model : a text string.
value of inner defaultstyle element of annotation object
current
annotation object.
Gets the BorderStyleAlt element, a child of the link element.
Gets the BorderStyleAlt element, a child of the link element.
Corresponds to the Border key in the common annotation dictionary.
For more details see paragraph 6.5.3 in Xfdf document specification.
inner
BorderStyleAlt object.
Sets the BorderStyleAlt element, a child of the link element.
Sets the BorderStyleAlt element, a child of the link element.
Corresponds to the Border key in the common annotation dictionary.
inner
BorderStyleAlt object
current
annotation object.
Gets the string, containing vertices element, a child of the polygon and polyline elements.
Gets the string, containing vertices element, a child of the polygon and polyline elements.
Corresponds to the Vertices key in the polygon or polyline annotation dictionary.
For more details see paragraph 6.5.31 in Xfdf document specification.
value of inner vertices element.
Sets the string, containing vertices element, a child of the polygon and polyline elements.
Sets the string, containing vertices element, a child of the polygon and polyline elements.
Corresponds to the Vertices key in the polygon or polyline annotation dictionary.
value of inner vertices element
current
annotation object.
Gets the reference to the source
.
Gets the reference to the source
. Used for attaching popups in case of reading data from pdf file.
an
of the source annotation object.
Sets the reference to the source
.
Sets the reference to the source
. Used for attaching popups in case of reading data from pdf file.
of the source annotation object
this
instance.
Represent annots tag in xfdf document structure.
Represent annots tag in xfdf document structure.
Content model: ( text | caret | freetext | fileattachment | highlight | ink | line | link
| circle | square | polygon | polyline | sound | squiggly | stamp |
strikeout | underline )*.
Attributes: none.
For more details see paragraph 6.4.1 in Xfdf specification.
Represents a list of children annotations.
Creates an instance with the empty list of children annotations.
Gets children annotations.
a
of
each representing a child annotation of this annots tag.
Adds a new
to the list of children annotations.
containing info about pdf document annotation.
this
instance.
Represents the attribute of any XFDF element.
Creates an instance with given attribute name and value.
the name of the attribute, constrained by XML attributes specification.
the value of the attribute, constrained by XML attributes specification.
Returns attribute name.
a string representation of attribute name, case-sensitive as per XML specification.
Returns attribute value.
a string representation of attribute value.
Represents the BorderStyleAlt element, a child of the link element.
Represents the BorderStyleAlt element, a child of the link element.
Corresponds to the Border key in the common annotation dictionary.
Content model: border style encoded in the format specified in the border style attributes.
Required attributes: HCornerRadius, VCornerRadius, Width.
Optional attributes: DashPattern.
For more details see paragraph 6.5.3 in Xfdf document specification.
For more details about attributes see paragraph 6.6.19 in Xfdf document specification.
Number specifying the horizontal corner radius of the rectangular border.
Number specifying the horizontal corner radius of the rectangular border.
Corresponds to array index 0 in the Border key in the common annotation dictionary.
Number specifying the vertical corner radius of the rectangular border.
Number specifying the vertical corner radius of the rectangular border.
Corresponds to array index 1 in the Border key in the common annotation dictionary.
Number specifying the width of the rectangular border.
Number specifying the width of the rectangular border.
Corresponds to array index 2 in the Border key in the common annotation dictionary.
An array of numbers specifying the pattern of dashes and gaps of the border.
An array of numbers specifying the pattern of dashes and gaps of the border.
Corresponds to array index 3 in the Border key in the common annotation dictionary.
Encoded border style string.
Creates an instance that encapsulates BorderStyleAlt XFDF element data.
a float value specifying the horizontal corner radius of the rectangular border.
a float value specifying the vertical corner radius of the rectangular border.
a float value specifying the width of the rectangular border.
Gets the horizontal corner radius of the rectangular border.
Gets the horizontal corner radius of the rectangular border.
Corresponds to array index 0 in the Border key in the common annotation dictionary.
a float value specifying the horizontal corner radius.
Gets the vertical corner radius of the rectangular border.
Gets the vertical corner radius of the rectangular border.
Corresponds to array index 1 in the Border key in the common annotation dictionary.
a float value specifying the vertical corner radius.
Gets the width of the rectangular border.
Gets the width of the rectangular border.
Corresponds to array index 2 in the Border key in the common annotation dictionary.
a float value specifying the width of the border.
Gets the dash pattern of the border.
Gets the dash pattern of the border.
Corresponds to array index 3 in the Border key in the common annotation dictionary.
an array of numbers specifying the pattern of dashes and gaps of the border.
Sets the dash pattern of the border.
Sets the dash pattern of the border.
Corresponds to array index 3 in the Border key in the common annotation dictionary.
an array of numbers specifying the pattern of dashes and gaps of the border.
this
instance.
Gets border style.
an encoded border style as string.
Sets border style.
an encoded border style as string.
this
instance.
Represents Dest element, a child of the link, GoTo, and GoToR elements.
Represents Dest element, a child of the link, GoTo, and GoToR elements.
Corresponds to the Dest key in the link annotations dictionary.
For more details see paragraph 6.5.10 in XFDF document specification.
Content model: ( Named | XYZ | Fit | FitH | FitV | FitR | FitB | FitBH | FitBV )
Represents Name attribute of Named element, a child of Dest element.
Represents Name attribute of Named element, a child of Dest element.
Allows a destination to be referred to indirectly by means of a name object or a byte string.
For more details see paragraph 6.5.25 in XFDF document specification.
Represents the XYZ element, a child of the Dest element.
Represents the XYZ element, a child of the Dest element.
Corresponds to the XYZ key in the destination syntax.
Required attributes: Page, Left, Bottom, Right, Top.
For more details see paragraph 6.5.32 in XFDF document specification.
Represents the Fit element, a child of the Dest element.
Represents the Fit element, a child of the Dest element.
Corresponds to the Fit key in the destination syntax.
Required attributes: Page.
For more details see paragraph 6.5.13 in XFDF document specification.
Represents the FitH element, a child of the Dest element.
Represents the FitH element, a child of the Dest element.
Corresponds to the FitH key in the destination syntax.
Required attributes: Page, Top.
For more details see paragraph 6.5.17 in XFDF document specification.
Represents the FitV element, a child of the Dest element.
Represents the FitV element, a child of the Dest element.
Corresponds to the FitV key in the destination syntax.
Required attributes: Page, Left.
For more details see paragraph 6.5.19 in XFDF document specification.
Represents the FitR element, a child of the Dest element.
Represents the FitR element, a child of the Dest element.
Corresponds to the FitR key in the destination syntax.
Required attributes: Page, Left, Bottom, Right, Top.
For more details see paragraph 6.5.18 in XFDF document specification.
Represents the FitB element, a child of the Dest element.
Represents the FitB element, a child of the Dest element.
Corresponds to the FitB key in the destination syntax.
Required attributes: Page.
For more details see paragraph 6.5.14 in XFDF document specification.
Represents the FitBH element, a child of the Dest element.
Represents the FitBH element, a child of the Dest element.
Corresponds to the FitBH key in the destination syntax.
Required attributes: Page, Top.
For more details see paragraph 6.5.15 in XFDF document specification.
Represents the FitBV element, a child of the Dest element.
Represents the FitBV element, a child of the Dest element.
Corresponds to the FitBV key in the destination syntax.
Required attributes: Page, Left.
For more details see paragraph 6.5.16 in XFDF document specification.
Creates an instance of
.
Gets the Name attribute of Named element, a child of Dest element.
Gets the Name attribute of Named element, a child of Dest element.
Allows a destination to be referred to indirectly by means of a name object or a byte string.
For more details see paragraph 6.5.25 in XFDF document specification.
string value of the Name attribute.
Sets the Name attribute of Named element, a child of Dest element.
Sets the Name attribute of Named element, a child of Dest element.
Allows a destination to be referred to indirectly by means of a name object or a byte string.
string value of the Name attribute
this
instance.
Gets the XYZ element, a child of the Dest element.
Gets the XYZ element, a child of the Dest element.
Corresponds to the XYZ key in the destination syntax.
Required attributes: Page, Left, Bottom, Right, Top.
For more details see paragraph 6.5.32 in XFDF document specification.
a
that represents XYZ of Dest element.
Sets the XYZ element, a child of the Dest element.
Sets the XYZ element, a child of the Dest element.
Corresponds to the XYZ key in the destination syntax.
Required attributes: Page, Left, Bottom, Right, Top.
a
that represents XYZ of Dest element
this
instance.
Gets the Fit element, a child of the Dest element.
Gets the Fit element, a child of the Dest element.
Corresponds to the Fit key in the destination syntax.
Required attributes: Page.
For more details see paragraph 6.5.13 in XFDF document specification.
a
that represents Fit of Dest element.
Sets the Fit element, a child of the Dest element.
Sets the Fit element, a child of the Dest element.
Corresponds to the Fit key in the destination syntax.
Required attributes: Page.
a
that represents Fit of Dest element
this
instance.
Gets the FitH element, a child of the Dest element.
Gets the FitH element, a child of the Dest element.
Corresponds to the FitH key in the destination syntax.
Required attributes: Page, Top.
For more details see paragraph 6.5.17 in XFDF document specification.
a
that represents FitH of Dest element.
Sets the FitH element, a child of the Dest element.
Sets the FitH element, a child of the Dest element.
Corresponds to the FitH key in the destination syntax.
Required attributes: Page, Top.
a
that represents FitH of Dest element
this
instance.
Gets the FitV element, a child of the Dest element.
Gets the FitV element, a child of the Dest element.
Corresponds to the FitV key in the destination syntax.
Required attributes: Page, Left.
For more details see paragraph 6.5.19 in XFDF document specification.
a
that represents FitV of Dest element.
Sets the FitV element, a child of the Dest element.
Sets the FitV element, a child of the Dest element.
Corresponds to the FitV key in the destination syntax.
Required attributes: Page, Left.
a
that represents FitV of Dest element
this
instance.
Gets the FitR element, a child of the Dest element.
Gets the FitR element, a child of the Dest element.
Corresponds to the FitR key in the destination syntax.
Required attributes: Page, Left, Bottom, Right, Top.
For more details see paragraph 6.5.18 in XFDF document specification.
a
that represents FitR of Dest element.
Sets the FitR element, a child of the Dest element.
Sets the FitR element, a child of the Dest element.
Corresponds to the FitR key in the destination syntax.
Required attributes: Page, Left, Bottom, Right, Top.
a
that represents FitR of Dest element
this
instance.
Sets the FitB element, a child of the Dest element.
Sets the FitB element, a child of the Dest element.
Corresponds to the FitB key in the destination syntax.
Required attributes: Page.
For more details see paragraph 6.5.14 in XFDF document specification.
a
that represents FitB of Dest element.
Gets the FitB element, a child of the Dest element.
Gets the FitB element, a child of the Dest element.
Corresponds to the FitB key in the destination syntax.
Required attributes: Page.
For more details see paragraph 6.5.14 in XFDF document specification.
a
that represents FitB of Dest element
this
instance.
Sets the FitBH element, a child of the Dest element.
Sets the FitBH element, a child of the Dest element.
Corresponds to the FitBH key in the destination syntax.
Required attributes: Page, Top.
For more details see paragraph 6.5.15 in XFDF document specification.
a
that represents FitBH of Dest element.
Gets the FitBH element, a child of the Dest element.
Gets the FitBH element, a child of the Dest element.
Corresponds to the FitBH key in the destination syntax.
Required attributes: Page, Top.
a
that represents FitBH of Dest element
this
instance.
Sets the FitBV element, a child of the Dest element.
Sets the FitBV element, a child of the Dest element.
Corresponds to the FitBV key in the destination syntax.
Required attributes: Page, Left.
For more details see paragraph 6.5.16 in XFDF document specification.
a
that represents FitBV of Dest element.
Sets the FitBV element, a child of the Dest element.
Sets the FitBV element, a child of the Dest element.
Corresponds to the FitBV key in the destination syntax.
Required attributes: Page, Left.
a
that represents FitBV of Dest element
this
instance.
Represents encoding attribute of data or resource elements (children of fileattachment and sound elements).
Represents the field element, a child of the fields and field elements.
Represents the field element, a child of the fields and field elements.
The field element corresponds to a form field.
Content model: ( field* | value* | ( value? & value-richtext? )).
Required attributes: name.
For more details see paragraph 6.3.2 in XFDF document specification.
Represents the name attribute of the field element.
Represents the name attribute of the field element.
Corresponds to the T key in the field dictionary.
In a hierarchical form field, the name is the partial field name.
For more details see paragraph 6.3.2.2 in XFDF document specification.
Represents the value element, a child of the field element and contains the field's value, whose format may
vary depending on the field type.
Represents the value element, a child of the field element and contains the field's value, whose format may
vary depending on the field type.
Corresponds to the V key in the FDF field dictionary.
Content model: text string.
For more details see paragraph 6.3.3 in XFDF document specification.
Represents the value-richtext element, a child of the field element and contains the field's value formatted as a
rich text string.
Represents the value-richtext element, a child of the field element and contains the field's value formatted as a
rich text string.
Corresponds to the RV key in the variable text field dictionary.
Content model: text strign or rich text string.
Attributes: none.
For more details see paragraph 6.3.4 in XFDF document specification.
Indicates if a value-richtext element is present inside the field.
Parent field of current field.
Creates an instance of
.
Creates an instance of
.
the name attribute of the field element
the field's value
indicates if a value-richtext element is present inside the field
Gets the string value of the name attribute of the field element.
Gets the string value of the name attribute of the field element.
Corresponds to the T key in the field dictionary.
In a hierarchical form field, the name is the partial field name.
For more details see paragraph 6.3.2.2 in XFDF document specification.
value of field name attribute.
Sets the string value of the name attribute of the field element.
Sets the string value of the name attribute of the field element.
Corresponds to the T key in the field dictionary.
In a hierarchical form field, the name is the partial field name.
value of field name attribute
Gets the string representation of the value element, a child of the field element and contains the field's value,
whose format may vary depending on the field type.
Gets the string representation of the value element, a child of the field element and contains the field's value,
whose format may vary depending on the field type.
Corresponds to the V key in the FDF field dictionary.
For more details see paragraph 6.3.3 in XFDF document specification.
representation of inner value element of the field.
Sets the string representation of the value element, a child of the field element and contains the field's value,
whose format may vary depending on the field type.
Sets the string representation of the value element, a child of the field element and contains the field's value,
whose format may vary depending on the field type.
Corresponds to the V key in the FDF field dictionary.
representation of inner value element of the field
Gets the string representation of the value-richtext element, a child of the field element and contains the
field's value formatted as a rich text string.
Gets the string representation of the value-richtext element, a child of the field element and contains the
field's value formatted as a rich text string.
Corresponds to the RV key in the variable text field dictionary.
Content model: text strign or rich text string.
For more details see paragraph 6.3.4 in XFDF document specification.
representation of inner value-richtext element of the field.
Sets the string representation of the value-richtext element, a child of the field element and contains the
field's value formatted as a rich text string.
Sets the string representation of the value-richtext element, a child of the field element and contains the
field's value formatted as a rich text string.
Corresponds to the RV key in the variable text field dictionary.
Content model: text string or rich text string.
representation of inner value-richtext element of the field
Gets a boolean indicating if a value-richtext element is present inside the field.
true if a value-richtext element is present inside the field, false otherwise.
Sets a boolean indicating if a value-richtext element is present inside the field.
a boolean indicating if a value-richtext element is present inside the field
Gets a parent field of current field.
parent
field object
of the current field.
Sets a parent field of current field.
field object
that is a parent of the current field
Represents the fields element, a child of the xfdf element and is the container for form field elements.
Represents the fields element, a child of the xfdf element and is the container for form field elements.
Content model: ( field* ).
Attributes: none.
For more details see paragraph 6.3.1 in Xfdf specification.
Represents a list of children fields
Creates an instance of
.
Gets a list of children fields
containing all children
field objects
Adds a new field to the list.
FieldObject containing the info about the form field
current
fields object
Represent Fit, a child of the Dest element.
Represent Fit, a child of the Dest element.
Content model: none.
Attributes: depends of type of Fit (FitH, FitB, FitV etc.).
For more details see paragraphs 6.5.13-6.5.19, 6.6.23 in Xfdf specification.
Represents the page displayed by current Fit element.
Represents the page displayed by current Fit element.
Attribute of Fit, FitB, FitBH, FitBV, FitH, FitR, FitV, XYZ elements.
Vertical coordinate positioned at the top edge of the window.
Vertical coordinate positioned at the bottom edge of the window.
Horizontal coordinate positioned at the left edge of the window.
Horizontal coordinate positioned at the right edge of the window.
Corresponds to the zoom object in the destination syntax.
Corresponds to the zoom object in the destination syntax.
Attribute of XYZ object.
Creates an instance of
.
the page displayed by current Fit element
Gets the PdfObject representing the page displayed by current Fit element.
Gets the PdfObject representing the page displayed by current Fit element.
Attribute of Fit, FitB, FitBH, FitBV, FitH, FitR, FitV, XYZ elements.
page
of the current Fit element.
Gets a float vertical coordinate positioned at the top edge of the window.
top vertical coordinate.
Sets a float vertical coordinate positioned at the top edge of the window.
vertical coordinate value
current
fit object.
Gets a float horizontal coordinate positioned at the left edge of the window.
left horizontal coordinate.
Sets a float horizontal coordinate positioned at the left edge of the window.
horizontal coordinate value
current
fit object.
Gets a float vertical coordinate positioned at the bottom edge of the window.
bottom vertical coordinate.
Sets a float vertical coordinate positioned at the bottom edge of the window.
vertical coordinate value
current
fit object.
Gets a float horizontal coordinate positioned at the right edge of the window.
right horizontal coordinate.
Sets a float horizontal coordinate positioned at the right edge of the window.
horizontal coordinate
current
fit object.
Gets a float representing the zoom ratio.
Gets a float representing the zoom ratio.
Attribute of XYZ object.
zoom ratio value.
Sets a float representing the zoom ratio.
Sets a float representing the zoom ratio.
Attribute of XYZ object.
ratio value
current
fit object.
Represents f element, child of the xfdf element.
Represents f element, child of the xfdf element.
Corresponds to the F key in the file dictionary.
Specifies the source file or target file: the PDF document that this XFDF file was exported from or is intended to be
imported into.
Attributes: href.
For more details see paragraph 6.2.2 in Xfdf document specification.
The name of the source or target file.
Creates an instance of
.
the name of the source or target file
Gets the name of the source or target file.
the name of the source or target file.
Sets the name of the source or target file.
the name of the source or target file
current
f object.
Represents ids element, child of the xfdf element.
Represents ids element, child of the xfdf element.
Corresponds to the ID key in the file dictionary.
The two attributes are file identifiers for the source or target file designated by the f element, taken
from the ID entry in the file’s trailer dictionary.
Attributes: original, modified.
For more details see paragraph 6.2.3 in Xfdf document specification.
This attribute corresponds to the permanent identifier which
is based on the contents of the file at the time it was originally created.
This attribute corresponds to the permanent identifier which
is based on the contents of the file at the time it was originally created.
This value does not change when the file is incrementally updated.
The value shall be a hexadecimal number.
A common value for this is an MD5 checksum.
The attribute contains a unique identifier for the
modified version of the pdf and corresponding xfdf document.
The attribute contains a unique identifier for the
modified version of the pdf and corresponding xfdf document. The
modified attribute corresponds to the changing identifier that is based
on the file's contents at the time it was last updated.
The value shall be a hexadecimal number.
A common value for this is an MD5 checksum.
Creates an instance of
.
Gets the string value of the permanent identifier which
is based on the contents of the file at the time it was originally created.
Gets the string value of the permanent identifier which
is based on the contents of the file at the time it was originally created.
This value does not change when the file is incrementally updated.
The value shall be a hexadecimal number.
the permanent identifier value.
Sets the string value of the permanent identifier which
is based on the contents of the file at the time it was originally created.
Sets the string value of the permanent identifier which
is based on the contents of the file at the time it was originally created.
This value does not change when the file is incrementally updated.
The value shall be a hexadecimal number.
A common value for this is an MD5 checksum.
the permanent identifier value
current
ids object.
Gets the string value of the unique identifier for the
modified version of the pdf and corresponding xfdf document.
Gets the string value of the unique identifier for the
modified version of the pdf and corresponding xfdf document. The
modified attribute corresponds to the changing identifier that is based
on the file's contents at the time it was last updated.
The value shall be a hexadecimal number.
the unique identifier value.
Sets the string value of the unique identifier for the
modified version of the pdf and corresponding xfdf document.
Sets the string value of the unique identifier for the
modified version of the pdf and corresponding xfdf document. The
modified attribute corresponds to the changing identifier that is based
on the file's contents at the time it was last updated.
The value shall be a hexadecimal number.
A common value for this is an MD5 checksum.
the unique identifier value
current
ids object.
Represents the mode attribute of data and resource elements.
Represents the mode attribute of data and resource elements.
Does not correspond to a PDF key.
Class containing constants to be used in XFDF processing.
Creates a new xml-styled document for writing xfdf info.
Creates a new xml-styled document for writing xfdf info.
Creates a new xfdf document based on given input stream.
the stream containing xfdf info.
Saves the info from output stream to xml-styled document.
the document to save info to.
the stream containing xfdf info.
Represents xfdf element, the top level element in an xfdf document.
Represents xfdf element, the top level element in an xfdf document.
For more details see paragraph 6.2.1 in Xfdf document specification.
Content model: ( f? & ids? & fields? & annots? )
Attributes: xml:space, xmlns.
Represents f element, child of the xfdf element.
Represents f element, child of the xfdf element.
Corresponds to the F key in the file dictionary.
Represents ids element, a child of the xfdf element.
Represents ids element, a child of the xfdf element.
Corresponds to the ID key in the file dictionary.
Represents the fields element, a child of the xfdf element and is the container for form field elements.
Represent annots element, a child of the xfdf element and is the container for annot elements.
A list of attributes of xfdf object.
Gets the f element, child of the xfdf element.
Gets the f element, child of the xfdf element.
Corresponds to the F key in the file dictionary.
the f element
Sets f element, child of the xfdf element.
Sets f element, child of the xfdf element.
Corresponds to the F key in the file dictionary.
element
Gets the ids element, child of the xfdf element.
Gets the ids element, child of the xfdf element.
Corresponds to the ID key in the file dictionary.
the ids element
Sets ids element, child of the xfdf element.
Sets ids element, child of the xfdf element.
Corresponds to the ID key in the file dictionary.
element
Gets the fields element, a child of the xfdf element and is the container for form field elements.
the fields element
Sets fields element, a child of the xfdf element and is the container for form field elements.
element
Gets the annots element, a child of the xfdf element and is the container for annot elements.
the annots element
Sets the annots element, a child of the xfdf element and is the container for annot elements.
element
Gets the list of attributes of xfdf object.
the list of attributes
Sets the list of attributes of xfdf object.
list of attributes objects
Merges info from XfdfObject to pdf document.
the target document for merge.
the name of the target document. Will be checked in the merge process to determined
if it is the same as href attribute of f element of merged XfdfObject. If the names are
different, a warning will be thrown.
Writes info from XfdfObject to .xfdf file.
name of the target file.
Writes info from XfdfObject to .xfdf file.
target output stream.
A factory for creating
objects.
Extracts data from pdf document acroform and annotations into XfdfObject.
Pdf document for data extraction
The name od pdf document for data extraction
XfdfObject containing data from pdf forms and annotations.
Extracts data from input stream into XfdfObject.
Extracts data from input stream into XfdfObject. Typically input stream is based on .xfdf file.
the input stream containing xml-styled xfdf data
XfdfObject containing original xfdf data.
Converts a string containing 2 or 4 float values into a
.
the annotation rectangle, defining the location of the annotation on the page
in default user space units. The value is four comma separated real numbers
which may be positive or negative: (xLeft, yBottom, xRight, yTop). If only two coordinates
are present, they should represent
width and height.
Converts a string containing 4 float values into a PdfArray, representing rectangle fringe.
Converts a string containing 4 float values into a PdfArray, representing rectangle fringe.
If the number of floats in the string is not equal to 4, returns and PdfArray with empty values.
Converts a string containing float values into a PdfArray, representing a pattern of dashes and gaps to be used
in drawing a dashed border.
Converts a PdfArray, representing a pattern of dashes and gaps to be used in drawing a dashed border,
into a string containing float values.
Converts a string containing justification value into an integer value representing a code specifying
the form of quadding (justification).
Converts an integer value representing a code specifying the form of quadding (justification) into a string
containing justification value.
Converts H key value in the link annotation dictionary to Highlight value of xfdf link annotation attribute.
Converts style (S key value) in the pdf annotation dictionary to style value of xfdf annotation attribute.
Converts a Rectangle to a string containing 4 float values.
Converts float value to string with UTF-8 encoding.
Converts a string containing 8*n float values into a float array, representing quadPoints.
Converts a string containing 8*n float values into a float array, representing quadPoints.
If the number of floats in the string is not a multiple of 8, returns an empty float array.
Converts a float array, representing quadPoints into a string containing 8*n float values.
Converts a string containing a comma separated list of names of the flags into an integer representation
of the flags.
Converts an integer representation of the flags into a string with a comma separated list of names of the flags.
Converts an array of 3 floats into a hex string representing the rgb color.
Converts a Color object into a hex string representing the rgb color.
Converts float representation of the rgb color into a hex string representing the rgb color.
Converts string containing id from decimal to hexadecimal format.
Converts string containing hex color code to Color object.
Converts string containing hex color code into an array of 3 integer values representing rgb color.
Converts an array of float vertices to string.
Converts to string an array of floats representing the fringe.
Converts to string an array of floats representing the fringe.
If the number of floats doesn't equal 4, an empty string is returned.
Converts a string into an array of floats representing vertices.
Returns a string representation of the start point of the line (x_1, y_1) based on given line array.
Returns a string representation of the start point of the line (x_1, y_1) based on given line array.
If the line array doesn't contain 4 floats, returns an empty string.
an array of 4 floats representing the line (x_1, y_1, x_2, y_2)
Returns a string representation of the end point of the line (x_2, y_2) based on given line array.
Returns a string representation of the end point of the line (x_2, y_2) based on given line array.
If the line array doesn't contain 4 floats, returns an empty string.
an array of 4 floats representing the line (x_1, y_1, x_2, y_2)
Merges existing XfdfObject into pdf document associated with it.
The object to be merged.
The associated pdf document.
The name of the associated pdf document.
Merges existing FieldsObject and children FieldObject entities into the form of the pdf document
associated with it.
object containing acroform fields data to be merged.
acroform to be filled with xfdf data.
Merges existing XfdfObject into pdf document associated with it.
The AnnotsObject with children AnnotObject entities to be mapped into PdfAnnotations.
The associated pdf document.
Creates a XfdfWriter for output stream specified.
A stream to write xfdf file into.
Writes data from
into a xfdf data file.
containing the data.