Package com.vladsch.flexmark.ext.macros

Class MacrosExtension

java.lang.Object

com.vladsch.flexmark.ext.macros.MacrosExtension

All Implemented Interfaces:

com.vladsch.flexmark.formatter.Formatter.FormatterExtension, com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension, com.vladsch.flexmark.parser.Parser.ParserExtension, com.vladsch.flexmark.parser.Parser.ReferenceHoldingExtension, com.vladsch.flexmark.util.misc.Extension

public class MacrosExtension
extends Object
implements com.vladsch.flexmark.parser.Parser.ParserExtension, com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension, com.vladsch.flexmark.parser.Parser.ReferenceHoldingExtension, com.vladsch.flexmark.formatter.Formatter.FormatterExtension

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

Fields

Modifier and Type	Field	Description
static com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.ext.macros.internal.MacroDefinitionRepository>	MACRO_DEFINITIONS
static com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.ast.KeepType>	MACRO_DEFINITIONS_KEEP
static com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.format.options.ElementPlacement>	MACRO_DEFINITIONS_PLACEMENT
static com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.format.options.ElementPlacementSort>	MACRO_DEFINITIONS_SORT
static com.vladsch.flexmark.util.data.DataKey<Boolean>	SOURCE_WRAP_MACRO_REFERENCES

Fields inherited from interface com.vladsch.flexmark.util.misc.Extension

EMPTY_LIST

Method Summary

Modifier and Type	Method	Description
static MacrosExtension	create()
void	extend(com.vladsch.flexmark.formatter.Formatter.Builder formatterBuilder)
void	extend(com.vladsch.flexmark.html.HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)
void	extend(com.vladsch.flexmark.parser.Parser.Builder parserBuilder)
void	parserOptions(com.vladsch.flexmark.util.data.MutableDataHolder options)
void	rendererOptions(@NotNull com.vladsch.flexmark.util.data.MutableDataHolder options)
boolean	transferReferences(com.vladsch.flexmark.util.data.MutableDataHolder document, com.vladsch.flexmark.util.data.DataHolder included)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MACRO_DEFINITIONS_KEEP

public static final com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.ast.KeepType> MACRO_DEFINITIONS_KEEP

MACRO_DEFINITIONS

public static final com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.ext.macros.internal.MacroDefinitionRepository> MACRO_DEFINITIONS

MACRO_DEFINITIONS_PLACEMENT

public static final com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.format.options.ElementPlacement> MACRO_DEFINITIONS_PLACEMENT

MACRO_DEFINITIONS_SORT

public static final com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.format.options.ElementPlacementSort> MACRO_DEFINITIONS_SORT

SOURCE_WRAP_MACRO_REFERENCES

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> SOURCE_WRAP_MACRO_REFERENCES

Method Detail

create

public static MacrosExtension create()

rendererOptions

public void rendererOptions(@NotNull
                            @NotNull com.vladsch.flexmark.util.data.MutableDataHolder options)

Specified by:

rendererOptions in interface com.vladsch.flexmark.formatter.Formatter.FormatterExtension

Specified by:

rendererOptions in interface com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension

parserOptions

public void parserOptions(com.vladsch.flexmark.util.data.MutableDataHolder options)

Specified by:

parserOptions in interface com.vladsch.flexmark.parser.Parser.ParserExtension

transferReferences

public boolean transferReferences(com.vladsch.flexmark.util.data.MutableDataHolder document,
                                  com.vladsch.flexmark.util.data.DataHolder included)

Specified by:

transferReferences in interface com.vladsch.flexmark.parser.Parser.ReferenceHoldingExtension

extend

public void extend(com.vladsch.flexmark.formatter.Formatter.Builder formatterBuilder)

Specified by:

extend in interface com.vladsch.flexmark.formatter.Formatter.FormatterExtension

extend

public void extend(com.vladsch.flexmark.parser.Parser.Builder parserBuilder)

Specified by:

extend in interface com.vladsch.flexmark.parser.Parser.ParserExtension

extend

public void extend(@NotNull
                   com.vladsch.flexmark.html.HtmlRenderer.Builder htmlRendererBuilder,
                   @NotNull
                   @NotNull String rendererType)

Specified by:

extend in interface com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension