ro.sync.ecss.extensions.api

Interface AuthorActionEventHandler

All Superinterfaces:

Extension

All Known Implementing Classes:

AuthorActionEventHandlerBase, DefaultAuthorActionEventHandler, DITAAuthorActionEventHandler, DocbookAuthorActionEventHandler, TEIAuthorActionEventHandler, XHTMLAuthorActionEventHandler

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface AuthorActionEventHandler
extends Extension

Intercepts action events in the Author mode and can handle them in a special manner. Since 19.0 an AuthorActionEventHandlerBase extended API base has been added which can be extended to provide additional functionality.

Since:

18

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AuthorActionEventHandler.AuthorActionEventType Events that are delegated to this handler.

Method Summary

Modifier and Type	Method and Description
boolean	canHandleEvent(AuthorAccess authorAccess, AuthorActionEventHandler.AuthorActionEventType eventType) Check if an Author action event can be handled.
default AuthorElement	getListItemAncestorToSplit(AuthorNode node, AuthorAccess access) Return the list item ancestor of the current node that needs to be split on Enter.
boolean	handleEvent(AuthorAccess authorAccess, AuthorActionEventHandler.AuthorActionEventType eventType) An event was generated.

Methods inherited from interface ro.sync.ecss.extensions.api.Extension

getDescription

Method Detail

handleEvent

boolean handleEvent(AuthorAccess authorAccess,
                    AuthorActionEventHandler.AuthorActionEventType eventType)

An event was generated.

Parameters:

authorAccess - Author access.

eventType - The type of the generated event.

Returns:

true if the event was handled and the default operation should be skipped, false to let the default operation execute.

canHandleEvent

boolean canHandleEvent(AuthorAccess authorAccess,
                       AuthorActionEventHandler.AuthorActionEventType eventType)

Check if an Author action event can be handled.

Parameters:

authorAccess - Access to the Author API.

eventType - The type of event generated.

Returns:

true if the Author action event can be handled.

getListItemAncestorToSplit

default AuthorElement getListItemAncestorToSplit(AuthorNode node,
                                                 AuthorAccess access)

Return the list item ancestor of the current node that needs to be split on Enter.

Parameters:

node - The node.

access - Access object to the Author API.

Returns:

the list item ancestor of the current node that needs to be split on Enter, or null.