Class Footnote
- java.lang.Object
-
- com.vladsch.flexmark.util.ast.Node
-
- com.vladsch.flexmark.ext.footnotes.Footnote
-
- All Implemented Interfaces:
LinkRefDerived
,LinkRendered
,DelimitedNode
,DoNotDecorate
,ReferencingNode<FootnoteRepository,FootnoteBlock>
,TextContainer
public class Footnote extends Node implements DelimitedNode, DoNotDecorate, LinkRendered, ReferencingNode<FootnoteRepository,FootnoteBlock>
A Footnote referencing node
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.vladsch.flexmark.util.ast.TextContainer
TextContainer.Flags
-
-
Field Summary
Fields Modifier and Type Field Description protected BasedSequence
closingMarker
protected FootnoteBlock
footnoteBlock
protected BasedSequence
openingMarker
protected int
referenceOrdinal
protected 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 Description Footnote()
Footnote(BasedSequence chars)
Footnote(BasedSequence openingMarker, BasedSequence text, BasedSequence closingMarker)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
getAstExtra(java.lang.StringBuilder out)
BasedSequence
getClosingMarker()
FootnoteBlock
getFootnoteBlock()
FootnoteBlock
getFootnoteBlock(FootnoteRepository footnoteRepository)
BasedSequence
getOpeningMarker()
BasedSequence
getReference()
FootnoteBlock
getReferenceNode(FootnoteRepository repository)
FootnoteBlock
getReferenceNode(Document document)
int
getReferenceOrdinal()
BasedSequence[]
getSegments()
BasedSequence
getText()
boolean
isDefined()
boolean
isTentative()
void
setClosingMarker(BasedSequence closingMarker)
void
setFootnoteBlock(FootnoteBlock footnoteBlock)
void
setOpeningMarker(BasedSequence openingMarker)
void
setReferenceOrdinal(int referenceOrdinal)
void
setText(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
-
Methods inherited from interface com.vladsch.flexmark.util.ast.TextContainer
collectEndText
-
-
-
-
Field Detail
-
openingMarker
protected BasedSequence openingMarker
-
text
protected BasedSequence text
-
closingMarker
protected BasedSequence closingMarker
-
footnoteBlock
protected FootnoteBlock footnoteBlock
-
referenceOrdinal
protected int referenceOrdinal
-
-
Constructor Detail
-
Footnote
public Footnote()
-
Footnote
public Footnote(BasedSequence chars)
-
Footnote
public Footnote(BasedSequence openingMarker, BasedSequence text, BasedSequence closingMarker)
-
-
Method Detail
-
getReferenceOrdinal
public int getReferenceOrdinal()
-
setReferenceOrdinal
public void setReferenceOrdinal(int referenceOrdinal)
-
getReference
@NotNull public BasedSequence getReference()
- Specified by:
getReference
in interfaceReferencingNode<FootnoteRepository,FootnoteBlock>
-
getReferenceNode
public FootnoteBlock getReferenceNode(Document document)
- Specified by:
getReferenceNode
in interfaceReferencingNode<FootnoteRepository,FootnoteBlock>
-
getReferenceNode
public FootnoteBlock getReferenceNode(FootnoteRepository repository)
- Specified by:
getReferenceNode
in interfaceReferencingNode<FootnoteRepository,FootnoteBlock>
-
isDefined
public boolean isDefined()
- Specified by:
isDefined
in interfaceReferencingNode<FootnoteRepository,FootnoteBlock>
-
isTentative
public boolean isTentative()
- Specified by:
isTentative
in interfaceLinkRefDerived
- 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 BasedSequence[] getSegments()
- Specified by:
getSegments
in classNode
-
getAstExtra
public void getAstExtra(@NotNull java.lang.StringBuilder out)
- Overrides:
getAstExtra
in classNode
-
getOpeningMarker
public BasedSequence getOpeningMarker()
- Specified by:
getOpeningMarker
in interfaceDelimitedNode
-
setOpeningMarker
public void setOpeningMarker(BasedSequence openingMarker)
- Specified by:
setOpeningMarker
in interfaceDelimitedNode
-
getText
public BasedSequence getText()
- Specified by:
getText
in interfaceDelimitedNode
-
setText
public void setText(BasedSequence text)
- Specified by:
setText
in interfaceDelimitedNode
-
getClosingMarker
public BasedSequence getClosingMarker()
- Specified by:
getClosingMarker
in interfaceDelimitedNode
-
setClosingMarker
public void setClosingMarker(BasedSequence closingMarker)
- Specified by:
setClosingMarker
in interfaceDelimitedNode
-
-