nutrient/com.pspdfkit.bookmarks/Bookmark

Bookmark

open class Bookmark : Comparable<Bookmark>

Represents a bookmark in a PDF document.

Constructors

Bookmark

constructor(@IntRange(from = 0) pageIndex: Int)

Creates a new bookmark pointing to a page with generated UUID.

constructor(@Nullable name: String, @IntRange(from = 0) pageIndex: Int)

Creates a new bookmark pointing to a page with generated UUID.

constructor(@NonNull uuid: String, @Nullable name: String, @IntRange(from = 0) pageIndex: Int)

Creates a new bookmark pointing to a page.

Properties

isDirty

open val isDirty: Boolean

Whether this bookmark has been modified since the document was last saved.

name

@Nullable

@get:Nullable

open var name: String

The human-readable display name of this bookmark.

pageIndex

@Nullable

@IntRange(from = 0)

@get:Nullable

val pageIndex: Integer

The zero-indexed page number this bookmark points to, or null for non-page targets.

sortKey

@Nullable

@get:Nullable

open val sortKey: Integer

Handles sorting of this bookmark.

uuid

@NonNull

@get:NonNull

val uuid: String

The unique identifier for this bookmark within the document.

Functions

clearDirty

open fun clearDirty()

Marks bookmark not dirty.

compareTo

open fun compareTo(@Nullable bookmark: Bookmark): Int

Compares this bookmark with another bookmark for ordering.

equals

open fun equals(o: Any): Boolean

Compares this bookmark with another object for equality.

hashCode

open fun hashCode(): Int

Returns a hash code value for this bookmark based on its UUID.

setSortKey

open fun setSortKey(sortKey: Int)

Sets an integer to determine bookmark sort order.

toString

open fun toString(): String

Returns a string representation of this bookmark including its UUID, page index, name, and sort key.