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

Presentation

[androidJvm]\ 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

androidJvm

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 readingOrder 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

Presentation	[androidJvm] fun Presentation(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

Name	Summary
Companion	[androidJvm] object Companion
Fit	[androidJvm] @Serializable enum Fit : Enum<Presentation.Fit> , Parcelable Suggested method for constraining a resource inside the viewport.
Orientation	[androidJvm] @Serializable enum Orientation : Enum<Presentation.Orientation> , Parcelable Suggested orientation for the device when displaying the linked resource.
Overflow	[androidJvm] @Serializable enum Overflow : Enum<Presentation.Overflow> , Parcelable Suggested method for handling overflow while displaying the linked resource.
Page	[androidJvm] @Serializable enum Page : Enum<Presentation.Page> , Parcelable Indicates how the linked resource should be displayed in a reading environment that displays synthetic spreads.
Spread	[androidJvm] @Serializable enum Spread : Enum<Presentation.Spread> , Parcelable Indicates the condition to be met for the linked resource to be rendered within a synthetic spread.

Functions

Name	Summary
describeContents	[androidJvm] abstract fun describeContents(): Int
getJSON	[androidJvm] fun ~~getJSON~~(): JSONObject
toJSON	[androidJvm] open override fun toJSON(): JSONObject Serializes a Presentation to its RWPM JSON representation.
writeToParcel	[androidJvm] abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

Name	Summary
clipped	[androidJvm] val clipped: Boolean? = null
continuous	[androidJvm] val continuous: Boolean? = null
fit	[androidJvm] val fit: Presentation.Fit? = null
flow	[androidJvm] val ~~flow~~: Presentation.Overflow?
layout	[androidJvm] val layout: EpubLayout? = null
orientation	[androidJvm] val orientation: Presentation.Orientation? = null
overflow	[androidJvm] val overflow: Presentation.Overflow? = null
spread	[androidJvm] val spread: Presentation.Spread? = null

Extensions

Name	Summary
layoutOf	[androidJvm] fun Presentation.layoutOf(link: Link): EpubLayout Get the layout of the given resource in this publication. Falls back on REFLOWABLE.