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:

com.atlassian.renderer.v2.macro.Macro

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

Designate a certain part of a page to be the "excerpt". The body contents of the macro will now be rendered to ensure consistency between page that has an excerpt and also other macros that include the excerpt content. (CONF-6342)

Note that the actual content property stored with the page will be wiki markup. Other macros that include the excerpt (such as the excerpt-include) will need to be render it with the correct context so that things like links, images etc.. are rendered and displayed correctly.

Field Summary

static java.lang.String

EXCERPT_KEY

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

RAW_PARAMS_KEY

Constructor Summary

ExcerptMacro()

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()
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 java.lang.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 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