Top Fields Constructors Methods
com.vladsch.flexmark.ast

public abstract Class RefNode

extends Node
implements LinkRefDerived, ReferencingNode<ReferenceRepository, Reference>, DoNotLinkDecorate, TextContainer
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.util.ast.TextContainer, com.vladsch.flexmark.util.ast.DoNotLinkDecorate, com.vladsch.flexmark.util.ast.ReferencingNode, com.vladsch.flexmark.ast.LinkRefDerived
Known Direct Subclasses
com.vladsch.flexmark.ast.ImageRef, com.vladsch.flexmark.ast.LinkRef
Imports
com.vladsch.flexmark.ast.util.ReferenceRepository, com.vladsch.flexmark.parser.Parser, com.vladsch.flexmark.util.ast.*, com.vladsch.flexmark.util.misc.BitFieldSet, com.vladsch.flexmark.util.sequence.BasedSequence, .Escaping, .ReplacedTextMapper, com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder, org.jetbrains.annotations.NotNull

Field Summary

Modifier and TypeField and Description
protected boolean
protected BasedSequence
protected BasedSequence
protected BasedSequence
protected BasedSequence
protected BasedSequence
protected BasedSequence
Inherited from com.vladsch.flexmark.util.ast.Node:
AST_ADAPTEREMPTY_SEGMENTSSPLICE

Constructor Summary

AccessConstructor and Description
public
public
public
RefNode(BasedSequence textOpeningMarker, BasedSequence text, BasedSequence textClosingMarker, BasedSequence referenceOpeningMarker, BasedSequence reference, BasedSequence referenceClosingMarker)

public
RefNode(BasedSequence chars, BasedSequence textOpeningMarker, BasedSequence text, BasedSequence textClosingMarker, BasedSequence referenceOpeningMarker, BasedSequence reference, BasedSequence referenceClosingMarker)

public
RefNode(BasedSequence textOpeningMarker, BasedSequence text, BasedSequence textClosingMarker)

public
RefNode(BasedSequence chars, BasedSequence textOpeningMarker, BasedSequence text, BasedSequence textClosingMarker)

public
RefNode(BasedSequence textOpeningMarker, BasedSequence text, BasedSequence textClosingMarker, BasedSequence referenceOpeningMarker, BasedSequence referenceClosingMarker)

Method Summary

Modifier and TypeMethod and Description
public boolean
collectText(ISequenceBuilder<? extends ISequenceBuilder<?, BasedSequence>, BasedSequence>
sequence build to which to append text
out
,
int
collection flags
flags
,
NodeVisitor
node visitor to use to visit children
nodeVisitor
)

Implements com.vladsch.flexmark.util.ast.TextContainer.collectText.

Append node's text

public void
public BasedSequence
public @NotNull BasedSequence
public BasedSequence
public Reference
public Reference
public BasedSequence
public @NotNull BasedSequence[]
public BasedSequence
public BasedSequence
public BasedSequence
public boolean
public boolean
public boolean
public boolean
public void
setDefined(boolean defined)

public void
public void
public void
setReferenceClosingMarker(BasedSequence referenceClosingMarker)

public void
setReferenceOpeningMarker(BasedSequence referenceOpeningMarker)

public void
public void
public void
public void
protected @NotNull String
Inherited from com.vladsch.flexmark.util.ast.Node:
appendChainappendChildastCharsastExtraCharsastStringbaseSubSequencebaseSubSequencecountAncestorsOfTypecountDirectAncestorsOfTypedelimitedSegmentSpandelimitedSegmentSpanCharsendOfLineextractChainToextractToFirstInChaingetAncestorOfTypegetAstExtragetBaseSequencegetBlankLineSiblinggetCharsgetCharsFromSegmentsgetChildCharsgetChildIteratorgetChildOfTypegetChildrengetDescendantsgetDocumentgetEmptyPrefixgetEmptySuffixgetEndLineNumbergetEndOffsetgetEndOfLinegetExactChildCharsgetFirstChildgetFirstChildAnygetFirstChildAnyNotgetFirstInChaingetGrandParentgetLastBlankLineChildgetLastChildgetLastChildAnygetLastChildAnyNotgetLastInChaingetLeadSegmentgetLineColumnAtEndgetLineNumbergetNextgetNextAnygetNextAnyNotgetNodeNamegetNodeOfTypeIndexgetNodeOfTypeIndexgetOldestAncestorOfTypeAftergetParentgetPreviousgetPreviousAnygetPreviousAnyNotgetReversedChildIteratorgetReversedChildrengetReversedDescendantsgetSegmentsForCharsgetSourceRangegetStartLineNumbergetStartOffsetgetStartOfLinegetTextLengthgetTrailSegmenthasChildrenhasOrMoreChildreninsertAfterinsertBeforeinsertChainAfterinsertChainBeforeisOrDescendantOfTypelineColumnAtIndexlineColumnAtStartmoveTrailingBlankLinesprependChildremoveChildrensegmentSpansegmentSpansegmentSpanCharssegmentSpanCharssegmentSpanCharssegmentSpanCharsToVisiblesetCharssetCharsFromContentsetCharsFromContentOnlysetCharsFromSegmentssetParentspanningCharsstartOfLinetakeChildrentoAstStringtoSegmentSpantoStringunlink

Field Detail

isDefinedback to summary
protected boolean isDefined
referenceback to summary
protected BasedSequence reference
referenceClosingMarkerback to summary
protected BasedSequence referenceClosingMarker
referenceOpeningMarkerback to summary
protected BasedSequence referenceOpeningMarker
textback to summary
protected BasedSequence text
textClosingMarkerback to summary
protected BasedSequence textClosingMarker
textOpeningMarkerback to summary
protected BasedSequence textOpeningMarker

Constructor Detail

RefNodeback to summary
public RefNode()
RefNodeback to summary
public RefNode(BasedSequence chars)
RefNodeback to summary
public RefNode(BasedSequence textOpeningMarker, BasedSequence text, BasedSequence textClosingMarker, BasedSequence referenceOpeningMarker, BasedSequence reference, BasedSequence referenceClosingMarker)
RefNodeback to summary
public RefNode(BasedSequence chars, BasedSequence textOpeningMarker, BasedSequence text, BasedSequence textClosingMarker, BasedSequence referenceOpeningMarker, BasedSequence reference, BasedSequence referenceClosingMarker)
RefNodeback to summary
public RefNode(BasedSequence textOpeningMarker, BasedSequence text, BasedSequence textClosingMarker)
RefNodeback to summary
public RefNode(BasedSequence chars, BasedSequence textOpeningMarker, BasedSequence text, BasedSequence textClosingMarker)
RefNodeback to summary
public RefNode(BasedSequence textOpeningMarker, BasedSequence text, BasedSequence textClosingMarker, BasedSequence referenceOpeningMarker, BasedSequence referenceClosingMarker)

Method Detail

collectTextback to summary
public boolean collectText(ISequenceBuilder<? extends ISequenceBuilder<?, BasedSequence>, BasedSequence> out, int flags, NodeVisitor nodeVisitor)

Implements com.vladsch.flexmark.util.ast.TextContainer.collectText.

Doc from com.vladsch.flexmark.util.ast.TextContainer.collectText.

Append node's text

Parameters
out:ISequenceBuilder<? extends ISequenceBuilder<?, BasedSequence>, BasedSequence>

sequence build to which to append text

flags:int

collection flags

nodeVisitor:NodeVisitor

node visitor to use to visit children

Returns:boolean

true if child nodes should be visited

Annotations
@Override
getAstExtraback to summary
public void getAstExtra(@NotNull StringBuilder out)
Annotations
@Override
getDummyReferenceback to summary
public BasedSequence getDummyReference()
getReferenceback to summary
public @NotNull BasedSequence getReference()

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

Annotations
@NotNull
@Override
getReferenceClosingMarkerback to summary
public BasedSequence getReferenceClosingMarker()
getReferenceNodeback to summary
public Reference getReferenceNode(Document document)

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

Annotations
@Override
getReferenceNodeback to summary
public Reference getReferenceNode(ReferenceRepository repository)

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

Annotations
@Override
getReferenceOpeningMarkerback to summary
public BasedSequence getReferenceOpeningMarker()
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()
getTextClosingMarkerback to summary
public BasedSequence getTextClosingMarker()
getTextOpeningMarkerback to summary
public BasedSequence getTextOpeningMarker()
isDefinedback to summary
public boolean isDefined()

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

Annotations
@Override
isDummyReferenceback to summary
public boolean isDummyReference()
isReferenceTextCombinedback to summary
public boolean isReferenceTextCombined()
isTentativeback to summary
public boolean isTentative()

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

Returns:boolean

Doc from com.vladsch.flexmark.ast.LinkRefDerived.isTentative.

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

Annotations
@Override
setDefinedback to summary
public void setDefined(boolean defined)
setReferenceback to summary
public void setReference(BasedSequence reference)
setReferenceCharsback to summary
public void setReferenceChars(BasedSequence referenceChars)
setReferenceClosingMarkerback to summary
public void setReferenceClosingMarker(BasedSequence referenceClosingMarker)
setReferenceOpeningMarkerback to summary
public void setReferenceOpeningMarker(BasedSequence referenceOpeningMarker)
setTextback to summary
public void setText(BasedSequence text)
setTextCharsback to summary
public void setTextChars(BasedSequence textChars)
setTextClosingMarkerback to summary
public void setTextClosingMarker(BasedSequence textClosingMarker)
setTextOpeningMarkerback to summary
public void setTextOpeningMarker(BasedSequence textOpeningMarker)
toStringAttributesback to summary
protected @NotNull String toStringAttributes()

Overrides com.vladsch.flexmark.util.ast.Node.toStringAttributes.

Annotations
@NotNull
@Override