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

public Class AttributesExtension

extends Object
implements ParserExtension, RendererExtension, HtmlRendererExtension, FormatterExtension
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.formatter.Formatter.FormatterExtension, com.vladsch.flexmark.util.misc.Extension, com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension, com.vladsch.flexmark.html.RendererExtension, com.vladsch.flexmark.parser.Parser.ParserExtension
Imports
com.vladsch.flexmark.ext.attributes.internal.*, com.vladsch.flexmark.formatter.Formatter, com.vladsch.flexmark.html.HtmlRenderer, .RendererBuilder, .RendererExtension, com.vladsch.flexmark.parser.Parser, com.vladsch.flexmark.util.ast.KeepType, com.vladsch.flexmark.util.data.DataKey, .MutableDataHolder, com.vladsch.flexmark.util.format.options.DiscretionaryText, org.jetbrains.annotations.NotNull
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

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

public static final DataKey<KeepType>
ATTRIBUTES_KEEP

public static final DataKey<FencedCodeAddType>
FENCED_CODE_ADD_ATTRIBUTES

public static final DataKey<Boolean>
FENCED_CODE_INFO_ATTRIBUTES

public static final DataKey<AttributeImplicitName>
FORMAT_ATTRIBUTE_CLASS

public static final DataKey<DiscretionaryText>
FORMAT_ATTRIBUTE_EQUAL_SPACE

public static final DataKey<AttributeImplicitName>
FORMAT_ATTRIBUTE_ID

public static final DataKey<AttributeValueQuotes>
FORMAT_ATTRIBUTE_VALUE_QUOTES

public static final DataKey<Boolean>
FORMAT_ATTRIBUTES_COMBINE_CONSECUTIVE

public static final DataKey<Boolean>
FORMAT_ATTRIBUTES_SORT

public static final DataKey<DiscretionaryText>
FORMAT_ATTRIBUTES_SPACES

public static final DataKey<NodeAttributeRepository>
NODE_ATTRIBUTES

public static final DataKey<Boolean>
USE_EMPTY_IMPLICIT_AS_SPAN_DELIMITER

public static final DataKey<Boolean>
WRAP_NON_ATTRIBUTE_TEXT

Constructor Summary

AccessConstructor and Description
private
AttributesExtension()

Method Summary

Modifier and TypeMethod and Description
public static AttributesExtension
create()

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

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

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

public void
extend(@NotNull RendererBuilder rendererBuilder, @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.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ASSIGN_TEXT_ATTRIBUTESback to summary
public static final DataKey<Boolean> ASSIGN_TEXT_ATTRIBUTES
ATTRIBUTES_KEEPback to summary
public static final DataKey<KeepType> ATTRIBUTES_KEEP
FENCED_CODE_ADD_ATTRIBUTESback to summary
public static final DataKey<FencedCodeAddType> FENCED_CODE_ADD_ATTRIBUTES
FENCED_CODE_INFO_ATTRIBUTESback to summary
public static final DataKey<Boolean> FENCED_CODE_INFO_ATTRIBUTES
FORMAT_ATTRIBUTE_CLASSback to summary
public static final DataKey<AttributeImplicitName> FORMAT_ATTRIBUTE_CLASS
FORMAT_ATTRIBUTE_EQUAL_SPACEback to summary
public static final DataKey<DiscretionaryText> FORMAT_ATTRIBUTE_EQUAL_SPACE
FORMAT_ATTRIBUTE_IDback to summary
public static final DataKey<AttributeImplicitName> FORMAT_ATTRIBUTE_ID
FORMAT_ATTRIBUTE_VALUE_QUOTESback to summary
public static final DataKey<AttributeValueQuotes> FORMAT_ATTRIBUTE_VALUE_QUOTES
FORMAT_ATTRIBUTES_COMBINE_CONSECUTIVEback to summary
public static final DataKey<Boolean> FORMAT_ATTRIBUTES_COMBINE_CONSECUTIVE
FORMAT_ATTRIBUTES_SORTback to summary
public static final DataKey<Boolean> FORMAT_ATTRIBUTES_SORT
FORMAT_ATTRIBUTES_SPACESback to summary
public static final DataKey<DiscretionaryText> FORMAT_ATTRIBUTES_SPACES
NODE_ATTRIBUTESback to summary
public static final DataKey<NodeAttributeRepository> NODE_ATTRIBUTES
USE_EMPTY_IMPLICIT_AS_SPAN_DELIMITERback to summary
public static final DataKey<Boolean> USE_EMPTY_IMPLICIT_AS_SPAN_DELIMITER
WRAP_NON_ATTRIBUTE_TEXTback to summary
public static final DataKey<Boolean> WRAP_NON_ATTRIBUTE_TEXT

Constructor Detail

AttributesExtensionback to summary
private AttributesExtension()

Method Detail

createback to summary
public static AttributesExtension create()
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(Formatter.Builder formatterBuilder)

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

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