Package ro.sync.ecss.extensions.api
Interface AuthorListener
-
- All Superinterfaces:
CompoundEditListener
- All Known Implementing Classes:
AuthorListenerAdapter
@API(type=EXTENDABLE, src=PUBLIC) public interface AuthorListener extends CompoundEditListener
Listener notified about Author document changes, document structure changes and document content changes.
DANGER: You must avoid making live document changes on the received call backs. Please use instead the "ro.sync.ecss.extensions.api.AuthorDocumentController.setDocumentFilter(AuthorDocumentFilter)" API.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
attributeChanged(AttributeChangedEvent e)
Called when an Author attribute is changed in one of the document's elements.void
authorNodeNameChanged(AuthorNode node)
This is called when a node has been renamed.void
authorNodeStructureChanged(AuthorNode node)
The node structure has been changed.void
beforeAttributeChange(AttributeChangedEvent e)
Called when an attribute is about to be changed in one of the document's elements.void
beforeAuthorNodeNameChange(AuthorNode authorNode)
Called when a node name is about to be changed.void
beforeAuthorNodeStructureChange(AuthorNode authorNode)
Called when a node structure is about to be changed.void
beforeContentDelete(DocumentContentDeletedEvent e)
Called before some content is deleted from the document.void
beforeContentInsert(DocumentContentInsertedEvent e)
Called when content is about to be inserted into a document.void
beforeDoctypeChange()
Called before the DOCTYPE section is about to be changed.void
contentDeleted(DocumentContentDeletedEvent e)
Called when content is deleted from the document.void
contentInserted(DocumentContentInsertedEvent e)
Called when content is inserted into the document.void
doctypeChanged()
The DOCTYPE section has been changed.void
documentChanged(AuthorDocument oldDocument, AuthorDocument newDocument)
A new document has been set into the author page.-
Methods inherited from interface ro.sync.ecss.extensions.api.CompoundEditListener
beforeCompoundEditCancelled, compoundEditCancelled, compoundEditEnded, compoundEditStarted
-
-
-
-
Method Detail
-
beforeContentDelete
void beforeContentDelete(DocumentContentDeletedEvent e)
Called before some content is deleted from the document.- Parameters:
e
- TheDocumentContentDeletedEvent
.
-
beforeAttributeChange
void beforeAttributeChange(AttributeChangedEvent e)
Called when an attribute is about to be changed in one of the document's elements.- Parameters:
e
- TheAttributeChangedEvent
.
-
beforeContentInsert
void beforeContentInsert(DocumentContentInsertedEvent e)
Called when content is about to be inserted into a document.- Parameters:
e
- TheDocumentContentInsertedEvent
.
-
beforeDoctypeChange
void beforeDoctypeChange()
Called before the DOCTYPE section is about to be changed.
-
beforeAuthorNodeStructureChange
void beforeAuthorNodeStructureChange(AuthorNode authorNode)
Called when a node structure is about to be changed.- Parameters:
authorNode
- TheAuthorNode
that contains the modification.
-
beforeAuthorNodeNameChange
void beforeAuthorNodeNameChange(AuthorNode authorNode)
Called when a node name is about to be changed.
TheauthorNode
is a reference to the actual node in theAuthorDocument
so its name will be changed after the name change operation is completed.
If the old name of the node will be needed after the call of this method it should be obtained and saved during this method call.- Parameters:
authorNode
- TheAuthorNode
that will be changed.
-
attributeChanged
void attributeChanged(AttributeChangedEvent e)
Called when an Author attribute is changed in one of the document's elements.- Parameters:
e
- TheAttributeChangedEvent
.
-
authorNodeNameChanged
void authorNodeNameChanged(AuthorNode node)
This is called when a node has been renamed.- Parameters:
node
- TheAuthorNode
that was renamed.
-
authorNodeStructureChanged
void authorNodeStructureChanged(AuthorNode node)
The node structure has been changed. An insert or delete operation has been made and affected the children of the node.- Parameters:
node
- TheAuthorNode
that contains the modification.
-
documentChanged
void documentChanged(AuthorDocument oldDocument, AuthorDocument newDocument)
A new document has been set into the author page.- Parameters:
oldDocument
- The old Author documentnewDocument
- The new Author document.
-
contentDeleted
void contentDeleted(DocumentContentDeletedEvent e)
Called when content is deleted from the document.- Parameters:
e
- TheDocumentContentDeletedEvent
.
-
contentInserted
void contentInserted(DocumentContentInsertedEvent e)
Called when content is inserted into the document.- Parameters:
e
- TheDocumentContentInsertedEvent
.
-
doctypeChanged
void doctypeChanged()
The DOCTYPE section has been changed.
-
-