epub4kmp-core/io.documentnode.epub4kmp.browsersupport/Navigator

Navigator

class Navigator(var book: Book? = null)(source)

A helper class for EPUB browser applications.

Tracks the user's position within a Book, supports moving between resources, and notifies registered NavigationEventListeners.

Not thread-safe; protect external access if you call this from multiple coroutines.

Constructors

Navigator

constructor(book: Book? = null)

Properties

book

var book: Book?

currentFragmentId

var currentFragmentId: String?

currentResource

var currentResource: Resource?

currentSectionPos

var currentSectionPos: Int

Functions

addNavigationEventListener

fun addNavigationEventListener(listener: NavigationEventListener): Boolean

getCurrentSpinePos

fun getCurrentSpinePos(): Int

The current position within the spine, or < 0 if the current position is not within the spine.

gotoBook

fun gotoBook(book: Book, source: Any?)

gotoFirstSpineSection

fun gotoFirstSpineSection(source: Any?): Int

gotoLastSpineSection

fun gotoLastSpineSection(source: Any?): Int

gotoNextSpineSection

fun gotoNextSpineSection(source: Any?): Int

gotoPreviousSpineSection

fun gotoPreviousSpineSection(source: Any?): Int

fun gotoPreviousSpineSection(pagePos: Int, source: Any?): Int

gotoResource

fun gotoResource(resource: Resource, source: Any?): Int

fun gotoResource(resourceHref: String, source: Any): Int

fun gotoResource(resource: Resource, pagePos: Int, source: Any?): Int

fun gotoResource(resource: Resource, fragmentId: String, source: Any?): Int

fun gotoResource(resource: Resource, pagePos: Int, fragmentId: String?, source: Any?): Int

gotoResourceId

fun gotoResourceId(resourceId: String?, source: Any?): Int

gotoSpineSection

fun gotoSpineSection(newSpinePos: Int, source: Any?): Int

fun gotoSpineSection(newSpinePos: Int, newPagePos: Int, source: Any?): Int

Go to a specific section. Illegal spine positions are silently ignored.

hasNextSpineSection

fun hasNextSpineSection(): Boolean

hasPreviousSpineSection

fun hasPreviousSpineSection(): Boolean

removeNavigationEventListener

fun removeNavigationEventListener(listener: NavigationEventListener): Boolean

setCurrentResource

fun setCurrentResource(currentResource: Resource): Int

Sets the current index and resource without calling the event listeners.

setCurrentSpinePos

fun setCurrentSpinePos(currentIndex: Int)

Sets the current index and resource without calling the event listeners.