readium-navigator/org.readium.r2.navigator

Package-level declarations

Types

interface DecorableNavigator : Navigator

A navigator able to render arbitrary decorations over a publication.

data class Decoration(val id: DecorationId, val locator: Locator, val style: Decoration.Style, val extras: Map<String, Any> = mapOf()) : JSONable, Parcelable

A decoration is a user interface element drawn on top of a publication. It associates a style to be rendered with a discrete locator in the publication.

DecorationChange

sealed class DecorationChange

Represents an atomic change in a list of Decoration objects.

DecorationId

typealias DecorationId = String

Unique identifier for a decoration.

HyperlinkNavigator

interface HyperlinkNavigator : Navigator

A navigator supporting hyperlinks.

Navigator

interface Navigator

Base interface for a navigator rendering a publication.

NavigatorFragment

abstract class NavigatorFragment : Fragment, Navigator

OverflowableNavigator

interface OverflowableNavigator : VisualNavigator

A VisualNavigator with content that can extend beyond the viewport.

RestorationNotSupportedException

object RestorationNotSupportedException : Exception

SelectableNavigator

interface SelectableNavigator : Navigator

A navigator supporting user selection.

Selection

data class Selection(val locator: Locator, val rect: RectF?)

Represents a user content selection in a navigator.

SimpleOverflow

data class SimpleOverflow(val readingProgression: ReadingProgression, val scroll: Boolean, val axis: Axis) : OverflowableNavigator.Overflow

VisualNavigator

interface VisualNavigator : Navigator

A navigator rendering the publication visually on-screen.

Functions

changesByHref

suspend fun List<Decoration>.changesByHref(target: List<Decoration>): Map<Url, List<DecorationChange>>

Lists the atomic changes between the receiver list and the target list of Decoration objects.