epub4kmp-core/io.documentnode.epub4kmp.domain/Spine

Spine

class Spine(spineReferences: List<SpineReference>)(source)

The spine sections are the sections of the book in the order in which the book should be read.

This contrasts with the Table of Contents sections which is an index into the Book's sections.

Constructors

Spine

constructor(spineReferences: List<SpineReference>)

constructor(tableOfContents: TableOfContents)

Creates a spine out of all the resources in the table of contents.

constructor()

Types

Companion

object Companion

Properties

isEmpty

val isEmpty: Boolean

size

val size: Int

The number of elements in the spine.

tocResource

var tocResource: Resource?

Functions

addResource

fun addResource(resource: Resource): SpineReference

Adds the given resource to the spine references and returns it.

addSpineReference

fun addSpineReference(spineReference: SpineReference): SpineReference

Adds the given spineReference to the spine references and returns it.

findFirstResourceById

fun findFirstResourceById(resourceId: String?): Int

Finds the first resource that has the given resourceId.

getResource

fun getResource(index: Int): Resource?

Gets the resource at the given index. Null if not found.

getResourceIndex

fun getResourceIndex(currentResource: Resource?): Int

The position within the spine of the given resource.

fun getResourceIndex(resourceHref: String?): Int

The first position within the spine of a resource with the given href.

getSpineReferences

fun getSpineReferences(): List<SpineReference>

setSpineReferences

fun setSpineReferences(spineReferences: List<SpineReference>)

Spine

See also

Constructors

Types

Properties

Functions