ro.sync.ecss.extensions.api

Class DocbookAuthorActionEventHandler

java.lang.Object

ro.sync.ecss.extensions.api.DefaultAuthorActionEventHandler

ro.sync.ecss.extensions.api.DocbookAuthorActionEventHandler

All Implemented Interfaces:

AuthorActionEventHandler, Extension

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public class DocbookAuthorActionEventHandler
extends DefaultAuthorActionEventHandler

Author action event handler for DocBook.

Nested Class Summary

Nested classes/interfaces inherited from interface ro.sync.ecss.extensions.api.AuthorActionEventHandler

AuthorActionEventHandler.AuthorActionEventType

Constructor Summary

Constructors

Constructor and Description
DocbookAuthorActionEventHandler()

Method Summary

Modifier and Type	Method and Description
protected boolean	areCompatibleLists(AuthorNode node1, AuthorNode node2) Check if two given nodes are compatible lists (i.e.
protected java.lang.String	getPreferredXMLElementContent(AuthorAccess authorAccess) Get the preferred XML element content to be inserted.
protected boolean	isList(AuthorNode node) Check if the given node is a list.
protected void	promoteSubListItems(AuthorDocumentController controller, AuthorNode theDemotedCandidate, AuthorNode listElement) Sometimes, when we demote a list item, we want it to become the sibling of its children.

Methods inherited from class ro.sync.ecss.extensions.api.DefaultAuthorActionEventHandler

canHandleEvent, getDescription, handleEvent, isMovableListItem, promote

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocbookAuthorActionEventHandler

public DocbookAuthorActionEventHandler()

Method Detail

promoteSubListItems

protected void promoteSubListItems(AuthorDocumentController controller,
                                   AuthorNode theDemotedCandidate,
                                   AuthorNode listElement)
                            throws javax.swing.text.BadLocationException,
                                   AuthorOperationException

Description copied from class: DefaultAuthorActionEventHandler

Sometimes, when we demote a list item, we want it to become the sibling of its children. To obtain this, after demoting the item along with its children, we promote the children. This method promotes the children.

Overrides:

promoteSubListItems in class DefaultAuthorActionEventHandler

Parameters:

controller - The Author document controller.

theDemotedCandidate - The candidate which was demoted.

listElement - The parent list of the demoted item.

Throws:

javax.swing.text.BadLocationException

AuthorOperationException

See Also:

DefaultAuthorActionEventHandler.promoteSubListItems(ro.sync.ecss.extensions.api.AuthorDocumentController, ro.sync.ecss.extensions.api.node.AuthorNode, ro.sync.ecss.extensions.api.node.AuthorNode)

isList

protected boolean isList(AuthorNode node)

Description copied from class: DefaultAuthorActionEventHandler

Check if the given node is a list.

Overrides:

isList in class DefaultAuthorActionEventHandler

Parameters:

node - The node.

Returns:

true if the node is a list.

See Also:

DefaultAuthorActionEventHandler.isList(ro.sync.ecss.extensions.api.node.AuthorNode)

areCompatibleLists

protected boolean areCompatibleLists(AuthorNode node1,
                                     AuthorNode node2)

Description copied from class: DefaultAuthorActionEventHandler

Check if two given nodes are compatible lists (i.e. if we accept items from one list to migrate into the other one).

Overrides:

areCompatibleLists in class DefaultAuthorActionEventHandler

Returns:

true if the two given nodes are compatible lists.

See Also:

DefaultAuthorActionEventHandler.areCompatibleLists(ro.sync.ecss.extensions.api.node.AuthorNode, ro.sync.ecss.extensions.api.node.AuthorNode)

getPreferredXMLElementContent

protected java.lang.String getPreferredXMLElementContent(AuthorAccess authorAccess)

Description copied from class: DefaultAuthorActionEventHandler

Get the preferred XML element content to be inserted. Can be null.

Overrides:

getPreferredXMLElementContent in class DefaultAuthorActionEventHandler

Parameters:

authorAccess - The author access.

Returns:

the preferred XML element content to be inserted.

See Also:

DefaultAuthorActionEventHandler.getPreferredXMLElementContent(ro.sync.ecss.extensions.api.AuthorAccess)