com.atlassian.renderer.v2.macro
Class BaseMacro

java.lang.Object
  com.atlassian.renderer.v2.macro.BaseMacro

All Implemented Interfaces:

Macro

Direct Known Subclasses:

AbstractPanelMacro, BasicAnchorMacro, ColorMacro, InlineHtmlMacro, LoremIpsumMacro, QuoteMacro, RadeoxCompatibilityMacro, ResourceAwareMacroDecorator

public abstract class BaseMacro
extends java.lang.Object
implements Macro

Field Summary

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

RAW_PARAMS_KEY

Constructor Summary

BaseMacro()

Method Summary

boolean	suppressMacroRenderingDuringWysiwyg() Suppress the rendering of the macro -- the macro's body may still be rendered (depending on the render mode of the macro), but the HTML the macro adds will not be created.
boolean	suppressSurroundingTagDuringWysiwygRendering() Suppress surrounding div/span during Wysiwyg rendering.

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

execute, getBodyRenderMode, hasBody, isInline

Constructor Detail

BaseMacro

public BaseMacro()

Method Detail

suppressSurroundingTagDuringWysiwygRendering

public boolean suppressSurroundingTagDuringWysiwygRendering()

Description copied from interface: Macro

Suppress surrounding div/span during Wysiwyg rendering. This should return true if the macro provides it's own Wysiwyg processing HTML.

Specified by:

suppressSurroundingTagDuringWysiwygRendering in interface Macro

suppressMacroRenderingDuringWysiwyg

public boolean suppressMacroRenderingDuringWysiwyg()

Description copied from interface: Macro

Suppress the rendering of the macro -- the macro's body may still be rendered (depending on the render mode of the macro), but the HTML the macro adds will not be created.

Specified by:

suppressMacroRenderingDuringWysiwyg in interface Macro

Returns: