colibrio-reader-framework/com.colibrio.core.publication.base/SyntheticSpreadBehavior

SyntheticSpreadBehavior

enum SyntheticSpreadBehavior : Enum<SyntheticSpreadBehavior>

Describes in which orientations the reading system should present the publication in spread mode. Can be overridden per content document.

Entries

NONE

Reading Systems must not incorporate spine items in a Synthetic Spread.

LANDSCAPE

Reading Systems should render a Synthetic Spread for spine items only when the device is in landscape orientation.

BOTH

Reading Systems should render a Synthetic Spread regardless of device orientation.

AUTO

No explicit Synthetic Spread behavior is defined. Reading Systems may use Synthetic Spreads in specific or all device orientations

Types

Companion

object Companion

Functions

serialize

fun serialize(generator: JsonGenerator)

valueOf

fun valueOf(value: String): SyntheticSpreadBehavior

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

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

Properties

name

val name: String

ordinal

val ordinal: Int

value

val value: String