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
FieldsModifier and TypeFieldDescriptionprotected BasedSequence
protected FootnoteBlock
protected BasedSequence
protected int
protected BasedSequence
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
ConstructorsConstructorDescriptionFootnote()
Footnote
(BasedSequence chars) Footnote
(BasedSequence openingMarker, BasedSequence text, BasedSequence closingMarker) -
Method Summary
Modifier and TypeMethodDescriptionvoid
getAstExtra
(@NotNull StringBuilder out) getFootnoteBlock
(FootnoteRepository footnoteRepository) @NotNull BasedSequence
getReferenceNode
(FootnoteRepository repository) getReferenceNode
(Document document) int
@NotNull BasedSequence[]
getText()
boolean
boolean
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 Details
-
openingMarker
-
text
-
closingMarker
-
footnoteBlock
-
referenceOrdinal
protected int referenceOrdinal
-
-
Constructor Details
-
Footnote
public Footnote() -
Footnote
-
Footnote
-
-
Method Details
-
getReferenceOrdinal
public int getReferenceOrdinal() -
setReferenceOrdinal
public void setReferenceOrdinal(int referenceOrdinal) -
getReference
- Specified by:
getReference
in interfaceReferencingNode<FootnoteRepository,
FootnoteBlock>
-
getReferenceNode
- Specified by:
getReferenceNode
in interfaceReferencingNode<FootnoteRepository,
FootnoteBlock>
-
getReferenceNode
- 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
-
getFootnoteBlock
-
setFootnoteBlock
-
getSegments
- Specified by:
getSegments
in classNode
-
getAstExtra
- Overrides:
getAstExtra
in classNode
-
getOpeningMarker
- Specified by:
getOpeningMarker
in interfaceDelimitedNode
-
setOpeningMarker
- Specified by:
setOpeningMarker
in interfaceDelimitedNode
-
getText
- Specified by:
getText
in interfaceDelimitedNode
-
setText
- Specified by:
setText
in interfaceDelimitedNode
-
getClosingMarker
- Specified by:
getClosingMarker
in interfaceDelimitedNode
-
setClosingMarker
- Specified by:
setClosingMarker
in interfaceDelimitedNode
-