Package com.vladsch.flexmark.ext.footnotes

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
private int	firstReferenceOffset
protected BasedSequence	footnote
private int	footnoteOrdinal
private int	footnoteReferences
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

Modifier and Type	Method	Description
void	addFirstReferenceOffset(int firstReferenceOffset)
int	compareTo(FootnoteBlock other)
void	getAstExtra(@NotNull java.lang.StringBuilder out)
BasedSequence	getClosingMarker()
int	getFirstReferenceOffset()
BasedSequence	getFootnote()
int	getFootnoteOrdinal()
int	getFootnoteReferences()
BasedSequence	getOpeningMarker()
@Nullable Footnote	getReferencingNode(@NotNull Node node)
@NotNull BasedSequence[]	getSegments()
BasedSequence	getText()
boolean	isItemParagraph(Paragraph node)
boolean	isParagraphInTightListItem(Paragraph node)
boolean	isParagraphWrappingDisabled(Paragraph node, ListOptions listOptions, DataHolder options)
boolean	isReferenced()
void	setClosingMarker(BasedSequence closingMarker)
void	setFirstReferenceOffset(int firstReferenceOffset)
void	setFootnote(BasedSequence footnote)
void	setFootnoteOrdinal(int footnoteOrdinal)
void	setFootnoteReferences(int footnoteReferences)
void	setOpeningMarker(BasedSequence openingMarker)
void	setText(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

Methods inherited from class java.lang.Object

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

Field Detail

openingMarker

protected BasedSequence openingMarker

text

protected BasedSequence text

closingMarker

protected BasedSequence closingMarker

footnote

protected BasedSequence footnote

footnoteOrdinal

private int footnoteOrdinal

firstReferenceOffset

private int firstReferenceOffset

footnoteReferences

private int footnoteReferences

Constructor Detail

FootnoteBlock

public FootnoteBlock()

FootnoteBlock

public FootnoteBlock(BasedSequence chars)

Method Detail

compareTo

public int compareTo(FootnoteBlock other)

Specified by:

compareTo in interface java.lang.Comparable<FootnoteBlock>

getFootnoteReferences

public int getFootnoteReferences()

setFootnoteReferences

public void setFootnoteReferences(int footnoteReferences)

getReferencingNode

@Nullable
public @Nullable Footnote getReferencingNode(@NotNull
                                             @NotNull Node node)

Specified by:

getReferencingNode in interface ReferenceNode<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 java.lang.StringBuilder out)

Overrides:

getAstExtra in class Node

getSegments

@NotNull
public @NotNull BasedSequence[] getSegments()

Specified by:

getSegments in class Node

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 interface ParagraphItemContainer

isParagraphWrappingDisabled

public boolean isParagraphWrappingDisabled(Paragraph node,
                                           ListOptions listOptions,
                                           DataHolder options)

Specified by:

isParagraphWrappingDisabled in interface ParagraphItemContainer

isParagraphInTightListItem

public boolean isParagraphInTightListItem(Paragraph node)

Specified by:

isParagraphInTightListItem in interface ParagraphItemContainer