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

public Class MacroExtension

extends Object
implements ParserExtension, HtmlRendererExtension
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension, com.vladsch.flexmark.util.misc.Extension, com.vladsch.flexmark.parser.Parser.ParserExtension
Imports
com.vladsch.flexmark.ext.xwiki.macros.internal.MacroBlockParser, .MacroInlineParser, .MacroNodeRenderer, com.vladsch.flexmark.html.HtmlRenderer, com.vladsch.flexmark.parser.Parser, com.vladsch.flexmark.util.data.DataKey, .MutableDataHolder, 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 Macro nodes.

Field Summary

Modifier and TypeField and Description
public static final DataKey<Boolean>
ENABLE_BLOCK_MACROS

public static final DataKey<Boolean>
ENABLE_INLINE_MACROS

public static final DataKey<Boolean>
ENABLE_RENDERING

Constructor Summary

AccessConstructor and Description
private
MacroExtension()

Method Summary

Modifier and TypeMethod and Description
public static MacroExtension
create()

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

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
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 options)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ENABLE_BLOCK_MACROSback to summary
public static final DataKey<Boolean> ENABLE_BLOCK_MACROS
ENABLE_INLINE_MACROSback to summary
public static final DataKey<Boolean> ENABLE_INLINE_MACROS
ENABLE_RENDERINGback to summary
public static final DataKey<Boolean> ENABLE_RENDERING

Constructor Detail

MacroExtensionback to summary
private MacroExtension()

Method Detail

createback to summary
public static MacroExtension create()
extendback to summary
public void extend(HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)
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
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)
Annotations
@Override