Package 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: ac2807764e4ce4815f90440d927eca1800430690 $

Constructor Summary

Constructors

Constructor	Description
ContextMacroParameters()

Method Summary

Modifier and Type	Method	Description
String	getDocument()
org.xwiki.rendering.macro.source.MacroContentSourceReference	getSource()
TransformationContextMode	getTransformationContext()
boolean	isRestricted()
void	setDocument(String documentReference)
void	setRestricted(boolean restricted)
void	setSource(org.xwiki.rendering.macro.source.MacroContentSourceReference source)
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

isRestricted

public boolean isRestricted()

Returns:

true if the content should be executed in a restricted context

Since:

14.10.4, 15.0, 15.1RC1

setRestricted

public void setRestricted(boolean restricted)

Parameters:

restricted - true if the content should be executed in a restricted context

Since:

14.10.4, 15.0, 15.1RC1

setSource

public void setSource(org.xwiki.rendering.macro.source.MacroContentSourceReference source)

Parameters:

source - the reference of the content to parse

Since:

15.1RC1, 14.10.5

getSource

public org.xwiki.rendering.macro.source.MacroContentSourceReference getSource()

Returns:

the reference of the content to parse

Since:

15.1RC1, 14.10.5