ro.sync.ecss.extensions.api
Interface DocumentContentChangedEvent

All Superinterfaces:

AuthorDocumentEvent

All Known Subinterfaces:

DocumentContentDeletedEvent, DocumentContentInsertedEvent

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface DocumentContentChangedEvent
extends AuthorDocumentEvent

Event received by an AuthorListener when changes have been made in the content of the AuthorDocument.

Field Summary

static int	DELETE_FRAGMENT_EVENT Delete fragment event type.
static int	DELETE_TEXT_EVENT Delete simple text event type.
static int	INSERT_FRAGMENT_EVENT Insert fragment event type.
static int	INSERT_NODE_EVENT Insert node event type.
static int	INSERT_TEXT_EVENT Insert simple text event type.

Method Summary

int	getLength() Returns the length of the change.
int	getOffset() Returns the start offset at which the change occurred.
AuthorNode	getParentNode() Returns the AuthorNode containing the change.
int	getType() Returns the type of this event.
boolean	isSimpleTextEdit() Deprecated. Use getType() to determine the type of edit.

Field Detail

INSERT_TEXT_EVENT

static final int INSERT_TEXT_EVENT

Insert simple text event type.

See Also:

Constant Field Values

INSERT_NODE_EVENT

static final int INSERT_NODE_EVENT

Insert node event type.

See Also:

Constant Field Values

INSERT_FRAGMENT_EVENT

static final int INSERT_FRAGMENT_EVENT

Insert fragment event type.

See Also:

Constant Field Values

DELETE_TEXT_EVENT

static final int DELETE_TEXT_EVENT

Delete simple text event type.

See Also:

Constant Field Values

DELETE_FRAGMENT_EVENT

static final int DELETE_FRAGMENT_EVENT

Delete fragment event type.

See Also:

Constant Field Values

Method Detail

getLength

int getLength()

Returns the length of the change.

Returns:

the length of the change. Zero in case of an attribute change.

getOffset

int getOffset()

Returns the start offset at which the change occurred.

Returns:

the offset at which the change occurred. 0 in case of an attribute change.

getParentNode

AuthorNode getParentNode()

Returns the AuthorNode containing the change.

Returns:

The node containing the change.

isSimpleTextEdit

@Deprecated
boolean isSimpleTextEdit()

Deprecated. Use getType() to determine the type of edit.

Needed to verify if the change was a simple text edit and no node structure was affected.

Returns:

true if the edit was a simple text edit, no node structure was affected.

getType

int getType()

Returns the type of this event. It can be one of the constants: INSERT_TEXT_EVENT, INSERT_FRAGMENT_EVENT, INSERT_NODE_EVENT DELETE_TEXT_EVENT, DELETE_FRAGMENT_EVENT

Returns:

The document changed event type.