readium-shared/org.readium.r2.shared.publication.services.content/Content/TextElement

TextElement

data class TextElement(val locator: Locator, val role: Content.TextElement.Role, val segments: List<Content.TextElement.Segment>, val attributes: List<Content.Attribute<*>> = emptyList()) : Content.TextualElement

A text element.

Parameters

role

Purpose of this element in the broader context of the document.

segments

Ranged portions of text with associated attributes.

Constructors

constructor(locator: Locator, role: Content.TextElement.Role, segments: List<Content.TextElement.Segment>, attributes: List<Content.Attribute<*>> = emptyList())

Types

interface Role

Represents a purpose of an element in the broader context of the document.

data class Segment(val locator: Locator, val text: String, val attributes: List<Content.Attribute<*>>) : Content.AttributesHolder

Ranged portion of text with associated attributes.

Properties

accessibilityLabel

open val accessibilityLabel: String?

open override val attributes: List<Content.Attribute<*>>

Associated list of attributes.

open val language: Language?

open override val locator: Locator

Locator targeting this element in the Publication.

val role: Content.TextElement.Role

val segments: List<Content.TextElement.Segment>

open override val text: String

Human-readable text representation for this element.

Functions

open fun <V> attribute(key: Content.AttributeKey<V>): V?

Gets the first attribute with the given key.

open fun <V> attributes(key: Content.AttributeKey<V>): List<V>

Gets all the attributes with the given key.