com.vladsch.flexmark.docx.converter.DocxRendererContext Maven / Gradle / Ivy

Go to download
package com.vladsch.flexmark.docx.converter;

import com.vladsch.flexmark.ast.Node;
import com.vladsch.flexmark.docx.converter.internal.DocxRendererOptions;
import com.vladsch.flexmark.docx.converter.internal.DocxRendererPhase;
import com.vladsch.flexmark.docx.converter.util.DocxContext;
import com.vladsch.flexmark.html.renderer.LinkResolverContext;

import java.util.Collection;

/**
 * The context for node rendering, including configuration and functionality for the node renderer to use.
 */
public interface DocxRendererContext extends DocxContext, LinkResolverContext {
    /**
     * Get iterable of nodes of given types, in order of their appearance in the document tree, depth first traversal.
     * Only node classes returned by {@link NodeDocxRenderer#getNodeClasses()} of all loaded extensions
     * will be available to formatters.
     * 
     *
     * @param classes node classes to return
     * @return iterable
     */
    Iterable nodesOfType(Class[] classes);
    Iterable nodesOfType(Collection> classes);
    /**
     * Get iterable of nodes of given types, in reverse order of their appearance in the document tree, depth first traversal.
     * Only node classes returned by {@link NodeDocxRenderer#getNodeClasses()} of all loaded extensions
     * will be available to formatters.
     *
     * @param classes node classes to return
     * @return iterable
     */
    Iterable reversedNodesOfType(Class[] classes);
    Iterable reversedNodesOfType(Collection> classes);

    /**
     * @return current rendering phase
     */
    DocxRendererPhase getPhase();

    /**
     * @return the {@link DocxRendererOptions} for the context.
     */
    DocxRendererOptions getDocxRendererOptions();


}