flexmark-java - project architecture overview

getResourceString()

IRender

class DocxRenderer

Renders a tree of nodes to docx4j API.

println()

external

class? PrintStream

builder()

IParse

class Parser

Parses input text to a tree of nodes. Start with the #builder method, configure the ...

build()

BuilderBase

class Parser.Builder

Builder for configuring a Parser .

Create a new builder for configuring the DocxRenderer.

builder()

build()

BuilderBase...

class DocxRenderer.Builder

Builder for configuring an DocxRenderer . See methods for default configuration.

Parse the specified input text into a tree of nodes. <p> Note that this method is th...

parse()

Render the tree of nodes to DocX.

getDefaultTemplate()

Render a node to the given word processing package

File()

external

class? File

save()

external

class? OpcPackage

getResourceInputStream()

InputStreamReader()

external

class? InputStreamReader

BufferedReader()

external

class? BufferedReader

readLine()

RuntimeException()

external

class? RuntimeException

Builder()

loadExtensions()

MutableDataSet

abstract class BuilderBase

contains()

DataHolder

class DataSet

get()

DataKeyBase

class DataKey

NOTE: Constructors have changed in a breaking way from 0.50.x and prior implementati...

extensions()

size()

external

class? Collection

Preload operation for extension, perform any data config and other operation needed ...

preloadExtension()

Load extension if it is valid

loadExtension()

set()

Tracks keys set by extension initialization

addExtensionApiPoint()

Call to add extension API point to track

Parser()

toImmutable()

DataSet...

class MutableDataSet

calculateBlockParserFactories()

ParserState

class DocumentParser

getLeadInHandler()

Dependent

interface CustomBlockParserFactory

Custom block parser factory to create parser instance specific block parser factory

calculateParagraphPreProcessors()

MutableDataSet()

set()

calculateBlockPreProcessors()

calculateDelimiterProcessors()

LightInlineParserImpl...

class InlineParserImpl

calculateDelimiterCharacters()

calculateLinkRefProcessors()

calculateSpecialCharacters()

calculatePostProcessors()

class PostProcessorManager

MutableDataSetter

interface DataHolder

resolveFlatDependencies()

class DependencyResolver

resolveDependencies()

DependentItemMap()

OrderedMap

class DependentItemMap

apply()

external

interface Function

containsKey()

class OrderedMap

size()

affectsGlobalScope()

interface Dependent

class DependentItem

getBeforeDependents()

class Ref

class OrderedSet

getIndexedValueProxy()

indexIterable()

IndexedIterable()

ReversibleIndexedIterable

class IndexedIterable

Indexed<V>Anonymous()

class OrderedMap.Indexed<V>Anonymous

BitSetIterable()

ReversibleIterable

class BitSetIterable

ReversibleIndexedIterator

class IndexedIterator

BitSetIterator()

ReversibleIterator

class BitSetIterator

AsteriskDelimiterProcessor()

BitSetIterator()

isValidIndex()

set()

EmphasisDelimiterProcessor

class AsteriskDelimiterProcessor

UnderscoreDelimiterProcessor()

addDelimiterProcessors()

EmphasisDelimiterProcessor

class UnderscoreDelimiterProcessor

getOpeningCharacter()

interface DelimiterProcessor

Custom delimiter processor for additional delimiters besides _ and * . Note that imp...

addDelimiterProcessorForChar()

getClosingCharacter()

getCanonicalName()

external

class? Class

Whether the element consists of nested [] inside the link ref. For example Wiki link...

getBracketNestingLevel()

interface LinkRefProcessorFactory

Processing of elements which are based on a link ref: [] or ![] This includes footno...

getWantExclamationPrefix()

Whether the image ref is desired, if not then ! will be stripped off the prefix and ...

LinkRefProcessorData()

class LinkRefProcessorData

PostProcessorDependencyStage()

class PostProcessorManager.PostProcessorDependencyStage

A map of nodes of interest as keys and values a set of classes, if implemented by an...

getNodeTypes()

Dependent

interface PostProcessorFactory

interface InlineParserFactory

DocumentParser()

of()

IRichSequence...

interface BasedSequence

A CharSequence that references original char sequence with offsets into original pre...

The main parsing function. Returns a parsed document AST.

parse()

postProcess()

getParsing()

interface LightInlineParser

apply()

DocumentBlockParser()

AbstractBlockParser...

class DocumentBlockParser

activateBlockParser()

containsKey()

BlockTracker...

class ClassifyingBlockTracker

blockParserAdded()

containsKey()

class OrderedMultiMap

interface BlockParser

Parser for a specific block node. Implementations should subclass AbstractBlockParse...

putKeyValue()

IRichSequenceBase...

abstract class BasedSequenceImpl

Implementation of BaseSequence

BasedSequenceImpl

class SubSequence

A BasedSequence implementation which wraps original CharSequence to provide a BasedS...

LightInlineParser

interface InlineParser

Parser for inline content (text, links, emphasized text, etc). This interface is not...

Get a portion of this sequence

class Parsing

incorporateLine()

Analyze a line of text and update the document appropriately. We parse markdown text...

finalizeAndProcess()

Document()

Block...

class Document

indexOfAny()

interface SequenceUtils

indexOfAny()

test()

interface CharPredicate

Interface for set of characters to use for inclusion exclusion tests Can be used for...

abstract class Node

BlankLine()

Block

class BlankLine

setClaimedBlankLine()

See if the block parser can continue parsing the current block

tryContinue()

isFinalize()

BlockContinue

class BlockContinueImpl

Finalize a block. Close it and do any necessary postprocessing, e.g. creating string...

finalize()

getClaimedBlankLine()

isLastLineBlank()

breakOutOfLists()

Break out of all containing lists, resetting the tip of the document to the parent o...

Allows block parsers to be interrupted by other block parsers

isInterruptible()

Allows block parsers to keep indenting spaces for those blocks that are interruptibl...

finalizeBlocks()

Finalize blocks of previous line.

getNewIndex()

BlockStart

class BlockStartImpl

isReplaceActiveBlockParser()

getNewColumn()

removeActiveBlockParser()

getBlockParsers()

addChild()

Add block parser of type T as a child of the currently active parsers. If the tip ca...

getActiveBlockParser()

Add line content to the active block parser. We assume it can accept lines -- that c...

isParagraphParser()

addLine()

propagateLastLineBlank()

BlankLine()

ParagraphParser()

AbstractBlockParser

class ParagraphParser

unlink()

setParent()

setCharsFromContent()

SequenceUtils

interface IRichSequence

A CharSequence that provides a rich set of manipulation methods. NOTE: '\0' changed ...

setChars()

Get the start offset of this sequence into {@link #getBaseSequence()} and {@link #ge...

getStartOffset()

class Utils

Get the end offset of this sequence into {@link # getBaseSequence()} and {@link #getB...

max()

Get a portion of this sequence's base sequence <p> NOTE: this means that if this seq...

baseSubSequence()

deactivateBlockParser()

getParent()

ContentNode

abstract class Block

Append all from child to end of chain to this node

getLastChild()

getFirstInChain()

insertChainAfter()

setCharsFromContentOnly()

closeBlock()

Used to clean up and prepare for the next parsing run of the AbstractBlockParser for...

finalizeClosedBlock()

columnsToNextTabStop()

breakOutOnDoubleBlankLine()

MatchedBlockParserImpl()

MatchedBlockParser

class MatchedBlockParserImpl

Allows block parsers to determine if they can be interrupted by other block parsers

canInterruptBy()

tryStart()

interface BlockParserFactory

Parser factory for a block node for determining when a block starts. Implementations...

interface CollectionHost

getValue()

Pair()

Paired

class Pair

Get a portion of this sequence starting from a given offset to endIndex of the seque...

prefixOf()

BasedSequenceImpl...

class PrefixedSubSequence

A BasedSequence with an out of scope of original char sequence prefix a subSequence(...

Add another line to the block

addLine()

prefixOf()

PrefixedSubSequence()

setLastLineBlank()

isPropagatingLastBlankLine()

getParent()

preProcessParagraphs()

preProcessBlocks()

processInlines()

Walk through a block & children recursively, parsing string content into inline cont...

class ClassificationBag

ParagraphPreProcessorCache()

ItemFactoryMap

class DocumentParser.ParagraphPreProcessorCache

pre-process a paragraph block

getCategoryItems()

preProcessParagraph()

class ItemFactoryMap

Process Paragraph Content on closing of the paragraph block to removeIndex non-text ...

interface ParagraphPreProcessor

Node...

abstract class ContentNode

getLineChars()

setContent()

Block...

class Paragraph

Block types that this pre-processors processes

Dependent

interface BlockPreProcessorFactory

Create a paragraph pre processor for the document

Called on block nodes of interest as given by the NodePreProcessorFactory after all ...

preProcess()

interface BlockPreProcessor

get()

IndexedItemSetMap

abstract class IndexedItemSetMapBase

getConcurrentModsIndexedProxy()

IndexedProxy()

Indexed

class OrderedSet.IndexedProxy

Do inline processing for the block content using the given inline parser interface

keySet()

processDocument()

PostProcessorManager()

interface PostProcessor

NodeClassifierVisitor()

NodeVisitorBase...

class NodeClassifierVisitor

classify()

getExclusionSet()

NodeTracker

class ClassifyingNodeTracker

ClassifyingNodeTracker()

interface ReversibleIterable

CollectionHost<V>Anonymous()

addAll()

ClassificationBag()

class ClassificationBag.CollectionHost<V>Anonymous

OrderedSet()

IndexedItemBitSetMap()

IndexedItemSetMapBase

class IndexedItemBitSetMap

CollectionHost<K>Anonymous()

IndexedItemBitSetMap()

OrderedMap()

class OrderedMap.CollectionHost<K>Anonymous

entrySet()

external

interface Map

getKey()

external

interface Map$Entry

Visit the child nodes.

interface NodeTracker

class CopyOnWriteRef

setDocumentProperties()

ByteArrayOutputStream()

external

class? ByteArrayOutputStream

toString()

formatDocumentBody()

class XmlFormatter

Pretty-prints xml, supplied as a string. eg. String formattedXml = XmlFormatter.form...

sortDocumentParts()

class XmlDocxSorter

Pretty-prints docx xml, supplied as a string. putting parts in the following order: ...

getDefaultTemplate()

load()

external

class? WordprocessingMLPackage

MainDocxRenderer()

DocxContextImpl...

class DocxRenderer.MainDocxRenderer

ScopedDataSet()

DataSet

class ScopedDataSet

values()

enum DocxRendererPhase

COLLECT,DOCUMENT_FIRST,DOCUMENT_TOP,DOCUMENT, DOCUMENT_BOTTOM

Create a new HeaderIdGenerator for the specified resolver context.

HtmlIdGeneratorFactory

interface HeaderIdGeneratorFactory

Factory for instantiating an HTML id generator

setDefaultStyleAndNumbering()

Factory()

HeaderIdGeneratorFactory

class HeaderIdGenerator.Factory

class TwoWayHashMap

apply()

Dependent

interface LinkResolverFactory

Factory()

LinkResolverFactory

class DocxLinkResolver.Factory

Dependent

interface UriContentResolverFactory

Factory()

UriContentResolverFactory

class FileUriContentResolver.Factory

Dependent

interface AttributeProviderFactory

getOptions()

Create a new node renderer for the specified rendering context.

interface NodeDocxRendererFactory

Factory for instantiating new node renderers when rendering is done.

getNodeFormattingHandlers()

interface NodeDocxRenderer

A renderer for a set of node types.

getNodeType()

abstract class AstHandler

Base class for tracking generic node to specific node handler

Collect nodes of given type so that they can be quickly accessed without traversing ...

getNodeClasses()

getBookmarkWrapsChildrenClasses()

Return mapping of all nodes whose children should be wrapped in a bookmark if the pa...

getFormattingPhases()

NodeDocxRenderer

interface PhasedNodeDocxRenderer

A renderer for a document node for a specific rendering phase

NodeCollectingVisitor()

class NodeCollectingVisitor

collect()

getSubClassingBag()

setContentContainer()

DocxContext...

abstract class DocxContextImpl

HeaderIdGenerator()

HtmlIdGenerator...

class HeaderIdGenerator

HeaderIdGenerator()

getMainDocumentPart()

MainDocumentPart()

external

class? MainDocumentPart

addTargetPart()

external

class? Base

getStyleDefinitionsPart()

external

class? DocumentPart

StyleDefinitionsPart()

external

class? StyleDefinitionsPart

unmarshalString()

external

class? XmlUtils

getNumberingDefinitionsPart()

setJaxbElement()

NumberingDefinitionsPart()

external

class? NumberingDefinitionsPart

setJaxbElement()

external

class? JaxbXmlPartXPathAware

DocxLinkResolver()

LinkResolver

class DocxLinkResolver

Get the current rendering context {@link DataHolder}. These are the options passed o...

getOptions()

interface LinkResolverBasicContext

removePrefix()

FileUriContentResolver()

UriContentResolver

class FileUriContentResolver

- works with files

class SubClassingBag

interface HtmlIdGenerator

MainDocxRenderer.AllNodesVisitorAnonymous()

AllNodesVisitor

class DocxRenderer.MainDocxRenderer.AllNodesVisitorAnonymous

visit()

abstract class AllNodesVisitor

AstHandler

class NodeDocxRendererHandler

Render the specified node.

renderDocument()

getNodeId()

createBookmarkStart()

Insert bookmark start into current P

AstAction

interface NodeDocxRendererHandler.CustomNodeDocxRenderer

getSecond()

createCTBookmark()

external

class? ObjectFactory

getNextBookmarkId()

setId()

external

class? CTMarkup

Get a valid bookmark for given id

getValidBookmarkName()

DocxContextFrameProvider

interface DocxContext

setName()

external

class? CTBookmark

createBodyBookmarkStart()

Add element to content <p> May not be added at the end of content but inserted into ...

addContentElement()

interface ContentContainer

getP()

getContent()

external

class? P

Get the last P of the container or null if there is none

getLastP()

interface ParaContainer

add a new P. Don't change anything about it, just add it to its proper container

getPPr()

FormatProvider

interface BlockFormatProvider

adjustPPrForFormatting()

getPPr()

isEmpty()

external

class? StyleUtil

getRPr()

external

class? PPr

setRPr()

createPStyle()

createPPrBasePStyle()

setPStyle()

external

class? PPrBase

setVal()

external

class? PPrBase$PStyle

createCTMarkupRange()

getId()

createBodyBookmarkEnd()

getContextFrame()

run()

external

class? Runnable

finalize, add elements to the document after main part as needed after this method r...

close()

interface FormatProvider

getDocPropsCustomPart()

DocPropsCustomPart()

external

class? DocPropsCustomPart

getContents()

external

class? JaxbXmlPart

Properties()

external

class? Properties

external

class? PageSizePaper

external

class? Document

PageDimensions()

external

class? PageDimensions

setPgSize()

getSectPr()

external

class? Body

getPgSz()

setPgSz()

external

class? SectPr

StringReader()

external

class? StringReader

InputSource()

external

class? InputSource

newInstance()

external

class? DocumentBuilderFactory

external

class? DocumentBuilder

getElementsByTagName()

external

class? Document

newInstance()

external

class? DOMImplementationRegistry

getDOMImplementation()

createLSSerializer()

external

class? DOMImplementationLS

getDomConfig()

external

class? LSSerializer

setParameter()

external

class? DOMConfiguration

getLength()

external

class? NodeList