org.randombits.support.confluence.legacy

Class LegacyConfluenceMacro

java.lang.Object

com.atlassian.renderer.v2.macro.BaseMacro

org.randombits.support.confluence.legacy.LegacyConfluenceMacro

All Implemented Interfaces:

com.atlassian.renderer.v2.macro.Macro

public abstract class LegacyConfluenceMacro
extends com.atlassian.renderer.v2.macro.BaseMacro

A legacy macro adapter which rewires the old BaseMacro calls to the new com.atlassian.confluence.macro.Macro interface calls, to create an adapter for your macro, you can extend this and implement the getXHtmlMacro() method and getBodyRenderMode() methods as appropriate, the actual logic and functionality will be delegated to the new macro style.

Author:

Bo Wang

Field Summary

Fields inherited from interface com.atlassian.renderer.v2.macro.Macro

RAW_PARAMS_KEY

Constructor Summary

Constructors

Constructor and Description
LegacyConfluenceMacro()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	execute(java.util.Map params, java.lang.String body, com.atlassian.renderer.RenderContext renderContext)
protected abstract com.atlassian.confluence.macro.Macro	getXHtmlMacro()
boolean	hasBody()
boolean	isInline()

Methods inherited from class com.atlassian.renderer.v2.macro.BaseMacro

getTokenType, getWysiwygBodyType, suppressMacroRenderingDuringWysiwyg, suppressSurroundingTagDuringWysiwygRendering

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.renderer.v2.macro.Macro

getBodyRenderMode

Constructor Detail

LegacyConfluenceMacro

public LegacyConfluenceMacro()

Method Detail

getXHtmlMacro

protected abstract com.atlassian.confluence.macro.Macro getXHtmlMacro()

hasBody

public boolean hasBody()

isInline

public boolean isInline()

Specified by:

isInline in interface com.atlassian.renderer.v2.macro.Macro

Overrides:

isInline in class com.atlassian.renderer.v2.macro.BaseMacro

execute

public java.lang.String execute(java.util.Map params,
                       java.lang.String body,
                       com.atlassian.renderer.RenderContext renderContext)
                         throws com.atlassian.renderer.v2.macro.MacroException

Throws:

com.atlassian.renderer.v2.macro.MacroException