Package com.vladsch.flexmark.formatter

Class Formatter.Builder

  • All Implemented Interfaces:
    com.vladsch.flexmark.util.data.DataHolder, com.vladsch.flexmark.util.data.MutableDataHolder, com.vladsch.flexmark.util.data.MutableDataSetter
    Enclosing class:
    Formatter
    public static class Formatter.Builder
extends com.vladsch.flexmark.util.builder.BuilderBase<Formatter.Builder>
    Builder for configuring an Formatter. See methods for default configuration.

    • Field Summary

      • Fields inherited from class com.vladsch.flexmark.util.data.DataSet

        dataSet

      • Fields inherited from interface com.vladsch.flexmark.util.data.DataHolder

        NULL

    • Constructor Summary

      Constructors 
      Constructor Description
      Builder()  
      Builder​(com.vladsch.flexmark.util.data.DataHolder options)  

    • Constructor Detail

      • Builder

        public Builder()

      • Builder

        public Builder​(com.vladsch.flexmark.util.data.DataHolder options)

    • Method Detail

      • build

        @NotNull
public @NotNull Formatter build()
        Specified by:
        build in class com.vladsch.flexmark.util.builder.BuilderBase<Formatter.Builder>
        Returns:
        the configured Formatter

      • removeApiPoint

        protected void removeApiPoint​(@NotNull
                              @NotNull Object apiPoint)
        Specified by:
        removeApiPoint in class com.vladsch.flexmark.util.builder.BuilderBase<Formatter.Builder>

      • preloadExtension

        protected void preloadExtension​(@NotNull
                                @NotNull com.vladsch.flexmark.util.misc.Extension extension)
        Specified by:
        preloadExtension in class com.vladsch.flexmark.util.builder.BuilderBase<Formatter.Builder>

      • loadExtension

        protected boolean loadExtension​(@NotNull
                                @NotNull com.vladsch.flexmark.util.misc.Extension extension)
        Specified by:
        loadExtension in class com.vladsch.flexmark.util.builder.BuilderBase<Formatter.Builder>

      • nodeFormatterFactory

        public Formatter.Builder nodeFormatterFactory​(NodeFormatterFactory nodeFormatterFactory)
        Add a factory for instantiating a node renderer (done when rendering). This allows to override the rendering of node types or define rendering for custom node types.

        If multiple node renderers for the same node type are created, the one from the factory that was added first "wins". (This is how the rendering for core node types can be overridden; the default rendering comes last.)

        Parameters:
        nodeFormatterFactory - the factory for creating a node renderer
        Returns:
        this

      • htmlIdGeneratorFactory

        @NotNull
public @NotNull Formatter.Builder htmlIdGeneratorFactory​(@NotNull
                                                         @NotNull HeaderIdGeneratorFactory htmlIdGeneratorFactory)
        Add a factory for generating the header id attribute from the header's text
        Parameters:
        htmlIdGeneratorFactory - the factory for generating header tag id attributes
        Returns:
        this

      • linkResolverFactory

        @NotNull
public @NotNull Formatter.Builder linkResolverFactory​(@NotNull
                                                      @NotNull LinkResolverFactory linkResolverFactory)
        Add a factory for instantiating a node renderer (done when rendering). This allows to override the rendering of node types or define rendering for custom node types.

        If multiple node renderers for the same node type are created, the one from the factory that was added first "wins". (This is how the rendering for core node types can be overridden; the default rendering comes last.)

        Parameters:
        linkResolverFactory - the factory for creating a node renderer
        Returns:
        this