ro.sync.ecss.extensions.api.content
Interface TextContext

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface TextContext

Current Text Context where the text content iterator is positioned.

Since:

13

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

Field Summary

static int	EDITABLE The returned text is in editable context.
static int	EDITABLE_IN_FILTERED_CONDITIONAL_PROFILING The returned text is in editable context but a profiling condition is applied and filters the node when the output will be published..
static int	NOT_EDITABLE_IN_DELETE_CHANGE_TRACKING The returned text is in delete change tracking context.
static int	NOT_EDITABLE_IN_READ_ONLY The returned text is in an entity or content reference.

Method Summary

int	getEditableState() Check if we can edit at the current iterator offset.
java.lang.CharSequence	getText() Gets the current text from the context.
int	getTextStartOffset() Gets the start offset of the returned text.
void	replaceText(java.lang.CharSequence newTextContent) Replaces the current context text with the new text content.

Field Detail

EDITABLE

static final int EDITABLE

The returned text is in editable context.

See Also:

Constant Field Values

EDITABLE_IN_FILTERED_CONDITIONAL_PROFILING

static final int EDITABLE_IN_FILTERED_CONDITIONAL_PROFILING

The returned text is in editable context but a profiling condition is applied and filters the node when the output will be published..

See Also:

Constant Field Values

NOT_EDITABLE_IN_DELETE_CHANGE_TRACKING

static final int NOT_EDITABLE_IN_DELETE_CHANGE_TRACKING

The returned text is in delete change tracking context.

See Also:

Constant Field Values

NOT_EDITABLE_IN_READ_ONLY

static final int NOT_EDITABLE_IN_READ_ONLY

The returned text is in an entity or content reference.

See Also:

Constant Field Values

Method Detail

getText

java.lang.CharSequence getText()

Gets the current text from the context.

Returns:

The current text from the context.

getTextStartOffset

int getTextStartOffset()

Gets the start offset of the returned text. The start offset is absolute in the Author Document's content.

Returns:

The start offset of the returned text.

getEditableState

int getEditableState()

Check if we can edit at the current iterator offset.

Returns:

true if we can edit at the current iterator offset or false if we are in read-only content (entities, content references or delete change tracking).

replaceText

void replaceText(java.lang.CharSequence newTextContent)

Replaces the current context text with the new text content.

Parameters:

newTextContent - The new text content.