Top Methods
com.vladsch.flexmark.ext.enumerated.reference

public Interface EnumeratedOrdinalRenderer

Known Direct Implementers
com.vladsch.flexmark.ext.enumerated.reference.internal.EnumeratedReferenceNodeRenderer.OrdinalRenderer, com.vladsch.flexmark.ext.enumerated.reference.internal.EnumRefTextCollectingVisitor.OrdinalRenderer

Method Summary

Modifier and TypeMethod and Description
public void
endRendering()

After Rendering is complete

public Runnable

Returns:

current empty enum runnable
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
)

Render individual reference format

public void
setEnumOrdinalRunnable(Runnable
runnable
runnable
)

Execute this runnable when empty enum text or link is encountered

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

Start of rendering for all renderings

Method Detail

endRenderingback to summary
public void endRendering()

After Rendering is complete

getEnumOrdinalRunnableback to summary
public Runnable getEnumOrdinalRunnable()

Return current enum ordinal runnable, used to save previous state

Returns:Runnable

current empty enum runnable

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

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.

setEnumOrdinalRunnableback to summary
public void setEnumOrdinalRunnable(Runnable runnable)

Execute this runnable when empty enum text or link is encountered

Parameters
runnable:Runnable

runnable

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

Start of rendering for all renderings

Parameters
renderings:EnumeratedReferenceRendering[]

renderings which will be rendered