itext.pdfa
PdfA1Checker defines the requirements of the PDF/A-1 standard and contains
method implementations from the abstract
class.
PdfA1Checker defines the requirements of the PDF/A-1 standard and contains
method implementations from the abstract
class.
The specification implemented by this class is ISO 19005-1
Creates a PdfA1Checker with the required conformance
the required conformance, a or
b
Retrieve maximum allowed real value.
maximum allowed real number
Retrieve maximal allowed integer value.
maximal allowed integer number
Retrieve minimal allowed integer value.
minimal allowed integer number
Retrieve maximum allowed length of the name object.
maximum allowed length of the name
Returns maximum allowed bytes length of the string in a PDF document.
maximum string length
Gets forbidden annotation types.
a set of forbidden annotation types
Gets a
of fields with kids from a
of
objects.
the
of form fields
objects
the
of form fields
PdfA2Checker defines the requirements of the PDF/A-2 standard and contains a
number of methods that override the implementations of its superclass
.
PdfA2Checker defines the requirements of the PDF/A-2 standard and contains a
number of methods that override the implementations of its superclass
.
The specification implemented by this class is ISO 19005-2
Creates a PdfA2Checker with the required conformance
the required conformance, a or
u or b
Checks the number of components in DeviceN color space.
the color space to check
Gets annotation types which are allowed not to have appearance stream.
set of annotation names.
Checked annotation against actions, exception will be thrown if either
A
or
AA
actions aren't allowed for specific type of annotation.
an annotation PDF dictionary
Checks if the catalog is compliant with the PDF/A-2 standard.
the catalog dictionary
Checks if the page is compliant with the PDF/A-2 standard.
the page dictionary
For pdf/a-2+ checkers this method is overridden to use
method.
the
to check
Verify the conformity of the Form XObject with appropriate
specification.
Verify the conformity of the Form XObject with appropriate
specification. Throws PdfAConformanceException if any discrepancy was found
the
to be checked
the
current content stream
Verify the conformity of the transparency group XObject with appropriate
specification.
Verify the conformity of the transparency group XObject with appropriate
specification. Throws PdfAConformanceException if any discrepancy was found
the
transparency group XObject.
the
current content stream
Check optional content configuration dictionary against AS key.
a content configuration dictionary
Retrieve transparency error message valid for the pdf/a standard being used.
error message.
Check if blendMode is compatible with pdf/a standard being used.
blend mode name to check.
PdfA3Checker defines the requirements of the PDF/A-3 standard and contains a
number of methods that override the implementations of its superclass
.
PdfA3Checker defines the requirements of the PDF/A-3 standard and contains a
number of methods that override the implementations of its superclass
.
The specification implemented by this class is ISO 19005-3
Creates a PdfA3Checker with the required conformance
the required conformance, a or
u or b
PdfA4Checker defines the requirements of the PDF/A-4 standard and contains a
number of methods that override the implementations of its superclass
.
PdfA4Checker defines the requirements of the PDF/A-4 standard and contains a
number of methods that override the implementations of its superclass
.
The specification implemented by this class is ISO 19005-4
Creates a PdfA4Checker with the required conformance
the required conformance
Check the conformity of the AA dictionary on catalog level.
the catalog dictionary
Check the conformity of the AA dictionary on catalog level.
the catalog dictionary
Check the conformity of the AA dictionary on widget level.
the widget dictionary
the catalog
to check
A PDF/A-4e conforming file shall specify the value of
pdfa:conformance
as E.
A PDF/A-4e conforming file shall specify the value of
pdfa:conformance
as E. A PDF/A-4f conforming file
shall specify the value of
pdfa:conformance
as F. A file that does not conform to either PDF/A-4e or
PDF/A-4f shall not provide any
pdfa:conformance.
pdfa:conformance
value to check
if
pdfa:conformance
value is valid,
otherwise
An abstract class that will run through all necessary checks defined in the
different PDF/A standards and levels.
An abstract class that will run through all necessary checks defined in the
different PDF/A standards and levels. A number of common checks are executed
in this class, while standard-dependent specifications are implemented in the
available subclasses. The standard that is followed is the series of ISO
19005 specifications, currently generations 1 through 3. The ZUGFeRD standard
is derived from ISO 19005-3.
While it is possible to subclass this method and implement its abstract
methods in client code, this is not encouraged and will have little effect.
It is not possible to plug custom implementations into iText, because iText
should always refuse to create non-compliant PDF/A, which would be possible
with client code implementations. Any future generations of the PDF/A
standard and its derivates will get their own implementation in the
iText - pdfa project.
The Red-Green-Blue color profile as defined by the International Color
Consortium.
The Cyan-Magenta-Yellow-Key (black) color profile as defined by the
International Color Consortium.
The Grayscale color profile as defined by the International Color
Consortium.
The Output device class
The Monitor device class
The maximum Graphics State stack depth in PDF/A documents, i.e. the
maximum number of graphics state operators with code q that
may be opened (i.e. not yet closed by a corresponding Q) at
any point in a content stream sequence.
The maximum Graphics State stack depth in PDF/A documents, i.e. the
maximum number of graphics state operators with code q that
may be opened (i.e. not yet closed by a corresponding Q) at
any point in a content stream sequence.
Defined as 28 by PDF/A-1 section 6.1.12, by referring to the PDF spec
Appendix C table 1 "architectural limits".
Contains some objects that are already checked.
Contains some objects that are already checked.
NOTE: Not all objects that were checked are stored in that set. This set is used for avoiding double checks for
actions, signatures, xObjects and page objects; and for letting those objects to be manually flushed.
Use this mechanism carefully: objects that are able to be changed (or at least if object's properties
that shall be checked are able to be changed) shouldn't be marked as checked if they are not to be
flushed immediately.
Creates a PdfAChecker with the required conformance.
the required conformance
This method checks a number of document-wide requirements of the PDF/A
standard.
This method checks a number of document-wide requirements of the PDF/A
standard. The algorithms of some of these checks vary with the PDF/A
level and thus are implemented in subclasses; others are implemented
as private methods in this class.
The catalog being checked
.
.
This method checks all requirements that must be fulfilled by a page in a
PDF/A document.
the page that must be checked
This method checks the requirements that must be fulfilled by a COS
object in a PDF/A document.
the COS object that must be checked
Gets the
for this file.
the defined conformance for this document.
In full check mode all objects will be tested for ISO conformance.
In full check mode all objects will be tested for ISO conformance. If full check mode is
switched off objects which were not modified might be skipped to speed up the validation
of the document
true if full check mode is switched on
In full check mode all objects will be tested for ISO conformance.
In full check mode all objects will be tested for ISO conformance. If full check mode is
switched off objects which were not modified might be skipped to speed up the validation
of the document
is a new value for full check mode switcher
This method checks compliance of the tag structure elements, such as struct elements
or parent tree entries.
an object that represents tag structure element.
This method checks compliance of the signature dictionary
a
containing the signature.
This method checks compliance of the signature type.
if CAdES signature type is used,
otherwise
This method checks compliance with the graphics state architectural
limitation, explained by
.
the operation to check the graphics state counter for
This method checks compliance with the inline image restrictions in the
PDF/A specs, specifically filter parameters.
a
containing the inline image
a
containing the color spaces used in the document
This method checks compliance with the color restrictions imposed by the
available color spaces in the document.
canvas graphics state
the color to check
a
containing the color spaces used in the document
whether the color is used for fill or stroke operations
current content stream
This method performs a range of checks on the given color space, depending
on the type and properties of that color space.
the color space to check
the pdf object to check color space in
a
containing the color spaces used in the document
whether or not to also check the parent color space
whether the color space is used for fill or stroke operations
Set Pdf A output intent color space.
Catalog dictionary to retrieve the color space from.
Checks whether the rendering intent of the document is within the allowed
range of intents.
Checks whether the rendering intent of the document is within the allowed
range of intents. This is defined in ISO 19005-1 section 6.2.9, and
unchanged in newer generations of the PDF/A specification.
the intent to be analyzed
Performs a check of the each font glyph as a Form XObject.
Performs a check of the each font glyph as a Form XObject. See ISO 19005-2 Annex A.5.
This only applies to type 3 fonts.
This method will be abstract in update 7.2
to be checked
stream containing checked font
Performs a number of checks on the graphics state, among others ISO
19005-1 section 6.2.8 and 6.4 and ISO 19005-2 section 6.2.5 and 6.2.10.
Performs a number of checks on the graphics state, among others ISO
19005-1 section 6.2.8 and 6.4 and ISO 19005-2 section 6.2.5 and 6.2.10.
This method will be abstract in the update 7.2
the graphics state to be checked
current content stream
Performs a number of checks on the font.
Performs a number of checks on the font. See ISO 19005-1 section 6.3,
ISO 19005-2 and ISO 19005-3 section 6.2.11.
Be aware that not all constraints defined in the ISO are checked in this method,
for most of them we consider that iText always creates valid fonts.
font to be checked
Verify the conformity of the cross-reference table.
is the Xref table
Verify the conformity of encryption usage.
encryption object to verify
Verify the conformity of the text written by the specified font.
text to verify
font to verify the text against
Attest content stream conformance with appropriate specification.
Attest content stream conformance with appropriate specification.
Throws
if any discrepancy was found.
is a content stream to validate
Attest content stream conformance with appropriate specification.
Attest content stream conformance with appropriate specification.
Throws
if any discrepancy was found.
is a content stream to validate
the resources of the contentStream
Verify the conformity of the operand of content stream with appropriate
specification.
Verify the conformity of the operand of content stream with appropriate
specification. Throws PdfAConformanceException if any discrepancy was found
is an operand of content stream to validate
Retrieve maximum allowed number of indirect objects in conforming document.
maximum allowed number of indirect objects
Retrieve forbidden actions in conforming document.
set of
with forbidden actions
Retrieve allowed actions in conforming document.
set of
with allowed named actions
Checks if the action is allowed.
to be checked
Verify the conformity of the annotation dictionary.
the annotation
to be checked
Checks if entries in catalog dictionary are valid.
the catalog
to be checked
Verify the conformity of used color spaces on the page.
the
contains contents for colors to be checked
the
contains resources for colors to be checked
Verify the conformity of the given image.
the image to check
the
containing the color spaces used in the document
Verify the conformity of the file specification dictionary.
the
containing file specification to be checked
Verify the conformity of the form dictionary.
the form
to be checked
Verify the conformity of the form XObject dictionary.
the
to check
Performs a number of checks on the logical structure of the document.
the catalog
to check
Performs a number of checks on the metadata of the document.
the catalog
to check
Verify the conformity of the non-symbolic TrueType font.
the
to check
Verify the conformity of the output intents array in the catalog dictionary.
the
of a catalog or page to check
Verify the conformity of the page dictionary.
the
to check
the page's resources dictionary
Checks the allowable size of the page.
the
of page which size being checked
Verify the conformity of the PDF array.
the
to check
Verify the conformity of the PDF dictionary.
the
to check
Verify the conformity of the PDF name.
the
to check
Verify the conformity of the PDF number.
the
to check
Verify the conformity of the PDF stream.
the
to check
Verify the conformity of the PDF string.
the
to check
Verify the conformity of the symbolic TrueType font.
the
to check
Verify the conformity of the trailer dictionary.
the
of trailer to check
Verify the conformity of the pdf catalog.
the
of trailer to check
Verify the conformity of the page transparency.
the
contains contents for transparency to be checked
the
contains resources for transparency to be checked
Verify the conformity of the resources dictionary.
the
to be checked
the pdf object to check resources for
Checks if the specified flag is set.
a set of flags specifying various characteristics of the PDF object
to be checked
true if the specified flag is set
Checks conformance of PDF/A standard.
the
to be checked
true if the specified aConformance is a for PDF/A-1, PDF/A-2 or PDF/A-3
Checks whether the specified dictionary has a transparency group.
the
to check
true if and only if the specified dictionary has a
key and its value is
a dictionary with
subtype
Checks whether the specified dictionary was already checked.
the
to check
true if the specified dictionary was checked
Checks resources of the appearance streams.
the dictionary with appearance streams to check.
Check single annotation appearance stream.
the
to check
Exception that is thrown when the PDF Document doesn't adhere to the PDF/A specification.
Creates a PdfAConformanceException.
the error message
Creates a PdfAConformanceException.
the error message
an object
Class that bundles all the error message templates as constants.
Class containing pdfa conformance constants to be used in logging.
Class containing constants to be used in logging.
The class presents default font strategy for PDF/A documents which
doesn't provide default font because all used fonts must be embedded.
Instantiates a new
instance based on the document which will use that strategy.
the pdf document which will use that strategy
.
This class extends
and is in charge of creating files
that comply with the PDF/A standard.
This class extends
and is in charge of creating files
that comply with the PDF/A standard.
Client code is still responsible for making sure the file is actually PDF/A
compliant: multiple steps must be undertaken (depending on the
) to ensure that the PDF/A standard is followed.
This class will throw exceptions, mostly
,
and thus refuse to output a PDF/A file if at any point the document does not
adhere to the PDF/A guidelines specified by the
.
Constructs a new PdfADocument for writing purposes, i.e. from scratch.
Constructs a new PdfADocument for writing purposes, i.e. from scratch. A
PDF/A file has a conformance, and must have an explicit output
intent.
the
object to write to
the generation and strictness level of the PDF/A that must be followed.
a
Constructs a new PdfADocument for writing purposes, i.e. from scratch.
Constructs a new PdfADocument for writing purposes, i.e. from scratch. A
PDF/A file has a conformance, and must have an explicit output
intent.
the
object to write to
the generation and strictness level of the PDF/A that must be followed.
a
a
Opens a PDF/A document in the stamping mode.
PDF reader.
PDF writer.
Opens a PDF/A document in stamping mode.
PDF reader.
PDF writer.
properties of the stamping process
Gets correct
for specified PDF/A conformance.
the conformance for which checker is needed
the correct PDF/A checker
The class is helper which used for PDF/A document to properly configure PDF document's info dictionary.
Instantiates a new
instance based on the document.
the pdf document which will use that helper
.
.
The class implements PDF page factory which is used for creating correct PDF/A documents.
Instantiates a new
instance based on
.
the PDF/A checker
.
.
Utilities to construct an XMP for a PDF/A file.