yorkie/dev.yorkie.document.json/JsonTree

JsonTree

JsonTree is a CRDT-based tree structure that is used to represent the document tree of text-based editor such as ProseMirror.

Types

Companion

object Companion

ElementNode

interface ElementNode : JsonTree.TreeNode

TextNode

interface TextNode : JsonTree.TreeNode

TreeNode

sealed interface TreeNode

Properties

val id: TimeTicket

rootTreeNode

val rootTreeNode: JsonTree.TreeNode

size

val size: Int

Functions

edit

fun edit(fromIndex: Int, toIndex: Int, vararg content: JsonTree.TreeNode)

fun edit(fromIndex: Int, toIndex: Int, splitLevel: Int, vararg contents: JsonTree.TreeNode)

Edits this tree with the given node.

editByPath

fun editByPath(fromPath: List<Int>, toPath: List<Int>, vararg contents: JsonTree.TreeNode, splitLevel: Int = 0)

Edits this tree with the given node and path.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

indexRangeToPosRange

fun indexRangeToPosRange(range: Pair<Int, Int>): TreePosStructRange

Converts the index range into the TreePosStructRange.

indexToPath

fun indexToPath(index: Int): List<Int>

Returns the path of the given index.

mergeByPath

fun mergeByPath(path: List<Int>)

Merges the element node at the given path into its left sibling.

pathRangeToPosRange

fun pathRangeToPosRange(range: Pair<List<Int>, List<Int>>): TreePosStructRange

Converts the path range into the TreePosStructRange.

pathToIndex

fun pathToIndex(path: List<Int>): Int

Returns the index of given path.

posRangeToIndexRange

fun posRangeToIndexRange(range: TreePosStructRange): Pair<Int, Int>

Converts the position range into the index range.

posRangeToPathRange

fun posRangeToPathRange(range: TreePosStructRange): Pair<List<Int>, List<Int>>

Converts the position range into the path range.

removeStyle

fun removeStyle(fromIndex: Int, toIndex: Int, attributesToRemove: List<String>)

Removes the attributes in attributesToRemove from the elements in the given index range.

removeStyleByPath

fun removeStyleByPath(fromPath: List<Int>, toPath: List<Int>, attributesToRemove: List<String>)

Removes the attributes in attributesToRemove from the elements in the path range between fromPath and toPath.

splitByPath

fun splitByPath(path: List<Int>)

Splits the tree at the given path.

style

fun style(fromIndex: Int, toIndex: Int, attributes: Map<String, String>)

Sets the attributes to the elements of the given range.

styleByPath

fun styleByPath(path: List<Int>, attributes: Map<String, String>)

Sets the attributes to the element at the given path.

fun styleByPath(fromPath: List<Int>, toPath: List<Int>, attributes: Map<String, String>)

Sets the attributes to the elements in the path range between fromPath and toPath.

toJson

fun toJson(): String

toString

open override fun toString(): String

toXml

fun toXml(): String

Returns the XML string of this tree.