readium-shared/org.readium.r2.shared.publication.presentation/Presentation

Presentation

data class Presentation(val clipped: Boolean? = null, val continuous: Boolean? = null, val fit: Presentation.Fit? = null, val orientation: Presentation.Orientation? = null, val overflow: Presentation.Overflow? = null, val spread: Presentation.Spread? = null, val layout: EpubLayout? = null) : JSONable, Parcelable

The Presentation Hints extension defines a number of hints for User Agents about the way content should be presented to the user.

https://readium.org/webpub-manifest/extensions/presentation.html https://readium.org/webpub-manifest/schema/extensions/presentation/metadata.schema.json

These properties are nullable to avoid having default values when it doesn't make sense for a given publication. If a navigator needs a default value when not specified, Presentation.DEFAULT_X and Presentation.X.DEFAULT can be used.

Parameters

clipped

Specifies whether or not the parts of a linked resource that flow out of the viewport are clipped.

continuous

Indicates how the progression between resources from the reading order should be handled.

fit

Suggested method for constraining a resource inside the viewport.

orientation

Suggested orientation for the device when displaying the linked resource.

overflow

Suggested method for handling overflow while displaying the linked resource.

spread

Indicates the condition to be met for the linked resource to be rendered within a synthetic spread.

layout

Hints how the layout of the resource should be presented (EPUB extension).

Constructors

constructor(clipped: Boolean? = null, continuous: Boolean? = null, fit: Presentation.Fit? = null, orientation: Presentation.Orientation? = null, overflow: Presentation.Overflow? = null, spread: Presentation.Spread? = null, layout: EpubLayout? = null)

Types

object Companion

@Serializable

enum Fit : Parcelable, Enum<Presentation.Fit>

Suggested method for constraining a resource inside the viewport.

@Serializable

enum Orientation : Parcelable, Enum<Presentation.Orientation>

Suggested orientation for the device when displaying the linked resource.

@Serializable

enum Overflow : Parcelable, Enum<Presentation.Overflow>

Suggested method for handling overflow while displaying the linked resource.

@Serializable

enum Page : Parcelable, Enum<Presentation.Page>

Indicates how the linked resource should be displayed in a reading environment that displays synthetic spreads.

@Serializable

enum Spread : Parcelable, Enum<Presentation.Spread>

Indicates the condition to be met for the linked resource to be rendered within a synthetic spread.

Properties

val clipped: Boolean?

val continuous: Boolean?

val fit: Presentation.Fit?

val layout: EpubLayout?

val orientation: Presentation.Orientation?

val overflow: Presentation.Overflow?

val spread: Presentation.Spread?

Functions

describeContents

abstract fun describeContents(): Int

fun Presentation.layoutOf(link: Link): EpubLayout

Get the layout of the given resource in this publication. Falls back on REFLOWABLE.

open override fun toJSON(): JSONObject

Serializes a Presentation to its RWPM JSON representation.

abstract fun writeToParcel(p0: Parcel, p1: Int)