toggle menu
pspdfkit
PSPDFKit
switch theme
search in API
pspdfkit
/
com.pspdfkit.bookmarks
/
Bookmark
Bookmark
open
class
Bookmark
:
Comparable
<
T
>
Represents a bookmark in a PDF document.
Members
Constructors
Bookmark
Link copied to clipboard
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
is
Dirty
Link copied to clipboard
open
val
isDirty
:
Boolean
name
Link copied to clipboard
@
Nullable
@get:
Nullable
open
var
name
:
String
page
Index
Link copied to clipboard
@
Nullable
@
IntRange
(
from
=
0
)
@get:
Nullable
val
pageIndex
:
Integer
sort
Key
Link copied to clipboard
@
Nullable
@get:
Nullable
open
val
sortKey
:
Integer
Handles sorting of this bookmark.
uuid
Link copied to clipboard
@
NonNull
@get:
NonNull
val
uuid
:
String
Functions
clear
Dirty
Link copied to clipboard
open
fun
clearDirty
(
)
Marks bookmark not dirty.
compare
To
Link copied to clipboard
open
fun
compareTo
(
@
Nullable
bookmark
:
Bookmark
)
:
Int
equals
Link copied to clipboard
open
fun
equals
(
o
:
Any
)
:
Boolean
hash
Code
Link copied to clipboard
open
fun
hashCode
(
)
:
Int
set
Sort
Key
Link copied to clipboard
open
fun
setSortKey
(
sortKey
:
Int
)
Sets an integer to determine bookmark sort order.
to
String
Link copied to clipboard
open
fun
toString
(
)
:
String