Package com.vladsch.flexmark.ext.wikilink

Class WikiNode

java.lang.Object

com.vladsch.flexmark.util.ast.Node

com.vladsch.flexmark.ext.wikilink.WikiNode

All Implemented Interfaces:

LinkRefDerived, DoNotDecorate, TextContainer

Direct Known Subclasses:

WikiImage, WikiLink

public class WikiNode
extends Node
implements DoNotDecorate, TextContainer, LinkRefDerived

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	anchorMarker
protected BasedSequence	anchorRef
protected BasedSequence	closingMarker
protected BasedSequence	link
protected boolean	linkIsFirst
protected BasedSequence	openingMarker
protected BasedSequence	pageRef
static char	SEPARATOR_CHAR
protected BasedSequence	text
protected BasedSequence	textSeparatorMarker

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
WikiNode(boolean linkIsFirst)
WikiNode(BasedSequence chars, boolean linkIsFirst, boolean allowAnchors, boolean canEscapePipe, boolean canEscapeAnchor)

Method Summary

Modifier and Type	Method	Description
boolean	collectText(ISequenceBuilder<? extends ISequenceBuilder<?,BasedSequence>,BasedSequence> out, int flags, NodeVisitor nodeVisitor)	Append node's text
BasedSequence	getAnchorMarker()
BasedSequence	getAnchorRef()
void	getAstExtra(java.lang.StringBuilder out)
BasedSequence	getClosingMarker()
BasedSequence	getLink()
BasedSequence	getOpeningMarker()
BasedSequence	getPageRef()
BasedSequence[]	getSegments()
BasedSequence	getText()
BasedSequence	getTextSeparatorMarker()
boolean	isLinkIsFirst()
boolean	isTentative()
void	setAnchorMarker(BasedSequence anchorMarker)
void	setAnchorRef(BasedSequence anchorRef)
void	setClosingMarker(BasedSequence closingMarker)
void	setLink(BasedSequence linkChars, boolean allowAnchors, boolean canEscapeAnchor)
void	setLinkChars(BasedSequence linkChars, boolean allowAnchors, boolean canEscapePipe, boolean canEscapeAnchor)
void	setOpeningMarker(BasedSequence openingMarker)
void	setPageRef(BasedSequence pageRef)
void	setText(BasedSequence text)
void	setTextSeparatorMarker(BasedSequence textSeparatorMarker)

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

collectEndText

Field Detail

SEPARATOR_CHAR

public static final char SEPARATOR_CHAR

See Also:

Constant Field Values

openingMarker

protected BasedSequence openingMarker

link

protected BasedSequence link

pageRef

protected BasedSequence pageRef

anchorMarker

protected BasedSequence anchorMarker

anchorRef

protected BasedSequence anchorRef

textSeparatorMarker

protected BasedSequence textSeparatorMarker

text

protected BasedSequence text

closingMarker

protected BasedSequence closingMarker

linkIsFirst

protected final boolean linkIsFirst

Constructor Detail

WikiNode

public WikiNode(boolean linkIsFirst)

WikiNode

public WikiNode(BasedSequence chars,
                boolean linkIsFirst,
                boolean allowAnchors,
                boolean canEscapePipe,
                boolean canEscapeAnchor)

Method Detail

getSegments

@NotNull
public BasedSequence[] getSegments()

Specified by:

getSegments in class Node

getAstExtra

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

Overrides:

getAstExtra in class Node

isLinkIsFirst

public boolean isLinkIsFirst()

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.

getOpeningMarker

public BasedSequence getOpeningMarker()

setOpeningMarker

public void setOpeningMarker(BasedSequence openingMarker)

getPageRef

public BasedSequence getPageRef()

setPageRef

public void setPageRef(BasedSequence pageRef)

getTextSeparatorMarker

public BasedSequence getTextSeparatorMarker()

setTextSeparatorMarker

public void setTextSeparatorMarker(BasedSequence textSeparatorMarker)

getText

public BasedSequence getText()

setText

public void setText(BasedSequence text)

getClosingMarker

public BasedSequence getClosingMarker()

setClosingMarker

public void setClosingMarker(BasedSequence closingMarker)

getAnchorMarker

public BasedSequence getAnchorMarker()

setAnchorMarker

public void setAnchorMarker(BasedSequence anchorMarker)

getAnchorRef

public BasedSequence getAnchorRef()

setAnchorRef

public void setAnchorRef(BasedSequence anchorRef)

getLink

public BasedSequence getLink()

setLink

public void setLink(BasedSequence linkChars,
                    boolean allowAnchors,
                    boolean canEscapeAnchor)

setLinkChars

public void setLinkChars(BasedSequence linkChars,
                         boolean allowAnchors,
                         boolean canEscapePipe,
                         boolean canEscapeAnchor)

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