senselogic.sitevision.api.render

Enum RendererContext

Object

Enum<RendererContext>

senselogic.sitevision.api.render.RendererContext

All Implemented Interfaces:

Serializable, Comparable<RendererContext>

@Requireable(value="RendererContext")
public enum RendererContext
extends Enum<RendererContext>

Render context determines which page to use as context when rendering page content.

Using proper rendering context is important to get the expected output when rendering page content dynamically. This applies to all functions that use ContentRenderer or TextModuleRenderer to render output.

Page content modules that in any way are contextual (e.g. "prints name of current page") will produce unexpected output if the rendering context is not properly specified.

• Use ORIGIN_PAGE when you want the content to be rendered as it would be on the page where the content part actually resides.
• Use CURRENT_PAGE when you want the content to be rendered as it would be if the content part resided on the page that is currently rendering.

Since:

Sitevision 2026.03.1

Author:

Magnus Lövgren

Enum Constant Summary

Enum Constants

Enum Constant and Description
CURRENT_PAGE Will use the current page as context, i.e. the page that is currently being rendered.
ORIGIN_PAGE Will use the page that is the origin of the content being rendered as context.

Method Summary

Modifier and Type	Method and Description
static RendererContext	valueOf(String name) Returns the enum constant of this type with the specified name.
static RendererContext[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ORIGIN_PAGE

@Requireable(value="RendererContext.ORIGIN_PAGE")
public static final RendererContext ORIGIN_PAGE

Will use the page that is the origin of the content being rendered as context.

Conceptually ~ "I want the content output as-is, as I can see it on the original page where the content part actually resides".

CURRENT_PAGE

@Requireable(value="RendererContext.CURRENT_PAGE")
public static final RendererContext CURRENT_PAGE

Will use the current page as context, i.e. the page that is currently being rendered.

Conceptually ~ "I want the content output as it would be if the content part resided on the page that is currently rendering".

Method Detail

values

public static RendererContext[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RendererContext c : RendererContext.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RendererContext valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null