senselogic.sitevision.api.render

Interface TextModuleRendererBuilder

All Superinterfaces:

Builder<TextModuleRenderer>

@Requireable(value="TextModuleRendererBuilder")
public interface TextModuleRendererBuilder
extends Builder<TextModuleRenderer>

Builder for creating a TextModuleRenderer instance.

TextModuleRendererBuilder has one mandatory attribute and one optional attribute:

• page (mandatory) - The page (sv:page, sv:article, sv:sitePage) where the Text modules to render resides. Must be non-null.
• rendererContext (optional) - Determines what context to use when Text modules of the page is rendered. Default is RendererContext.ORIGIN_PAGE.

Using the TextModuleRendererBuilder is pretty straightforward, if you remember that it is stateful. Conceptually you would typically use it like this:

1. Get the TextModuleRendererBuilder
2. Set the page
3. Do build

When you have built a TextModuleRenderer instance, you can re-use the TextModuleRendererBuilder to build more instances. Typically like:

1. Set the page
2. Do build

Tip! The Builder interface documentation contains more information about Builders and how to work with them and TextModuleRenderer has a code example of how this builder and its result can be used.

An instance of the Sitevision class implementing this interface can be obtained via RendererBuilderFactory.getTextModuleRendererBuilder(). See RendererBuilderFactory for how to obtain an instance of the RendererBuilderFactory interface.

Since:

Sitevision 7

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
TextModuleRenderer	build() Creates a TextModuleRenderer instance for the page of this builder.
TextModuleRendererBuilder	setPage(Node aPageNode) Sets the page of this builder.
TextModuleRendererBuilder	setRendererContext(RendererContext aRendererContext) Sets the renderer context to use when rendering content.

Method Detail

setPage

TextModuleRendererBuilder setPage(Node aPageNode)

Sets the page of this builder.

Parameters:

aPageNode - a page (sv:page, sv:article, sv:sitePage)

Returns:

this builder

setRendererContext

TextModuleRendererBuilder setRendererContext(RendererContext aRendererContext)

Sets the renderer context to use when rendering content.

If not set or set to null, the default renderer context (RendererContext.ORIGIN_PAGE) will be used.

Parameters:

aRendererContext - the render context

Returns:

this builder

Since:

Sitevision 2026.03.1

build

TextModuleRenderer build()
                  throws IllegalStateException

Creates a TextModuleRenderer instance for the page of this builder.

Specified by:

build in interface Builder<TextModuleRenderer>

Returns:

a Text module renderer instance

Throws:

IllegalStateException - if no valid page is set