com.atlassian.confluence.plugins.expand

Class ExpandV2Macro

java.lang.Object

com.atlassian.confluence.plugins.expand.ExpandV2Macro

All Implemented Interfaces:

com.atlassian.renderer.v2.macro.Macro

public class ExpandV2Macro
extends Object
implements com.atlassian.renderer.v2.macro.Macro

A v2 compatible Expand Macro for use within unmigrated wiki blocks. This delegates to the XHTML version of the ExpandMacro for execution.

Field Summary

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

RAW_PARAMS_KEY

Constructor Summary

Constructors

Constructor and Description
ExpandV2Macro(com.atlassian.sal.api.message.I18nResolver i18nResolver, com.atlassian.webresource.api.assembler.PageBuilderService pageBuilderService, com.atlassian.confluence.renderer.template.TemplateRenderer templateRenderer)

Method Summary

Modifier and Type	Method and Description
String	execute(Map parameters, String body, com.atlassian.renderer.RenderContext renderContext)
com.atlassian.renderer.v2.RenderMode	getBodyRenderMode()
com.atlassian.renderer.TokenType	getTokenType(Map parameters, String body, com.atlassian.renderer.RenderContext context)
com.atlassian.renderer.v2.macro.WysiwygBodyType	getWysiwygBodyType()
boolean	hasBody()
boolean	isInline()
boolean	suppressMacroRenderingDuringWysiwyg()
boolean	suppressSurroundingTagDuringWysiwygRendering()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExpandV2Macro

public ExpandV2Macro(com.atlassian.sal.api.message.I18nResolver i18nResolver,
                     com.atlassian.webresource.api.assembler.PageBuilderService pageBuilderService,
                     com.atlassian.confluence.renderer.template.TemplateRenderer templateRenderer)

Method Detail

getTokenType

public com.atlassian.renderer.TokenType getTokenType(Map parameters,
                                                     String body,
                                                     com.atlassian.renderer.RenderContext context)

Specified by:

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

isInline

public boolean isInline()

Specified by:

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

hasBody

public boolean hasBody()

Specified by:

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

getBodyRenderMode

public com.atlassian.renderer.v2.RenderMode getBodyRenderMode()

Specified by:

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

execute

public String execute(Map parameters,
                      String body,
                      com.atlassian.renderer.RenderContext renderContext)
               throws com.atlassian.renderer.v2.macro.MacroException

Specified by:

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

Throws:

com.atlassian.renderer.v2.macro.MacroException

suppressSurroundingTagDuringWysiwygRendering

public boolean suppressSurroundingTagDuringWysiwygRendering()

Specified by:

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

suppressMacroRenderingDuringWysiwyg

public boolean suppressMacroRenderingDuringWysiwyg()

Specified by:

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

getWysiwygBodyType

public com.atlassian.renderer.v2.macro.WysiwygBodyType getWysiwygBodyType()

Specified by:

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