com.vladsch.flexmark.ext.tables

Class TablesExtension

java.lang.Object

com.vladsch.flexmark.ext.tables.TablesExtension

All Implemented Interfaces:

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

public class TablesExtension
extends 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 (Parser.Builder.extensions(Iterable), HtmlRenderer.Builder.extensions(Iterable)).

The parsed tables are turned into TableBlock blocks.

Field Summary

Fields

Modifier and Type	Field and Description
static DataKey<Boolean>	APPEND_MISSING_COLUMNS
static DataKey<String>	CLASS_NAME
static DataKey<Boolean>	COLUMN_SPANS
static DataKey<Boolean>	DISCARD_EXTRA_COLUMNS
static DataKey<Boolean>	FORMAT_ADJUST_COLUMN_WIDTH
static DataKey<Boolean>	FORMAT_APPLY_COLUMN_ALIGNMENT
static DataKey<CharWidthProvider>	FORMAT_CHAR_WIDTH_PROVIDER
static DataKey<Boolean>	FORMAT_FILL_MISSING_COLUMNS
static DataKey<Boolean>	FORMAT_LEAD_TRAIL_PIPES
static DataKey<DiscretionaryText>	FORMAT_LEFT_ALIGN_MARKER
static DataKey<Integer>	FORMAT_MIN_SEPARATOR_COLUMN_WIDTH
static DataKey<Integer>	FORMAT_MIN_SEPARATOR_DASHES
static DataKey<Boolean>	FORMAT_REMOVE_CAPTION
static DataKey<Boolean>	FORMAT_SPACE_AROUND_PIPES
static DataKey<Boolean>	HEADER_SEPARATOR_COLUMN_MATCH
static DataKey<Integer>	MAX_HEADER_ROWS
static DataKey<Integer>	MIN_HEADER_ROWS
static DataKey<Integer>	MIN_SEPARATOR_DASHES
static DataKey<Boolean>	TRIM_CELL_WHITESPACE
static DataKey<Boolean>	WITH_CAPTION

Fields inherited from interface com.vladsch.flexmark.Extension

EMPTY_LIST, EMPTY_SET

Constructor Summary

Constructors

Constructor and Description
TablesExtension()

Method Summary

Modifier and Type	Method and Description
static Extension	create()
void	extend(Formatter.Builder builder)
void	extend(HtmlRenderer.Builder rendererBuilder, String rendererType)
void	extend(Parser.Builder parserBuilder)
void	parserOptions(MutableDataHolder options)
void	rendererOptions(MutableDataHolder options)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_HEADER_ROWS

public static final DataKey<Integer> MAX_HEADER_ROWS

MIN_HEADER_ROWS

public static final DataKey<Integer> MIN_HEADER_ROWS

MIN_SEPARATOR_DASHES

public static final DataKey<Integer> MIN_SEPARATOR_DASHES

APPEND_MISSING_COLUMNS

public static final DataKey<Boolean> APPEND_MISSING_COLUMNS

DISCARD_EXTRA_COLUMNS

public static final DataKey<Boolean> DISCARD_EXTRA_COLUMNS

TRIM_CELL_WHITESPACE

public static final DataKey<Boolean> TRIM_CELL_WHITESPACE

COLUMN_SPANS

public static final DataKey<Boolean> COLUMN_SPANS

HEADER_SEPARATOR_COLUMN_MATCH

public static final DataKey<Boolean> HEADER_SEPARATOR_COLUMN_MATCH

CLASS_NAME

public static final DataKey<String> CLASS_NAME

WITH_CAPTION

public static final DataKey<Boolean> WITH_CAPTION

FORMAT_LEAD_TRAIL_PIPES

public static final DataKey<Boolean> FORMAT_LEAD_TRAIL_PIPES

FORMAT_SPACE_AROUND_PIPES

public static final DataKey<Boolean> FORMAT_SPACE_AROUND_PIPES

FORMAT_ADJUST_COLUMN_WIDTH

public static final DataKey<Boolean> FORMAT_ADJUST_COLUMN_WIDTH

FORMAT_APPLY_COLUMN_ALIGNMENT

public static final DataKey<Boolean> FORMAT_APPLY_COLUMN_ALIGNMENT

FORMAT_FILL_MISSING_COLUMNS

public static final DataKey<Boolean> FORMAT_FILL_MISSING_COLUMNS

FORMAT_REMOVE_CAPTION

public static final DataKey<Boolean> FORMAT_REMOVE_CAPTION

FORMAT_LEFT_ALIGN_MARKER

public static final DataKey<DiscretionaryText> FORMAT_LEFT_ALIGN_MARKER

FORMAT_MIN_SEPARATOR_COLUMN_WIDTH

public static final DataKey<Integer> FORMAT_MIN_SEPARATOR_COLUMN_WIDTH

FORMAT_MIN_SEPARATOR_DASHES

public static final DataKey<Integer> FORMAT_MIN_SEPARATOR_DASHES

FORMAT_CHAR_WIDTH_PROVIDER

public static final DataKey<CharWidthProvider> FORMAT_CHAR_WIDTH_PROVIDER

Constructor Detail

TablesExtension

public TablesExtension()

Method Detail

create

public static Extension create()

extend

public void extend(Formatter.Builder builder)

Specified by:

extend in interface Formatter.FormatterExtension

rendererOptions

public void rendererOptions(MutableDataHolder options)

Specified by:

rendererOptions in interface Formatter.FormatterExtension

Specified by:

rendererOptions in interface HtmlRenderer.HtmlRendererExtension

parserOptions

public void parserOptions(MutableDataHolder options)

Specified by:

parserOptions in interface Parser.ParserExtension

extend

public void extend(Parser.Builder parserBuilder)

Specified by:

extend in interface Parser.ParserExtension

extend

public void extend(HtmlRenderer.Builder rendererBuilder,
                   String rendererType)

Specified by:

extend in interface HtmlRenderer.HtmlRendererExtension