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

public Class EnumeratedReferenceNodeRenderer

extends Object
implements PhasedNodeRenderer
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.html.renderer.PhasedNodeRenderer, com.vladsch.flexmark.html.renderer.NodeRenderer
Imports
com.vladsch.flexmark.ast.Heading, com.vladsch.flexmark.ext.enumerated.reference.*, com.vladsch.flexmark.html.HtmlWriter, com.vladsch.flexmark.html.renderer.*, com.vladsch.flexmark.util.ast.Document, .Node, com.vladsch.flexmark.util.data.DataHolder, org.jetbrains.annotations.NotNull, java.util.HashSet, .LinkedHashSet, .Set

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
private static class

Field Summary

Modifier and TypeField and Description
private EnumeratedReferences
private final HtmlIdGenerator
private final EnumeratedReferenceOptions
private Runnable

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Set<NodeRenderingHandler<?>>
public Set<RenderingPhase>
private void
private void
public void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

enumeratedOrdinalsback to summary
private EnumeratedReferences enumeratedOrdinals
headerIdGeneratorback to summary
private final HtmlIdGenerator headerIdGenerator
optionsback to summary
private final EnumeratedReferenceOptions options
ordinalRunnableback to summary
private Runnable ordinalRunnable

Constructor Detail

EnumeratedReferenceNodeRendererback to summary
public EnumeratedReferenceNodeRenderer(DataHolder options)

Method Detail

getNodeRenderingHandlersback to summary
public Set<NodeRenderingHandler<?>> getNodeRenderingHandlers()

Implements com.vladsch.flexmark.html.renderer.NodeRenderer.getNodeRenderingHandlers.

Returns:Set<NodeRenderingHandler<?>>

Doc from com.vladsch.flexmark.html.renderer.NodeRenderer.getNodeRenderingHandlers.

the mapping of nodes this renderer handles to rendering function

Annotations
@Override
getRenderingPhasesback to summary
public Set<RenderingPhase> getRenderingPhases()

Implements com.vladsch.flexmark.html.renderer.PhasedNodeRenderer.getRenderingPhases.

Annotations
@Override
renderback to summary
private void render(EnumeratedReferenceText node, NodeRendererContext context, HtmlWriter html)
renderback to summary
private void render(EnumeratedReferenceBlock node, NodeRendererContext context, HtmlWriter html)
renderDocumentback to summary
public void renderDocument(@NotNull NodeRendererContext context, @NotNull HtmlWriter html, @NotNull Document document, @NotNull RenderingPhase phase)
Annotations
@Override
com.vladsch.flexmark.ext.enumerated.reference.internal back to summary

public Class EnumeratedReferenceNodeRenderer.Factory

extends Object
implements NodeRendererFactory
Class Inheritance
  • java.lang.Object
  • com.vladsch.flexmark.ext.enumerated.reference.internal.EnumeratedReferenceNodeRenderer.Factory
All Implemented Interfaces
com.vladsch.flexmark.html.renderer.NodeRendererFactory, java.util.function.Function

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public @NotNull NodeRenderer
apply(@NotNull DataHolder
the function argument
options
)

Implements java.util.function.Function.apply.

Applies this function to the given argument.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

applyback to summary
public @NotNull NodeRenderer apply(@NotNull DataHolder options)

Implements java.util.function.Function.apply.

Doc from java.util.function.Function.apply.

Applies this function to the given argument.

Parameters
options:@NotNull DataHolder

the function argument

Returns:@NotNull NodeRenderer

the function result

Annotations
@NotNull
@Override
com.vladsch.flexmark.ext.enumerated.reference.internal back to summary

private Class EnumeratedReferenceNodeRenderer.OrdinalRenderer

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

Field Summary

Modifier and TypeField and Description
pack-priv final NodeRendererContext
pack-priv final HtmlWriter
pack-priv final EnumeratedReferenceNodeRenderer

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
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

contextback to summary
pack-priv final NodeRendererContext context
htmlback to summary
pack-priv final HtmlWriter html
rendererback to summary
pack-priv final EnumeratedReferenceNodeRenderer renderer

Constructor Detail

OrdinalRendererback to summary
public OrdinalRenderer(EnumeratedReferenceNodeRenderer renderer, NodeRendererContext context, HtmlWriter html)

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