Class AttributesExtension

java.lang.Object

com.vladsch.flexmark.ext.attributes.AttributesExtension

All Implemented Interfaces:

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

public class AttributesExtension
extends Object
implements Parser.ParserExtension, RendererExtension, HtmlRenderer.HtmlRendererExtension, Formatter.FormatterExtension

Extension for attributes

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

The parsed attributes text is turned into AttributesNode nodes.

Field Summary

Fields

Modifier and Type	Field	Description
static final DataKey<Boolean>	ASSIGN_TEXT_ATTRIBUTES
static final DataKey<KeepType>	ATTRIBUTES_KEEP
static final DataKey<FencedCodeAddType>	FENCED_CODE_ADD_ATTRIBUTES
static final DataKey<Boolean>	FENCED_CODE_INFO_ATTRIBUTES
static final DataKey<AttributeImplicitName>	FORMAT_ATTRIBUTE_CLASS
static final DataKey<DiscretionaryText>	FORMAT_ATTRIBUTE_EQUAL_SPACE
static final DataKey<AttributeImplicitName>	FORMAT_ATTRIBUTE_ID
static final DataKey<AttributeValueQuotes>	FORMAT_ATTRIBUTE_VALUE_QUOTES
static final DataKey<Boolean>	FORMAT_ATTRIBUTES_COMBINE_CONSECUTIVE
static final DataKey<Boolean>	FORMAT_ATTRIBUTES_SORT
static final DataKey<DiscretionaryText>	FORMAT_ATTRIBUTES_SPACES
static final DataKey<NodeAttributeRepository>	NODE_ATTRIBUTES
static final DataKey<Boolean>	USE_EMPTY_IMPLICIT_AS_SPAN_DELIMITER
static final DataKey<Boolean>	WRAP_NON_ATTRIBUTE_TEXT

Fields inherited from interface Extension

EMPTY_LIST

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AttributesExtension()

Method Summary

Modifier and Type	Method	Description
static AttributesExtension	create()
void	extend(Formatter.Builder formatterBuilder)
void	extend(@NotNull RendererBuilder rendererBuilder, @NotNull String rendererType)	Called to give each extension to register extension points that it contains
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.

Methods inherited from class Object

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

Field Details

NODE_ATTRIBUTES

public static final DataKey<NodeAttributeRepository> NODE_ATTRIBUTES

ATTRIBUTES_KEEP

public static final DataKey<KeepType> ATTRIBUTES_KEEP

ASSIGN_TEXT_ATTRIBUTES

public static final DataKey<Boolean> ASSIGN_TEXT_ATTRIBUTES

FENCED_CODE_INFO_ATTRIBUTES

public static final DataKey<Boolean> FENCED_CODE_INFO_ATTRIBUTES

FENCED_CODE_ADD_ATTRIBUTES

public static final DataKey<FencedCodeAddType> FENCED_CODE_ADD_ATTRIBUTES

WRAP_NON_ATTRIBUTE_TEXT

public static final DataKey<Boolean> WRAP_NON_ATTRIBUTE_TEXT

USE_EMPTY_IMPLICIT_AS_SPAN_DELIMITER

public static final DataKey<Boolean> USE_EMPTY_IMPLICIT_AS_SPAN_DELIMITER

FORMAT_ATTRIBUTES_COMBINE_CONSECUTIVE

public static final DataKey<Boolean> FORMAT_ATTRIBUTES_COMBINE_CONSECUTIVE

FORMAT_ATTRIBUTES_SORT

public static final DataKey<Boolean> FORMAT_ATTRIBUTES_SORT

FORMAT_ATTRIBUTES_SPACES

public static final DataKey<DiscretionaryText> FORMAT_ATTRIBUTES_SPACES

FORMAT_ATTRIBUTE_EQUAL_SPACE

public static final DataKey<DiscretionaryText> FORMAT_ATTRIBUTE_EQUAL_SPACE

FORMAT_ATTRIBUTE_VALUE_QUOTES

public static final DataKey<AttributeValueQuotes> FORMAT_ATTRIBUTE_VALUE_QUOTES

FORMAT_ATTRIBUTE_ID

public static final DataKey<AttributeImplicitName> FORMAT_ATTRIBUTE_ID

FORMAT_ATTRIBUTE_CLASS

public static final DataKey<AttributeImplicitName> FORMAT_ATTRIBUTE_CLASS

Constructor Details

AttributesExtension

private AttributesExtension()

Method Details

create

public static AttributesExtension create()

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

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(Formatter.Builder formatterBuilder)

Specified by:

extend in interface Formatter.FormatterExtension

rendererOptions

public void rendererOptions(@NotNull
 @NotNull MutableDataHolder options)

Description copied from interface: RendererExtension

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

Specified by:

rendererOptions in interface RendererExtension

Parameters:

options - option set that will be used for the builder

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)

extend

public void extend(@NotNull
 @NotNull RendererBuilder rendererBuilder,
 @NotNull
 @NotNull String rendererType)

Description copied from interface: RendererExtension

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

Specified by:

extend in interface RendererExtension

Parameters:

rendererBuilder - 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.linkResolverFactory(LinkResolverFactory)
• HtmlRenderer.Builder.htmlIdGeneratorFactory(HeaderIdGeneratorFactory)