org.xwiki.rendering.transformation

Interface RenderingContext

All Superinterfaces:

Cloneable

@Role
@Unstable
public interface RenderingContext
extends Cloneable

The context of the rendering engine during transformation.

Since:

6.0

Version:

$Id: 431a4d8dd0611a3a24dbe9ecf635ec13ec37154a $

Method Summary

Methods

Modifier and Type	Method and Description
Block	getCurrentBlock()
Syntax	getDefaultSyntax()
Syntax	getTargetSyntax()
Transformation	getTransformation()
String	getTransformationId()
XDOM	getXDOM()
boolean	isRestricted()

Method Detail

getXDOM

XDOM getXDOM()

Returns:

the complete XDOM of the content currently being transformed.

getCurrentBlock

Block getCurrentBlock()

Returns:

the current Block being processed by the transformation. Currently, on the macro transformation report here the currently processed macro block.

getDefaultSyntax

Syntax getDefaultSyntax()

Returns:

the default syntax to fallback on if not provided by a block, the XDOM or some other means.

isRestricted

boolean isRestricted()

Returns:

true if the current transformation is executed in a restricted context. In a restricted context, potentially insecure transformations should not be executed, like the html and scripts macros.

getTransformation

Transformation getTransformation()

Returns:

the current Transformation instance being executed. Useful for Macros which need to perform other transformations in turn such as the Include macro which needs to execute the transformation if the included page should be executed in its own context.

getTransformationId

String getTransformationId()

Returns:

an id representing the transformation being evaluated. It's a free form name that may be used to perform some caching based on a key. For example the Velocity Macro is using this id to pass it to the underlying Velocity Engine so that it caches macros using this key.

getTargetSyntax

Syntax getTargetSyntax()

Returns:

the syntax of the renderer that is going to be used, can be null if the renderer is unknown or if blocks are not being rendered (for example if the Rendering is used for parsing content)

Since:

6.2M1