Top Inners Fields Constructors Methods
com.vladsch.flexmark.ext.enumerated.reference.internal

public Class EnumRefTextCollectingVisitor

extends Object
Class Inheritance
Annotations
@SuppressWarnings:WeakerAccess
Imports
com.vladsch.flexmark.ast.*, com.vladsch.flexmark.ext.enumerated.reference.*, com.vladsch.flexmark.util.ast.DoNotCollectText, .NodeVisitor, .VisitHandler, com.vladsch.flexmark.util.sequence.BasedSequence, com.vladsch.flexmark.util.sequence.builder.SequenceBuilder

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
EnumRefTextCollectingVisitor.OrdinalRenderer

Field Summary

Modifier and TypeField and Description
private Runnable
ordinalRunnable

private SequenceBuilder
out

private final NodeVisitor
visitor

Constructor Summary

AccessConstructor and Description
public
EnumRefTextCollectingVisitor()

public
EnumRefTextCollectingVisitor(int ordinal)

Method Summary

Modifier and TypeMethod and Description
public void
collect(BasedSequence basedSequence, EnumeratedReferenceRendering[] renderings, String defaultFormat)

public String
collectAndGetText(BasedSequence basedSequence, EnumeratedReferenceRendering[] renderings, String defaultFormat)

public String
getText()

private void
visit(EnumeratedReferenceText node)

private void
visit(SoftLineBreak node)

private void
visit(HardLineBreak node)

private void
visit(HtmlEntity node)

private void
visit(Text node)

private void
visit(TextBase node)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ordinalRunnableback to summary
private Runnable ordinalRunnable
outback to summary
private SequenceBuilder out
visitorback to summary
private final NodeVisitor visitor

Constructor Detail

EnumRefTextCollectingVisitorback to summary
public EnumRefTextCollectingVisitor()
EnumRefTextCollectingVisitorback to summary
public EnumRefTextCollectingVisitor(int ordinal)

Method Detail

collectback to summary
public void collect(BasedSequence basedSequence, EnumeratedReferenceRendering[] renderings, String defaultFormat)
collectAndGetTextback to summary
public String collectAndGetText(BasedSequence basedSequence, EnumeratedReferenceRendering[] renderings, String defaultFormat)
getTextback to summary
public String getText()
visitback to summary
private void visit(EnumeratedReferenceText node)
visitback to summary
private void visit(EnumeratedReferenceLink node)
visitback to summary
private void visit(SoftLineBreak node)
visitback to summary
private void visit(HardLineBreak node)
visitback to summary
private void visit(HtmlEntity node)
visitback to summary
private void visit(Text node)
visitback to summary
private void visit(TextBase node)
com.vladsch.flexmark.ext.enumerated.reference.internal back to summary

private Class EnumRefTextCollectingVisitor.OrdinalRenderer

extends Object
implements EnumeratedOrdinalRenderer
Class Inheritance
  • java.lang.Object
  • com.vladsch.flexmark.ext.enumerated.reference.internal.EnumRefTextCollectingVisitor.OrdinalRenderer
All Implemented Interfaces
com.vladsch.flexmark.ext.enumerated.reference.EnumeratedOrdinalRenderer

Field Summary

Modifier and TypeField and Description
pack-priv final EnumRefTextCollectingVisitor
renderer

Constructor Summary

AccessConstructor and Description
public
OrdinalRenderer(EnumRefTextCollectingVisitor renderer)

Method Summary

Modifier and TypeMethod and Description
public void
endRendering()

Implements com.vladsch.flexmark.ext.enumerated.reference.EnumeratedOrdinalRenderer.endRendering.

After Rendering is complete

public Runnable
getEnumOrdinalRunnable()

Implements com.vladsch.flexmark.ext.enumerated.reference.EnumeratedOrdinalRenderer.getEnumOrdinalRunnable.

Return current enum ordinal runnable, used to save previous state

public void
render(int
ordinal for the reference
referenceOrdinal, EnumeratedReferenceBlock
reference format or null
referenceFormat, String
default text to use if referenceFormat is null or not being used
defaultText, boolean
true if need to add separator character after output of referenceOrdinal

Should set current enum ordinal runnable to output the given referenceOrdinal if referenceFormat is not null the runnable is saved before this call and restored after so there is no need to save its value.

Note

if referenceFormat is null and the current runnable is not null then it should be run after output of default text and before output of referenceOrdinal, to make sure that parent compound ordinal formats are output.

needSeparator)

Implements com.vladsch.flexmark.ext.enumerated.reference.EnumeratedOrdinalRenderer.render.

Render individual reference format

public void
setEnumOrdinalRunnable(Runnable
runnable
runnable)

Implements com.vladsch.flexmark.ext.enumerated.reference.EnumeratedOrdinalRenderer.setEnumOrdinalRunnable.

Execute this runnable when empty enum text or link is encountered

public void
startRendering(EnumeratedReferenceRendering[]
renderings which will be rendered
renderings)

Implements com.vladsch.flexmark.ext.enumerated.reference.EnumeratedOrdinalRenderer.startRendering.

Start of rendering for all renderings

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

rendererback to summary
pack-priv final EnumRefTextCollectingVisitor renderer

Constructor Detail

OrdinalRendererback to summary
public OrdinalRenderer(EnumRefTextCollectingVisitor renderer)

Method Detail

endRenderingback to summary
public void endRendering()

Implements com.vladsch.flexmark.ext.enumerated.reference.EnumeratedOrdinalRenderer.endRendering.

Doc from com.vladsch.flexmark.ext.enumerated.reference.EnumeratedOrdinalRenderer.endRendering.

After Rendering is complete

Annotations
@Override
getEnumOrdinalRunnableback to summary
public Runnable getEnumOrdinalRunnable()

Implements com.vladsch.flexmark.ext.enumerated.reference.EnumeratedOrdinalRenderer.getEnumOrdinalRunnable.

Doc from com.vladsch.flexmark.ext.enumerated.reference.EnumeratedOrdinalRenderer.getEnumOrdinalRunnable.

Return current enum ordinal runnable, used to save previous state

Returns:Runnable

current empty enum runnable

Annotations
@Override
renderback to summary
public void render(int referenceOrdinal, EnumeratedReferenceBlock referenceFormat, String defaultText, boolean needSeparator)

Implements com.vladsch.flexmark.ext.enumerated.reference.EnumeratedOrdinalRenderer.render.

Doc from com.vladsch.flexmark.ext.enumerated.reference.EnumeratedOrdinalRenderer.render.

Render individual reference format

Parameters
referenceOrdinal:int

ordinal for the reference

referenceFormat:EnumeratedReferenceBlock

reference format or null

defaultText:String

default text to use if referenceFormat is null or not being used

needSeparator:boolean

true if need to add separator character after output of referenceOrdinal

Should set current enum ordinal runnable to output the given referenceOrdinal if referenceFormat is not null the runnable is saved before this call and restored after so there is no need to save its value.

Note

if referenceFormat is null and the current runnable is not null then it should be run after output of default text and before output of referenceOrdinal, to make sure that parent compound ordinal formats are output.

Annotations
@Override
setEnumOrdinalRunnableback to summary
public void setEnumOrdinalRunnable(Runnable runnable)

Implements com.vladsch.flexmark.ext.enumerated.reference.EnumeratedOrdinalRenderer.setEnumOrdinalRunnable.

Doc from com.vladsch.flexmark.ext.enumerated.reference.EnumeratedOrdinalRenderer.setEnumOrdinalRunnable.

Execute this runnable when empty enum text or link is encountered

Parameters
runnable:Runnable

runnable

Annotations
@Override
startRenderingback to summary
public void startRendering(EnumeratedReferenceRendering[] renderings)

Implements com.vladsch.flexmark.ext.enumerated.reference.EnumeratedOrdinalRenderer.startRendering.

Doc from com.vladsch.flexmark.ext.enumerated.reference.EnumeratedOrdinalRenderer.startRendering.

Start of rendering for all renderings

Parameters
renderings:EnumeratedReferenceRendering[]

renderings which will be rendered

Annotations
@Override