com.vladsch.flexmark.ext.enumerated.reference

Interface EnumeratedOrdinalRenderer

public interface EnumeratedOrdinalRenderer

Method Summary

Modifier and Type	Method and Description
void	endRendering() After Rendering is complete
Runnable	getEnumOrdinalRunnable() Return current enum ordinal runnable, used to save previous state
void	render(int referenceOrdinal, EnumeratedReferenceBlock referenceFormat, String defaultText, boolean needSeparator) Render individual reference format
void	setEnumOrdinalRunnable(Runnable runnable) Execute this runnable when empty enum text or link is encountered
void	startRendering(EnumeratedReferenceRendering[] renderings) Start of rendering for all renderings

Method Detail

startRendering

void startRendering(EnumeratedReferenceRendering[] renderings)

Start of rendering for all renderings

Parameters:

renderings - renderings which will be rendered

setEnumOrdinalRunnable

void setEnumOrdinalRunnable(Runnable runnable)

Execute this runnable when empty enum text or link is encountered

Parameters:

runnable - runnable

getEnumOrdinalRunnable

Runnable getEnumOrdinalRunnable()

Return current enum ordinal runnable, used to save previous state

Returns:

current empty enum runnable

render

void render(int referenceOrdinal,
            EnumeratedReferenceBlock referenceFormat,
            String defaultText,
            boolean needSeparator)

Render individual reference format

Parameters:

referenceOrdinal - ordinal for the reference

referenceFormat - reference format or null

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

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

endRendering

void endRendering()

After Rendering is complete