Class AttributesNodeFormatter

java.lang.Object

com.vladsch.flexmark.ext.attributes.internal.AttributesNodeFormatter

All Implemented Interfaces:

ExplicitAttributeIdProvider, NodeFormatter, PhasedNodeFormatter

public class AttributesNodeFormatter
extends Object
implements PhasedNodeFormatter, ExplicitAttributeIdProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AttributesNodeFormatter.Factory

Field Summary

Fields

Modifier and Type	Field	Description
static final DataKey<Map<String,String>>	ATTRIBUTE_ORIGINAL_ID_MAP
static final DataKey<Map<String,String>>	ATTRIBUTE_TRANSLATED_MAP
static final DataKey<Integer>	ATTRIBUTE_TRANSLATION_ID
static final DataKey<Map<String,String>>	ATTRIBUTE_TRANSLATION_MAP
static final DataKey<Map<String,String>>	ATTRIBUTE_UNIQUIFICATION_CATEGORY_MAP
static final DataKey<Map<String,String>>	ATTRIBUTE_UNIQUIFICATION_ID_MAP
private int	attributeOriginalId
private Map<String,String>	attributeOriginalIdMap
private Map<String,String>	attributeTranslatedMap
private Map<String,String>	attributeTranslationMap
private Map<String,String>	attributeUniquificationIdMap
private final AttributesFormatOptions	formatOptions
static final DataKey<Set<Node>>	PROCESSED_ATTRIBUTES

Constructor Summary

Constructors

Constructor	Description
AttributesNodeFormatter(DataHolder options)

Method Summary

Modifier and Type	Method	Description
void	addExplicitId(@NotNull Node node, @Nullable String id, @NotNull NodeFormatterContext context, @NotNull MarkdownWriter markdown)	Used by AttributesExtension to insert attributes for headings during merge
(package private) static AttributeNode	combineAttributes(LinkedHashMap<String, AttributeNode> attributeNodes, AttributeNode attributeNode)
static String	getEncodedIdAttribute(String category, String categoryId, NodeFormatterContext context, MarkdownWriter markdown)
private static String	getEncodedIdAttribute(String category, String categoryId, NodeFormatterContext context, MarkdownWriter markdown, Map<String,String> attributeTranslationMap, Map<String,String> attributeTranslatedMap)
private String	getEncodedOriginalId(String attribute, NodeFormatterContext context)
@Nullable Set<FormattingPhase>	getFormattingPhases()
@Nullable Set<Class<?>>	getNodeClasses()	Collect nodes of given type so that they can be quickly accessed without traversing the AST by all formatting extensions.
@Nullable Set<NodeFormattingHandler<?>>	getNodeFormattingHandlers()
(package private) boolean	hasNoIdAttribute(Node node)
(package private) void	render(AttributesNode node, NodeFormatterContext context, MarkdownWriter markdown)
void	renderDocument(@NotNull NodeFormatterContext context, @NotNull MarkdownWriter markdown, @NotNull Document document, @NotNull FormattingPhase phase)	Render the specified node.

Methods inherited from class Object

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

Methods inherited from interface NodeFormatter

getBlockQuoteLikePrefixChar

Field Details

ATTRIBUTE_TRANSLATION_MAP

public static final DataKey<Map<String,String>> ATTRIBUTE_TRANSLATION_MAP

ATTRIBUTE_TRANSLATED_MAP

public static final DataKey<Map<String,String>> ATTRIBUTE_TRANSLATED_MAP

ATTRIBUTE_ORIGINAL_ID_MAP

public static final DataKey<Map<String,String>> ATTRIBUTE_ORIGINAL_ID_MAP

PROCESSED_ATTRIBUTES

public static final DataKey<Set<Node>> PROCESSED_ATTRIBUTES

ATTRIBUTE_UNIQUIFICATION_ID_MAP

public static final DataKey<Map<String,String>> ATTRIBUTE_UNIQUIFICATION_ID_MAP

ATTRIBUTE_UNIQUIFICATION_CATEGORY_MAP

public static final DataKey<Map<String,String>> ATTRIBUTE_UNIQUIFICATION_CATEGORY_MAP

ATTRIBUTE_TRANSLATION_ID

public static final DataKey<Integer> ATTRIBUTE_TRANSLATION_ID

attributeTranslationMap

private Map<String,String> attributeTranslationMap

attributeTranslatedMap

private Map<String,String> attributeTranslatedMap

attributeOriginalIdMap

private Map<String,String> attributeOriginalIdMap

attributeUniquificationIdMap

private Map<String,String> attributeUniquificationIdMap

attributeOriginalId

private int attributeOriginalId

formatOptions

private final AttributesFormatOptions formatOptions

Constructor Details

AttributesNodeFormatter

public AttributesNodeFormatter(DataHolder options)

Method Details

getNodeClasses

@Nullable
public @Nullable Set<Class<?>> getNodeClasses()

Description copied from interface: NodeFormatter

Collect nodes of given type so that they can be quickly accessed without traversing the AST by all formatting extensions.

Specified by:

getNodeClasses in interface NodeFormatter

Returns:

the nodes of interest to this formatter during formatting.

getFormattingPhases

@Nullable
public @Nullable Set<FormattingPhase> getFormattingPhases()

Specified by:

getFormattingPhases in interface PhasedNodeFormatter

addExplicitId

public void addExplicitId(@NotNull
 @NotNull Node node,
 @Nullable
 @Nullable String id,
 @NotNull
 @NotNull NodeFormatterContext context,
 @NotNull
 @NotNull MarkdownWriter markdown)

Description copied from interface: ExplicitAttributeIdProvider

Used by AttributesExtension to insert attributes for headings during merge

Specified by:

addExplicitId in interface ExplicitAttributeIdProvider

Parameters:

node - node

id - explicit id

context - context

markdown - markdown writer

hasNoIdAttribute

boolean hasNoIdAttribute(Node node)

renderDocument

public void renderDocument(@NotNull
 @NotNull NodeFormatterContext context,
 @NotNull
 @NotNull MarkdownWriter markdown,
 @NotNull
 @NotNull Document document,
 @NotNull
 @NotNull FormattingPhase phase)

Description copied from interface: PhasedNodeFormatter

Render the specified node.

Specified by:

renderDocument in interface PhasedNodeFormatter

Parameters:

context - node renderer context instance

markdown - markdown writer instance

document - the document node to render

phase - rendering phase for which to generate the output. Will be any of FormattingPhase except FormattingPhase.DOCUMENT because this phase is used for the non-phased node rendering

getNodeFormattingHandlers

@Nullable
public @Nullable Set<NodeFormattingHandler<?>> getNodeFormattingHandlers()

Specified by:

getNodeFormattingHandlers in interface NodeFormatter

Returns:

the mapping of nodes this renderer handles to rendering function

getEncodedIdAttribute

public static String getEncodedIdAttribute(String category,
 String categoryId,
 NodeFormatterContext context,
 MarkdownWriter markdown)

getEncodedIdAttribute

private static String getEncodedIdAttribute(String category,
 String categoryId,
 NodeFormatterContext context,
 MarkdownWriter markdown,
 Map<String,String> attributeTranslationMap,
 Map<String,String> attributeTranslatedMap)

getEncodedOriginalId

private String getEncodedOriginalId(String attribute,
 NodeFormatterContext context)

render

void render(AttributesNode node,
 NodeFormatterContext context,
 MarkdownWriter markdown)

combineAttributes

static AttributeNode combineAttributes(LinkedHashMap<String, AttributeNode> attributeNodes,
 AttributeNode attributeNode)