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

NavigationCollectionType

enum NavigationCollectionType : Enum<NavigationCollectionType>

Describes the different type of navigation collections.

Entries

The main table of contents as specified in the source publication.

A list of pages as specified in the source publication. This is used in EPUB to refer to page-breaks within a printed edition of the publication.

LANDMARKS

A collection of references to well-known/recurring components as specified in the source publication, such as index, glossary, etc.

CUSTOM

A navigation collection not matching any other type defined in this enum, but that is specified in the source publication.

LIST_OF_AUDIO_CLIPS

A listing of audio clips included in the publication, as specified in the source publication.

LIST_OF_ILLUSTRATIONS

A listing of illustrations included in the publication, as specified in the source publication.

LIST_OF_TABLES

A listing of tables included in the publication, as specified in the source publication.

LIST_OF_VIDEO_CLIPS

A listing of video clips included in the publication, as specified in the source publication.

Types

Companion

object Companion

Functions

serialize

fun serialize(generator: JsonGenerator)

valueOf

fun valueOf(value: String): NavigationCollectionType

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<NavigationCollectionType>

Returns an array containing the constants of this enum type, in the order they're declared.

Properties

name

val name: String

ordinal

val ordinal: Int

value

val value: String