Package de.espirit.firstspirit.agency

Interface RenderingAgent

public interface RenderingAgent

Agent to perform content rendering of FirstSpirit elements.

Example usage:

 IDProvider node = ..;
 String content = context.requireSpecialist(RenderingAgent.TYPE).createRenderer(node)
    .templateSet("html")
    .language("EN_US")
    .preview()
    .render();
 

Since:

5.2.1503

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RenderingAgent.BasicRenderResult	Rendering result.
static interface	RenderingAgent.MediaLinkListener	Listener which is called when a link to a media is generated.
static interface	RenderingAgent.Renderer	Node specific renderer, use RenderingAgent.Renderer.render() or RenderingAgent.Renderer.getResult() to get the rendered template output.
static interface	RenderingAgent.RendererWithoutLinkRoot	An intermediate instance which has to be enriched with a link root before further usage.
static enum	RenderingAgent.RenderMode	Rendering mode, either RenderingAgent.RenderMode.PREVIEW, RenderingAgent.RenderMode.WEBEDIT, or RenderingAgent.RenderMode.DEFAULT.
static interface	RenderingAgent.RenderResult	Rendering result.

Field Summary

Fields

Modifier and Type	Field	Description
static final SpecialistType<RenderingAgent>	TYPE	The agents technical type to be used to request the agent from a SpecialistsBroker.

Method Summary

Modifier and Type	Method	Description
@NotNull RenderingAgent.Renderer	createRenderer(@NotNull IDProvider node)	Create a content renderer for the provided node.
@NotNull RenderingAgent.RendererWithoutLinkRoot	createRenderer(@NotNull String templateSource)	Create a renderer for a template source string.

Field Details

TYPE

static final SpecialistType<RenderingAgent> TYPE

The agents technical type to be used to request the agent from a SpecialistsBroker.

Since:

5.2.1503

Method Details

createRenderer

@NotNull
@NotNull RenderingAgent.Renderer createRenderer(@NotNull
 @NotNull IDProvider node)

Create a content renderer for the provided node. Supported node types are Page, Section, PageRef, Dataset (including derived classes), parsed Media, and TemplateContentProvider like e.g. a FormatTemplate) (supported since version 5.2.1805).

Parameters:

node - Node to render.

Returns:

A new RenderingAgent.Renderer instance.

Since:

5.2.1503

createRenderer

@NotNull
@NotNull RenderingAgent.RendererWithoutLinkRoot createRenderer(@NotNull
 @NotNull String templateSource)
                                                        throws ParsingError

Create a renderer for a template source string.

Usage example:

     final String url = context.requireSpecialist(RenderingAgent.TYPE)
                .createRenderer("$CMS_REF(node)$")
                .linkRoot(pageRef)
                .additionalContext("node", node)
                .webedit()
                .render();
 

Returns:

A new intermediate renderer instance.

Throws:

ParsingError - If the provided template source isn't syntactical correct.

Since:

5.2.1805

See Also:

• RenderingAgent.RendererWithoutLinkRoot.linkRoot(Media)
• RenderingAgent.RendererWithoutLinkRoot.linkRoot(PageRef)