com.vladsch.flexmark.ext.footnotes

Class Footnote

java.lang.Object

com.vladsch.flexmark.ast.Node

com.vladsch.flexmark.ast.CustomNode

com.vladsch.flexmark.ext.footnotes.Footnote

All Implemented Interfaces:

DelimitedNode, DoNotDecorate, ReferencingNode<FootnoteRepository,FootnoteBlock>

public class Footnote
extends CustomNode
implements DelimitedNode, DoNotDecorate, ReferencingNode<FootnoteRepository,FootnoteBlock>

A Footnote referencing node

Field Summary

Fields

Modifier and Type	Field and Description
protected BasedSequence	closingMarker
protected FootnoteBlock	footnoteBlock
protected BasedSequence	openingMarker
protected BasedSequence	text

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

EMPTY_SEGMENTS, SPLICE

Constructor Summary

Constructors

Constructor and Description
Footnote()
Footnote(BasedSequence chars)
Footnote(BasedSequence openingMarker, BasedSequence text, BasedSequence closingMarker)

Method Summary

Modifier and Type	Method and Description
void	getAstExtra(StringBuilder out)
BasedSequence	getClosingMarker()
FootnoteBlock	getFootnoteBlock()
FootnoteBlock	getFootnoteBlock(FootnoteRepository footnoteRepository)
BasedSequence	getOpeningMarker()
BasedSequence	getReference()
FootnoteBlock	getReferenceNode(Document document)
FootnoteBlock	getReferenceNode(FootnoteRepository repository)
BasedSequence[]	getSegments()
BasedSequence	getText()
boolean	isDefined()
void	setClosingMarker(BasedSequence closingMarker)
void	setFootnoteBlock(FootnoteBlock footnoteBlock)
void	setOpeningMarker(BasedSequence openingMarker)
void	setText(BasedSequence text)

Methods inherited from class com.vladsch.flexmark.ast.Node

appendChild, astChars, astExtraChars, astString, countAncestorsOfType, countDirectAncestorsOfType, delimitedSegmentSpan, delimitedSegmentSpanChars, deNullify, getAncestorOfType, getBlankLineSibling, getChars, getCharsFromSegments, getChildChars, getChildIterator, getChildOfType, getChildren, getDescendants, getDocument, getEndLineNumber, getEndOffset, getFirstChild, getFirstChildAny, getFirstChildAnyNot, getLastBlankLineChild, getLastChild, getLastChildAny, getLastChildAnyNot, getLeadSegment, getLineNumber, getNext, getNextAny, getNextAnyNot, getNodeName, getNodeOfTypeIndex, getNodeOfTypeIndex, getOldestAncestorOfTypeAfter, getParent, getPrevious, getPreviousAny, getPreviousAnyNot, getReversedChildIterator, getReversedChildren, getReversedDescendants, getSegmentsForChars, getStartLineNumber, getStartOffset, getTextLength, getTrailSegment, hasChildren, hasOrMoreChildren, insertAfter, insertBefore, isOrDescendantOfType, moveTrailingBlankLines, prependChild, removeChildren, segmentSpan, segmentSpan, segmentSpanChars, segmentSpanChars, segmentSpanChars, setChars, setCharsFromContent, setCharsFromContentOnly, setCharsFromSegments, setParent, 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 BasedSequence openingMarker

text

protected BasedSequence text

closingMarker

protected BasedSequence closingMarker

footnoteBlock

protected FootnoteBlock footnoteBlock

Constructor Detail

Footnote

public Footnote()

Footnote

public Footnote(BasedSequence chars)

Footnote

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

Method Detail

getReference

public BasedSequence getReference()

Specified by:

getReference in interface ReferencingNode<FootnoteRepository,FootnoteBlock>

getReferenceNode

public FootnoteBlock getReferenceNode(Document document)

Specified by:

getReferenceNode in interface ReferencingNode<FootnoteRepository,FootnoteBlock>

getReferenceNode

public FootnoteBlock getReferenceNode(FootnoteRepository repository)

Specified by:

getReferenceNode in interface ReferencingNode<FootnoteRepository,FootnoteBlock>

isDefined

public boolean isDefined()

Specified by:

isDefined in interface ReferencingNode<FootnoteRepository,FootnoteBlock>

getFootnoteBlock

public FootnoteBlock getFootnoteBlock(FootnoteRepository footnoteRepository)

getFootnoteBlock

public FootnoteBlock getFootnoteBlock()

setFootnoteBlock

public void setFootnoteBlock(FootnoteBlock footnoteBlock)

getSegments

public BasedSequence[] getSegments()

Specified by:

getSegments in class Node

getAstExtra

public void getAstExtra(StringBuilder out)

Overrides:

getAstExtra in class Node

getOpeningMarker

public BasedSequence getOpeningMarker()

Specified by:

getOpeningMarker in interface DelimitedNode

setOpeningMarker

public void setOpeningMarker(BasedSequence openingMarker)

Specified by:

setOpeningMarker in interface DelimitedNode

getText

public BasedSequence getText()

Specified by:

getText in interface DelimitedNode

setText

public void setText(BasedSequence text)

Specified by:

setText in interface DelimitedNode

getClosingMarker

public BasedSequence getClosingMarker()

Specified by:

getClosingMarker in interface DelimitedNode

setClosingMarker

public void setClosingMarker(BasedSequence closingMarker)

Specified by:

setClosingMarker in interface DelimitedNode