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:

com.vladsch.flexmark.ast.ParagraphItemContainer, com.vladsch.flexmark.util.ast.Content, com.vladsch.flexmark.util.ast.ReferenceNode<FootnoteRepository,FootnoteBlock,Footnote>, Comparable<FootnoteBlock>

public class FootnoteBlock
extends com.vladsch.flexmark.util.ast.Block
implements com.vladsch.flexmark.util.ast.ReferenceNode<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 and 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

EMPTY_SEGMENTS, SPLICE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addFirstReferenceOffset(int firstReferenceOffset)
int	compareTo(FootnoteBlock other)
void	getAstExtra(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()
Footnote	getReferencingNode(com.vladsch.flexmark.util.ast.Node node)
com.vladsch.flexmark.util.sequence.BasedSequence[]	getSegments()
com.vladsch.flexmark.util.sequence.BasedSequence	getText()
boolean	isItemParagraph(com.vladsch.flexmark.ast.Paragraph node)
boolean	isParagraphWrappingDisabled(com.vladsch.flexmark.ast.Paragraph node, com.vladsch.flexmark.parser.ListOptions listOptions, com.vladsch.flexmark.util.options.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, countAncestorsOfType, countDirectAncestorsOfType, delimitedSegmentSpan, delimitedSegmentSpanChars, deNullify, extractChainTo, extractToFirstInChain, getAncestorOfType, getBlankLineSibling, getChars, getCharsFromSegments, getChildChars, getChildIterator, getChildOfType, getChildren, getDescendants, getDocument, getEndLineNumber, getEndOffset, getExactChildChars, getFirstChild, getFirstChildAny, getFirstChildAnyNot, getFirstInChain, getLastBlankLineChild, getLastChild, getLastChildAny, getLastChildAnyNot, getLastInChain, getLeadSegment, getLineNumber, getNext, getNextAny, getNextAnyNot, getNodeName, getNodeOfTypeIndex, getNodeOfTypeIndex, getOldestAncestorOfTypeAfter, getPrevious, getPreviousAny, getPreviousAnyNot, getReversedChildIterator, getReversedChildren, getReversedDescendants, getSegmentsForChars, getStartLineNumber, getStartOffset, getTextLength, getTrailSegment, hasChildren, hasOrMoreChildren, insertAfter, insertBefore, insertChainAfter, insertChainBefore, isOrDescendantOfType, moveTrailingBlankLines, prependChild, removeChildren, segmentSpan, segmentSpan, segmentSpanChars, segmentSpanChars, segmentSpanChars, setChars, setCharsFromContent, setCharsFromContentOnly, setCharsFromSegments, spanningChars, 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 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

compareTo

public int compareTo(FootnoteBlock other)

Specified by:

compareTo in interface Comparable<FootnoteBlock>

getFootnoteReferences

public int getFootnoteReferences()

setFootnoteReferences

public void setFootnoteReferences(int footnoteReferences)

getReferencingNode

public Footnote getReferencingNode(com.vladsch.flexmark.util.ast.Node node)

Specified by:

getReferencingNode in interface com.vladsch.flexmark.util.ast.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(StringBuilder out)

Overrides:

getAstExtra in class com.vladsch.flexmark.util.ast.Node

getSegments

public 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.options.DataHolder options)

Specified by:

isParagraphWrappingDisabled in interface com.vladsch.flexmark.ast.ParagraphItemContainer