com.vladsch.flexmark.util.format

Class MarkdownTable

java.lang.Object

com.vladsch.flexmark.util.format.MarkdownTable

public class MarkdownTable
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MarkdownTable.IndexSpanOffset

Field Summary

Fields

Modifier and Type	Field and Description
TableSection	body
TableSection	caption
TableSection	header
TableFormatOptions	options
TableSection	separator

Constructor Summary

Constructors

Constructor and Description
MarkdownTable(DataHolder options)
MarkdownTable(TableFormatOptions options)

Method Summary

Modifier and Type	Method and Description
void	addCell(TableCell cell)
boolean	addTrackedOffset(int offset)
boolean	addTrackedOffset(int offset, boolean afterSpace)
boolean	addTrackedOffset(int offset, boolean afterSpace, boolean afterDelete)
boolean	addTrackedOffset(int offset, Character c, boolean afterDelete)
static void	appendFormattedCaption(LineFormattingAppendable out, BasedSequence caption, TableFormatOptions options)
void	appendTable(LineFormattingAppendable out)
void	deleteColumns(int column, int count)
void	deleteRows(int rowIndex, int count)
void	fillMissingColumns()
void	fillMissingColumns(Integer minColumn)
void	finalizeTable()
void	forAllBodyRows(int startIndex, int count, TableRowManipulator manipulator)
void	forAllBodyRows(int startIndex, TableRowManipulator manipulator)
void	forAllBodyRows(TableRowManipulator manipulator)
void	forAllContentRows(int startIndex, int count, TableRowManipulator manipulator)
void	forAllContentRows(int startIndex, TableRowManipulator manipulator)
void	forAllContentRows(TableRowManipulator manipulator)
void	forAllHeaderRows(int startIndex, int count, TableRowManipulator manipulator)
void	forAllHeaderRows(int startIndex, TableRowManipulator manipulator)
void	forAllHeaderRows(TableRowManipulator manipulator)
void	forAllRows(int startIndex, int count, TableRowManipulator manipulator)
void	forAllRows(int startIndex, TableRowManipulator manipulator)
void	forAllRows(TableRowManipulator manipulator)
void	forAllSectionRows(int startIndex, int count, TableRowManipulator manipulator)
void	forAllSectionRows(int startIndex, TableRowManipulator manipulator)
void	forAllSectionRows(TableRowManipulator manipulator)
static String	formattedCaption(BasedSequence caption, TableFormatOptions options)
List<TableRow>	getAllContentRows()
int	getAllContentRowsCount()
List<TableRow>	getAllRows()
int	getAllRowsCount()
TableSection	getAllRowsSection(int index)
List<TableRow>	getAllSectionRows()
int	getAllSectionsRowsCount()
int	getBodyRowCount()
BasedSequence	getCaption()
TableCell	getCaptionCell()
int	getCaptionRowCount()
TableCellOffsetInfo	getCellOffsetInfo(int offset)
boolean	getHaveCaption()
boolean	getHeader()
int	getHeadingRowCount()
int	getMaxBodyColumns()
int	getMaxColumns()
int	getMaxColumnsWithoutColumns(boolean withSeparator, int... skipColumns)
int	getMaxColumnsWithoutRows(boolean withSeparator, int... skipRows)
int	getMaxHeadingColumns()
int	getMaxSeparatorColumns()
int	getMinColumns()
int	getMinColumnsWithoutColumns(boolean withSeparator, int... skipColumns)
int	getMinColumnsWithoutRows(boolean withSeparator, int... skipRows)
int	getSeparatorRowCount()
int	getTableStartOffset()
Map<Integer,Integer>	getTrackedOffsets()
void	insertColumns(int column, int count)
void	insertRows(int rowIndex, int count)
boolean	isAllRowsEmptyAt(int rowIndex) Test a row for having all empty columns
boolean	isAllRowsSeparator(int index)
boolean	isContentRowsEmptyAt(int rowIndex) Test a row for having all empty columns
boolean	isEmptyColumn(int column) Test all rows for having given column empty.
boolean	isSeparator()
void	moveColumn(int fromColumn, int toColumn)
void	nextRow()
void	normalize()
void	setCaption(CharSequence caption)
void	setCaptionCell(TableCell captionCell)
void	setCaptionWithMarkers(Node tableCellNode, CharSequence captionOpen, CharSequence caption, CharSequence captionClose)
void	setHeader(boolean header)
void	setSeparator(boolean separator)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

header

public final TableSection header

separator

public final TableSection separator

body

public final TableSection body

caption

public final TableSection caption

options

public TableFormatOptions options

Constructor Detail

MarkdownTable

public MarkdownTable(DataHolder options)

MarkdownTable

public MarkdownTable(TableFormatOptions options)

Method Detail

getCaptionCell

public TableCell getCaptionCell()

setCaptionCell

public void setCaptionCell(TableCell captionCell)

getCaption

public BasedSequence getCaption()

setCaption

public void setCaption(CharSequence caption)

setCaptionWithMarkers

public void setCaptionWithMarkers(Node tableCellNode,
                                  CharSequence captionOpen,
                                  CharSequence caption,
                                  CharSequence captionClose)

getHeadingRowCount

public int getHeadingRowCount()

getSeparatorRowCount

public int getSeparatorRowCount()

getBodyRowCount

public int getBodyRowCount()

getCaptionRowCount

public int getCaptionRowCount()

getMaxHeadingColumns

public int getMaxHeadingColumns()

getMaxSeparatorColumns

public int getMaxSeparatorColumns()

getMaxBodyColumns

public int getMaxBodyColumns()

getHaveCaption

public boolean getHaveCaption()

getMinColumns

public int getMinColumns()

getMaxColumns

public int getMaxColumns()

getMinColumnsWithoutColumns

public int getMinColumnsWithoutColumns(boolean withSeparator,
                                       int... skipColumns)

getMaxColumnsWithoutColumns

public int getMaxColumnsWithoutColumns(boolean withSeparator,
                                       int... skipColumns)

getMinColumnsWithoutRows

public int getMinColumnsWithoutRows(boolean withSeparator,
                                    int... skipRows)

getMaxColumnsWithoutRows

public int getMaxColumnsWithoutRows(boolean withSeparator,
                                    int... skipRows)

getTrackedOffsets

public Map<Integer,Integer> getTrackedOffsets()

getTableStartOffset

public int getTableStartOffset()

getCellOffsetInfo

public TableCellOffsetInfo getCellOffsetInfo(int offset)

addTrackedOffset

public boolean addTrackedOffset(int offset)

addTrackedOffset

public boolean addTrackedOffset(int offset,
                                boolean afterSpace)

addTrackedOffset

public boolean addTrackedOffset(int offset,
                                boolean afterSpace,
                                boolean afterDelete)

addTrackedOffset

public boolean addTrackedOffset(int offset,
                                Character c,
                                boolean afterDelete)

getAllRows

public List<TableRow> getAllRows()

getAllContentRows

public List<TableRow> getAllContentRows()

getAllSectionRows

public List<TableRow> getAllSectionRows()

isAllRowsSeparator

public boolean isAllRowsSeparator(int index)

getAllRowsSection

public TableSection getAllRowsSection(int index)

getAllRowsCount

public int getAllRowsCount()

getAllContentRowsCount

public int getAllContentRowsCount()

getAllSectionsRowsCount

public int getAllSectionsRowsCount()

forAllRows

public void forAllRows(TableRowManipulator manipulator)

forAllRows

public void forAllRows(int startIndex,
                       TableRowManipulator manipulator)

forAllRows

public void forAllRows(int startIndex,
                       int count,
                       TableRowManipulator manipulator)

forAllContentRows

public void forAllContentRows(TableRowManipulator manipulator)

forAllContentRows

public void forAllContentRows(int startIndex,
                              TableRowManipulator manipulator)

forAllContentRows

public void forAllContentRows(int startIndex,
                              int count,
                              TableRowManipulator manipulator)

forAllSectionRows

public void forAllSectionRows(TableRowManipulator manipulator)

forAllSectionRows

public void forAllSectionRows(int startIndex,
                              TableRowManipulator manipulator)

forAllSectionRows

public void forAllSectionRows(int startIndex,
                              int count,
                              TableRowManipulator manipulator)

forAllHeaderRows

public void forAllHeaderRows(TableRowManipulator manipulator)

forAllHeaderRows

public void forAllHeaderRows(int startIndex,
                             TableRowManipulator manipulator)

forAllHeaderRows

public void forAllHeaderRows(int startIndex,
                             int count,
                             TableRowManipulator manipulator)

forAllBodyRows

public void forAllBodyRows(TableRowManipulator manipulator)

forAllBodyRows

public void forAllBodyRows(int startIndex,
                           TableRowManipulator manipulator)

forAllBodyRows

public void forAllBodyRows(int startIndex,
                           int count,
                           TableRowManipulator manipulator)

deleteRows

public void deleteRows(int rowIndex,
                       int count)

insertRows

public void insertRows(int rowIndex,
                       int count)

insertColumns

public void insertColumns(int column,
                          int count)

deleteColumns

public void deleteColumns(int column,
                          int count)

moveColumn

public void moveColumn(int fromColumn,
                       int toColumn)

isEmptyColumn

public boolean isEmptyColumn(int column)

Test all rows for having given column empty. All columns after row's max column are empty

Parameters:

column - index in allRows list

Returns:

true if column is empty for all rows, separator row excluded

isAllRowsEmptyAt

public boolean isAllRowsEmptyAt(int rowIndex)

Test a row for having all empty columns

Parameters:

rowIndex - index in allRows list

Returns:

true if row is empty or is a separator row

isContentRowsEmptyAt

public boolean isContentRowsEmptyAt(int rowIndex)

Test a row for having all empty columns

Parameters:

rowIndex - index in allRows list

Returns:

true if row is empty or is a separator row

getHeader

public boolean getHeader()

setHeader

public void setHeader(boolean header)

isSeparator

public boolean isSeparator()

setSeparator

public void setSeparator(boolean separator)

nextRow

public void nextRow()

addCell

public void addCell(TableCell cell)

Parameters:

cell - cell to add

normalize

public void normalize()

finalizeTable

public void finalizeTable()

fillMissingColumns

public void fillMissingColumns()

fillMissingColumns

public void fillMissingColumns(Integer minColumn)

appendTable

public void appendTable(LineFormattingAppendable out)

appendFormattedCaption

public static void appendFormattedCaption(LineFormattingAppendable out,
                                          BasedSequence caption,
                                          TableFormatOptions options)

formattedCaption

public static String formattedCaption(BasedSequence caption,
                                      TableFormatOptions options)

toString

public String toString()

Overrides:

toString in class Object