com.atlassian.confluence.renderer.v2.macros
Class DocMacro

java.lang.Object
  com.atlassian.renderer.v2.macro.BaseMacro
      com.atlassian.confluence.renderer.v2.macros.DocMacro

All Implemented Interfaces:

com.atlassian.renderer.v2.macro.Macro

public class DocMacro
extends com.atlassian.renderer.v2.macro.BaseMacro

Field Summary

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

RAW_PARAMS_KEY

Constructor Summary

DocMacro()

Method Summary

java.lang.String	execute(java.util.Map parameters, java.lang.String body, com.atlassian.renderer.RenderContext renderContext)
com.atlassian.renderer.v2.RenderMode	getBodyRenderMode()
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

DocMacro

public DocMacro()

Method Detail

isInline

public boolean isInline()

hasBody

public boolean hasBody()

getBodyRenderMode

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

execute

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

Throws:

com.atlassian.renderer.v2.macro.MacroException

suppressSurroundingTagDuringWysiwygRendering

public boolean suppressSurroundingTagDuringWysiwygRendering()

Specified by:

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

Overrides:

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

suppressMacroRenderingDuringWysiwyg

public boolean suppressMacroRenderingDuringWysiwyg()

Specified by:

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

Overrides:

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