Package com.vladsch.flexmark.ext.tables

Class TablesExtension

java.lang.Object

com.vladsch.flexmark.ext.tables.TablesExtension

All Implemented Interfaces:

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

public class TablesExtension
extends java.lang.Object
implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, Formatter.FormatterExtension

Extension for GFM tables using "|" pipes (GitHub Flavored Markdown).

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

The parsed tables are turned into TableBlock blocks.

Field Summary

Fields

Modifier and Type	Field	Description
static DataKey<java.lang.Boolean>	APPEND_MISSING_COLUMNS
static DataKey<java.lang.String>	CLASS_NAME
static DataKey<java.lang.Boolean>	COLUMN_SPANS
static DataKey<java.lang.Boolean>	DISCARD_EXTRA_COLUMNS
static DataKey<CharWidthProvider>	FORMAT_CHAR_WIDTH_PROVIDER
static DataKey<java.lang.Boolean>	FORMAT_TABLE_ADJUST_COLUMN_WIDTH
static DataKey<java.lang.Boolean>	FORMAT_TABLE_APPLY_COLUMN_ALIGNMENT
static DataKey<TableCaptionHandling>	FORMAT_TABLE_CAPTION
static DataKey<DiscretionaryText>	FORMAT_TABLE_CAPTION_SPACES
static DataKey<java.lang.Boolean>	FORMAT_TABLE_FILL_MISSING_COLUMNS
static NullableDataKey<java.lang.Integer>	FORMAT_TABLE_FILL_MISSING_MIN_COLUMN
static DataKey<java.lang.String>	FORMAT_TABLE_INDENT_PREFIX
static DataKey<java.lang.Boolean>	FORMAT_TABLE_LEAD_TRAIL_PIPES
static DataKey<DiscretionaryText>	FORMAT_TABLE_LEFT_ALIGN_MARKER
static DataKey<TableManipulator>	FORMAT_TABLE_MANIPULATOR
static DataKey<java.lang.Integer>	FORMAT_TABLE_MIN_SEPARATOR_COLUMN_WIDTH
static DataKey<java.lang.Integer>	FORMAT_TABLE_MIN_SEPARATOR_DASHES
static DataKey<java.lang.Boolean>	FORMAT_TABLE_SPACE_AROUND_PIPES
static DataKey<java.lang.Boolean>	FORMAT_TABLE_TRIM_CELL_WHITESPACE
static DataKey<java.lang.Boolean>	HEADER_SEPARATOR_COLUMN_MATCH
static DataKey<java.lang.Integer>	MAX_HEADER_ROWS
static DataKey<java.lang.Integer>	MIN_HEADER_ROWS
static DataKey<java.lang.Integer>	MIN_SEPARATOR_DASHES
static DataKey<java.lang.Boolean>	TRIM_CELL_WHITESPACE
static DataKey<java.lang.Boolean>	WITH_CAPTION

Fields inherited from interface com.vladsch.flexmark.util.misc.Extension

EMPTY_LIST

Constructor Summary

Constructors

Constructor	Description
TablesExtension()

Method Summary

Modifier and Type	Method	Description
static TablesExtension	create()
void	extend(Formatter.Builder formatterBuilder)
void	extend(HtmlRenderer.Builder htmlRendererBuilder, java.lang.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(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 java.lang.Object

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

Field Detail

TRIM_CELL_WHITESPACE

public static final DataKey<java.lang.Boolean> TRIM_CELL_WHITESPACE

MIN_SEPARATOR_DASHES

public static final DataKey<java.lang.Integer> MIN_SEPARATOR_DASHES

MAX_HEADER_ROWS

public static final DataKey<java.lang.Integer> MAX_HEADER_ROWS

MIN_HEADER_ROWS

public static final DataKey<java.lang.Integer> MIN_HEADER_ROWS

APPEND_MISSING_COLUMNS

public static final DataKey<java.lang.Boolean> APPEND_MISSING_COLUMNS

DISCARD_EXTRA_COLUMNS

public static final DataKey<java.lang.Boolean> DISCARD_EXTRA_COLUMNS

COLUMN_SPANS

public static final DataKey<java.lang.Boolean> COLUMN_SPANS

HEADER_SEPARATOR_COLUMN_MATCH

public static final DataKey<java.lang.Boolean> HEADER_SEPARATOR_COLUMN_MATCH

CLASS_NAME

public static final DataKey<java.lang.String> CLASS_NAME

WITH_CAPTION

public static final DataKey<java.lang.Boolean> WITH_CAPTION

FORMAT_TABLE_TRIM_CELL_WHITESPACE

public static final DataKey<java.lang.Boolean> FORMAT_TABLE_TRIM_CELL_WHITESPACE

FORMAT_TABLE_LEAD_TRAIL_PIPES

public static final DataKey<java.lang.Boolean> FORMAT_TABLE_LEAD_TRAIL_PIPES

FORMAT_TABLE_SPACE_AROUND_PIPES

public static final DataKey<java.lang.Boolean> FORMAT_TABLE_SPACE_AROUND_PIPES

FORMAT_TABLE_ADJUST_COLUMN_WIDTH

public static final DataKey<java.lang.Boolean> FORMAT_TABLE_ADJUST_COLUMN_WIDTH

FORMAT_TABLE_APPLY_COLUMN_ALIGNMENT

public static final DataKey<java.lang.Boolean> FORMAT_TABLE_APPLY_COLUMN_ALIGNMENT

FORMAT_TABLE_FILL_MISSING_COLUMNS

public static final DataKey<java.lang.Boolean> FORMAT_TABLE_FILL_MISSING_COLUMNS

FORMAT_TABLE_FILL_MISSING_MIN_COLUMN

public static final NullableDataKey<java.lang.Integer> FORMAT_TABLE_FILL_MISSING_MIN_COLUMN

FORMAT_TABLE_LEFT_ALIGN_MARKER

public static final DataKey<DiscretionaryText> FORMAT_TABLE_LEFT_ALIGN_MARKER

FORMAT_TABLE_MIN_SEPARATOR_COLUMN_WIDTH

public static final DataKey<java.lang.Integer> FORMAT_TABLE_MIN_SEPARATOR_COLUMN_WIDTH

FORMAT_TABLE_MIN_SEPARATOR_DASHES

public static final DataKey<java.lang.Integer> FORMAT_TABLE_MIN_SEPARATOR_DASHES

FORMAT_CHAR_WIDTH_PROVIDER

public static final DataKey<CharWidthProvider> FORMAT_CHAR_WIDTH_PROVIDER

FORMAT_TABLE_MANIPULATOR

public static final DataKey<TableManipulator> FORMAT_TABLE_MANIPULATOR

FORMAT_TABLE_CAPTION

public static final DataKey<TableCaptionHandling> FORMAT_TABLE_CAPTION

FORMAT_TABLE_CAPTION_SPACES

public static final DataKey<DiscretionaryText> FORMAT_TABLE_CAPTION_SPACES

FORMAT_TABLE_INDENT_PREFIX

public static final DataKey<java.lang.String> FORMAT_TABLE_INDENT_PREFIX

Constructor Detail

TablesExtension

public TablesExtension()

Method Detail

create

public static TablesExtension create()

extend

public void extend(Formatter.Builder formatterBuilder)

Specified by:

extend in interface Formatter.FormatterExtension

rendererOptions

public void rendererOptions(@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

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
                   java.lang.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)