Top Description Fields Constructors Methods
com.vladsch.flexmark.ext.footnotes

public Class Footnote

extends Node
implements DelimitedNode, DoNotDecorate, LinkRendered, ReferencingNode<FootnoteRepository, FootnoteBlock>
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.util.ast.ReferencingNode, com.vladsch.flexmark.ast.LinkRendered, com.vladsch.flexmark.ast.LinkRefDerived, com.vladsch.flexmark.util.ast.DoNotDecorate, com.vladsch.flexmark.util.ast.DelimitedNode, com.vladsch.flexmark.util.ast.TextContainer
Imports
com.vladsch.flexmark.ast.LinkRendered, com.vladsch.flexmark.ext.footnotes.internal.FootnoteRepository, com.vladsch.flexmark.util.ast.*, com.vladsch.flexmark.util.sequence.BasedSequence, org.jetbrains.annotations.NotNull
A Footnote referencing node

Field Summary

Modifier and TypeField and Description
protected BasedSequence
closingMarker

protected FootnoteBlock
footnoteBlock

protected BasedSequence
openingMarker

protected int
referenceOrdinal

protected BasedSequence
text

Inherited from com.vladsch.flexmark.util.ast.Node:
AST_ADAPTEREMPTY_SEGMENTSSPLICE

Constructor Summary

AccessConstructor and Description
public
Footnote()

public
Footnote(BasedSequence chars)

public
Footnote(BasedSequence openingMarker, BasedSequence text, BasedSequence closingMarker)

Method Summary

Modifier and TypeMethod and Description
public void
getAstExtra(@NotNull StringBuilder out)

public BasedSequence
getClosingMarker()

Implements com.vladsch.flexmark.util.ast.DelimitedNode.getClosingMarker.

public FootnoteBlock
getFootnoteBlock(FootnoteRepository footnoteRepository)

public FootnoteBlock
getFootnoteBlock()

public BasedSequence
getOpeningMarker()

Implements com.vladsch.flexmark.util.ast.DelimitedNode.getOpeningMarker.

public @NotNull BasedSequence
getReference()

Implements com.vladsch.flexmark.util.ast.ReferencingNode.getReference.

public FootnoteBlock
getReferenceNode(Document document)

Implements com.vladsch.flexmark.util.ast.ReferencingNode.getReferenceNode, com.vladsch.flexmark.util.ast.ReferencingNode.getReferenceNode.

public FootnoteBlock
getReferenceNode(FootnoteRepository repository)

Implements com.vladsch.flexmark.util.ast.ReferencingNode.getReferenceNode.

public int
getReferenceOrdinal()

public @NotNull BasedSequence[]
getSegments()

Implements abstract com.vladsch.flexmark.util.ast.Node.getSegments.

public BasedSequence
getText()

Implements com.vladsch.flexmark.util.ast.DelimitedNode.getText.

public boolean
isDefined()

Implements com.vladsch.flexmark.util.ast.ReferencingNode.isDefined.

public boolean

Returns:

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

Implements com.vladsch.flexmark.ast.LinkRefDerived.isTentative.

public void
setClosingMarker(BasedSequence closingMarker)

Implements com.vladsch.flexmark.util.ast.DelimitedNode.setClosingMarker.

public void
setFootnoteBlock(FootnoteBlock footnoteBlock)

public void
setOpeningMarker(BasedSequence openingMarker)

Implements com.vladsch.flexmark.util.ast.DelimitedNode.setOpeningMarker.

public void
setReferenceOrdinal(int referenceOrdinal)

public void
setText(BasedSequence text)

Implements com.vladsch.flexmark.util.ast.DelimitedNode.setText.

Inherited from com.vladsch.flexmark.util.ast.Node:
appendChainappendChildastCharsastExtraCharsastStringbaseSubSequencebaseSubSequencecountAncestorsOfTypecountDirectAncestorsOfTypedelimitedSegmentSpandelimitedSegmentSpanCharsendOfLineextractChainToextractToFirstInChaingetAncestorOfTypegetAstExtragetBaseSequencegetBlankLineSiblinggetCharsgetCharsFromSegmentsgetChildCharsgetChildIteratorgetChildOfTypegetChildrengetDescendantsgetDocumentgetEmptyPrefixgetEmptySuffixgetEndLineNumbergetEndOffsetgetEndOfLinegetExactChildCharsgetFirstChildgetFirstChildAnygetFirstChildAnyNotgetFirstInChaingetGrandParentgetLastBlankLineChildgetLastChildgetLastChildAnygetLastChildAnyNotgetLastInChaingetLeadSegmentgetLineColumnAtEndgetLineNumbergetNextgetNextAnygetNextAnyNotgetNodeNamegetNodeOfTypeIndexgetNodeOfTypeIndexgetOldestAncestorOfTypeAftergetParentgetPreviousgetPreviousAnygetPreviousAnyNotgetReversedChildIteratorgetReversedChildrengetReversedDescendantsgetSegmentsForCharsgetSourceRangegetStartLineNumbergetStartOffsetgetStartOfLinegetTextLengthgetTrailSegmenthasChildrenhasOrMoreChildreninsertAfterinsertBeforeinsertChainAfterinsertChainBeforeisOrDescendantOfTypelineColumnAtIndexlineColumnAtStartmoveTrailingBlankLinesprependChildremoveChildrensegmentSpansegmentSpansegmentSpanCharssegmentSpanCharssegmentSpanCharssegmentSpanCharsToVisiblesetCharssetCharsFromContentsetCharsFromContentOnlysetCharsFromSegmentssetParentspanningCharsstartOfLinetakeChildrentoAstStringtoSegmentSpantoStringtoStringAttributesunlink

Field Detail

closingMarkerback to summary
protected BasedSequence closingMarker
footnoteBlockback to summary
protected FootnoteBlock footnoteBlock
openingMarkerback to summary
protected BasedSequence openingMarker
referenceOrdinalback to summary
protected int referenceOrdinal
textback to summary
protected BasedSequence text

Constructor Detail

Footnoteback to summary
public Footnote()
Footnoteback to summary
public Footnote(BasedSequence chars)
Footnoteback to summary
public Footnote(BasedSequence openingMarker, BasedSequence text, BasedSequence closingMarker)

Method Detail

getAstExtraback to summary
public void getAstExtra(@NotNull StringBuilder out)
Annotations
@Override
getClosingMarkerback to summary
public BasedSequence getClosingMarker()

Implements com.vladsch.flexmark.util.ast.DelimitedNode.getClosingMarker.

getFootnoteBlockback to summary
public FootnoteBlock getFootnoteBlock(FootnoteRepository footnoteRepository)
getFootnoteBlockback to summary
public FootnoteBlock getFootnoteBlock()
getOpeningMarkerback to summary
public BasedSequence getOpeningMarker()

Implements com.vladsch.flexmark.util.ast.DelimitedNode.getOpeningMarker.

getReferenceback to summary
public @NotNull BasedSequence getReference()

Implements com.vladsch.flexmark.util.ast.ReferencingNode.getReference.

Annotations
@NotNull
@Override
getReferenceNodeback to summary
public FootnoteBlock getReferenceNode(Document document)

Implements com.vladsch.flexmark.util.ast.ReferencingNode.getReferenceNode, com.vladsch.flexmark.util.ast.ReferencingNode.getReferenceNode.

Annotations
@Override
getReferenceNodeback to summary
public FootnoteBlock getReferenceNode(FootnoteRepository repository)

Implements com.vladsch.flexmark.util.ast.ReferencingNode.getReferenceNode.

Annotations
@Override
getReferenceOrdinalback to summary
public int getReferenceOrdinal()
getSegmentsback to summary
public @NotNull BasedSequence[] getSegments()

Implements abstract com.vladsch.flexmark.util.ast.Node.getSegments.

Annotations
@NotNull
@Override
getTextback to summary
public BasedSequence getText()

Implements com.vladsch.flexmark.util.ast.DelimitedNode.getText.

isDefinedback to summary
public boolean isDefined()

Implements com.vladsch.flexmark.util.ast.ReferencingNode.isDefined.

isTentativeback to summary
public boolean isTentative()

Implements com.vladsch.flexmark.ast.LinkRefDerived.isTentative.

Returns:boolean

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

Annotations
@Override
setClosingMarkerback to summary
public void setClosingMarker(BasedSequence closingMarker)

Implements com.vladsch.flexmark.util.ast.DelimitedNode.setClosingMarker.

setFootnoteBlockback to summary
public void setFootnoteBlock(FootnoteBlock footnoteBlock)
setOpeningMarkerback to summary
public void setOpeningMarker(BasedSequence openingMarker)

Implements com.vladsch.flexmark.util.ast.DelimitedNode.setOpeningMarker.

setReferenceOrdinalback to summary
public void setReferenceOrdinal(int referenceOrdinal)
setTextback to summary
public void setText(BasedSequence text)

Implements com.vladsch.flexmark.util.ast.DelimitedNode.setText.