Package com.vladsch.flexmark.ext.footnotes

Class FootnoteBlock

  • All Implemented Interfaces:
    com.vladsch.flexmark.ast.ParagraphItemContainer, com.vladsch.flexmark.util.ast.Content, com.vladsch.flexmark.util.ast.ReferenceNode<com.vladsch.flexmark.ext.footnotes.internal.FootnoteRepository,​FootnoteBlock,​Footnote>, Comparable<FootnoteBlock>
    public class FootnoteBlock
extends com.vladsch.flexmark.util.ast.Block
implements com.vladsch.flexmark.util.ast.ReferenceNode<com.vladsch.flexmark.ext.footnotes.internal.FootnoteRepository,​FootnoteBlock,​Footnote>, com.vladsch.flexmark.ast.ParagraphItemContainer
    A Footnote definition node containing text and other inline nodes nodes as children.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected com.vladsch.flexmark.util.sequence.BasedSequence closingMarker  
      protected com.vladsch.flexmark.util.sequence.BasedSequence footnote  
      protected com.vladsch.flexmark.util.sequence.BasedSequence openingMarker  
      protected com.vladsch.flexmark.util.sequence.BasedSequence text  

      • Fields inherited from class com.vladsch.flexmark.util.ast.ContentNode

        lineSegments

      • Fields inherited from class com.vladsch.flexmark.util.ast.Node

        AST_ADAPTER, EMPTY_SEGMENTS, SPLICE

    • Constructor Summary

      Constructors 
      Constructor Description
      FootnoteBlock()  
      FootnoteBlock​(com.vladsch.flexmark.util.sequence.BasedSequence chars)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addFirstReferenceOffset​(int firstReferenceOffset)  
      int compareTo​(FootnoteBlock other)  
      void getAstExtra​(@NotNull StringBuilder out)  
      com.vladsch.flexmark.util.sequence.BasedSequence getClosingMarker()  
      int getFirstReferenceOffset()  
      com.vladsch.flexmark.util.sequence.BasedSequence getFootnote()  
      int getFootnoteOrdinal()  
      int getFootnoteReferences()  
      com.vladsch.flexmark.util.sequence.BasedSequence getOpeningMarker()  
      @Nullable Footnote getReferencingNode​(@NotNull com.vladsch.flexmark.util.ast.Node node)  
      @NotNull com.vladsch.flexmark.util.sequence.BasedSequence[] getSegments()  
      com.vladsch.flexmark.util.sequence.BasedSequence getText()  
      boolean isItemParagraph​(com.vladsch.flexmark.ast.Paragraph node)  
      boolean isParagraphInTightListItem​(com.vladsch.flexmark.ast.Paragraph node)  
      boolean isParagraphWrappingDisabled​(com.vladsch.flexmark.ast.Paragraph node, com.vladsch.flexmark.parser.ListOptions listOptions, com.vladsch.flexmark.util.data.DataHolder options)  
      boolean isReferenced()  
      void setClosingMarker​(com.vladsch.flexmark.util.sequence.BasedSequence closingMarker)  
      void setFirstReferenceOffset​(int firstReferenceOffset)  
      void setFootnote​(com.vladsch.flexmark.util.sequence.BasedSequence footnote)  
      void setFootnoteOrdinal​(int footnoteOrdinal)  
      void setFootnoteReferences​(int footnoteReferences)  
      void setOpeningMarker​(com.vladsch.flexmark.util.sequence.BasedSequence openingMarker)  
      void setText​(com.vladsch.flexmark.util.sequence.BasedSequence text)  

      • Methods inherited from class com.vladsch.flexmark.util.ast.Block

        getParent, setParent

      • Methods inherited from class com.vladsch.flexmark.util.ast.ContentNode

        getContentChars, getContentChars, getContentLines, getContentLines, getLineChars, getLineCount, getSpanningChars, setContent, setContent, setContent, setContentLine, setContentLines

      • Methods inherited from class com.vladsch.flexmark.util.ast.Node

        appendChain, appendChild, astChars, astExtraChars, astString, baseSubSequence, baseSubSequence, countAncestorsOfType, countDirectAncestorsOfType, delimitedSegmentSpan, delimitedSegmentSpanChars, endOfLine, extractChainTo, extractToFirstInChain, getAncestorOfType, getBaseSequence, getBlankLineSibling, getChars, getCharsFromSegments, getChildChars, getChildIterator, getChildOfType, getChildren, getDescendants, getDocument, getEmptyPrefix, getEmptySuffix, getEndLineNumber, getEndOffset, getEndOfLine, getExactChildChars, getFirstChild, getFirstChildAny, getFirstChildAnyNot, getFirstInChain, getGrandParent, getLastBlankLineChild, getLastChild, getLastChildAny, getLastChildAnyNot, getLastInChain, getLeadSegment, getLineColumnAtEnd, getLineNumber, getNext, getNextAny, getNextAnyNot, getNodeName, getNodeOfTypeIndex, getNodeOfTypeIndex, getOldestAncestorOfTypeAfter, getPrevious, getPreviousAny, getPreviousAnyNot, getReversedChildIterator, getReversedChildren, getReversedDescendants, getSegmentsForChars, getSourceRange, getStartLineNumber, getStartOffset, getStartOfLine, getTextLength, getTrailSegment, hasChildren, hasOrMoreChildren, insertAfter, insertBefore, insertChainAfter, insertChainBefore, isOrDescendantOfType, lineColumnAtIndex, lineColumnAtStart, moveTrailingBlankLines, prependChild, removeChildren, segmentSpan, segmentSpan, segmentSpanChars, segmentSpanChars, segmentSpanChars, segmentSpanCharsToVisible, setChars, setCharsFromContent, setCharsFromContentOnly, setCharsFromSegments, spanningChars, startOfLine, takeChildren, toAstString, toSegmentSpan, toString, toStringAttributes, unlink

    • Field Detail

      • openingMarker

        protected com.vladsch.flexmark.util.sequence.BasedSequence openingMarker

      • text

        protected com.vladsch.flexmark.util.sequence.BasedSequence text

      • closingMarker

        protected com.vladsch.flexmark.util.sequence.BasedSequence closingMarker

      • footnote

        protected com.vladsch.flexmark.util.sequence.BasedSequence footnote

    • Constructor Detail

      • FootnoteBlock

        public FootnoteBlock()

      • FootnoteBlock

        public FootnoteBlock​(com.vladsch.flexmark.util.sequence.BasedSequence chars)

    • Method Detail

      • getFootnoteReferences

        public int getFootnoteReferences()

      • setFootnoteReferences

        public void setFootnoteReferences​(int footnoteReferences)

      • getReferencingNode

        @Nullable
public @Nullable Footnote getReferencingNode​(@NotNull
                                             @NotNull com.vladsch.flexmark.util.ast.Node node)
        Specified by:
        getReferencingNode in interface com.vladsch.flexmark.util.ast.ReferenceNode<com.vladsch.flexmark.ext.footnotes.internal.FootnoteRepository,​FootnoteBlock,​Footnote>

      • getFirstReferenceOffset

        public int getFirstReferenceOffset()

      • setFirstReferenceOffset

        public void setFirstReferenceOffset​(int firstReferenceOffset)

      • addFirstReferenceOffset

        public void addFirstReferenceOffset​(int firstReferenceOffset)

      • isReferenced

        public boolean isReferenced()

      • getFootnoteOrdinal

        public int getFootnoteOrdinal()

      • setFootnoteOrdinal

        public void setFootnoteOrdinal​(int footnoteOrdinal)

      • getAstExtra

        public void getAstExtra​(@NotNull
                        @NotNull StringBuilder out)
        Overrides:
        getAstExtra in class com.vladsch.flexmark.util.ast.Node

      • getSegments

        @NotNull
public @NotNull com.vladsch.flexmark.util.sequence.BasedSequence[] getSegments()
        Specified by:
        getSegments in class com.vladsch.flexmark.util.ast.Node

      • getOpeningMarker

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

      • setOpeningMarker

        public void setOpeningMarker​(com.vladsch.flexmark.util.sequence.BasedSequence openingMarker)

      • getText

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

      • setText

        public void setText​(com.vladsch.flexmark.util.sequence.BasedSequence text)

      • getClosingMarker

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

      • setClosingMarker

        public void setClosingMarker​(com.vladsch.flexmark.util.sequence.BasedSequence closingMarker)

      • getFootnote

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

      • setFootnote

        public void setFootnote​(com.vladsch.flexmark.util.sequence.BasedSequence footnote)

      • isItemParagraph

        public boolean isItemParagraph​(com.vladsch.flexmark.ast.Paragraph node)
        Specified by:
        isItemParagraph in interface com.vladsch.flexmark.ast.ParagraphItemContainer

      • isParagraphWrappingDisabled

        public boolean isParagraphWrappingDisabled​(com.vladsch.flexmark.ast.Paragraph node,
                                           com.vladsch.flexmark.parser.ListOptions listOptions,
                                           com.vladsch.flexmark.util.data.DataHolder options)
        Specified by:
        isParagraphWrappingDisabled in interface com.vladsch.flexmark.ast.ParagraphItemContainer

      • isParagraphInTightListItem

        public boolean isParagraphInTightListItem​(com.vladsch.flexmark.ast.Paragraph node)
        Specified by:
        isParagraphInTightListItem in interface com.vladsch.flexmark.ast.ParagraphItemContainer