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

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

All Implemented Interfaces:

Macro

public class ExcerptMacro

extends BaseMacro

Designate a certain part of a page to be the "excerpt". Doesn't change the rendering of the page, but the excerpt is placed in the rendering context, so you can render a page to retrieve its excerpt.

Obviously, the extracted excerpt will be rendered up to the point where the macro filter kicks in, so if you then put it back in the page in another macro, the remainder of the rendering will draw it properly. This may not be what you want, and will cause problems if the excerpt itself contains macros.

The macro attempts to make sure an included page doesn't clobber the surrounding page's excerpt, but not very well.

Field Summary

static String

EXCERPT_KEY

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

RAW_PARAMS_KEY

Constructor Summary

ExcerptMacro()

Method Summary

String	execute(Map parameters, String body, RenderContext renderContext)
RenderMode	getBodyRenderMode()
boolean	hasBody()
boolean	isInline()
void	setContentPropertyManager(ContentPropertyManager contentPropertyManager)

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

suppressMacroRenderingDuringWysiwyg, suppressSurroundingTagDuringWysiwygRendering

Methods inherited from class java.lang.Object

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

Field Detail

EXCERPT_KEY

public static final String EXCERPT_KEY

See Also:

Constant Field Values

Constructor Detail

ExcerptMacro

public ExcerptMacro()

Method Detail

setContentPropertyManager

public void setContentPropertyManager(ContentPropertyManager contentPropertyManager)

isInline

public boolean isInline()

hasBody

public boolean hasBody()

getBodyRenderMode

public RenderMode getBodyRenderMode()

execute

public String execute(Map parameters,
                      String body,
                      RenderContext renderContext)
               throws MacroException

Throws:

MacroException