itext.pdfua

The class defines the requirements of the PDF/UA-1 standard and contains method implementations from the abstract class.

The class defines the requirements of the PDF/UA-1 standard and contains method implementations from the abstract class. The specification implemented by this class is ISO 14289-1.

Creates PdfUA1Checker instance with PDF document which will be validated against PDF/UA-1 standard.

the document to validate

Verify the conformity of the file specification dictionary.

the containing file specification to be checked

Checks that the Catalog dictionary of a conforming file (the version number of a file may be any value from 1.0 to 1.7) contains the Metadata key whose value is a metadata stream.

Checks that the Catalog dictionary of a conforming file (the version number of a file may be any value from 1.0 to 1.7) contains the Metadata key whose value is a metadata stream. Also checks that the value of pdfuaid:part is 1 for conforming PDF files. Checks that the Metadata stream in the document catalog dictionary includes a dc:title entry reflecting the title of the document. document catalog dictionary

For all non-symbolic TrueType fonts used for rendering, the embedded TrueType font program shall contain one or several non-symbolic cmap entries such that all necessary glyph lookups can be carried out.

the embedded TrueType font program to check

Checks cmap entries present in the embedded TrueType font program of the symbolic TrueType font.

Checks cmap entries present in the embedded TrueType font program of the symbolic TrueType font. The “cmap” table in the embedded font program shall either contain exactly one encoding or it shall contain, at least, the Microsoft Symbol (3,0 – Platform ID = 3, Encoding ID = 0) encoding. the embedded TrueType font program to check

This method checks the requirements that must be fulfilled by a COS object in a PDF/UA document.

the COS object that must be checked

The class defines the requirements of the PDF/UA-2 standard and contains method implementations from the abstract class.

The class defines the requirements of the PDF/UA-2 standard and contains method implementations from the abstract class. The specification implemented by this class is ISO 14289-2.

Creates instance with PDF document which will be validated against PDF/UA-2 standard.

the document to validate

Gets the PDF/UA validation context which contains common information and utilities used for PDF/UA validation.

the PDF/UA validation context

Gets the PDF document being validated.

the PDF document being validated

Checks that the Catalog dictionary of a conforming file contains the Metadata key whose value is a metadata stream as defined in ISO 32000-2:2020.

Checks that the Catalog dictionary of a conforming file contains the Metadata key whose value is a metadata stream as defined in ISO 32000-2:2020. Also checks that the value of pdfuaid:part is 2 for conforming PDF files and validates required pdfuaid:rev value. Checks that the Metadata stream as specified in ISO 32000-2:2020, 14.3 in the document catalog dictionary includes a dc: title entry reflecting the title of the document. document catalog dictionary

Checks that the given PDF object and all its descendant objects recursively (if any) are compliant with PDF/UA-2 standard.

Checks that the given PDF object and all its descendant objects recursively (if any) are compliant with PDF/UA-2 standard. The check is performed on all objects except for indirect objects. the PDF object to check

Validates document catalog dictionary against PDF/UA-2 standard.

document catalog dictionary to check

Validates all annotations and form fields present in the document against PDF/UA-2 standard.

to check form fields present in the acroform

Validates structure tree root dictionary against PDF/UA-2 standard.

Validates structure tree root dictionary against PDF/UA-2 standard. Additionally, checks that within a given explicitly provided namespace, structure types are not role mapped to other structure types in the same namespace. In the StructTreeRoot RoleMap there is no explicitly provided namespace, that's why it is not checked. structure tree root dictionary to check

Creates responsible for validation of tag tree elements.

to be validated responsible for validation of tag tree elements

For all non-symbolic TrueType fonts used for rendering, the embedded TrueType font program shall contain at least the Microsoft Unicode (3, 1 – Platform ID = 3, Encoding ID = 1), or the Macintosh Roman (1, 0 – Platform ID = 1, Encoding ID = 0) “cmap” subtable.

the embedded TrueType font program to check

Checks cmap entries present in the embedded TrueType font program of the symbolic TrueType font.

Checks cmap entries present in the embedded TrueType font program of the symbolic TrueType font. The “cmap” subtable in the embedded font program shall either contain the Microsoft Symbol (3, 0 – Platform ID = 3, Encoding ID = 0) or the Mac Roman (1, 0 – Platform ID = 1, Encoding ID = 1) encoding. the embedded TrueType font program to check

An abstract class that will run through all necessary checks defined in the different PDF/UA standards.

An abstract class that will run through all necessary checks defined in the different PDF/UA standards. 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 14289 specifications, currently generations 1 and 2. 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/UA, which would be possible with client code implementations. Any future generations of the PDF/UA standard and its derivatives will get their own implementation in the iText - pdfua project.

Creates new instance.

Logs a warn on page flushing that page flushing is disabled in PDF/UA mode.

Checks that the default natural language for content and text strings is specified using the Lang entry, with a nonempty value, in the document catalog dictionary.

document catalog dictionary

Checks that the ViewerPreferences dictionary of the document catalog dictionary is present and contains at least the DisplayDocTitle key with a value of , as defined in ISO 32000-1:2008, 12.2, Table 150 or ISO 32000-2:2020, Table 147.

document catalog dictionary

Checks that all optional content configuration dictionaries in the file, including the default one, shall contain a Name entry (see ISO 32000-2:2020, Table 96, or ISO 32000-1:2008, 8.11.2.1, Table 98) whose value is a non-empty text string when document contains a Configs entry in the OCProperties entry of the document catalog dictionary (see ISO 32000-2:2020, Table 29, or ISO 32000-1:2008, 7.7.2, Table 28), and the Configs entry contains at least one optional content configuration dictionary.

Checks if content marked as Artifact resides in Artifact content, but real content does not.

the tag structure stack the current BMC to check

Checks if content is neither marked as Artifact nor tagged as real content.

tag structure stack to check

Checks that font programs for all fonts used for rendering within a conforming file, as determined by whether at least one of its glyphs is referenced from one or more content streams, are embedded within that file, as defined in ISO 32000-2:2020, 9.9 and ISO 32000-1:2008, 9.9. Checks character encodings rules as defined in ISO 14289-2, 8.4.5.7 and ISO 14289-1, 7.21.6. collection of fonts used in the document

Checks cmap entries present in the embedded TrueType font program of the non-symbolic TrueType font.

the embedded TrueType font program to check

Checks cmap entries present in the embedded TrueType font program of the symbolic TrueType font.

the embedded TrueType font program to check

Checks that embedded fonts define all glyphs referenced for rendering within the conforming file.

the text to check the font to check

Creates new instance.

Class that provides methods for checking PDF/UA compliance of actions.

Check PDF/UA compliance of an action

action to check

Class that provides methods for checking PDF/UA compliance of annotations.

Is annotation visible: if hidden flag isn't set and annotation intersects CropBox (default value is MediaBox).

annotation to check if annotation should be checked, otherwise

Helper class that checks the conformance of annotations while iterating the tag tree structure.

Creates a new instance of the .

The validation context

This class is a validator for IETF BCP 47 language tag (RFC 5646).

Validate language tag against RFC 5646.

language tag string if it is a valid tag, otherwise

Class that holds the validation context while iterating the tag tree structure.

The validation context that holds necessary information during the tag tree iteration.

Creates a new instance of the .

The validation context

Class that provides methods for checking PDF/UA compliance of interactive form fields.

Creates a new instance.

Handler for checking form field elements in the tag tree.

Creates a new instance.

The validation context

Gets a widget annotation kid if it exists.

Parent structure element Kid as PdfDictionary

Class that provides methods for checking PDF/UA compliance of Formula elements.

Creates a new instance.

Handler for checking Formula elements in the TagTree.

Creates a new instance.

The validation context

Class that provides methods for checking PDF/UA compliance of graphics elements.

Creates a new instance.

The validation context

Checks if image has alternative description or actual text.

the image to check

Helper class that checks the conformance of graphics tags while iterating the tag tree structure.

Creates a new instance of the .

the validation context

Utility class which performs headings check according to PDF/UA-1 specification.

Creates a new instance of .

the validation context

Checks if layout element has correct heading.

layout element to check

Checks if structure element has correct heading.

structure element to check

Handler class that checks heading tags while traversing the tag tree.

Creates a new instance of .

the validation context

Utility class for delegating the layout checks to the correct checking logic.

Creates a new instance.

the validation context

Checks renderer for PDF UA compliance.

the renderer to check

Utility class for delegating notes checks to the correct checking logic.

Creates a new instance of .

Handler for checking Note elements in the TagTree.

Creates a new instance.

The validation context

This class keeps track of useful information when validating a PdfUaDocument.

This class keeps track of useful information when validating a PdfUaDocument. It also contains some useful utility functions that help with PDF UA validation.

Creates a new instance of .

the instance that is being validated

Resolves the node's role to a standard role.

The node you want to resolve the standard role for The role

Resolves the role to a standard role.

the role you want to resolve the standard role for resolved role

Resolves the role to a standard role.

the role you want to resolve the standard role for namespace where role is defined resolved role

Checks if a resolved role's is equal to the provided role.

Checks if a resolved role's is equal to the provided role. Note: This method will not check recursive mapping. So either the node's role is the provided role, or the standard role is the provided role. So we do not take into account the roles in between the mappings. The role we want to check against The structure node we want to check The if the role matches

Retrieves object reference instance by provided structure parent index.

index of the structure parent of the page that belong to instance

Retrieves the PDF/UA conformance of the .

value

Class that represents a matrix of cells in a table.

Class that represents a matrix of cells in a table. It is used to check if the table has valid headers and scopes for the cells. the type of the cell

Creates a new instance.

the iterator that will be used to iterate over the cells of the document that is being checked

Runs the algorithm to check if the table has valid headers and scopes for the cells.

Class that has the result of the algorithm that checks the table for PDF/UA compliance.

Creates a new instance.

The table that needs to be checked The validation context

Interface that provides methods for iterating over the elements of a table.

Checks if there is a next element in the iteration.

if there is a next element, otherwise

Gets the next element in the iteration.

the next element

Gets the number of rows in the body of the table.

the number of rows in the body of the table

Gets the number of rows in the header of the table.

the number of rows in the header of the table

Gets the number of rows in the footer of the table.

the number of rows in the footer of the table

Returns the amount of columns the table has.

Returns the amount of columns the table has. All rows in a table in UA specification must have the same column count. So return the max column count for correctly generated error messages. the amount of columns

Gets the row index of the current position.

the row index

Gets the column index of current position.

the column index

Gets the rowspan of current position.

the rowspan

Gets the colspan of the current position

the colspan of current position

The result matrix to validate PDF UA1 tables based on the TagTreeStructure of the document.

Creates a new instance.

a table structure element The validation context

Class that iterates over the cells of a table.

Creates a new instance.

the table that will be iterated the validation context

Class that provides methods for checking PDF/UA compliance of table elements.

Creates a new instance.

the validation context

Checks if the table is pdf/ua compliant.

the table to check

Handler class that checks table tags.

Creates a new instance of .

the validationContext

Creates an iterator to iterate over the table structures.

Creates a new instance.

the root table struct element the validation context

Checks if there is a next element in the iteration.

if there is a next element, otherwise

Gets the next table structure element in the iteration.

the next in the iteration

Gets the number of rows in the body of the table.

the number of rows in the table body

Gets the number of rows in the header of the table.

the number of rows in the table header

Gets the number of rows in the footer of the table.

the number of rows in the table footer

Gets the total number of columns in the table.

the total number of columns in the table

Gets the zero-based row index of the current table element.

the zero-based row index of the current element

Gets the zero-based column index of the current table element.

the zero-based column index of the current element

Gets the rowspan attribute value of the current table element.

the rowspan value of the current element (minimum 1)

Gets the colspan attribute value of the current table element.

the colspan value of the current element (minimum 1)

Class that provides methods for checking PDF/UA-1 compliance of annotations.

Is annotation visible: if hidden flag isn't set and annotation intersects CropBox (default value is MediaBox).

annotation to check if annotation should be checked, otherwise

Checks the annotation element for PDF/UA-1 compliance.

The validation context The structure element to check

Helper class that checks the conformance of annotations while iterating the tag tree structure.

Creates a new instance of the .

the validation context

Class that provides methods for checking PDF/UA-1 compliance of interactive form fields.

Creates a new instance.

Checks "Form" structure element.

structure element to check

Gets a widget annotation kid if it exists.

parent structure element kid as

Handler for checking form field elements in the tag tree.

Creates a new instance.

the validation context

Class that provides methods for checking PDF/UA-1 compliance of Formula elements.

Checks "Formula" structure element.

structure element to check

Handler for checking Formula elements in the TagTree.

Creates a new instance.

The validation context

Utility class which performs headings check according to PDF/UA-1 specification.

Creates a new instance of .

the validation context

Checks if layout element has correct heading.

layout element to check

Checks if structure element has correct heading.

structure element to check

Handler class that checks heading tags while traversing the tag tree.

Creates a new instance of .

the validation context

Utility class which performs lists check according to PDF/UA-1 specification.

Creates a new instance of .

the validation context

Checks if list element has correct tag structure according to PDF/UA-1 specification.

Checks if list element has correct tag structure according to PDF/UA-1 specification. Conforming files shall tag any real content within LI structure element as either Lbl or LBody. list structure element to check

Handler class that checks list tags while traversing the tag tree.

Creates a new instance of .

the validation context

Utility class for delegating notes checks to the correct checking logic.

Handler for checking Note elements in the TagTree.

Creates a new instance.

The validation context

Utility class which performs XFA forms check according to PDF/UA-1 specification.

Checks XFA form of the document if exists.

the document to check

Class that provides methods for checking PDF/UA-2 compliance of annotations.

Creates a new instance of the .

Checks PDF/UA-2 compliance of the annotations in the document.

to check annotations for

Checks PDF/UA-2 compliance of the annotation.

the annotation dictionary to check used to find the structure node enclosing the annotation using its StructParent value

Checks PDF/UA-2 compliance of the annotations.

to check annotations for

Checks PDF/UA-2 compliance of the annotation.

the annotation dictionary to check used to find the structure node enclosing the annotation using its StructParent value

Checks the PDF/UA-2 requirements related to the Contents entry for specific annotation types.

the annotation subtype the annotation dictionary

Checks PDF/UA-2 compliance of the annotation.

the annotation dictionary to check the parent structure element

Checks the PDF/UA-2 8.9.2.3 Markup annotations requirements.

the markup annotations the parent role

Handler for checking annotation elements in the tag tree.

Creates a new instance of the .

the validation context

Utility class which performs UA-2 checks related to Replacements and Alternatives.

Creates instance.

Collects all text strings, which contain PUA Unicode values.

which contains all the data needed for validation

Checks previously collected data according to Replacements and Alternatives UA-2 rules.

to be checked

Utility class which performs UA-2 checks related to intra-document destinations.

Creates instance.

which contains destination which was added instance to which destination was added

Creates instance.

instance in which destinations shall be checked

Checks all the destinations in the document.

Checks specific destination which was recently added.

Utility class which performs the EmbeddedFiles name tree check according to PDF/UA-2 specification.

Verify the conformity of the EmbeddedFiles name tree.

document catalog dictionary

Verify the conformity of the file specification dictionary.

the containing file specification to be checked

Class that provides methods for checking PDF/UA-2 compliance of interactive form fields.

Creates a new instance.

the validation context

Verifies the conformity of the widget annotation present in the document.

Verifies the conformity of the widget annotation present in the document. Checks that each widget annotation is either Form structure element or an Artifact; if label for a widget annotation is not present or an additional action (AA) entry is present, Contents entry is provided. the to check widgets from

Verifies the conformity of the document Acroform dictionary.

Verifies the conformity of the document Acroform dictionary. Checks that each widget annotation is either Form structure element or an Artifact; if label for a widget annotation is not present or an additional action (AA) entry is present, Contents entry is provided; text field RV and V values are textually equal. the form to be checked

Checks "Form" structure element.

structure element to check

Checks that Form structure element contains at most one widget annotation.

Form structure element to check

Handler for checking form field elements in the tag tree.

Creates a new instance.

the validation context

Utility class which performs "Formula" tag related checks according to PDF/UA-2 specification.

Checks if "math" structure element from "MathML" namespace is enclosed within "Formula" tag.

structure element to check

Handler class that checks "Formula" tags while traversing the tag tree.

Creates a new instance of .

the validation context

Utility class which performs headings check according to PDF/UA-2 specification.

Creates a new instance of .

the validation context

Checks if layout element has correct heading according to PDF/UA-2 specification.

Checks if layout element has correct heading according to PDF/UA-2 specification. Conforming files shall use the explicitly numbered heading structure types (H1-Hn) and shall not use the H structure type. Note, that PDF/UA-2 specification does not include requirements on the use of sequential heading levels. But where a heading’s level is evident, the heading level of the structure element enclosing it shall match that heading level, e.g. a heading with the real content “5.1.6.4 Some header” is evidently at heading level 4. This requirement is not checked. layout element to check

Checks if layout element has correct heading according to PDF/UA-2 specification.

Handler class that checks heading tags while traversing the tag tree.

Creates a new instance of .

the validation context

Class that provides methods for checking PDF/UA-2 compliance of link annotations.

Verifies that each link annotation present in the document is tagged.

the to check links for

Checks that link annotation is enclosed in either a Link or Reference structure element.

Checks that link annotation is enclosed in either a Link or Reference structure element. Also checks that link annotations that target different locations are in separate Link or Reference structure elements, and multiple link annotations targeting the same location are included in a single Link or Reference structure element. link annotation object reference in the structure tree

Checks that link annotations that target different locations (destinations) are in separate Link or Reference structure elements, and multiple link annotations targeting the same location are included in a single Link or Reference structure element.

link annotation object reference in the structure tree

Helper class that checks the conformance of link annotations while iterating the tag tree structure.

Creates a new instance of the .

the validation context the to check link annotations for

Utility class which performs lists check according to PDF/UA-2 specification.

Creates a new instance of .

the validation context

Checks if list element has correct tag structure according to PDF/UA-2 specification.

Checks if list element has correct tag structure according to PDF/UA-2 specification. Conforming files shall tag any real content within LI structure element as either Lbl or LBody. For list items, if Lbl is present, not None ListNumbering attribute shall be specified on the respective L structure element. list structure element to check

Handler class that checks list tags while traversing the tag tree.

Creates a new instance of .

the validation context

Utility class which performs Note and FENote checks according to PDF/UA-2 specification.

Checks if Note and FENote elements are correct according to PDF/UA-2 specification.

list structure element to check

Handler class that checks Note and FENote tags while traversing the tag tree.

Creates a new instance of .

the validation context

Utility class which performs UA-2 checks related to PdfString objects.

Checks PdfString object to be UA-2 compatible.

to be checked

Utility class which performs table of contents check according to PDF/UA-2 specification.

Creates a new instance of .

the validation context

Checks that table of contents item identifies the target of the reference according to PDF/UA-2 specification.

Checks that table of contents item identifies the target of the reference according to PDF/UA-2 specification. Each TOCI in the table of contents shall identify the target of the reference using the Ref entry, either directly on the TOCI structure element itself or on a child structure element contained within, such as a Reference structure element. TOCI structure element to check

Handler class that checks TOCI tags while traversing the tag tree.

Creates a new instance of .

the validation context

Utility class which performs XFA forms check according to PDF/UA-2 specification.

Checks if XFA form of the document exists.

the document to check

Utility class which performs XFA forms check according to PDF/UA specification.

Checks XFA form of the document if exists.

the document to check

Exception that is thrown when the PDF Document doesn't adhere to the PDF/UA specification.

Creates a PdfUAConformanceException.

the error message

Creates a PdfUAConformanceException.

the detail message the cause

Class that bundles all the error message templates as constants.

Class containing the log message constants.

Class that holds the configuration for the PDF/UA document.

Creates a new PdfUAConfig instance.

the conformance of the PDF/UA document the title of the PDF/UA document the language of the PDF/UA document

Gets the UA conformance.

The

Gets the title.

The title

Gets the language.

The language

Creates a Pdf/UA document.

Creates a Pdf/UA document. This class is an extension of PdfDocument and adds the necessary configuration for PDF/UA conformance. It will add necessary validation to guide the user to create a PDF/UA compliant document.

Creates a PdfUADocument instance.

The writer to write the PDF document The configuration for the PDF/UA document

Creates a PdfUADocument instance.

The writer to write the PDF document The properties for the PDF document The configuration for the PDF/UA document

Creates a PdfUADocument instance.

The reader to read the PDF document The writer to write the PDF document The configuration for the PDF/UA document

Creates a PdfUADocument instance.

The reader to read the PDF document The writer to write the PDF document The properties for the PDF document The configuration for the PDF/UA document

Creates a list of for specified PDF/UA conformance.

Creates a list of for specified PDF/UA conformance. If you want to enable/disable specific checks, you can override the implementation. the conformance for which checker is needed the correct list of PDF/UA checkers

Creates new instance.

the object on which the will be based to check the requirements of the PDF/UA-1 standard

Creates new instance.

the object which will contain the the size of the to check the requirements of the PDF/UA-1 standard

Creates new instance.

the object on which the will be based to check the requirements of the PDF/UA standard

Creates new instance.

the object which will contain the the size of the to check the requirements of the PDF/UA standard

The class implements PDF page factory which is used for creating correct PDF/UA documents.

Instantiates a new instance based on .

the PDF/UA checker the object on which the will be based The based on the to add page of the created page The based on the and

Class that holds the configuration for the Well Tagged PDF document.

Creates a new WellTaggedPdfConfig instance.

the conformance of the Well Tagged PDF document the title of the Well Tagged PDF document the language of the Well Tagged PDF document

Creates a new WellTaggedPdfConfig instance.

the conformance of the Well Tagged PDF document the title of the Well Tagged PDF document the language of the Well Tagged PDF document

Gets the Well Tagged PDF conformance.

The

Gets the title.

The title

Gets the language.

The language

Creates a Well Tagged PDF document.

Creates a Well Tagged PDF document. This class is an extension of PdfDocument and adds the necessary configuration for Well Tagged conformance. It will add necessary validation to guide the user to create a Well Tagged compliant document.

Creates a WellTaggedPdfDocument instance.

The writer to write the PDF document The configuration for the Well Tagged document

Creates a WellTaggedPdfDocument instance.

The writer to write the PDF document The properties for the PDF document The configuration for the Well Tagged document

Creates a WellTaggedPdfDocument instance.

The reader to read the PDF document The writer to write the PDF document The configuration for the Well Tagged document

Creates a WellTaggedPdfDocument instance.

The reader to read the PDF document The writer to write the PDF document The properties for the PDF document The configuration for the Well Tagged document

Creates a list of for Well Tagged conformance.

Creates a list of for Well Tagged conformance. If you want to enable/disable specific checks, you can override the implementation. the Well Tagged PDF conformance for which the checkers should be created list of Well Tagged related checkers

Checker that validates a PDF document against the Well Tagged PDF for Accessibility standard.

Creates a new instance.

Creates a new instance. The created checker will validate the provided document against the WTPDF for Accessibility standard. the to validate; must not be

Checks that the Catalog dictionary of a conforming file contains the Metadata key whose value is a metadata stream as defined in ISO 32000-2:2020.

Checks that the Catalog dictionary of a conforming file contains the Metadata key whose value is a metadata stream as defined in ISO 32000-2:2020. Checks that the Metadata stream as specified in ISO 32000-2:2020, 14.3 in the document catalog dictionary includes a dc: title entry reflecting the title of the document. document catalog dictionary

A specialized annotation checker for well-tagged PDFs intended for reuse, which extends the standard PdfUA2AnnotationChecker to enforce additional requirements specific to this specification.

Creates a new instance of the .

Handler for checking annotation elements in the tag tree.

Creates a new instance of the .

the validation context

class performs validation of a PDF document against WTPDF For Reuse standard.

Creates instance which will be validated against WTPDF For Reuse standard.

the document to validate

Validates document catalog dictionary against PDF/UA-2 standard.

document catalog dictionary to check

Validates all annotations and form fields present in the document against PDF/UA-2 standard.

to check form fields present in the acroform

Checks that the Catalog dictionary of a conforming file contains the Metadata key whose value is a metadata stream as defined in ISO 32000-2:2020.

Performs layout checks for a PDF document being validated against the Well Tagged PDF for Reuse standard.

Creates a new instance.

the validation context

Checks renderer for PDF UA compliance.

the renderer to check