Annotation

Default border width when none is set.

Default border effect intensity for cloudy borders.

Return value for when the annotation doesn't have a set object number.

Return value for when the annotation doesn't have a set page number.

Default minimum size of an annotation in PDF points.

Attaches a binary instant JSON attachment to the annotation. Can later be fetched using fetchBinaryInstantJsonAttachment(OutputStream).

If this annotation has a binary instant JSON attachment, this will write it into the provided OutputStream.

Regenerates the annotation's appearance stream if necessary.

Note: this call may block for a while and should not be invoked on the main thread.

Regenerates the annotation's appearance stream if necessary.

Returns the annotation's alpha.

Returns custom appearance stream generator that overrides appearance stream generation of this annotation.

Returns currently set blend mode. Defaults to NORMAL for all annotations except highlight.

Returns the border color of this annotation or Color#TRANSPARENT if no color is set. Note that alpha channel is not taken into account as per PDF specifications.

Returns currently set dash array or null if no pattern is set.

Returns the current border effect on the annotation or NO_EFFECT if none is set.

Returns the current border effect intensity.

Returns the current border style on the annotation or NONE if none is set.

Returns the border line width / thickness.

Position of this annotation on the page. Changing bounding box does not change annotations bounds. Instead call setBoundingBox(RectF) to change annotation bounds.

Position of this annotation on the page. The returned RectF is a copy, so changing its values won't update the annotation's bounds. Instead call setBoundingBox(RectF) providing the altered rect to update the annotation.

Returns a color associated with this annotation or Color#TRANSPARENT if no color is set. Note that alpha channel is not taken into account as per PDF specifications. This is the text color for FreeTextAnnotation and WidgetAnnotation.

Returns text contents of the annotation. This is usually the displayed text for annotations that display text or accessibility label for annotations that don't.

Creates a copy of this annotation that isn't attached to the document with the page index set to given index. If this type of annotation can't be copied this method will return null.

Note: This will reset the name of the resulting annotation to an automatically generated UUID if you want to keep the original name you have to manually set it on the returned copy.

Returns the creation date of the annotation.

Returns the name of the creator of this annotation.

Retrieves custom data for the annotation.

Annotations can store additional user-specified data. PSPDFKit will not use or evaluate customData in the UI directly. You have full control over this property. For new annotation, this defaults to null.

Returns a fill color associated with this object or Color#TRANSPARENT if no color is set. Note that alpha channel is not taken into account as per PDF specifications.

Annotation flags set. Changing returned EnumSet does not change annotation flags. Instead call setFlags(EnumSet) to change annotation flags.

Retrieves the annotation this annotation replies to, or null it this annotation is not a reply or the license doesn't support replies feature.

Note: this call may block for a while and should not be invoked on the main thread.

Retrieves the annotation this annotation replies to asynchronously. The response is emitted inside the RxJava's Maybe. It will contain the requested annotation if it exists, or be empty otherwise.

Gets instant record group of the annotation, or null if this annotation is detached.

Returns MeasurementInfo when the annotation is a measurement annotation (see isMeasurement(), null if not. Throws an InvalidPSPDFKitLicenseException if measurement tools component is not licensed. Throws an IllegalStateException if there is an issue generating the information.

Returns the minimum size of the annotation.

Returns the date when this annotation was last modified.

Returns the content of Title/Name field of this annotation. This can be used to globally identify the annotation. This property will be automatically set to a type 4 (pseudo random) UUID during annotation construction time.

The object number of this annotation inside the PDF document file. This method will only return a valid object number if this annotation is attached to a document (i.e. when isAttached() returns true). If the annotation is not attached to any document, this method will return OBJECT_NUMBER_NOT_SET.

Note that there is no guarantee that object numbers stay the same when saving and reopening a document. If a persistent identifier is required, use the getName() property instead, which by default is initialized to hold a type 4 (pseudo randomly generated) UUID.

The page number to which this annotation belongs. If the annotation is not attached to any document, this method will return PAGE_NUMBER_NOT_SET.

Returns rich text contents of the annotation. This is text to be displayed in a pop-up for text markup annotations.

Returns the subject of this annotation.

Gets the annotation type of the annotation.

A unique in-memory identifier for each annotation. Generated at runtime, therefore not persisted (in the PDF).

Unlike getName(), this method is guaranteed to always return a non-null value, even for existing annotations in a document.

Checks if this annotation has a binary instant JSON attachment. For example, a stamp annotation with an image has one.

Test annotation flag.

Check if the annotation has locked contents - i.e. annotation content can't be modified.

Tells whether this annotation is attached to a document.

Check if the annotation is locked - i.e. annotation can't be deleted or modified (except contents).

Returns true when the annotation is a measurement annotation. Measurement annotations can be: - LineAnnotation: Distance measurement - PolylineAnnotation: Perimeter measurement - PolygonAnnotation: Polygonal area measurement - CircleAnnotation: Elliptical area measurement - SquareAnnotation: Rectangular area measurement

Returns whether the annotation is modified or not.

Whether the annotations is a reply to another annotation.

Check if the annotation is resizable, or if this is a non-resizable annotation.

Returns true when the annotation is a signature annotation. Annotations that can be signatures are InkAnnotation and StampAnnotation.

Renders the appearance of this annotation into the passed bitmap.

Renders the appearance of this annotation into the passed bitmap.

Asynchronously renders the appearance of this annotation into the passed bitmap.

Asynchronously renders the appearance of this annotation into the passed bitmap.

Sets the annotations' alpha value. It's the value in range <0.0f...1.0f>.

Sets custom appearance stream generator that overrides appearance stream generation of this annotation. The appearanceStreamGenerator will be called when necessary to generate annotation's appearance stream.

Note: This does not automatically remove existing appearance streams. The appearance stream only gets generated when the annotation has been modified or when calling generateAppearanceStream() explicitly.

Sets the blend mode used when generating annotation's appearance stream.

Sets the border color for this annotation. Border color usually redirects to color, unless overridden to have a real backing store (this is the case for WidgetAnnotation).

Note: The annotation will only store the RGB part and discard the alpha channel set here. Annotation opacity is set via the setAlpha(float) property.

Sets a dash style for the border. It's in form of an array where the numbers mean full_length, empty length, full_length... etc.. The pattern is repeated.

To get a dashed border, setBorderStyle(BorderStyle) should be set to DASHED and color of the border should be set with setBorderColor(int).

Sets a border effect for current annotation. Currently supports no effect and cloudy.

Note: setBorderEffectIntensity(float) should be set to non-zero (e.g. 1.0) for Cloudy border to be displayed.

Sets border effect intensity. Valid only if the border effect is CLOUDY. The value is suggested to be between 0 and 2 but other values are valid as well. Default value is 0.

Sets a border style for current annotation. It should be accompanied with setBorderColor(int) call to set the border color as well.

Sets border line width / thickness. For border to appear, color and style should be set via setBorderColor(int) and setBorderStyle(BorderStyle) as well.

Sets the position and size of this annotation on the page.

Sets the color for this annotation. This is the text color for FreeTextAnnotation, WidgetAnnotation, and RedactionAnnotation.

Note: The annotation will only store the RGB part and discard the alpha channel set here. Annotation opacity is set via the setAlpha(float) property.

Sets text contents of the annotation. This is usually the displayed text for annotations that display text or accessibility label for annotations that don't.

Sets created date for this annotation.

Sets the creator of this annotation.

Sets custom data to the annotation. The contents of this property are saved to the document when saving.

Annotations can store additional user-specified data here. PSPDFKit will not use or evaluate customData in the UI directly. You have full control over this property. For new annotation, this defaults to null.

Sets the fill color for this annotation. Only used for certain annotation types. LinkAnnotations, for example, aren't affected by this property.

Note: The annotation will only store the RGB part and discard the alpha channel set here. Annotation opacity is set via the setAlpha(float) property.

Sets annotation flags.

Sets the annotation that this annotation replies to.

Sets last modified date for this annotation.

Sets Title / Name field for this annotation

Sets rich text contents of the annotation. This is the text to be displayed in a pop-up for text markup annotations.

Sets the subject of this annotation.

Starting with PSPDFKit 5.0 this method will no longer affect the appearance of stamp annotations. Use setStampType(StampType) and setTitle(String) instead.

Produces Instant JSON representation of this annotation.

Note: Make sure the annotation is attached to the document before exporting it to Instant JSON.

Annotations may override this method to transform their properties (i.e. points, rects, sizes) whenever the bounding box of the annotation changed.

Return the measurement label and value for this annotation if it is a measurement. Returns null if it's not a measurement. Overridden in child shape annotations who can be measurements. Calculates the measurement value based on the passed `measurementProperties` and shape size.