com.vladsch.flexmark.ext.tables

Class TablesExtension

java.lang.Object

com.vladsch.flexmark.ext.tables.TablesExtension

All Implemented Interfaces:

com.vladsch.flexmark.formatter.Formatter.FormatterExtension, com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension, com.vladsch.flexmark.parser.Parser.ParserExtension, com.vladsch.flexmark.util.misc.Extension

public class TablesExtension
extends Object
implements com.vladsch.flexmark.parser.Parser.ParserExtension, com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension, com.vladsch.flexmark.formatter.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 and Description
static com.vladsch.flexmark.util.data.DataKey<Boolean>	APPEND_MISSING_COLUMNS
static com.vladsch.flexmark.util.data.DataKey<String>	CLASS_NAME
static com.vladsch.flexmark.util.data.DataKey<Boolean>	COLUMN_SPANS
static com.vladsch.flexmark.util.data.DataKey<Boolean>	DISCARD_EXTRA_COLUMNS
static com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.format.CharWidthProvider>	FORMAT_CHAR_WIDTH_PROVIDER
static com.vladsch.flexmark.util.data.DataKey<Boolean>	FORMAT_TABLE_ADJUST_COLUMN_WIDTH
static com.vladsch.flexmark.util.data.DataKey<Boolean>	FORMAT_TABLE_APPLY_COLUMN_ALIGNMENT
static com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.format.options.TableCaptionHandling>	FORMAT_TABLE_CAPTION
static com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.format.options.DiscretionaryText>	FORMAT_TABLE_CAPTION_SPACES
static com.vladsch.flexmark.util.data.DataKey<Boolean>	FORMAT_TABLE_FILL_MISSING_COLUMNS
static com.vladsch.flexmark.util.data.NullableDataKey<Integer>	FORMAT_TABLE_FILL_MISSING_MIN_COLUMN
static com.vladsch.flexmark.util.data.DataKey<String>	FORMAT_TABLE_INDENT_PREFIX
static com.vladsch.flexmark.util.data.DataKey<Boolean>	FORMAT_TABLE_LEAD_TRAIL_PIPES
static com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.format.options.DiscretionaryText>	FORMAT_TABLE_LEFT_ALIGN_MARKER
static com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.format.TableManipulator>	FORMAT_TABLE_MANIPULATOR
static com.vladsch.flexmark.util.data.DataKey<Integer>	FORMAT_TABLE_MIN_SEPARATOR_COLUMN_WIDTH
static com.vladsch.flexmark.util.data.DataKey<Integer>	FORMAT_TABLE_MIN_SEPARATOR_DASHES
static com.vladsch.flexmark.util.data.DataKey<Boolean>	FORMAT_TABLE_SPACE_AROUND_PIPES
static com.vladsch.flexmark.util.data.DataKey<Boolean>	FORMAT_TABLE_TRIM_CELL_WHITESPACE
static com.vladsch.flexmark.util.data.DataKey<Boolean>	HEADER_SEPARATOR_COLUMN_MATCH
static com.vladsch.flexmark.util.data.DataKey<Integer>	MAX_HEADER_ROWS
static com.vladsch.flexmark.util.data.DataKey<Integer>	MIN_HEADER_ROWS
static com.vladsch.flexmark.util.data.DataKey<Integer>	MIN_SEPARATOR_DASHES
static com.vladsch.flexmark.util.data.DataKey<Boolean>	TRIM_CELL_WHITESPACE
static com.vladsch.flexmark.util.data.DataKey<Boolean>	WITH_CAPTION

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

EMPTY_LIST

Constructor Summary

Constructors

Constructor and Description
TablesExtension()

Method Summary

Modifier and Type	Method and Description
static TablesExtension	create()
void	extend(com.vladsch.flexmark.formatter.Formatter.Builder formatterBuilder)
void	extend(com.vladsch.flexmark.html.HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)
void	extend(com.vladsch.flexmark.parser.Parser.Builder parserBuilder)
void	parserOptions(com.vladsch.flexmark.util.data.MutableDataHolder options)
void	rendererOptions(@NotNull com.vladsch.flexmark.util.data.MutableDataHolder options)

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 com.vladsch.flexmark.util.data.DataKey<Boolean> TRIM_CELL_WHITESPACE

MIN_SEPARATOR_DASHES

public static final com.vladsch.flexmark.util.data.DataKey<Integer> MIN_SEPARATOR_DASHES

MAX_HEADER_ROWS

public static final com.vladsch.flexmark.util.data.DataKey<Integer> MAX_HEADER_ROWS

MIN_HEADER_ROWS

public static final com.vladsch.flexmark.util.data.DataKey<Integer> MIN_HEADER_ROWS

APPEND_MISSING_COLUMNS

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> APPEND_MISSING_COLUMNS

DISCARD_EXTRA_COLUMNS

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> DISCARD_EXTRA_COLUMNS

COLUMN_SPANS

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> COLUMN_SPANS

HEADER_SEPARATOR_COLUMN_MATCH

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> HEADER_SEPARATOR_COLUMN_MATCH

CLASS_NAME

public static final com.vladsch.flexmark.util.data.DataKey<String> CLASS_NAME

WITH_CAPTION

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> WITH_CAPTION

FORMAT_TABLE_TRIM_CELL_WHITESPACE

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> FORMAT_TABLE_TRIM_CELL_WHITESPACE

FORMAT_TABLE_LEAD_TRAIL_PIPES

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> FORMAT_TABLE_LEAD_TRAIL_PIPES

FORMAT_TABLE_SPACE_AROUND_PIPES

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> FORMAT_TABLE_SPACE_AROUND_PIPES

FORMAT_TABLE_ADJUST_COLUMN_WIDTH

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> FORMAT_TABLE_ADJUST_COLUMN_WIDTH

FORMAT_TABLE_APPLY_COLUMN_ALIGNMENT

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> FORMAT_TABLE_APPLY_COLUMN_ALIGNMENT

FORMAT_TABLE_FILL_MISSING_COLUMNS

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> FORMAT_TABLE_FILL_MISSING_COLUMNS

FORMAT_TABLE_FILL_MISSING_MIN_COLUMN

public static final com.vladsch.flexmark.util.data.NullableDataKey<Integer> FORMAT_TABLE_FILL_MISSING_MIN_COLUMN

FORMAT_TABLE_LEFT_ALIGN_MARKER

public static final com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.format.options.DiscretionaryText> FORMAT_TABLE_LEFT_ALIGN_MARKER

FORMAT_TABLE_MIN_SEPARATOR_COLUMN_WIDTH

public static final com.vladsch.flexmark.util.data.DataKey<Integer> FORMAT_TABLE_MIN_SEPARATOR_COLUMN_WIDTH

FORMAT_TABLE_MIN_SEPARATOR_DASHES

public static final com.vladsch.flexmark.util.data.DataKey<Integer> FORMAT_TABLE_MIN_SEPARATOR_DASHES

FORMAT_CHAR_WIDTH_PROVIDER

public static final com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.format.CharWidthProvider> FORMAT_CHAR_WIDTH_PROVIDER

FORMAT_TABLE_MANIPULATOR

public static final com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.format.TableManipulator> FORMAT_TABLE_MANIPULATOR

FORMAT_TABLE_CAPTION

public static final com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.format.options.TableCaptionHandling> FORMAT_TABLE_CAPTION

FORMAT_TABLE_CAPTION_SPACES

public static final com.vladsch.flexmark.util.data.DataKey<com.vladsch.flexmark.util.format.options.DiscretionaryText> FORMAT_TABLE_CAPTION_SPACES

FORMAT_TABLE_INDENT_PREFIX

public static final com.vladsch.flexmark.util.data.DataKey<String> FORMAT_TABLE_INDENT_PREFIX

Constructor Detail

TablesExtension

public TablesExtension()

Method Detail

create

public static TablesExtension create()

extend

public void extend(com.vladsch.flexmark.formatter.Formatter.Builder formatterBuilder)

Specified by:

extend in interface com.vladsch.flexmark.formatter.Formatter.FormatterExtension

rendererOptions

public void rendererOptions(@NotNull
                            @NotNull com.vladsch.flexmark.util.data.MutableDataHolder options)

Specified by:

rendererOptions in interface com.vladsch.flexmark.formatter.Formatter.FormatterExtension

Specified by:

rendererOptions in interface com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension

parserOptions

public void parserOptions(com.vladsch.flexmark.util.data.MutableDataHolder options)

Specified by:

parserOptions in interface com.vladsch.flexmark.parser.Parser.ParserExtension

extend

public void extend(com.vladsch.flexmark.parser.Parser.Builder parserBuilder)

Specified by:

extend in interface com.vladsch.flexmark.parser.Parser.ParserExtension

extend

public void extend(@NotNull
                   com.vladsch.flexmark.html.HtmlRenderer.Builder htmlRendererBuilder,
                   @NotNull
                   @NotNull String rendererType)

Specified by:

extend in interface com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension