org.xwiki.rendering.macro.wikibridge
Interface WikiMacro

All Superinterfaces:

Comparable<org.xwiki.rendering.macro.Macro<?>>, org.xwiki.rendering.macro.Macro<WikiMacroParameters>

public interface WikiMacro
extends org.xwiki.rendering.macro.Macro<WikiMacroParameters>

Interface for defining wiki content based xwiki rendering macros.

Since:

2.0M2

Version:

$Id: cbce724763135ebb8ec2cfa31327717632bf1297 $

Method Summary

org.xwiki.model.reference.DocumentReference	getDocumentReference()
String	getId() Deprecated. since 2.3M1, use MacroDescriptor.getId() instead

Methods inherited from interface org.xwiki.rendering.macro.Macro

execute, getDescriptor, getPriority, supportsInlineMode

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getId

@Deprecated
String getId()

Deprecated. since 2.3M1, use MacroDescriptor.getId() instead

Returns:

the id under which this macro is registered with the component manager

getDocumentReference

org.xwiki.model.reference.DocumentReference getDocumentReference()

Returns:

the DocumentReference of the Wiki Macro

Since:

2.3M1