Package io.keikai.doc.collab.types

Class YXmlText

java.lang.Object

io.keikai.doc.collab.types.AbstractType<YTextEvent>

io.keikai.doc.collab.types.YText

io.keikai.doc.collab.types.YXmlText

public class YXmlText
extends YText

Represents text in a Dom Element. In the future this type will also handle simple formatting information like bold and italic.

Field Summary

Fields inherited from class io.keikai.doc.collab.types.AbstractType

_doc, _length, _map, _searchMarker

Constructor Summary

Constructors

Constructor	Description
YXmlText()	Constructs a new YText without an optional initial string.
YXmlText(String string)	Constructs a new YText with an optional initial string.

Method Summary

Modifier and Type	Method	Description
YXmlText	clone()	Makes a copy of this data type that can be included somewhere else.
YXmlText	copy()
YXmlElement	getNextSibling()
YXmlElement	getPrevSibling()
static YXmlText	readYXmlText(UpdateDecoder decoder)	Overloaded method for reading with UpdateDecoderV1
String	toJSON()	Converts the type to a JSON object representation.
String	toString()
void	write(UpdateEncoder encoder)	Writes this type's state to the encoder.

Methods inherited from class io.keikai.doc.collab.types.YText

applyDelta, applyDelta, callObserver, cleanupYTextAfterTransaction, cleanupYTextFormatting, delete, delete, equalAttrs, findNextPosition, format, getAttribute, getAttributes, getSearchMarker, insert, insert, insertEmbed, insertEmbed, insertNegatedAttributes, integrate, isHasFormatting, length, readYText, removeAttribute, setAttribute, setHasFormatting, setSearchMarker, toDeltaList, toDeltaList, toDeltaMap, toDeltaMap

Methods inherited from class io.keikai.doc.collab.types.AbstractType

callTypeObservers, createMapIterator, getDeepEventHandler, getDoc, getFirst, getItem, getMap, getParent, getStart, getTypeChildren, isParentOf, observe, observe, observeDeep, setLength, setMap, setStart, typeListCreateIterator, typeListDelete, typeListForEach, typeListForEachSnapshot, typeListGet, typeListInsertGenerics, typeListInsertGenericsAfter, typeListMap, typeListPushGenerics, typeListSlice, typeListToArray, typeListToArraySnapshot, typeMapDelete, typeMapGet, typeMapGetAll, typeMapGetAllSnapshot, typeMapGetSnapshot, typeMapHas, typeMapSet, unobserve, unobserveDeep

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

YXmlText

public YXmlText()

Constructs a new YText without an optional initial string.

YXmlText

public YXmlText(String string)

Constructs a new YText with an optional initial string.

Parameters:

string - The initial value of the YText.

Method Details

getNextSibling

public YXmlElement getNextSibling()

Returns:

YXmlElement or YXmlText|null

getPrevSibling

public YXmlElement getPrevSibling()

Returns:

YXmlElement or YXmlText|null

copy

public YXmlText copy()

Overrides:

copy in class YText

clone

public YXmlText clone()

Makes a copy of this data type that can be included somewhere else. Note that the content is only readable _after_ it has been included somewhere in the Ydoc.

Overrides:

clone in class YText

Returns:

YXmlText

toString

public String toString()

Overrides:

toString in class YText

toJSON

public String toJSON()

Description copied from class: AbstractType

Converts the type to a JSON object representation.

Overrides:

toJSON in class YText

Returns:

The JSON object representation

write

public void write(UpdateEncoder encoder)

Description copied from class: AbstractType

Writes this type's state to the encoder.

Overrides:

write in class YText

Parameters:

encoder - The encoder to write data to.

readYXmlText

public static YXmlText readYXmlText(UpdateDecoder decoder)

Overloaded method for reading with UpdateDecoderV1

Parameters:

decoder - The decoder to read data from.

Returns:

YXmlText