org.xwiki.rendering.internal.macro.context
Class ContextMacro

java.lang.Object
  org.xwiki.rendering.macro.AbstractMacro<ContextMacroParameters>
      org.xwiki.rendering.internal.macro.context.ContextMacro

All Implemented Interfaces:

java.lang.Comparable<org.xwiki.rendering.macro.Macro<?>>, org.xwiki.component.phase.Initializable, org.xwiki.rendering.macro.Macro<ContextMacroParameters>

@Component
@Named(value="context")
@Singleton
public class ContextMacro
extends org.xwiki.rendering.macro.AbstractMacro<ContextMacroParameters>

Execute the macro's content in the context of another document's reference.

Since:

3.0M1

Version:

$Id$

Field Summary

Fields inherited from class org.xwiki.rendering.macro.AbstractMacro

beanManager, DEFAULT_CATEGORY_CONTENT, DEFAULT_CATEGORY_DEVELOPMENT, DEFAULT_CATEGORY_FORMATTING, DEFAULT_CATEGORY_NAVIGATION

Constructor Summary

ContextMacro()
Create and initialize the descriptor of the macro.

Method Summary

java.util.List<org.xwiki.rendering.block.Block>	execute(ContextMacroParameters parameters, java.lang.String content, org.xwiki.rendering.transformation.MacroTransformationContext context)
boolean	supportsInlineMode()

Methods inherited from class org.xwiki.rendering.macro.AbstractMacro

compareTo, getDescriptor, getPriority, initialize, setDefaultCategory, setDescriptor, setPriority

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextMacro

public ContextMacro()

Create and initialize the descriptor of the macro.

Method Detail

supportsInlineMode

public boolean supportsInlineMode()

See Also:

Macro.supportsInlineMode()

execute

public java.util.List<org.xwiki.rendering.block.Block> execute(ContextMacroParameters parameters,
                                                               java.lang.String content,
                                                               org.xwiki.rendering.transformation.MacroTransformationContext context)
                                                        throws org.xwiki.rendering.macro.MacroExecutionException

Throws:

org.xwiki.rendering.macro.MacroExecutionException

See Also:

Macro.execute(Object, String, MacroTransformationContext)