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.builder.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.options.DataKey<Boolean>	ADJUST_COLUMN_WIDTH Deprecated. use FORMAT_TABLE_ prefixed name
static com.vladsch.flexmark.util.options.DataKey<Boolean>	APPEND_MISSING_COLUMNS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	APPLY_COLUMN_ALIGNMENT Deprecated. use FORMAT_TABLE_ prefixed name
static com.vladsch.flexmark.util.options.DataKey<com.vladsch.flexmark.util.mappers.CharWidthProvider>	CHAR_WIDTH_PROVIDER Deprecated. use FORMAT_TABLE_ prefixed name
static com.vladsch.flexmark.util.options.DataKey<String>	CLASS_NAME
static com.vladsch.flexmark.util.options.DataKey<Boolean>	COLUMN_SPANS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	DISCARD_EXTRA_COLUMNS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	FILL_MISSING_COLUMNS Deprecated. use FORMAT_TABLE_ prefixed name
static com.vladsch.flexmark.util.options.DataKey<Boolean>	FORMAT_ADJUST_COLUMN_WIDTH Deprecated. use FORMAT_TABLE_ prefixed name
static com.vladsch.flexmark.util.options.DataKey<Boolean>	FORMAT_APPLY_COLUMN_ALIGNMENT Deprecated. use FORMAT_TABLE_ prefixed name
static com.vladsch.flexmark.util.options.DataKey<com.vladsch.flexmark.util.mappers.CharWidthProvider>	FORMAT_CHAR_WIDTH_PROVIDER
static com.vladsch.flexmark.util.options.DataKey<Boolean>	FORMAT_FILL_MISSING_COLUMNS Deprecated. use FORMAT_TABLE_ prefixed name
static com.vladsch.flexmark.util.options.DataKey<Boolean>	FORMAT_LEAD_TRAIL_PIPES Deprecated. use FORMAT_TABLE_ prefixed name
static com.vladsch.flexmark.util.options.DataKey<com.vladsch.flexmark.util.format.options.DiscretionaryText>	FORMAT_LEFT_ALIGN_MARKER Deprecated. use FORMAT_TABLE_ prefixed name
static com.vladsch.flexmark.util.options.DataKey<Integer>	FORMAT_MIN_SEPARATOR_COLUMN_WIDTH Deprecated. use FORMAT_TABLE_ prefixed name
static com.vladsch.flexmark.util.options.DataKey<Integer>	FORMAT_MIN_SEPARATOR_DASHES Deprecated. use FORMAT_TABLE_ prefixed name
static com.vladsch.flexmark.util.options.DataKey<Boolean>	FORMAT_REMOVE_CAPTION Deprecated. use FORMAT_TABLE_ prefixed name
static com.vladsch.flexmark.util.options.DataKey<Boolean>	FORMAT_SPACE_AROUND_PIPES Deprecated. use FORMAT_TABLE_ prefixed name
static com.vladsch.flexmark.util.options.DataKey<Boolean>	FORMAT_TABLE_ADJUST_COLUMN_WIDTH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	FORMAT_TABLE_APPLY_COLUMN_ALIGNMENT
static com.vladsch.flexmark.util.options.DataKey<com.vladsch.flexmark.util.format.options.TableCaptionHandling>	FORMAT_TABLE_CAPTION
static com.vladsch.flexmark.util.options.DataKey<com.vladsch.flexmark.util.format.options.DiscretionaryText>	FORMAT_TABLE_CAPTION_SPACES
static com.vladsch.flexmark.util.options.DataKey<Boolean>	FORMAT_TABLE_FILL_MISSING_COLUMNS
static com.vladsch.flexmark.util.options.DataKey<String>	FORMAT_TABLE_INDENT_PREFIX
static com.vladsch.flexmark.util.options.DataKey<Boolean>	FORMAT_TABLE_LEAD_TRAIL_PIPES
static com.vladsch.flexmark.util.options.DataKey<com.vladsch.flexmark.util.format.options.DiscretionaryText>	FORMAT_TABLE_LEFT_ALIGN_MARKER
static com.vladsch.flexmark.util.options.DataKey<com.vladsch.flexmark.util.format.TableManipulator>	FORMAT_TABLE_MANIPULATOR
static com.vladsch.flexmark.util.options.DataKey<Integer>	FORMAT_TABLE_MIN_SEPARATOR_COLUMN_WIDTH
static com.vladsch.flexmark.util.options.DataKey<Integer>	FORMAT_TABLE_MIN_SEPARATOR_DASHES
static com.vladsch.flexmark.util.options.DataKey<Boolean>	FORMAT_TABLE_SPACE_AROUND_PIPES
static com.vladsch.flexmark.util.options.DataKey<Boolean>	FORMAT_TABLE_TRIM_CELL_WHITESPACE
static com.vladsch.flexmark.util.options.DataKey<Boolean>	HEADER_SEPARATOR_COLUMN_MATCH
static com.vladsch.flexmark.util.options.DataKey<Boolean>	LEAD_TRAIL_PIPES Deprecated. use FORMAT_TABLE_ prefixed name
static com.vladsch.flexmark.util.options.DataKey<com.vladsch.flexmark.util.format.options.DiscretionaryText>	LEFT_ALIGN_MARKER Deprecated. use FORMAT_TABLE_ prefixed name
static com.vladsch.flexmark.util.options.DataKey<Integer>	MAX_HEADER_ROWS
static com.vladsch.flexmark.util.options.DataKey<Integer>	MIN_HEADER_ROWS
static com.vladsch.flexmark.util.options.DataKey<Integer>	MIN_SEPARATOR_COLUMN_WIDTH Deprecated. use FORMAT_TABLE_ prefixed name
static com.vladsch.flexmark.util.options.DataKey<Integer>	MIN_SEPARATOR_DASHES
static com.vladsch.flexmark.util.options.DataKey<Boolean>	MULTI_LINE_ROWS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	REMOVE_CAPTION Deprecated. use FORMAT_TABLE_CAPTION with enum value, this option only has effect FORMAT_TABLE_CAPTION is set to AS_IS
static com.vladsch.flexmark.util.options.DataKey<Boolean>	SPACE_AROUND_PIPES Deprecated. use FORMAT_TABLE_ prefixed name
static com.vladsch.flexmark.util.options.DataKey<Boolean>	TRIM_CELL_WHITESPACE
static com.vladsch.flexmark.util.options.DataKey<Boolean>	WITH_CAPTION

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

EMPTY_LIST, EMPTY_SET

Constructor Summary

Constructors

Constructor and Description
TablesExtension()

Method Summary

Modifier and Type	Method and Description
static com.vladsch.flexmark.util.builder.Extension	create()
void	extend(com.vladsch.flexmark.formatter.Formatter.Builder builder)
void	extend(com.vladsch.flexmark.html.HtmlRenderer.Builder rendererBuilder, String rendererType)
void	extend(com.vladsch.flexmark.parser.Parser.Builder parserBuilder)
void	parserOptions(com.vladsch.flexmark.util.options.MutableDataHolder options)
void	rendererOptions(com.vladsch.flexmark.util.options.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.options.DataKey<Boolean> TRIM_CELL_WHITESPACE

MIN_SEPARATOR_DASHES

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

MAX_HEADER_ROWS

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

MIN_HEADER_ROWS

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

APPEND_MISSING_COLUMNS

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

DISCARD_EXTRA_COLUMNS

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

COLUMN_SPANS

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

HEADER_SEPARATOR_COLUMN_MATCH

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

CLASS_NAME

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

WITH_CAPTION

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

MULTI_LINE_ROWS

public static final com.vladsch.flexmark.util.options.DataKey<Boolean> MULTI_LINE_ROWS

FORMAT_TABLE_TRIM_CELL_WHITESPACE

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

FORMAT_TABLE_LEAD_TRAIL_PIPES

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

FORMAT_TABLE_SPACE_AROUND_PIPES

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

FORMAT_TABLE_ADJUST_COLUMN_WIDTH

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

FORMAT_TABLE_APPLY_COLUMN_ALIGNMENT

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

FORMAT_TABLE_FILL_MISSING_COLUMNS

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

FORMAT_TABLE_LEFT_ALIGN_MARKER

public static final com.vladsch.flexmark.util.options.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.options.DataKey<Integer> FORMAT_TABLE_MIN_SEPARATOR_COLUMN_WIDTH

FORMAT_TABLE_MIN_SEPARATOR_DASHES

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

FORMAT_CHAR_WIDTH_PROVIDER

public static final com.vladsch.flexmark.util.options.DataKey<com.vladsch.flexmark.util.mappers.CharWidthProvider> FORMAT_CHAR_WIDTH_PROVIDER

FORMAT_TABLE_MANIPULATOR

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

FORMAT_TABLE_CAPTION

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

FORMAT_TABLE_CAPTION_SPACES

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

FORMAT_TABLE_INDENT_PREFIX

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

FORMAT_LEAD_TRAIL_PIPES

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<Boolean> FORMAT_LEAD_TRAIL_PIPES

Deprecated. use FORMAT_TABLE_ prefixed name

FORMAT_SPACE_AROUND_PIPES

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<Boolean> FORMAT_SPACE_AROUND_PIPES

Deprecated. use FORMAT_TABLE_ prefixed name

FORMAT_ADJUST_COLUMN_WIDTH

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<Boolean> FORMAT_ADJUST_COLUMN_WIDTH

Deprecated. use FORMAT_TABLE_ prefixed name

FORMAT_APPLY_COLUMN_ALIGNMENT

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<Boolean> FORMAT_APPLY_COLUMN_ALIGNMENT

Deprecated. use FORMAT_TABLE_ prefixed name

FORMAT_FILL_MISSING_COLUMNS

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<Boolean> FORMAT_FILL_MISSING_COLUMNS

Deprecated. use FORMAT_TABLE_ prefixed name

FORMAT_REMOVE_CAPTION

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<Boolean> FORMAT_REMOVE_CAPTION

Deprecated. use FORMAT_TABLE_ prefixed name

FORMAT_LEFT_ALIGN_MARKER

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<com.vladsch.flexmark.util.format.options.DiscretionaryText> FORMAT_LEFT_ALIGN_MARKER

Deprecated. use FORMAT_TABLE_ prefixed name

FORMAT_MIN_SEPARATOR_COLUMN_WIDTH

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<Integer> FORMAT_MIN_SEPARATOR_COLUMN_WIDTH

Deprecated. use FORMAT_TABLE_ prefixed name

FORMAT_MIN_SEPARATOR_DASHES

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<Integer> FORMAT_MIN_SEPARATOR_DASHES

Deprecated. use FORMAT_TABLE_ prefixed name

REMOVE_CAPTION

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<Boolean> REMOVE_CAPTION

Deprecated. use FORMAT_TABLE_CAPTION with enum value, this option only has effect FORMAT_TABLE_CAPTION is set to AS_IS

LEAD_TRAIL_PIPES

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<Boolean> LEAD_TRAIL_PIPES

Deprecated. use FORMAT_TABLE_ prefixed name

SPACE_AROUND_PIPES

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<Boolean> SPACE_AROUND_PIPES

Deprecated. use FORMAT_TABLE_ prefixed name

ADJUST_COLUMN_WIDTH

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<Boolean> ADJUST_COLUMN_WIDTH

Deprecated. use FORMAT_TABLE_ prefixed name

APPLY_COLUMN_ALIGNMENT

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<Boolean> APPLY_COLUMN_ALIGNMENT

Deprecated. use FORMAT_TABLE_ prefixed name

FILL_MISSING_COLUMNS

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<Boolean> FILL_MISSING_COLUMNS

Deprecated. use FORMAT_TABLE_ prefixed name

LEFT_ALIGN_MARKER

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<com.vladsch.flexmark.util.format.options.DiscretionaryText> LEFT_ALIGN_MARKER

Deprecated. use FORMAT_TABLE_ prefixed name

MIN_SEPARATOR_COLUMN_WIDTH

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<Integer> MIN_SEPARATOR_COLUMN_WIDTH

Deprecated. use FORMAT_TABLE_ prefixed name

CHAR_WIDTH_PROVIDER

@Deprecated
public static final com.vladsch.flexmark.util.options.DataKey<com.vladsch.flexmark.util.mappers.CharWidthProvider> CHAR_WIDTH_PROVIDER

Deprecated. use FORMAT_TABLE_ prefixed name

Constructor Detail

TablesExtension

public TablesExtension()

Method Detail

create

public static com.vladsch.flexmark.util.builder.Extension create()

extend

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

Specified by:

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

rendererOptions

public void rendererOptions(com.vladsch.flexmark.util.options.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.options.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(com.vladsch.flexmark.html.HtmlRenderer.Builder rendererBuilder,
                   String rendererType)

Specified by:

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