Skip to content

//shared/org.readium.r2.shared

Package org.readium.r2.shared

Types

Name Summary
Clip [androidJvm]
data class Clip(audioResource: String?, fragmentId: String?, start: Double?, end: Double?)
Enumerable [androidJvm]
class Enumerable(index: Int, values: List<String>, ref: String, name: String) : UserProperty
Incremental [androidJvm]
class Incremental(value: Float, min: Float, max: Float, step: Float, suffix: String, ref: String, name: String) : UserProperty
Injectable [androidJvm]
enum Injectable : Enum<Injectable> , Serializable
JSONable [androidJvm]
interface JSONable
MediaOverlayNode [androidJvm]
data class MediaOverlayNode(text: String, audio: String?, children: List<MediaOverlayNode>, role: List<String>) : Serializable
MediaOverlays [androidJvm]
data class MediaOverlays(nodes: List<MediaOverlayNode>) : Serializable
PdfSupport [androidJvm]
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.TYPEALIAS, AnnotationTarget.PROPERTY])
annotation class PdfSupport
ReadiumCSSName [androidJvm]
enum ReadiumCSSName : Enum<ReadiumCSSName>
RootFile [androidJvm]
class RootFile
Search [androidJvm]
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.TYPEALIAS, AnnotationTarget.PROPERTY])
annotation class Search
Switchable [androidJvm]
class Switchable(onValue: String, offValue: String, on: Boolean, ref: String, name: String) : UserProperty
UserException [androidJvm]
open class UserException : Exception
An exception that can be presented to the user using a localized message.
UserProperties [androidJvm]
class UserProperties : Serializable
UserProperty [androidJvm]
sealed class UserProperty

Functions

Name Summary
promise [androidJvm]
fun Request.promise(): Promise<Triple<Request, Response, ByteArray>, Exception>
toJSON [androidJvm]
fun List<JSONable>.toJSON(): JSONArray
Serializes a list of JSONable into a JSONArray.

Properties

Name Summary
APPEARANCE_NAME [androidJvm]
const val APPEARANCE_NAME: String
APPEARANCE_REF [androidJvm]
const val APPEARANCE_REF: String
COLUMN_COUNT_NAME [androidJvm]
const val COLUMN_COUNT_NAME: String
COLUMN_COUNT_REF [androidJvm]
const val COLUMN_COUNT_REF: String
FONT_FAMILY_NAME [androidJvm]
const val FONT_FAMILY_NAME: String
FONT_FAMILY_REF [androidJvm]
const val FONT_FAMILY_REF: String
FONT_OVERRIDE_NAME [androidJvm]
const val FONT_OVERRIDE_NAME: String
FONT_OVERRIDE_REF [androidJvm]
const val FONT_OVERRIDE_REF: String
FONT_SIZE_NAME [androidJvm]
const val FONT_SIZE_NAME: String
FONT_SIZE_REF [androidJvm]
const val FONT_SIZE_REF: String
LETTER_SPACING_NAME [androidJvm]
const val LETTER_SPACING_NAME: String
LETTER_SPACING_REF [androidJvm]
const val LETTER_SPACING_REF: String
LINE_HEIGHT_NAME [androidJvm]
const val LINE_HEIGHT_NAME: String
LINE_HEIGHT_REF [androidJvm]
const val LINE_HEIGHT_REF: String
PAGE_MARGINS_NAME [androidJvm]
const val PAGE_MARGINS_NAME: String
PAGE_MARGINS_REF [androidJvm]
const val PAGE_MARGINS_REF: String
PUBLISHER_DEFAULT_NAME [androidJvm]
const val PUBLISHER_DEFAULT_NAME: String
PUBLISHER_DEFAULT_REF [androidJvm]
const val PUBLISHER_DEFAULT_REF: String
SCROLL_NAME [androidJvm]
const val SCROLL_NAME: String
SCROLL_REF [androidJvm]
const val SCROLL_REF: String
TEXT_ALIGNMENT_NAME [androidJvm]
const val TEXT_ALIGNMENT_NAME: String
TEXT_ALIGNMENT_REF [androidJvm]
const val TEXT_ALIGNMENT_REF: String
WORD_SPACING_NAME [androidJvm]
const val WORD_SPACING_NAME: String
WORD_SPACING_REF [androidJvm]
const val WORD_SPACING_REF: String