quarkdown-core/com.quarkdown.core.document.numbering/AlphaNumberingSymbol

AlphaNumberingSymbol

data class AlphaNumberingSymbol(val case: StringCase) : NumberingCounterSymbol

A numbering strategy that counts items as letters of the latin alphabet: 0, A, B, C, ...

Parameters

case

whether the letters should be uppercase or lowercase

Constructors

AlphaNumberingSymbol

constructor(case: StringCase)

Properties

case

val case: StringCase

supportedRange

open override val supportedRange: IntRange

The range of values that this symbol can map to. If a value is outside this range, it cannot be mapped and an alternative strategy should be used. In the default NumberingFormat.format implementation, out-of-range values are simply mapped to their decimal representation. E.g. AlphaNumberingSymbol can map values from 1-26 as A-Z. Value 0 is formatted as 0.

Functions

map

open override fun map(index: Int): String

Maps a numeric value to a string according to the numbering strategy.