Class FootnoteBlock
- java.lang.Object
-
- com.vladsch.flexmark.util.ast.Node
-
- com.vladsch.flexmark.util.ast.ContentNode
-
- com.vladsch.flexmark.util.ast.Block
-
- com.vladsch.flexmark.ext.footnotes.FootnoteBlock
-
- All Implemented Interfaces:
ParagraphItemContainer
,Content
,ReferenceNode<FootnoteRepository,FootnoteBlock,Footnote>
,java.lang.Comparable<FootnoteBlock>
public class FootnoteBlock extends Block implements ReferenceNode<FootnoteRepository,FootnoteBlock,Footnote>, ParagraphItemContainer
A Footnote definition node containing text and other inline nodes nodes as children.
-
-
Field Summary
Fields Modifier and Type Field Description protected BasedSequence
closingMarker
protected BasedSequence
footnote
protected BasedSequence
openingMarker
protected 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(BasedSequence chars)
-
Method Summary
-
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 BasedSequence openingMarker
-
text
protected BasedSequence text
-
closingMarker
protected BasedSequence closingMarker
-
footnote
protected BasedSequence footnote
-
-
Constructor Detail
-
FootnoteBlock
public FootnoteBlock()
-
FootnoteBlock
public FootnoteBlock(BasedSequence chars)
-
-
Method Detail
-
compareTo
public int compareTo(FootnoteBlock other)
- Specified by:
compareTo
in interfacejava.lang.Comparable<FootnoteBlock>
-
getFootnoteReferences
public int getFootnoteReferences()
-
setFootnoteReferences
public void setFootnoteReferences(int footnoteReferences)
-
getReferencingNode
@Nullable public Footnote getReferencingNode(@NotNull Node node)
- Specified by:
getReferencingNode
in interfaceReferenceNode<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 java.lang.StringBuilder out)
- Overrides:
getAstExtra
in classNode
-
getSegments
@NotNull public BasedSequence[] getSegments()
- Specified by:
getSegments
in classNode
-
getOpeningMarker
public BasedSequence getOpeningMarker()
-
setOpeningMarker
public void setOpeningMarker(BasedSequence openingMarker)
-
getText
public BasedSequence getText()
-
setText
public void setText(BasedSequence text)
-
getClosingMarker
public BasedSequence getClosingMarker()
-
setClosingMarker
public void setClosingMarker(BasedSequence closingMarker)
-
getFootnote
public BasedSequence getFootnote()
-
setFootnote
public void setFootnote(BasedSequence footnote)
-
isItemParagraph
public boolean isItemParagraph(Paragraph node)
- Specified by:
isItemParagraph
in interfaceParagraphItemContainer
-
isParagraphWrappingDisabled
public boolean isParagraphWrappingDisabled(Paragraph node, ListOptions listOptions, DataHolder options)
- Specified by:
isParagraphWrappingDisabled
in interfaceParagraphItemContainer
-
isParagraphInTightListItem
public boolean isParagraphInTightListItem(Paragraph node)
- Specified by:
isParagraphInTightListItem
in interfaceParagraphItemContainer
-
-