org.docgene.plugins

Interface ElementHook

public interface ElementHook

An element hook is a class which is able to handle ParagraphElements to add content to the output.

Method Summary

Modifier and Type	Method and Description
default void	createArticles() Create articles.
void	handleElement(ParagraphElement element) Handle an element.
default void	startArticle(org.docgene.model.XMLArticle article) Start the processing of an article.
java.util.Set<java.lang.String>	supportedElements() Return the set of StyledElement.getDeclaration()s which will be handled by this ElementHook.

Method Detail

supportedElements

java.util.Set<java.lang.String> supportedElements()

Return the set of StyledElement.getDeclaration()s which will be handled by this ElementHook. The handleElement(org.docgene.model.ParagraphElement) method will only be called for those elements.

Returns:

the set of supported elements.

createArticles

default void createArticles()

Create articles.

startArticle

default void startArticle(org.docgene.model.XMLArticle article)

Start the processing of an article. Return true if the article msut be handled by the ElementHook.

Parameters:

article - the article

handleElement

void handleElement(ParagraphElement element)

Handle an element. This element StyledElement.getDeclaration() is guaranteed to be one of the keys returned by supportedElements().

Parameters:

element - the element