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

Segment

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

Ranged portion of text with associated attributes.

Parameters

locator

Locator to the segment of text.

text

Text in the segment.

attributes

Attributes associated with this segment, e.g. language.

Constructors

constructor(locator: Locator, text: String, attributes: List<Content.Attribute<*>>)

Properties

accessibilityLabel

open val accessibilityLabel: String?

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

open val language: Language?

val locator: Locator

val text: String

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.