kitepdf-core/io.github.yuroyami.kitepdf.core/KiteOutlineItem

KiteOutlineItem

class KiteOutlineItem(val title: String, val pageIndex: Int?, val children: List<KiteOutlineItem> = emptyList(), val target: KiteBookmark? = null)

One node of a format-neutral outline (PDF bookmarks / EPUB table of contents), for a viewer's navigation panel.

Constructors

KiteOutlineItem

constructor(title: String, pageIndex: Int?, children: List<KiteOutlineItem> = emptyList(), target: KiteBookmark? = null)

Properties

children

val children: List<KiteOutlineItem>

pageIndex

val pageIndex: Int?

Zero-based target page, or null when the destination is unresolvable OR not laid out yet. Navigate by target instead when the document may still be laying out.

target

val target: KiteBookmark?

Where this entry points, in a form that needs no layout to build and only its own chapter to resolve. Null when the destination is unresolvable.

title

val title: String