pspdfkit/com.pspdfkit.annotations/FileAnnotation

FileAnnotation

Represents an annotation associated with EmbeddedFile.

Constructors

constructor(@IntRange(from = 0) pageIndex: Int, @NonNull boundingBox: RectF, @NonNull embeddedFileSource: EmbeddedFileSource)

Creates a new file annotation.

constructor(@NonNull properties: AnnotationPropertyMap, markDirty: Boolean, @Nullable resourceId: String)

Intended for internal usage only.

Types

IconName

@Documented

@Retention(value = RetentionPolicy.SOURCE)

annotation class IconName

Denotes that a parameter must belong to on of these strings defined in : PUSH_PIN, PAPERCLIP, GRAPH, TAG.

Properties

GRAPH

val GRAPH: String = "Graph"

PAPERCLIP

val PAPERCLIP: String = "Paperclip"

PUSH_PIN

val PUSH_PIN: String = "PushPin"

TAG

val TAG: String = "Tag"

Functions

getFile

@Nullable

open fun getFile(): EmbeddedFile

Returns a file set for this annotation.

getIconName

@NonNull

open fun getIconName(): String

Returns the name of the icon that should be displayed for this annotation.

getType

@NonNull

open fun getType(): AnnotationType

Gets the annotation type of the annotation.

isLocked

open fun isLocked(): Boolean

Check if the annotation is locked - i.e.

isResizable

open fun isResizable(): Boolean

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

setFileSource

open fun setFileSource(@NonNull fileSource: EmbeddedFileSource)

Replaces an embedded file associated with this annotation.

setIconName

open fun setIconName(@FileAnnotation.IconName iconName: String)

Sets the name of the icon that should be displayed for this annotation.

updateTransformationProperties

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

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