public static interface RenderingAgent.Renderer
render()
or getResult()
to get the rendered template output. All
other methods support fluent chaining. If you call a specific method twice, the value provided in the first call
is lost.Modifier and Type | Method and Description |
---|---|
RenderingAgent.Renderer |
additionalContext(Map<String,?> additionalContext)
Adds the provided values to the topmost context.
|
RenderingAgent.Renderer |
additionalContext(String key,
Object value)
Adds the provided value to the top-most context.
|
RenderingAgent.Renderer |
context(PageRef pageRef)
Set the provided page reference as context (e.g. to provide the sitestore variables in the rendering context).
|
RenderingAgent.Renderer |
context(SiteStoreFolder folder)
Set the provided folder as context (e.g. to provide the sitestore variables in the rendering context).
|
RenderingAgent.Renderer |
dataset(Dataset dataset)
Provide a dataset to be used for a content projection.
|
RenderingAgent.Renderer |
datasetIdentifier(Identifier identifier)
Provide a dataset to be used for a content projection (e.g. detail view, one entity per page).
|
RenderingAgent.Renderer |
evaluateProjectProperties(boolean value)
Switch flag if the
ProjectProperties should be evaluated when rendering content . |
RenderingAgent.RenderResult |
getResult()
Trigger the rendering of the node and delivers the rendering result.
|
RenderingAgent.Renderer |
language(Language language)
Overwrite which language should be used for rendering - default language is the project master language.
|
RenderingAgent.Renderer |
language(String abbreviation)
Overwrite which language should be used for rendering - default language is the project master language.
|
RenderingAgent.Renderer |
logListener(LogListener logListener)
Provide the listener for log events during rendering.
|
RenderingAgent.Renderer |
mediaLinkListener(RenderingAgent.MediaLinkListener mediaLinkListener)
Provide the listener for media link events during rendering.
|
RenderingAgent.Renderer |
mode(RenderingAgent.RenderMode mode)
Set the desired
render mode . |
RenderingAgent.Renderer |
pageIndex(int index)
Provide the sub-page index for content projections.
|
RenderingAgent.Renderer |
preview()
Shortcut for
mode (PREVIEW ). |
RenderingAgent.Renderer |
redirectTemplateLogToDefaultLog()
Redirect template logging to default log.
|
String |
render()
Trigger the rendering of the node and delivers the rendered output.
|
RenderingAgent.Renderer |
skipProjectProperties()
Switch off
ProjectProperties evaluation when rendering content . |
RenderingAgent.Renderer |
strict()
Shortcut for
mode (STRICT ). |
RenderingAgent.Renderer |
templateSet(String templateSetUid)
Overwrite which template set should be used for rendering - default template set is the first template set of
the project.
|
RenderingAgent.Renderer |
templateSet(TemplateSet templateSet)
Overwrite which template set should be used for rendering - default template set is the first template set of
the project.
|
RenderingAgent.Renderer |
urlFactory(String publicName)
Set a custom url factory (default is the preview url factory).
|
RenderingAgent.Renderer |
urlFactory(UrlFactory urlFactory)
Set a custom url factory (default is the preview url factory).
|
RenderingAgent.Renderer |
urlFactorySettings(Map<String,String> urlFactorySettings)
Set custom initialization parameters (will be passed to
UrlFactory.init(Map, PathLookup) of the
configured url factory). |
RenderingAgent.Renderer |
urlPrefix(String urlPrefix)
Set the url prefix used for absolute urls generated with
$CMS_REF(..., abs:1)$ . |
RenderingAgent.Renderer |
webedit()
Shortcut for
mode (WEBEDIT ). |
@NotNull RenderingAgent.Renderer language(@NotNull Language language)
language(Language)
@NotNull RenderingAgent.Renderer language(@NotNull String abbreviation)
language(Language)
@NotNull RenderingAgent.Renderer templateSet(@NotNull TemplateSet templateSet)
templateSet(String)
@NotNull RenderingAgent.Renderer templateSet(@NotNull String templateSetUid)
templateSet(TemplateSet)
@NotNull RenderingAgent.Renderer context(@NotNull SiteStoreFolder folder)
folder
- Folder node to determine variables from.@NotNull RenderingAgent.Renderer context(@NotNull PageRef pageRef)
pageRef
- Page reference node to determine variables from.@NotNull RenderingAgent.Renderer additionalContext(@NotNull Map<String,?> additionalContext)
additionalContext
- Sets the provided values as top-most context.@NotNull RenderingAgent.Renderer additionalContext(@NotNull String key, @Nullable Object value)
key
- Variable name.value
- Variable value.@NotNull RenderingAgent.Renderer preview()
mode
(PREVIEW
).@NotNull RenderingAgent.Renderer webedit()
mode
(WEBEDIT
).@NotNull RenderingAgent.Renderer strict()
mode
(STRICT
). See the
description of the enum value for a detailed description.@NotNull RenderingAgent.Renderer mode(@NotNull RenderingAgent.RenderMode mode)
render mode
.mode
- Rendering mode, either RenderingAgent.RenderMode.PREVIEW
, RenderingAgent.RenderMode.WEBEDIT
,
RenderingAgent.RenderMode.DEFAULT
, or RenderingAgent.RenderMode.STRICT
.@NotNull RenderingAgent.Renderer urlFactory(@NotNull UrlFactory urlFactory)
urlFactory
- An url factory instance.urlFactory(String)
,
urlFactorySettings(Map)
@NotNull RenderingAgent.Renderer urlFactory(@NotNull String publicName)
publicName
- The public name of an url factory instance which will be used for $CMS_REF(..)$
expressions during renderingurlFactory(String)
,
urlFactorySettings(Map)
@NotNull RenderingAgent.Renderer urlFactorySettings(@NotNull Map<String,String> urlFactorySettings)
UrlFactory.init(Map, PathLookup)
of the
configured url factory).urlFactorySettings
- Initialization parameters for the url factory.urlFactory(String)
,
urlFactory(UrlFactory)
@NotNull RenderingAgent.Renderer urlPrefix(@NotNull String urlPrefix)
$CMS_REF(..., abs:1)$
. A full qualified or
a path may be provided. The leading slash when providing a path could be omitted.urlPrefix
- Full qualified prefix.@NotNull RenderingAgent.Renderer logListener(@NotNull LogListener logListener)
logListener
- Listener which will be called for log events during rendering.redirectTemplateLogToDefaultLog()
@NotNull RenderingAgent.Renderer redirectTemplateLogToDefaultLog()
#global.logInfo("message text")
.logListener(LogListener)
@NotNull RenderingAgent.Renderer mediaLinkListener(@NotNull RenderingAgent.MediaLinkListener mediaLinkListener)
mediaLinkListener
- the listener to call for each linked media.@NotNull RenderingAgent.Renderer dataset(@NotNull Dataset dataset)
dataset
- the dataset to render for content projections.datasetIdentifier(Identifier)
,
pageIndex(int)
@NotNull RenderingAgent.Renderer datasetIdentifier(@NotNull Identifier identifier)
identifier
- the identifier of the dataset to render for content projections.dataset(Dataset)
,
pageIndex(int)
@NotNull RenderingAgent.Renderer pageIndex(int index)
0
and
Content2Params.getPageCount(Language)
.index
- the index of the sub-page to render.dataset(Dataset)
,
datasetIdentifier(Identifier)
@NotNull RenderingAgent.Renderer evaluateProjectProperties(boolean value)
ProjectProperties
should be evaluated when rendering content
.
The default behaviour is that the project properties are evaluated (true
).value
- New value, the default value is true
.skipProjectProperties()
@NotNull RenderingAgent.Renderer skipProjectProperties()
ProjectProperties
evaluation when rendering content
. This is the same
as evaluateProjectProperties(false)
.
The default behaviour is that the project properties are evaluated.evaluateProjectProperties(boolean)
@NotNull String render()
getResult()
.getContent()
.getResult()
@NotNull RenderingAgent.RenderResult getResult()
RenderingAgent.RenderResult.getContent()
() content} and
log
.Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210