pspdfkit/com.pspdfkit.annotations/Annotation

Annotation

abstract class Annotation

Represents a generic annotation in the PDF document.

Inheritors

Properties

appearanceStreamGenerator

@Nullable

@get:Nullable

open var appearanceStreamGenerator: AppearanceStreamGenerator

Custom AP stream generator for this annotation.

DEFAULT_BORDER_WIDTH

val DEFAULT_BORDER_WIDTH: Float = 1.0f

Default border width when none is set.

DEFAULT_CLOUDY_BORDER_EFFECT_INTENSITY

val DEFAULT_CLOUDY_BORDER_EFFECT_INTENSITY: Float = 2.0f

Default border effect intensity for cloudy borders.

inReplyTo

@Nullable

@get:Nullable

open var inReplyTo: Annotation

Annotation that this annotation replies to.

OBJECT_NUMBER_NOT_SET

val OBJECT_NUMBER_NOT_SET: Int = -2147483648

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

PAGE_NUMBER_NOT_SET

val PAGE_NUMBER_NOT_SET: Int = -2147483648

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

Functions

attachBinaryInstantJsonAttachment

open fun attachBinaryInstantJsonAttachment(@NonNull dataProvider: DataProvider, @Nullable mimeType: String)

Attaches a binary instant JSON attachment to the annotation.

createTextBlock

fun Annotation.createTextBlock(document: PdfDocument, range: Range): TextBlock

Creates TextBlock from textual annotation.

equals

open fun equals(o: Any): Boolean

fetchBinaryInstantJsonAttachment

@Nullable

open fun fetchBinaryInstantJsonAttachment(@NonNull outputStream: OutputStream): String

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

generateAppearanceStream

@WorkerThread

open fun generateAppearanceStream()

Regenerates the annotation's appearance stream if necessary.

generateAppearanceStreamAsync

@NonNull

open fun generateAppearanceStreamAsync(): Completable

Regenerates the annotation's appearance stream if necessary.

getAlpha

@FloatRange(from = 0.0, to = 1.0)

open fun getAlpha(): Float

Returns the annotation's main alpha (or stroke alpha).

getBlendMode

@NonNull

open fun getBlendMode(): BlendMode

Returns currently set blend mode.

getBorderColor

@ColorInt

open fun getBorderColor(): Int

Returns the border color of this annotation or Color#TRANSPARENT if no color is set.

getBorderDashArray

@Nullable

open fun getBorderDashArray(): List<Integer>

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

getBorderEffect

@NonNull

open fun getBorderEffect(): BorderEffect

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

getBorderEffectIntensity

@FloatRange(from = 0.0)

open fun getBorderEffectIntensity(): Float

Returns the current border effect intensity.

getBorderStyle

@NonNull

open fun getBorderStyle(): BorderStyle

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

getBorderWidth

open fun getBorderWidth(): Float

Returns the border line width / thickness.

getBoundingBox

@NonNull

open fun getBoundingBox(): RectF

@NonNull

open fun getBoundingBox(@Nullable rect: RectF): RectF

Position of this annotation on the page.

getColor

@ColorInt

open fun getColor(): Int

Returns a color associated with this annotation or Color#TRANSPARENT if no color is set.

getContents

@Nullable

open fun getContents(): String

Returns text contents of the annotation.

getCopy

@Nullable

open fun getCopy(@IntRange(from = 0) pageIndex: Int): Annotation

Creates a copy of this annotation that isn't attached to the document with the page index set to given index.

getCreatedDate

@Nullable

open fun getCreatedDate(): Date

Returns the creation date of the annotation.

getCreator

@Nullable

open fun getCreator(): String

Returns the name of the creator of this annotation.

getCustomData

@Nullable

open fun getCustomData(): JSONObject

Retrieves custom data for the annotation.

getFillAlpha

@FloatRange(from = 0.0, to = 1.0)

open fun getFillAlpha(): Float

Returns the fill alpha.

getFillColor

@ColorInt

open fun getFillColor(): Int

Returns a fill color associated with this object or Color#TRANSPARENT if no color is set.

getFlags

@NonNull

open fun getFlags(): EnumSet<AnnotationFlags>

Annotation flags set.

getGroup

@Nullable

open fun getGroup(): String

Returns the group string of the annotation.

getInReplyToAsync

@NonNull

open fun getInReplyToAsync(): Maybe<Annotation>

Retrieves the annotation this annotation replies to asynchronously.

getInstantRecordGroup

@Nullable

open fun getInstantRecordGroup(): String

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

getInternal

@RestrictTo(value = RestrictTo.Scope.LIBRARY_GROUP)

open fun getInternal(): InternalAnnotationApi

Gets APIs for restricted internal usage only.

getMeasurementInfo

@Nullable

open fun getMeasurementInfo(): MeasurementInfo

Returns MeasurementInfo when the annotation is a measurement annotation (see isMeasurement, null if not.

getMinimumSize

@NonNull

open fun getMinimumSize(): Size

Returns the minimum size of the annotation.

getModifiedDate

@Nullable

open fun getModifiedDate(): Date

Returns the date when this annotation was last modified.

getName

@Nullable

open fun getName(): String

Returns the content of Title/Name field of this annotation.

getObjectNumber

open fun getObjectNumber(): Int

The object number of this annotation inside the PDF document file.

getPageIndex

open fun getPageIndex(): Int

The page number to which this annotation belongs.

getRichText

@Nullable

open fun getRichText(): String

Returns rich text contents of the annotation.

getSubject

@Nullable

open fun getSubject(): String

Returns the subject of this annotation.

getType

@NonNull

abstract fun getType(): AnnotationType

Gets the annotation type of the annotation.

getUuid

@NonNull

open fun getUuid(): String

A unique in-memory identifier for each annotation.

hasBinaryInstantJsonAttachment

open fun hasBinaryInstantJsonAttachment(): Boolean

Checks if this annotation has a binary instant JSON attachment.

hasFlag

open fun hasFlag(@NonNull flag: AnnotationFlags): Boolean

Test annotation flag.

hashCode

open fun hashCode(): Int

hasLockedContents

open fun hasLockedContents(): Boolean

Check if the annotation has locked contents - i.e.

isAttached

open fun isAttached(): Boolean

Tells whether this annotation is attached to a document.

isLocked

open fun isLocked(): Boolean

Check if the annotation is locked - i.e.

isMeasurement

open fun isMeasurement(): Boolean

Returns true when the annotation is a measurement annotation.

isModified

open fun isModified(): Boolean

Returns whether the annotation is modified or not.

isReply

open fun isReply(): Boolean

Whether the annotations is a reply to another annotation.

isResizable

open fun isResizable(): Boolean

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

isSignature

open fun isSignature(): Boolean

Returns true when the annotation is a signature annotation.

isUiRotationSupported

open fun isUiRotationSupported(): Boolean

Returns true if this Annotation can be rotated in the UI.

makeNewGroupId

@NonNull

open fun makeNewGroupId(): String

Creates random string to be used as a group name.

renderToBitmap

open fun renderToBitmap(@NonNull bitmap: Bitmap)

open fun renderToBitmap(@NonNull bitmap: Bitmap, @NonNull configuration: AnnotationRenderConfiguration)

Renders the appearance of this annotation into the passed bitmap.

renderToBitmapAsync

open fun renderToBitmapAsync(@NonNull bitmap: Bitmap): Single<Bitmap>

@NonNull

open fun renderToBitmapAsync(@NonNull bitmap: Bitmap, @NonNull configuration: AnnotationRenderConfiguration): Single<Bitmap>

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

setAlpha

open fun setAlpha(@FloatRange(from = 0.0, to = 1.0) alpha: Float)

Sets the annotation's alpha (or stroke alpha) value.

setBlendMode

open fun setBlendMode(@NonNull blendMode: BlendMode)

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

setBorderColor

open fun setBorderColor(@ColorInt color: Int)

Sets the border color for this annotation.

setBorderDashArray

open fun setBorderDashArray(@Nullable dashes: List<Integer>)

Sets a dash style for the border.

setBorderEffect

open fun setBorderEffect(@NonNull borderEffect: BorderEffect)

Sets a border effect for current annotation.

setBorderEffectIntensity

open fun setBorderEffectIntensity(@FloatRange(from = 0.0) borderEffectIntensity: Float)

Sets border effect intensity.

setBorderStyle

open fun setBorderStyle(@NonNull borderStyle: BorderStyle)

Sets a border style for current annotation.

setBorderWidth

open fun setBorderWidth(@FloatRange(from = 0.0) borderWidth: Float)

Sets border line width / thickness.

setBoundingBox

open fun setBoundingBox(@NonNull newBoundingBox: RectF)

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

setColor

open fun setColor(@ColorInt color: Int)

Sets the color for this annotation.

setContents

open fun setContents(@Nullable contents: String)

Sets text contents of the annotation.

setContentSize

open fun setContentSize(@Nullable contentSize: RectF, adjustedForPageRotation: Boolean)

Sets the inner bounds that are used when rotating the annotation.

setCreatedDate

open fun setCreatedDate(@Nullable createdDate: Date)

Sets created date for this annotation.

setCreator

open fun setCreator(@Nullable creator: String)

Sets the creator of this annotation.

setCustomData

open fun setCustomData(@Nullable customData: JSONObject)

Sets custom data to the annotation.

setFillAlpha

open fun setFillAlpha(@FloatRange(from = 0.0, to = 1.0) alpha: Float)

Sets the annotation's fill alpha value if supported.

setFillColor

open fun setFillColor(@ColorInt color: Int)

Sets the fill color for this annotation.

setFlags

open fun setFlags(@NonNull flags: EnumSet<AnnotationFlags>)

Sets annotation flags.

setGroup

open fun setGroup(@Nullable group: String)

Sets the group of the annotation.

setMinimumAnnotationSizeForType

open fun setMinimumAnnotationSizeForType(@NonNull type: AnnotationType, @Nullable size: Size)

Set the minimum size for the specified annotation type in PDF points.

setModifiedDate

open fun setModifiedDate(@Nullable modifiedDate: Date)

Sets last modified date for this annotation.

setName

open fun setName(@Nullable name: String)

Sets Title / Name field for this annotation

setRichText

open fun setRichText(@Nullable richText: String)

Sets rich text contents of the annotation.

setSubject

open fun setSubject(@Nullable subject: String)

Sets the subject of this annotation.

toInstantJson

@NonNull

open fun toInstantJson(): String

Produces Instant JSON representation of this annotation.

toString

@NonNull

open fun toString(): String

updateTransformationProperties

abstract fun updateTransformationProperties(@NonNull newBoundingBox: RectF, @NonNull oldBoundingBox: RectF)

Annotations may override this method to transform their properties (i.e.