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

ContentDisplayAreaType

enum ContentDisplayAreaType : Enum<ContentDisplayAreaType>

Defines the type of Content Display Area option accepted in ReaderViewOptions.

Entries

Content Display Areas are based on the ReaderView element dimensions and the specified aspect-ratio.

Content Display Areas are based on the aspect-ratio derived from the publication's fixed-layout documents, if any exist. Otherwise, the aspect ratio is derived from the publication's cover image.

FILL

Content Display Areas fill the parent ReaderView element.

Types

Companion

object Companion

Properties

entries

val entries: EnumEntries<ContentDisplayAreaType>

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

serialize

fun serialize(generator: JsonGenerator)

valueOf

fun valueOf(value: String): ContentDisplayAreaType

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

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