Package com.vladsch.flexmark.util.format

Class MarkdownTable

  • public class MarkdownTable
extends Object

    • Constructor Detail

      • MarkdownTable

        public MarkdownTable​(@NotNull
                     @NotNull CharSequence tableChars,
                     @Nullable
                     @Nullable com.vladsch.flexmark.util.data.DataHolder options)

    • Method Detail

      • getCaptionCell

        public TableCell getCaptionCell()

      • getFormatTableIndentPrefix

        public CharSequence getFormatTableIndentPrefix()

      • setFormatTableIndentPrefix

        public void setFormatTableIndentPrefix​(CharSequence formatTableIndentPrefix)

      • setCaptionCell

        public void setCaptionCell​(TableCell captionCell)

      • getCaption

        public com.vladsch.flexmark.util.sequence.BasedSequence getCaption()

      • setCaption

        public void setCaption​(CharSequence caption)

      • setCaptionWithMarkers

        public void setCaptionWithMarkers​(com.vladsch.flexmark.util.ast.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

        @NotNull
public @NotNull List<TrackedOffset> getTrackedOffsets()

      • getTrackedOffset

        @Nullable
public @Nullable TrackedOffset getTrackedOffset​(int offset)

      • getTrackedOffsetIndex

        public int getTrackedOffsetIndex​(int offset)

      • getTableStartOffset

        public int getTableStartOffset()

      • addTrackedOffset

        @Deprecated
public boolean addTrackedOffset​(int offset,
                                boolean afterSpace,
                                boolean afterDelete)
        Deprecated.
        Use addTrackedOffset(TrackedOffset) To create: TrackedOffset.track(offset, afterSpace, afterDelete)

      • addTrackedOffset

        public boolean addTrackedOffset​(@NotNull
                                @NotNull TrackedOffset trackedOffset)

      • 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​(int startIndex,
                       int count,
                       TableRowManipulator manipulator)

      • forAllContentRows

        public void forAllContentRows​(int startIndex,
                              TableRowManipulator manipulator)

      • forAllContentRows

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

      • forAllSectionRows

        public void forAllSectionRows​(int startIndex,
                              TableRowManipulator manipulator)

      • forAllSectionRows

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

      • forAllHeaderRows

        public void forAllHeaderRows​(int startIndex,
                             TableRowManipulator manipulator)

      • forAllHeaderRows

        public void forAllHeaderRows​(int startIndex,
                             int count,
                             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)

      • setHeader

        public void setHeader()

      • setSeparator

        public void setSeparator()

      • setBody

        public void setBody()

      • nextRow

        public void nextRow()

      • addCell

        public void addCell​(@NotNull
                    @NotNull 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)

      • transposed

        public MarkdownTable transposed​(int columnHeaders)
        Transpose table
        Parameters:
        columnHeaders - number of first columns to use as header rows, 0..maxColumns
        Returns:
        transposed table

      • sorted

        public MarkdownTable sorted​(ColumnSort[] columnSorts,
                            int textCollectionFlags,
                            @Nullable
                            @Nullable NumericSuffixPredicate numericSuffixTester)
        Sort table
        Parameters:
        columnSorts - column sort information
        textCollectionFlags - collection flags to use for collecting cell text
        numericSuffixTester - predicate to test non-numeric suffix of numeric column content, return true if suffix is acceptable, null will result in all suffixes being accepted
        Returns:
        sorted table

      • appendTable

        public void appendTable​(com.vladsch.flexmark.util.sequence.LineAppendable out)

      • appendFormattedCaption

        public static void appendFormattedCaption​(com.vladsch.flexmark.util.sequence.LineAppendable out,
                                          com.vladsch.flexmark.util.sequence.BasedSequence caption,
                                          TableFormatOptions options)

      • formattedCaption

        public static String formattedCaption​(com.vladsch.flexmark.util.sequence.BasedSequence caption,
                                      TableFormatOptions options)