|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.xwiki.rendering.transformation.TransformationContext
public class TransformationContext
The context of the transformation process. Contains information such as the current XWiki DOM for the parsed content.
Constructor Summary | |
---|---|
TransformationContext()
Default constructor that doesn't set the XDOM or the Syntax. |
|
TransformationContext(XDOM xdom,
Syntax syntax)
Some macros require the XDOM and the Syntax to be set. |
|
TransformationContext(XDOM xdom,
Syntax syntax,
boolean restricted)
Some macros require the XDOM and the Syntax to be set. |
Method Summary | |
---|---|
TransformationContext |
clone()
|
String |
getId()
|
Syntax |
getSyntax()
|
XDOM |
getXDOM()
|
boolean |
isRestricted()
|
void |
setId(String id)
|
void |
setRestricted(boolean restricted)
|
void |
setSyntax(Syntax syntax)
|
void |
setXDOM(XDOM xdom)
|
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TransformationContext()
public TransformationContext(XDOM xdom, Syntax syntax)
xdom
- see setXDOM(org.xwiki.rendering.block.XDOM)
syntax
- see setSyntax(org.xwiki.rendering.syntax.Syntax)
public TransformationContext(XDOM xdom, Syntax syntax, boolean restricted)
xdom
- see setXDOM(org.xwiki.rendering.block.XDOM)
syntax
- see setSyntax(org.xwiki.rendering.syntax.Syntax)
restricted
- disables potentially harmful transformations.Method Detail |
---|
public String getId()
public void setId(String id)
id
- see getId()
public void setXDOM(XDOM xdom)
xdom
- the complete XDOM
of the content currently being transformed.public XDOM getXDOM()
XDOM
of the content currently being transformed.public void setSyntax(Syntax syntax)
syntax
- the current syntax.public Syntax getSyntax()
public boolean isRestricted()
public void setRestricted(boolean restricted)
restricted
- set indicator of whether the transformation context is restricted or not.public TransformationContext clone()
clone
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |