public interface RenderingAgent
Example usage:
IDProvider
node = ..; String content = context.requireSpecialist(RenderingAgent.TYPE
).createRenderer(node) .templateSet
("html") .language
("EN_US") .preview()
.render();
Modifier and Type | Interface and Description |
---|---|
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 class |
RenderingAgent.RenderMode
Rendering mode, either
RenderingAgent.RenderMode.PREVIEW , RenderingAgent.RenderMode.WEBEDIT , or RenderingAgent.RenderMode.DEFAULT . |
static interface |
RenderingAgent.RenderResult
Rendering result.
|
Modifier and Type | Field and Description |
---|---|
static SpecialistType<RenderingAgent> |
TYPE
The agents technical type to be used to request the agent from a
SpecialistsBroker . |
Modifier and Type | Method and Description |
---|---|
RenderingAgent.Renderer |
createRenderer(IDProvider node)
Create a content renderer for the provided node.
|
RenderingAgent.RendererWithoutLinkRoot |
createRenderer(String templateSource)
Create a renderer for a template source string.
|
static final SpecialistType<RenderingAgent> TYPE
SpecialistsBroker
.@NotNull RenderingAgent.Renderer createRenderer(@NotNull IDProvider node)
Page
, Section
,
PageRef
, Dataset
(including derived classes), parsed
Media
, and TemplateContentProvider
like e.g. a FormatTemplate
) (supported
since version 5.2.1805).node
- Node to render.RenderingAgent.Renderer
instance.@NotNull RenderingAgent.RendererWithoutLinkRoot createRenderer(@NotNull String templateSource) throws ParsingError
Usage example:
final String url = context.requireSpecialist(RenderingAgent.TYPE)
.createRenderer("$CMS_REF(node)$")
.linkRoot(pageRef)
.additionalContext("node", node)
.webedit()
.render();
intermediate renderer
instance.ParsingError
- If the provided template source isn't syntactical correct.RenderingAgent.RendererWithoutLinkRoot.linkRoot(Media)
,
RenderingAgent.RendererWithoutLinkRoot.linkRoot(PageRef)
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210