Class MacrosExtension

java.lang.Object

com.vladsch.flexmark.ext.macros.MacrosExtension

All Implemented Interfaces:

Formatter.FormatterExtension, HtmlRenderer.HtmlRendererExtension, Parser.ParserExtension, Parser.ReferenceHoldingExtension, Extension

public class MacrosExtension
extends Object
implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, Parser.ReferenceHoldingExtension, 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 final DataKey<MacroDefinitionRepository>	MACRO_DEFINITIONS
static final DataKey<KeepType>	MACRO_DEFINITIONS_KEEP
static final DataKey<ElementPlacement>	MACRO_DEFINITIONS_PLACEMENT
static final DataKey<ElementPlacementSort>	MACRO_DEFINITIONS_SORT
static final DataKey<Boolean>	SOURCE_WRAP_MACRO_REFERENCES

Fields inherited from interface Extension

EMPTY_LIST

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MacrosExtension()

Method Summary

Modifier and Type	Method	Description
static MacrosExtension	create()
void	extend(Formatter.Builder formatterBuilder)
void	extend(HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)	Called to give each extension to register extension points that it contains
void	extend(Parser.Builder parserBuilder)	This method is called on all extensions so that they can register their custom processors
void	parserOptions(MutableDataHolder options)	This method is called first on all extensions so that they can adjust the options that must be common to all extensions.
void	rendererOptions(@NotNull MutableDataHolder options)	This method is called first on all extensions so that they can adjust the options that must be common to all extensions.
boolean	transferReferences(MutableDataHolder document, DataHolder included)	This method is called to transfer references from included document to the source document

Methods inherited from class Object

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

Field Details

MACRO_DEFINITIONS_KEEP

public static final DataKey<KeepType> MACRO_DEFINITIONS_KEEP

MACRO_DEFINITIONS

public static final DataKey<MacroDefinitionRepository> MACRO_DEFINITIONS

MACRO_DEFINITIONS_PLACEMENT

public static final DataKey<ElementPlacement> MACRO_DEFINITIONS_PLACEMENT

MACRO_DEFINITIONS_SORT

public static final DataKey<ElementPlacementSort> MACRO_DEFINITIONS_SORT

SOURCE_WRAP_MACRO_REFERENCES

public static final DataKey<Boolean> SOURCE_WRAP_MACRO_REFERENCES

Constructor Details

MacrosExtension

private MacrosExtension()

Method Details

create

public static MacrosExtension create()

rendererOptions

public void rendererOptions(@NotNull
 @NotNull MutableDataHolder options)

Description copied from interface: HtmlRenderer.HtmlRendererExtension

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

Specified by:

rendererOptions in interface Formatter.FormatterExtension

Specified by:

rendererOptions in interface HtmlRenderer.HtmlRendererExtension

Parameters:

options - option set that will be used for the builder

parserOptions

public void parserOptions(MutableDataHolder options)

Description copied from interface: Parser.ParserExtension

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

Specified by:

parserOptions in interface Parser.ParserExtension

Parameters:

options - option set that will be used for the builder

transferReferences

public boolean transferReferences(MutableDataHolder document,
 DataHolder included)

Description copied from interface: Parser.ReferenceHoldingExtension

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

Specified by:

transferReferences in interface Parser.ReferenceHoldingExtension

Parameters:

document - destination document for references

included - source document for references

Returns:

true if there were references to transfer

extend

public void extend(Formatter.Builder formatterBuilder)

Specified by:

extend in interface Formatter.FormatterExtension

extend

public void extend(Parser.Builder parserBuilder)

Description copied from interface: Parser.ParserExtension

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

Specified by:

extend in interface Parser.ParserExtension

Parameters:

parserBuilder - parser builder with which to register extensions

See Also:

• Parser.Builder.customBlockParserFactory(CustomBlockParserFactory)
• Parser.Builder.customInlineParserExtensionFactory(InlineParserExtensionFactory)
• Parser.Builder.customInlineParserFactory(InlineParserFactory)
• Parser.Builder.customDelimiterProcessor(DelimiterProcessor)
• Parser.Builder.postProcessorFactory(PostProcessorFactory)
• Parser.Builder.paragraphPreProcessorFactory(ParagraphPreProcessorFactory)
• Parser.Builder.blockPreProcessorFactory(BlockPreProcessorFactory)
• Parser.Builder.linkRefProcessorFactory(LinkRefProcessorFactory)
• Parser.Builder.specialLeadInHandler(SpecialLeadInHandler)

extend

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

Description copied from interface: HtmlRenderer.HtmlRendererExtension

Called to give each extension to register extension points that it contains

Specified by:

extend in interface HtmlRenderer.HtmlRendererExtension

Parameters:

htmlRendererBuilder - builder to call back for extension point registration

rendererType - type of rendering being performed. For now "HTML", "JIRA" or "YOUTRACK"

See Also:

• HtmlRenderer.Builder.attributeProviderFactory(AttributeProviderFactory)
• HtmlRenderer.Builder.nodeRendererFactory(NodeRendererFactory)
• HtmlRenderer.Builder.linkResolverFactory(LinkResolverFactory)
• HtmlRenderer.Builder.htmlIdGeneratorFactory(HeaderIdGeneratorFactory)