Package net.carcdr.ycrdt

Interface YXmlText

All Superinterfaces:

AutoCloseable, YXmlNode

public interface YXmlText
extends YXmlNode, AutoCloseable

A collaborative XML text node that supports concurrent editing with formatting.

Nested Class Summary

Nested classes/interfaces inherited from interface net.carcdr.ycrdt.YXmlNode

YXmlNode.NodeType

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this text and releases resources.
void	delete(int index, int length)	Deletes text at the specified range.
void	delete(YTransaction txn, int index, int length)	Deletes text at the specified range within a transaction.
void	format(int index, int length, Map<String,Object> attributes)	Applies formatting attributes to a range of text.
void	format(YTransaction txn, int index, int length, Map<String,Object> attributes)	Applies formatting attributes to a range of text within a transaction.
List<FormattingChunk>	getFormattingChunks()	Returns the text content as formatting chunks.
List<FormattingChunk>	getFormattingChunks(YTransaction txn)	Returns the text content as formatting chunks within a transaction.
int	getIndexInParent()	Returns the index of this node within its parent.
int	getIndexInParent(YTransaction txn)	Returns the index of this node within its parent, using a transaction.
Object	getParent()	Returns the parent element or fragment.
Object	getParent(YTransaction txn)	Returns the parent element or fragment within a transaction.
void	insert(int index, String chunk)	Inserts text at the specified index.
void	insert(YTransaction txn, int index, String chunk)	Inserts text at the specified index within a transaction.
void	insertWithAttributes(int index, String chunk, Map<String,Object> attributes)	Inserts text with formatting attributes at the specified index.
void	insertWithAttributes(YTransaction txn, int index, String chunk, Map<String,Object> attributes)	Inserts text with formatting attributes at the specified index within a transaction.
boolean	isClosed()	Checks if this text has been closed.
int	length()	Returns the length of the text.
int	length(YTransaction txn)	Returns the length of the text within a transaction.
YSubscription	observe(YObserver observer)	Registers an observer for changes to this text.
void	push(String chunk)	Appends text to the end.
void	push(YTransaction txn, String chunk)	Appends text to the end within a transaction.
String	toString()	Returns the text content.
String	toString(YTransaction txn)	Returns the text content within a transaction.

Methods inherited from interface net.carcdr.ycrdt.YXmlNode

asElement, asText, getNodeType

Method Details

length

int length()

Returns the length of the text.

Returns:

the number of characters

length

int length(YTransaction txn)

Returns the length of the text within a transaction.

Parameters:

txn - the transaction

Returns:

the number of characters

toString

String toString()

Returns the text content.

Overrides:

toString in class Object

Returns:

the text as a string

toString

String toString(YTransaction txn)

Returns the text content within a transaction.

Parameters:

txn - the transaction

Returns:

the text as a string

insert

void insert(int index,
 String chunk)

Inserts text at the specified index.

Parameters:

index - the position to insert at

chunk - the text to insert

insert

void insert(YTransaction txn,
 int index,
 String chunk)

Inserts text at the specified index within a transaction.

Parameters:

txn - the transaction

index - the position to insert at

chunk - the text to insert

push

void push(String chunk)

Appends text to the end.

Parameters:

chunk - the text to append

push

void push(YTransaction txn,
 String chunk)

Appends text to the end within a transaction.

Parameters:

txn - the transaction

chunk - the text to append

delete

void delete(int index,
 int length)

Deletes text at the specified range.

Parameters:

index - the start position

length - the number of characters to delete

delete

void delete(YTransaction txn,
 int index,
 int length)

Deletes text at the specified range within a transaction.

Parameters:

txn - the transaction

index - the start position

length - the number of characters to delete

insertWithAttributes

void insertWithAttributes(int index,
 String chunk,
 Map<String,Object> attributes)

Inserts text with formatting attributes at the specified index.

Parameters:

index - the position to insert at

chunk - the text to insert

attributes - the formatting attributes

insertWithAttributes

void insertWithAttributes(YTransaction txn,
 int index,
 String chunk,
 Map<String,Object> attributes)

Inserts text with formatting attributes at the specified index within a transaction.

Parameters:

txn - the transaction

index - the position to insert at

chunk - the text to insert

attributes - the formatting attributes

format

void format(int index,
 int length,
 Map<String,Object> attributes)

Applies formatting attributes to a range of text.

Parameters:

index - the start position

length - the number of characters to format

attributes - the formatting attributes

format

void format(YTransaction txn,
 int index,
 int length,
 Map<String,Object> attributes)

Applies formatting attributes to a range of text within a transaction.

Parameters:

txn - the transaction

index - the start position

length - the number of characters to format

attributes - the formatting attributes

getParent

Object getParent()

Returns the parent element or fragment.

Returns:

the parent, or null if none

getParent

Object getParent(YTransaction txn)

Returns the parent element or fragment within a transaction.

Parameters:

txn - the transaction

Returns:

the parent, or null if none

getIndexInParent

int getIndexInParent()

Returns the index of this node within its parent.

Returns:

the index

getIndexInParent

int getIndexInParent(YTransaction txn)

Returns the index of this node within its parent, using a transaction.

Parameters:

txn - the transaction

Returns:

the index

getFormattingChunks

List<FormattingChunk> getFormattingChunks()

Returns the text content as formatting chunks.

Returns:

a list of formatting chunks

getFormattingChunks

List<FormattingChunk> getFormattingChunks(YTransaction txn)

Returns the text content as formatting chunks within a transaction.

Parameters:

txn - the transaction

Returns:

a list of formatting chunks

observe

YSubscription observe(YObserver observer)

Registers an observer for changes to this text.

Parameters:

observer - the observer to register

Returns:

a subscription handle for unregistering

close

void close()

Closes this text and releases resources.

Specified by:

close in interface AutoCloseable

isClosed

boolean isClosed()

Checks if this text has been closed.

Returns:

true if closed, false otherwise