senselogic.sitevision.api.render

Interface ContentRendererBuilder

All Superinterfaces:

Builder<ContentRenderer>

@Requireable(value="ContentRendererBuilder")
public interface ContentRendererBuilder
extends Builder<ContentRenderer>

Builder for creating a ContentRenderer instance.

ContentRendererBuilder has one mandatory attribute and one optional attribute:

• page (mandatory) - The page (sv:page, sv:article, sv:sitePage) where the content nodes to render resides. Must not be null and must not be "current page".
• parameters (optional) - A key/value map of page parameters to use when rendering the content nodes. May be null or empty.

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

1. Get the ContentRendererBuilder
2. Set the page
3. Potentially set the page parameters
4. Do build

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

1. Set the page
2. Potentially set the page parameters
3. 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.getContentRendererBuilder(). See RendererBuilderFactory for how to obtain an instance of the RendererBuilderFactory interface.

Since:

Sitevision 2026.01.1

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
ContentRenderer	build() Creates a ContentRenderer instance for the page of this builder.
ContentRendererBuilder	setPage(Node aPageNode) Sets the page of this builder.
ContentRendererBuilder	setParameters(Map<String,String> aParameters) Sets parameters for the page, to be used when rendering content.

Method Detail

setPage

ContentRendererBuilder setPage(Node aPageNode)

Sets the page of this builder.

Note! Due to security reasons (potential never-ending loops) it is prohibited to create a content renderer for the currently executing page (i.e. PortletContextUtil.getCurrentPage())!

Parameters:

aPageNode - a page node (sv:page, sv:article, sv:sitePage) where current user has READ permission, must not be null or "current page".

Returns:

this builder

setParameters

ContentRendererBuilder setParameters(Map<String,String> aParameters)

Sets parameters for the page, to be used when rendering content.

Parameters:

aParameters - a map of parameters

Returns:

this builder

build

ContentRenderer build()
               throws IllegalStateException

Creates a ContentRenderer instance for the page of this builder.

Specified by:

build in interface Builder<ContentRenderer>

Returns:

a content renderer instance

Throws:

IllegalStateException - if no page is set or if page is invalid (e.g. "current page")