Top Description Fields Constructors Methods
com.vladsch.flexmark.ext.tables

public Class TablesExtension

extends Object
implements ParserExtension, HtmlRendererExtension, FormatterExtension
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.formatter.Formatter.FormatterExtension, com.vladsch.flexmark.util.misc.Extension, com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension, com.vladsch.flexmark.parser.Parser.ParserExtension
Annotations
@SuppressWarnings:WeakerAccess
Imports
com.vladsch.flexmark.ext.tables.internal.TableJiraRenderer, .TableNodeFormatter, .TableNodeRenderer, .TableParagraphPreProcessor, com.vladsch.flexmark.formatter.Formatter, com.vladsch.flexmark.html.HtmlRenderer, com.vladsch.flexmark.parser.Parser, com.vladsch.flexmark.util.data.DataKey, .MutableDataHolder, .NullableDataKey, com.vladsch.flexmark.util.format.CharWidthProvider, .TableFormatOptions, .TableManipulator, com.vladsch.flexmark.util.format.options.DiscretionaryText, .TableCaptionHandling, org.jetbrains.annotations.NotNull
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

Modifier and TypeField and Description
public static final DataKey<Boolean>
APPEND_MISSING_COLUMNS

public static final DataKey<String>
CLASS_NAME

public static final DataKey<Boolean>
COLUMN_SPANS

public static final DataKey<Boolean>
DISCARD_EXTRA_COLUMNS

public static final DataKey<CharWidthProvider>
FORMAT_CHAR_WIDTH_PROVIDER

public static final DataKey<Boolean>
FORMAT_TABLE_ADJUST_COLUMN_WIDTH

public static final DataKey<Boolean>
FORMAT_TABLE_APPLY_COLUMN_ALIGNMENT

public static final DataKey<TableCaptionHandling>
FORMAT_TABLE_CAPTION

public static final DataKey<DiscretionaryText>
FORMAT_TABLE_CAPTION_SPACES

public static final DataKey<Boolean>
FORMAT_TABLE_FILL_MISSING_COLUMNS

public static final NullableDataKey<Integer>
FORMAT_TABLE_FILL_MISSING_MIN_COLUMN

public static final DataKey<String>
FORMAT_TABLE_INDENT_PREFIX

public static final DataKey<Boolean>
FORMAT_TABLE_LEAD_TRAIL_PIPES

public static final DataKey<DiscretionaryText>
FORMAT_TABLE_LEFT_ALIGN_MARKER

public static final DataKey<TableManipulator>
FORMAT_TABLE_MANIPULATOR

public static final DataKey<Integer>
FORMAT_TABLE_MIN_SEPARATOR_COLUMN_WIDTH

public static final DataKey<Integer>
FORMAT_TABLE_MIN_SEPARATOR_DASHES

public static final DataKey<Boolean>
FORMAT_TABLE_SPACE_AROUND_PIPES

public static final DataKey<Boolean>
FORMAT_TABLE_TRIM_CELL_WHITESPACE

public static final DataKey<Boolean>
HEADER_SEPARATOR_COLUMN_MATCH

public static final DataKey<Integer>
MAX_HEADER_ROWS

public static final DataKey<Integer>
MIN_HEADER_ROWS

public static final DataKey<Integer>
MIN_SEPARATOR_DASHES

public static final DataKey<Boolean>
TRIM_CELL_WHITESPACE

public static final DataKey<Boolean>
WITH_CAPTION

Constructor Summary

AccessConstructor and Description
public
TablesExtension()

Method Summary

Modifier and TypeMethod and Description
public static TablesExtension
create()

public void
extend(Formatter.Builder formatterBuilder)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.extend.

public void
extend(Parser.Builder
parser builder with which to register extensions
parserBuilder)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.extend.

This method is called on all extensions so that they can register their custom processors

public void
extend(HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)

public void
parserOptions(MutableDataHolder
option set that will be used for the builder
options)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.parserOptions.

This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

public void
rendererOptions(@NotNull MutableDataHolder
option set that will be used for the builder
options)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.rendererOptions.

This method is called first on all extensions so that they can adjust the options.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

APPEND_MISSING_COLUMNSback to summary
public static final DataKey<Boolean> APPEND_MISSING_COLUMNS
CLASS_NAMEback to summary
public static final DataKey<String> CLASS_NAME
COLUMN_SPANSback to summary
public static final DataKey<Boolean> COLUMN_SPANS
DISCARD_EXTRA_COLUMNSback to summary
public static final DataKey<Boolean> DISCARD_EXTRA_COLUMNS
FORMAT_CHAR_WIDTH_PROVIDERback to summary
public static final DataKey<CharWidthProvider> FORMAT_CHAR_WIDTH_PROVIDER
FORMAT_TABLE_ADJUST_COLUMN_WIDTHback to summary
public static final DataKey<Boolean> FORMAT_TABLE_ADJUST_COLUMN_WIDTH
FORMAT_TABLE_APPLY_COLUMN_ALIGNMENTback to summary
public static final DataKey<Boolean> FORMAT_TABLE_APPLY_COLUMN_ALIGNMENT
FORMAT_TABLE_CAPTIONback to summary
public static final DataKey<TableCaptionHandling> FORMAT_TABLE_CAPTION
FORMAT_TABLE_CAPTION_SPACESback to summary
public static final DataKey<DiscretionaryText> FORMAT_TABLE_CAPTION_SPACES
FORMAT_TABLE_FILL_MISSING_COLUMNSback to summary
public static final DataKey<Boolean> FORMAT_TABLE_FILL_MISSING_COLUMNS
FORMAT_TABLE_FILL_MISSING_MIN_COLUMNback to summary
public static final NullableDataKey<Integer> FORMAT_TABLE_FILL_MISSING_MIN_COLUMN
FORMAT_TABLE_INDENT_PREFIXback to summary
public static final DataKey<String> FORMAT_TABLE_INDENT_PREFIX
FORMAT_TABLE_LEAD_TRAIL_PIPESback to summary
public static final DataKey<Boolean> FORMAT_TABLE_LEAD_TRAIL_PIPES
FORMAT_TABLE_LEFT_ALIGN_MARKERback to summary
public static final DataKey<DiscretionaryText> FORMAT_TABLE_LEFT_ALIGN_MARKER
FORMAT_TABLE_MANIPULATORback to summary
public static final DataKey<TableManipulator> FORMAT_TABLE_MANIPULATOR
FORMAT_TABLE_MIN_SEPARATOR_COLUMN_WIDTHback to summary
public static final DataKey<Integer> FORMAT_TABLE_MIN_SEPARATOR_COLUMN_WIDTH
FORMAT_TABLE_MIN_SEPARATOR_DASHESback to summary
public static final DataKey<Integer> FORMAT_TABLE_MIN_SEPARATOR_DASHES
FORMAT_TABLE_SPACE_AROUND_PIPESback to summary
public static final DataKey<Boolean> FORMAT_TABLE_SPACE_AROUND_PIPES
FORMAT_TABLE_TRIM_CELL_WHITESPACEback to summary
public static final DataKey<Boolean> FORMAT_TABLE_TRIM_CELL_WHITESPACE
HEADER_SEPARATOR_COLUMN_MATCHback to summary
public static final DataKey<Boolean> HEADER_SEPARATOR_COLUMN_MATCH
MAX_HEADER_ROWSback to summary
public static final DataKey<Integer> MAX_HEADER_ROWS
MIN_HEADER_ROWSback to summary
public static final DataKey<Integer> MIN_HEADER_ROWS
MIN_SEPARATOR_DASHESback to summary
public static final DataKey<Integer> MIN_SEPARATOR_DASHES
TRIM_CELL_WHITESPACEback to summary
public static final DataKey<Boolean> TRIM_CELL_WHITESPACE
WITH_CAPTIONback to summary
public static final DataKey<Boolean> WITH_CAPTION

Constructor Detail

TablesExtensionback to summary
public TablesExtension()

Method Detail

createback to summary
public static TablesExtension create()
extendback to summary
public void extend(Formatter.Builder formatterBuilder)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.extend.

Annotations
@Override
extendback to summary
public void extend(Parser.Builder parserBuilder)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.extend.

Doc from com.vladsch.flexmark.parser.Parser.ParserExtension.extend.

This method is called on all extensions so that they can register their custom processors

Parameters
parserBuilder:Parser.Builder

parser builder with which to register extensions

Annotations
@Override
extendback to summary
public void extend(HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)
Annotations
@Override
parserOptionsback to summary
public void parserOptions(MutableDataHolder options)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.parserOptions.

Doc from com.vladsch.flexmark.parser.Parser.ParserExtension.parserOptions.

This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

Parameters
options:MutableDataHolder

option set that will be used for the builder

Annotations
@Override
rendererOptionsback to summary
public void rendererOptions(@NotNull MutableDataHolder options)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.rendererOptions.

Doc from com.vladsch.flexmark.formatter.Formatter.FormatterExtension.rendererOptions.

This method is called first on all extensions so that they can adjust the options.

Parameters
options:@NotNull MutableDataHolder

option set that will be used for the builder

Annotations
@Override