Class Text<A>

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

Type Parameters

A extends Indexable = Indexable

Index

Constructors

Properties

Accessors

Methods

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

Constructors

constructor

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

Properties

`Private` `Optional` context

context?: ChangeContext<Indexable>

`Private` `Optional` text

text?: CRDTText<A>

Accessors

length

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

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

Methods

createRangeForTest

createRangeForTest(fromIdx, toIdx): 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:343

delete

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

edit

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

empty

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

Returns undefined | [number, number]
- 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:82

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:289

getTreeByIndex

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

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

indexRangeToPosRange

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

initialize

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

posRangeToIndexRange

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

setStyle

setStyle(fromIdx, toIdx, attributes): 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
Internal
toJSForTest returns value with meta data for testing.

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

toJSON

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

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

toString

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

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

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:247

values

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

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