AnnotUtils

Applies custom appearance for a FreeText with custom spacing annotation. Note: appearance will only be applied for Android Lollipop and above. A write lock is expected around this call

A read lock is required around this method

A read lock is expected around this method.

Returns the bounding box of the specified annotation in screen space.

Creates a group of annotations

Applies custom appearance for a FreeText annotation that is generated from Android EditText Note 1: This API only takes effect on KitKit and above Note 2: A write lock is expected around this call

Applies custom appearance for a FreeText annotation that is generated from Android EditText Note 1: This API only takes effect on KitKit and above Note 2: A write lock is expected around this call

Attempts to create a new single page PDF document using the appearance from an Android view. Returns the output file if successfully created. If a file already exists, it will get overwritten.

Creates the FreeText appearance from PTRichEditor This method does not lock document, a write lock should be acquired outside

Static function to create a screenshot out of the bounds of an annot rect bbox. Note that this requires a read lock on the PDFDoc.

Asyncronous method for creating screenshots, as some complex files might take some time to render.

Flattens an annotation. A document lock is required around this method.

Viewer and page rotation

Returns the annotation color of the specified annotation.

Returns the annotation image resource ID.

Gets the annotation creation date in local date time

Gets the annotation date in local date time

Returns the annotation opacity of the specified annotation.

A read lock is needed around this method.

Annotation rotation reletive to page and viewer rotation

Gets the annot style A read lock is required for this function.

Returns annotation type as raw plural string (not localized).

Returns annotation type as string.

Returns annotation type as raw string (not localized).

Returns annotation type as string.

Returns annotation type as string.

Gets annotation rotation used in UI, read lock is not required.

Gets annotation count on page excluding certain types A read lock should be acquired outside of this method

Returns all annotations in this group if the annotation passed in is in an annotation group

Checks if the signature widget overlaps with a signature annotation within a certain distance Used to check if any annotations should be linked to the widget

Gets the author for the specified annotation. Annotation needs to be either type of markup or widget.

Gets the unique Id of the IRT parent annotation of this annotation

Converts a com.pdftron.pdf.Date to local Date object

Gets the vertices of a Polyline or a Polygon. This method does not lock the document, so a read lock should be acquired outside.

Gets the rotation degree from Stamp annotation. A read lock is expected around this method.

Gets the deprecated rotation degree from Stamp annotation. A read lock is expected around this method.

Gets the page corresponding to a certain stamp in our stamps repository.

A read lock is required.

Checks whether the annotation has the specified permission

Checks if the annotation is part of a group annotation

Checks if the annotation is an annotation reply

Gets whether the annotation rotation is not a multiple of 90 A read lock is needed around this method.

Gets whether the annotation rotation is not a multiple of 90

Checks if the annotation is area measurement This could return a polygon area or a rectangular area measure A read lock is expected around this method.

Checks if the annotation is an arrow A read lock is expected around this method.

Checks if the annotation is a freetext, but not callout A read lock is expected around this method.

Checks if the annotation is a callout A read lock is expected around this method.

Checks if the annotation is a cloud polygon A read lock is expected around this method.

Checks if the annotation is measure count tool A read lock is expected around this method.

Checks if the annotation is a free highlighter A read lock is expected around this method.

Checks if the annotation is a date text A read lock is expected around this method.

Checks if the annotation is a fill and sign type free text A read lock is expected around this method.

Check whether the selected annotations match an existing group

Checks if the annotation is an image stamp A read lock is expected around this method.

Checks if the annotation is a list box widget A read lock is expected around this method.

Checks if the annotation is perimeter measurement A read lock is expected around this method.

Checks if the annotation is rectangular area measurement A read lock is expected around this method.

Checks if the annotation is an ruler A read lock is expected around this method.

Checks if the annotation is a signature stamp A read lock is expected around this method.

Checks if annot is a SignatureField Widget A read lock is expected around this method.

Checks if the annotation is a line with no ending styles A read lock is expected around this method.

Checks if annot is a TextField Widget A read lock is expected around this method.

Sets the rotation degree for FreeText annotation. A write lock is expected around this method.

Sets the rotation degree from Stamp annotation. A write lock is expected around this method.

helper function to refresh annotation appearance. Note that some annotations may have their own custom appearance such as Text annotation.

Delete all annotations except for links and form fields This method does not lock document, a write lock should be acquired outside

Used in replacement of annotRemove(Annot) to handle direct object The returned Annot object should be used after this function. The Annot parameter should no longer be used after this function.

Used in replacement of annotRemove(Annot) to handle direct object and updates the viewer The returned Annot object should be used after this function. The Annot parameter should no longer be used after this function.

Delete all annotations except for links and form fields on pages This method does not lock document, a write lock should be acquired outside

Saves the free text in cache.

A write lock is required.

Sets the author for the specified markup annotation.

This method does not lock the document, so a write lock should be acquired outside.

Sets the author for the specified annotation, if possible.

This method does not lock the document, so a write lock should be acquired outside.

A write lock is expected around this call

A write lock is expected around this call

Sets the unique identifier for the specified annotation, if possible.

This method does not lock the document, so a write lock should be acquired outside.

Traverse over all annotations on the specified page. The visitor will be called for each annot via visit(Annot), allowing for arbitrary operations to be performed on the annot.

This method does not lock the document, so a read lock should be acquired outside.

Traverse over all annotations in the specified document. The AnnotUtils.AnnotVisitor will be called for each annot via visit(Annot), allowing for arbitrary operations to be performed on the annot.

This method does not lock the document, so a read lock should be acquired outside.

Traverse over all annotations in the specified document. The AnnotUtils.AnnotWithPageVisitor will be called for each annot via visit(Pair), allowing for arbitrary operations to be performed on the annot.

This method does not lock the document, so a read lock should be acquired outside.

Traverse over all annotations on the specified page. The visitor will be called for each annot via visit(Pair), allowing for arbitrary operations to be performed on the annot.

This method does not lock the document, so a read lock should be acquired outside.

Traverse over all pages in the specified document. The visitor will be called for each page via visit(Page), allowing for arbitrary operations to be performed on the page.

This method does not lock the document, so a read lock should be acquired outside.

Updates the annotation based on the new page and new screen Rect, so that the appearance will look right side up from the user's perspective. It will update any data points in the annotation based on the new page according to its rotation if needed (such as Ink Points, Poly points, Line points, etc...).

For Images, Signatures, Stamps, or any annotation with custom appearance, the appearance itself will be rotated if needed. You should not call refreshAppearance afterwards, otherwise the custom appearance will be lost.

A write lock is required around this method.

Updates the Rect and content Rect of the annotation when the annotation is moved. This method supports moving between different pages.

A write lock is required around this method.

Returns an XFDF command with add, modify, and delete tags containing annotations associated with the given annotation ids and PDFDoc.

Requires caller to hold a read lock.