Package com.vladsch.flexmark.ast

Class RefNode

java.lang.Object

com.vladsch.flexmark.util.ast.Node

com.vladsch.flexmark.ast.RefNode

All Implemented Interfaces:

LinkRefDerived, DoNotLinkDecorate, ReferencingNode<ReferenceRepository,Reference>, TextContainer

Direct Known Subclasses:

ImageRef, LinkRef

public abstract class RefNode
extends Node
implements LinkRefDerived, ReferencingNode<ReferenceRepository,Reference>, DoNotLinkDecorate, TextContainer

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 boolean	isDefined
protected BasedSequence	reference
protected BasedSequence	referenceClosingMarker
protected BasedSequence	referenceOpeningMarker
protected BasedSequence	text
protected BasedSequence	textClosingMarker
protected BasedSequence	textOpeningMarker

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
RefNode()
RefNode(BasedSequence chars)
RefNode(BasedSequence textOpeningMarker, BasedSequence text, BasedSequence textClosingMarker)
RefNode(BasedSequence chars, BasedSequence textOpeningMarker, BasedSequence text, BasedSequence textClosingMarker)
RefNode(BasedSequence textOpeningMarker, BasedSequence text, BasedSequence textClosingMarker, BasedSequence referenceOpeningMarker, BasedSequence referenceClosingMarker)
RefNode(BasedSequence textOpeningMarker, BasedSequence text, BasedSequence textClosingMarker, BasedSequence referenceOpeningMarker, BasedSequence reference, BasedSequence referenceClosingMarker)
RefNode(BasedSequence chars, BasedSequence textOpeningMarker, BasedSequence text, BasedSequence textClosingMarker, BasedSequence referenceOpeningMarker, BasedSequence reference, BasedSequence referenceClosingMarker)

Method Summary

Modifier and Type	Method	Description
boolean	collectText(ISequenceBuilder<? extends ISequenceBuilder<?,BasedSequence>,BasedSequence> out, int flags, NodeVisitor nodeVisitor)	Append node's text
void	getAstExtra(@NotNull java.lang.StringBuilder out)
BasedSequence	getDummyReference()
@NotNull BasedSequence	getReference()
BasedSequence	getReferenceClosingMarker()
Reference	getReferenceNode(ReferenceRepository repository)
Reference	getReferenceNode(Document document)
BasedSequence	getReferenceOpeningMarker()
@NotNull BasedSequence[]	getSegments()
BasedSequence	getText()
BasedSequence	getTextClosingMarker()
BasedSequence	getTextOpeningMarker()
boolean	isDefined()
boolean	isDummyReference()
boolean	isReferenceTextCombined()
boolean	isTentative()
void	setDefined(boolean defined)
void	setReference(BasedSequence reference)
void	setReferenceChars(BasedSequence referenceChars)
void	setReferenceClosingMarker(BasedSequence referenceClosingMarker)
void	setReferenceOpeningMarker(BasedSequence referenceOpeningMarker)
void	setText(BasedSequence text)
void	setTextChars(BasedSequence textChars)
void	setTextClosingMarker(BasedSequence textClosingMarker)
void	setTextOpeningMarker(BasedSequence textOpeningMarker)
protected @NotNull java.lang.String	toStringAttributes()

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, 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.TextContainer

collectEndText

Field Detail

textOpeningMarker

protected BasedSequence textOpeningMarker

text

protected BasedSequence text

textClosingMarker

protected BasedSequence textClosingMarker

referenceOpeningMarker

protected BasedSequence referenceOpeningMarker

reference

protected BasedSequence reference

referenceClosingMarker

protected BasedSequence referenceClosingMarker

isDefined

protected boolean isDefined

Constructor Detail

RefNode

public RefNode()

RefNode

public RefNode(BasedSequence chars)

RefNode

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

RefNode

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

RefNode

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

RefNode

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

RefNode

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

Method Detail

getSegments

@NotNull
public @NotNull BasedSequence[] getSegments()

Specified by:

getSegments in class Node

getAstExtra

public void getAstExtra(@NotNull
                        @NotNull java.lang.StringBuilder out)

Overrides:

getAstExtra in class Node

setReferenceChars

public void setReferenceChars(BasedSequence referenceChars)

setTextChars

public void setTextChars(BasedSequence textChars)

isReferenceTextCombined

public boolean isReferenceTextCombined()

isDefined

public boolean isDefined()

Specified by:

isDefined in interface ReferencingNode<ReferenceRepository,Reference>

setDefined

public void setDefined(boolean defined)

isTentative

public boolean isTentative()

Specified by:

isTentative in interface LinkRefDerived

Returns:

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

isDummyReference

public boolean isDummyReference()

getText

public BasedSequence getText()

getReference

@NotNull
public @NotNull BasedSequence getReference()

Specified by:

getReference in interface ReferencingNode<ReferenceRepository,Reference>

getReferenceNode

public Reference getReferenceNode(Document document)

Specified by:

getReferenceNode in interface ReferencingNode<ReferenceRepository,Reference>

getReferenceNode

public Reference getReferenceNode(ReferenceRepository repository)

Specified by:

getReferenceNode in interface ReferencingNode<ReferenceRepository,Reference>

getTextOpeningMarker

public BasedSequence getTextOpeningMarker()

setTextOpeningMarker

public void setTextOpeningMarker(BasedSequence textOpeningMarker)

setText

public void setText(BasedSequence text)

getTextClosingMarker

public BasedSequence getTextClosingMarker()

setTextClosingMarker

public void setTextClosingMarker(BasedSequence textClosingMarker)

getReferenceOpeningMarker

public BasedSequence getReferenceOpeningMarker()

setReferenceOpeningMarker

public void setReferenceOpeningMarker(BasedSequence referenceOpeningMarker)

setReference

public void setReference(BasedSequence reference)

getDummyReference

public BasedSequence getDummyReference()

getReferenceClosingMarker

public BasedSequence getReferenceClosingMarker()

setReferenceClosingMarker

public void setReferenceClosingMarker(BasedSequence referenceClosingMarker)

collectText

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

Description copied from interface: TextContainer

Append node's text

Specified by:

collectText in interface TextContainer

Parameters:

out - sequence build to which to append text

flags - collection flags

nodeVisitor - node visitor to use to visit children

Returns:

true if child nodes should be visited

toStringAttributes

@NotNull
protected @NotNull java.lang.String toStringAttributes()

Overrides:

toStringAttributes in class Node