colibrio-reader-framework/com.colibrio.readingsystem.base/ReaderPublicationNavigationItemReference

ReaderPublicationNavigationItemReference

data class ReaderPublicationNavigationItemReference(val readerDocumentIndexInSpine: Int, val navigationItem: ReaderPublicationNavigationItem, val navigationCollection: ReaderPublicationNavigationCollection)

Describes a reference to an item in the publication navigation.

Constructors

Link copied to clipboard
constructor(readerDocumentIndexInSpine: Int, navigationItem: ReaderPublicationNavigationItem, navigationCollection: ReaderPublicationNavigationCollection)

Properties

Link copied to clipboard
val collectionIndex: Int

The index of the collection within the publication navigation collections list.

Link copied to clipboard
val collectionType: NavigationCollectionType

The type of navigation collection.

Link copied to clipboard
val navigationCollection: ReaderPublicationNavigationCollection

The navigation collection the navigation item belongs to.

Link copied to clipboard
val navigationItem: ReaderPublicationNavigationItem

The reference navigation item.

Link copied to clipboard
val navigationItemId: Int

The id of the ReaderPublicationNavigationItem referenced.

Link copied to clipboard
val readerDocumentIndexInSpine: Int

The index in the related ReaderPublication's spine of the document that the navigation item references.