org.xwiki.rendering.macro.context

Class ContextMacroParameters

java.lang.Object

org.xwiki.rendering.macro.context.ContextMacroParameters

public class ContextMacroParameters
extends Object

Parameters for the Context macro.

Since:

3.0M1

Version:

$Id: 3aedb59d85349bb163439333d2746b3dbc0a910c $

Constructor Summary

Constructors

Constructor and Description
ContextMacroParameters()

Method Summary

Modifier and Type	Method and Description
String	getDocument()
TransformationContextMode	getTransformationContext()
void	setDocument(String documentReference)
void	setTransformationContext(TransformationContextMode mode)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContextMacroParameters

public ContextMacroParameters()

Method Detail

getDocument

public String getDocument()

Returns:

the reference to the document that will be set as the current document to evaluate the macro's content

setDocument

public void setDocument(String documentReference)

Parameters:

documentReference - refer to getDocument()

getTransformationContext

public TransformationContextMode getTransformationContext()

Returns:

the mode to use for setting the Transformation Context in which the Context Macro will execute, see TransformationContextMode for details

Since:

8.3, 8.4RC1

setTransformationContext

public void setTransformationContext(TransformationContextMode mode)

Parameters:

mode - refer to getTransformationContext()

Since:

8.3, 8.4RC1