ro.sync.ecss.extensions.api

Interface CompoundEditListener

All Known Subinterfaces:

AuthorListener

All Known Implementing Classes:

AuthorListenerAdapter

@API(type=EXTENDABLE,
     src=PUBLIC)
public interface CompoundEditListener

Listener notified when compound edits are started and ended.

Since:

23

*********************************
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.

Method Summary

Modifier and Type	Method and Description
default void	beforeCompoundEditCancelled() Called before a compound edit is cancelled.
default void	compoundEditCancelled() Called when a compound edit was cancelled.
default void	compoundEditEnded() Called when a compound edit was ended.
default void	compoundEditStarted() Called when a compound edit was started.

Method Detail

compoundEditStarted

default void compoundEditStarted()

Called when a compound edit was started. A compound edit can be started by calling AuthorDocumentController.beginCompoundEdit(). Note that this callback will not be invoked for nested calls of AuthorDocumentController.beginCompoundEdit(), but only for the first one.

compoundEditEnded

default void compoundEditEnded()

Called when a compound edit was ended. A compound edit can be ended by calling AuthorDocumentController.endCompoundEdit(). Note that this callback will not be invoked for nested calls of AuthorDocumentController.endCompoundEdit(), but only for the last one.

compoundEditCancelled

default void compoundEditCancelled()

Called when a compound edit was cancelled. A compound edit can be cancelled by calling AuthorDocumentController.cancelCompoundEdit(). When a compound edit is cancelled, the edits performed so far are automatically undone before this callback is invoked. After that, an compoundEditEnded() call is also received.

beforeCompoundEditCancelled

default void beforeCompoundEditCancelled()

Called before a compound edit is cancelled. A compound edit can be cancelled by calling AuthorDocumentController.cancelCompoundEdit(). When a compound edit is cancelled, the edits performed so far are automatically undone before this callback is invoked. After that, an compoundEditEnded() call is also received.

Since:

23.1