com.vladsch.flexmark.ext.footnotes

Class Footnote

java.lang.Object

com.vladsch.flexmark.util.ast.Node

com.vladsch.flexmark.ext.footnotes.Footnote

All Implemented Interfaces:

com.vladsch.flexmark.ast.LinkRefDerived, com.vladsch.flexmark.ast.LinkRendered, com.vladsch.flexmark.util.ast.DelimitedNode, com.vladsch.flexmark.util.ast.DoNotDecorate, com.vladsch.flexmark.util.ast.ReferencingNode<FootnoteRepository,FootnoteBlock>, com.vladsch.flexmark.util.ast.TextContainer

public class Footnote
extends com.vladsch.flexmark.util.ast.Node
implements com.vladsch.flexmark.util.ast.DelimitedNode, com.vladsch.flexmark.util.ast.DoNotDecorate, com.vladsch.flexmark.ast.LinkRendered, com.vladsch.flexmark.util.ast.ReferencingNode<FootnoteRepository,FootnoteBlock>

A Footnote referencing node

Nested Class Summary

Nested classes/interfaces inherited from interface com.vladsch.flexmark.util.ast.TextContainer

com.vladsch.flexmark.util.ast.TextContainer.Flags

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vladsch.flexmark.util.sequence.BasedSequence	closingMarker
protected FootnoteBlock	footnoteBlock
protected com.vladsch.flexmark.util.sequence.BasedSequence	openingMarker
protected int	referenceOrdinal
protected com.vladsch.flexmark.util.sequence.BasedSequence	text

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

AST_ADAPTER, EMPTY_SEGMENTS, SPLICE

Fields inherited from interface com.vladsch.flexmark.util.ast.TextContainer

F_ADD_SPACES_BETWEEN_NODES, F_FOR_HEADING_ID, F_LINK_ANCHOR, F_LINK_NODE_TEXT, F_LINK_PAGE_REF, F_LINK_TEXT, F_LINK_TEXT_TYPE, F_LINK_URL, F_NO_TRIM_REF_TEXT_END, F_NO_TRIM_REF_TEXT_START, F_NODE_TEXT

Constructor Summary

Constructors

Constructor and Description
Footnote()
Footnote(com.vladsch.flexmark.util.sequence.BasedSequence chars)
Footnote(com.vladsch.flexmark.util.sequence.BasedSequence openingMarker, com.vladsch.flexmark.util.sequence.BasedSequence text, com.vladsch.flexmark.util.sequence.BasedSequence closingMarker)

Method Summary

Modifier and Type	Method and Description
void	getAstExtra(@NotNull StringBuilder out)
com.vladsch.flexmark.util.sequence.BasedSequence	getClosingMarker()
FootnoteBlock	getFootnoteBlock()
FootnoteBlock	getFootnoteBlock(FootnoteRepository footnoteRepository)
com.vladsch.flexmark.util.sequence.BasedSequence	getOpeningMarker()
@NotNull com.vladsch.flexmark.util.sequence.BasedSequence	getReference()
FootnoteBlock	getReferenceNode(com.vladsch.flexmark.util.ast.Document document)
FootnoteBlock	getReferenceNode(FootnoteRepository repository)
int	getReferenceOrdinal()
@NotNull com.vladsch.flexmark.util.sequence.BasedSequence[]	getSegments()
com.vladsch.flexmark.util.sequence.BasedSequence	getText()
boolean	isDefined()
boolean	isTentative()
void	setClosingMarker(com.vladsch.flexmark.util.sequence.BasedSequence closingMarker)
void	setFootnoteBlock(FootnoteBlock footnoteBlock)
void	setOpeningMarker(com.vladsch.flexmark.util.sequence.BasedSequence openingMarker)
void	setReferenceOrdinal(int referenceOrdinal)
void	setText(com.vladsch.flexmark.util.sequence.BasedSequence text)

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, getParent, 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, setParent, 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

Methods inherited from interface com.vladsch.flexmark.util.ast.DelimitedNode

collectText, getChars

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

footnoteBlock

protected FootnoteBlock footnoteBlock

referenceOrdinal

protected int referenceOrdinal

Constructor Detail

Footnote

public Footnote()

Footnote

public Footnote(com.vladsch.flexmark.util.sequence.BasedSequence chars)

Footnote

public Footnote(com.vladsch.flexmark.util.sequence.BasedSequence openingMarker,
                com.vladsch.flexmark.util.sequence.BasedSequence text,
                com.vladsch.flexmark.util.sequence.BasedSequence closingMarker)

Method Detail

getReferenceOrdinal

public int getReferenceOrdinal()

setReferenceOrdinal

public void setReferenceOrdinal(int referenceOrdinal)

getReference

@NotNull
public @NotNull com.vladsch.flexmark.util.sequence.BasedSequence getReference()

Specified by:

getReference in interface com.vladsch.flexmark.util.ast.ReferencingNode<FootnoteRepository,FootnoteBlock>

getReferenceNode

public FootnoteBlock getReferenceNode(com.vladsch.flexmark.util.ast.Document document)

Specified by:

getReferenceNode in interface com.vladsch.flexmark.util.ast.ReferencingNode<FootnoteRepository,FootnoteBlock>

getReferenceNode

public FootnoteBlock getReferenceNode(FootnoteRepository repository)

Specified by:

getReferenceNode in interface com.vladsch.flexmark.util.ast.ReferencingNode<FootnoteRepository,FootnoteBlock>

isDefined

public boolean isDefined()

Specified by:

isDefined in interface com.vladsch.flexmark.util.ast.ReferencingNode<FootnoteRepository,FootnoteBlock>

isTentative

public boolean isTentative()

Specified by:

isTentative in interface com.vladsch.flexmark.ast.LinkRefDerived

Returns:

true if this node will be rendered as text because it depends on a reference which is not defined.

getFootnoteBlock

public FootnoteBlock getFootnoteBlock(FootnoteRepository footnoteRepository)

getFootnoteBlock

public FootnoteBlock getFootnoteBlock()

setFootnoteBlock

public void setFootnoteBlock(FootnoteBlock footnoteBlock)

getSegments

@NotNull
public @NotNull com.vladsch.flexmark.util.sequence.BasedSequence[] getSegments()

Specified by:

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

getAstExtra

public void getAstExtra(@NotNull
                        @NotNull StringBuilder out)

Overrides:

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

getOpeningMarker

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

Specified by:

getOpeningMarker in interface com.vladsch.flexmark.util.ast.DelimitedNode

setOpeningMarker

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

Specified by:

setOpeningMarker in interface com.vladsch.flexmark.util.ast.DelimitedNode

getText

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

Specified by:

getText in interface com.vladsch.flexmark.util.ast.DelimitedNode

setText

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

Specified by:

setText in interface com.vladsch.flexmark.util.ast.DelimitedNode

getClosingMarker

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

Specified by:

getClosingMarker in interface com.vladsch.flexmark.util.ast.DelimitedNode

setClosingMarker

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

Specified by:

setClosingMarker in interface com.vladsch.flexmark.util.ast.DelimitedNode