Class Text<A>

Text is an extended data type for the contents of a text editor.

Type Parameters

A extends Indexable = Indexable

Index

Constructors

Accessors

Methods

createRangeForTest delete edit empty getID getTreeByID getTreeByIndex indexRangeToPosRange initialize posRangeToIndexRange setStyle toJSForTest toJSON toString toTestString values

Constructors

constructor

new Text<A extends Indexable = Indexable>(
context?: ChangeContext<Indexable>,
text?: CRDTText<A>,
): Text<A>
Type Parameters
- A extends Indexable = Indexable
Parameters
- Optionalcontext: ChangeContext<Indexable>
- Optionaltext: CRDTText<A>
Returns Text<A>
- Defined in document/json/text.ts:65

Accessors

length

get length(): number
length returns size of RGATreeList.

Returns number
- Defined in document/json/text.ts:272

Methods

createRangeForTest

createRangeForTest(fromIdx: number, toIdx: number): RGATreeSplitPosRange
createRangeForTest returns pair of RGATreeSplitNodePos of the given indexes for testing purpose.
Parameters
- fromIdx: number
- toIdx: number
Returns RGATreeSplitPosRange
- Defined in document/json/text.ts:339

delete

delete(fromIdx: number, toIdx: number): [number, number] | undefined
delete deletes the text in the given range.
Parameters
- fromIdx: number
- toIdx: number
Returns [number, number] | undefined
- Defined in document/json/text.ts:146

edit

edit(
    fromIdx: number,
    toIdx: number,
    content: string,
    attributes?: A,
): [number, number] | undefined
edit edits this text with the given content.
Parameters
- fromIdx: number
- toIdx: number
- content: string
- Optionalattributes: A
Returns [number, number] | undefined
- Defined in document/json/text.ts:88

empty

empty(): [number, number] | undefined
empty makes the text empty.

Returns [number, number] | undefined
- Defined in document/json/text.ts:153

getID

getID(): TimeTicket
getID returns the ID of this text.

Returns TimeTicket
- Defined in document/json/text.ts:81

getTreeByID

getTreeByID(): LLRBTree<RGATreeSplitNodeID, RGATreeSplitNode<CRDTTextValue>>
getTreeByID returns IDTree of the text for testing purpose.

Returns LLRBTree<RGATreeSplitNodeID, RGATreeSplitNode<CRDTTextValue>>
- Defined in document/json/text.ts:286

getTreeByIndex

getTreeByIndex(): SplayTree<CRDTTextValue>
getTreeByIndex returns IndexTree of the text for testing purpose.

Returns SplayTree<CRDTTextValue>
- Defined in document/json/text.ts:279

indexRangeToPosRange

indexRangeToPosRange(range: [number, number]): TextPosStructRange
indexRangeToPosRange returns TextRangeStruct of the given index range.
Parameters
- range: [number, number]
Returns TextPosStructRange
- Defined in document/json/text.ts:210

initialize

initialize(context: ChangeContext, text: CRDTText<A>): void
initialize initialize this text with context and internal text.
Parameters
- context: ChangeContext
- text: CRDTText<A>
Returns void
- Defined in document/json/text.ts:73

posRangeToIndexRange

posRangeToIndexRange(range: TextPosStructRange): [number, number]
posRangeToIndexRange returns indexes of the given TextRangeStruct.
Parameters
- range: TextPosStructRange
Returns [number, number]
- Defined in document/json/text.ts:225

setStyle

setStyle(fromIdx: number, toIdx: number, attributes: A): boolean
setStyle styles this text with the given attributes.
Parameters
- fromIdx: number
- toIdx: number
- attributes: A
Returns boolean
- Defined in document/json/text.ts:160

toJSForTest

toJSForTest(): Devtools.JSONElement
toJSForTest returns value with meta data for testing.

Returns Devtools.JSONElement
- Defined in document/json/text.ts:324

toJSON

toJSON(): string
toJSON returns the JSON string of this tree.

Returns string
- Defined in document/json/text.ts:310

toString

toString(): string
toString returns the string representation of this text.

Returns string
- Defined in document/json/text.ts:296

toTestString

toTestString(): string
toTestString returns a String containing the meta data of the node for debugging purpose.

Returns string
- Defined in document/json/text.ts:244

values

values(): TextValueType<A>[]
values returns values of this text.

Returns TextValueType<A>[]
- Defined in document/json/text.ts:258