ro.sync.ecss.extensions.api

Class DITAAuthorActionEventHandler

java.lang.Object

ro.sync.ecss.extensions.api.DefaultAuthorActionEventHandler

ro.sync.ecss.extensions.api.DITAAuthorActionEventHandler

All Implemented Interfaces:

AuthorActionEventHandler, Extension

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

Author action event handler for DITA.

Nested Class Summary

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

AuthorActionEventHandler.AuthorActionEventType

Constructor Summary

Constructors

Constructor and Description
DITAAuthorActionEventHandler()

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 boolean	isMovableListItem(AuthorAccess authorAccess, AuthorNode candidate) Checks if this node represents a list item that can be promoted/demoted.

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

canHandleEvent, getDescription, handleEvent, promote, promoteSubListItems

Methods inherited from class java.lang.Object

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

Constructor Detail

DITAAuthorActionEventHandler

public DITAAuthorActionEventHandler()

Method Detail

isMovableListItem

protected boolean isMovableListItem(AuthorAccess authorAccess,
                                    AuthorNode candidate)

Description copied from class: DefaultAuthorActionEventHandler

Checks if this node represents a list item that can be promoted/demoted.

Overrides:

isMovableListItem in class DefaultAuthorActionEventHandler

Parameters:

authorAccess - The Author access.

candidate - The node that candidates for promotion/demotion.

Returns:

true if the list item can be promoted/demoted.

See Also:

DefaultAuthorActionEventHandler.isMovableListItem(ro.sync.ecss.extensions.api.AuthorAccess, 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)

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)

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)