readium-shared/org.readium.r2.shared.publication/Layout

Layout

Hint about the nature of the layout for the publication. https://readium.org/webpub-manifest/contexts/default/#layout-and-reading-progression

Entries

FIXED

Each resource is a “page” where both dimensions are usually contained in the device’s viewport. Based on user preferences, the reading system may also display two resources side by side in a spread.

REFLOWABLE

Reading systems are free to adapt text and layout entirely based on user preferences.

SCROLLED

Resources are displayed in a continuous scroll, usually by filling the width of the viewport, without any visible gap between between spine items.

Types

Companion

object Companion : MapCompanion<String, Layout>

Properties

entries

val entries: EnumEntries<Layout>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

value

val value: String

Functions

describeContents

abstract fun describeContents(): Int

valueOf

fun valueOf(value: String): Layout

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

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

writeToParcel

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