Top Description Fields Constructors Methods
com.vladsch.flexmark.ext.macros

public Class MacrosExtension

extends Object
implements ParserExtension, HtmlRendererExtension, ReferenceHoldingExtension, FormatterExtension
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.formatter.Formatter.FormatterExtension, com.vladsch.flexmark.util.misc.Extension, com.vladsch.flexmark.parser.Parser.ReferenceHoldingExtension, com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension, com.vladsch.flexmark.parser.Parser.ParserExtension
Imports
com.vladsch.flexmark.ext.macros.internal.*, com.vladsch.flexmark.formatter.Formatter, com.vladsch.flexmark.html.HtmlRenderer, com.vladsch.flexmark.parser.Parser, com.vladsch.flexmark.util.ast.KeepType, com.vladsch.flexmark.util.data.DataHolder, .DataKey, .MutableDataHolder, com.vladsch.flexmark.util.format.options.ElementPlacement, .ElementPlacementSort, org.jetbrains.annotations.NotNull
Extension for macros

Create it with create() and then configure it on the builders

The parsed macros text is turned into MacroReference nodes.

Field Summary

Modifier and TypeField and Description
public static final DataKey<MacroDefinitionRepository>
MACRO_DEFINITIONS

public static final DataKey<KeepType>
MACRO_DEFINITIONS_KEEP

public static final DataKey<ElementPlacement>
MACRO_DEFINITIONS_PLACEMENT

public static final DataKey<ElementPlacementSort>
MACRO_DEFINITIONS_SORT

public static final DataKey<Boolean>
SOURCE_WRAP_MACRO_REFERENCES

Constructor Summary

AccessConstructor and Description
private
MacrosExtension()

Method Summary

Modifier and TypeMethod and Description
public static MacrosExtension
create()

public void
extend(Formatter.Builder formatterBuilder)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.extend.

public void
extend(Parser.Builder
parser builder with which to register extensions
parserBuilder)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.extend.

This method is called on all extensions so that they can register their custom processors

public void
extend(HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)

public void
parserOptions(MutableDataHolder
option set that will be used for the builder
options)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.parserOptions.

This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

public void
rendererOptions(@NotNull MutableDataHolder
option set that will be used for the builder
options)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.rendererOptions.

This method is called first on all extensions so that they can adjust the options.

public boolean
transferReferences(MutableDataHolder
destination document for references
document, DataHolder
source document for references
included)

Implements com.vladsch.flexmark.parser.Parser.ReferenceHoldingExtension.transferReferences.

This method is called to transfer references from included document to the source document

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

MACRO_DEFINITIONSback to summary
public static final DataKey<MacroDefinitionRepository> MACRO_DEFINITIONS
MACRO_DEFINITIONS_KEEPback to summary
public static final DataKey<KeepType> MACRO_DEFINITIONS_KEEP
MACRO_DEFINITIONS_PLACEMENTback to summary
public static final DataKey<ElementPlacement> MACRO_DEFINITIONS_PLACEMENT
MACRO_DEFINITIONS_SORTback to summary
public static final DataKey<ElementPlacementSort> MACRO_DEFINITIONS_SORT
SOURCE_WRAP_MACRO_REFERENCESback to summary
public static final DataKey<Boolean> SOURCE_WRAP_MACRO_REFERENCES

Constructor Detail

MacrosExtensionback to summary
private MacrosExtension()

Method Detail

createback to summary
public static MacrosExtension create()
extendback to summary
public void extend(Formatter.Builder formatterBuilder)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.extend.

Annotations
@Override
extendback to summary
public void extend(Parser.Builder parserBuilder)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.extend.

Doc from com.vladsch.flexmark.parser.Parser.ParserExtension.extend.

This method is called on all extensions so that they can register their custom processors

Parameters
parserBuilder:Parser.Builder

parser builder with which to register extensions

Annotations
@Override
extendback to summary
public void extend(HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)
Annotations
@Override
parserOptionsback to summary
public void parserOptions(MutableDataHolder options)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.parserOptions.

Doc from com.vladsch.flexmark.parser.Parser.ParserExtension.parserOptions.

This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

Parameters
options:MutableDataHolder

option set that will be used for the builder

Annotations
@Override
rendererOptionsback to summary
public void rendererOptions(@NotNull MutableDataHolder options)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.rendererOptions.

Doc from com.vladsch.flexmark.formatter.Formatter.FormatterExtension.rendererOptions.

This method is called first on all extensions so that they can adjust the options.

Parameters
options:@NotNull MutableDataHolder

option set that will be used for the builder

Annotations
@Override
transferReferencesback to summary
public boolean transferReferences(MutableDataHolder document, DataHolder included)

Implements com.vladsch.flexmark.parser.Parser.ReferenceHoldingExtension.transferReferences.

Doc from com.vladsch.flexmark.parser.Parser.ReferenceHoldingExtension.transferReferences.

This method is called to transfer references from included document to the source document

Parameters
document:MutableDataHolder

destination document for references

included:DataHolder

source document for references

Returns:boolean

true if there were references to transfer

Annotations
@Override