com.atlassian.confluence.plugins.macros.advanced

Class ExcerptMacro

java.lang.Object

com.atlassian.renderer.v2.macro.BaseMacro

com.atlassian.confluence.plugins.macros.advanced.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

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

RAW_PARAMS_KEY

Constructor Summary

Constructors

Constructor and Description
ExcerptMacro()

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)
boolean	hasBody()
boolean	isInline()

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

getWysiwygBodyType, suppressMacroRenderingDuringWysiwyg, suppressSurroundingTagDuringWysiwygRendering

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcerptMacro

public ExcerptMacro()

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

Overrides:

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

isInline

public boolean isInline()

Specified by:

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

Overrides:

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

hasBody

public boolean hasBody()

getBodyRenderMode

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

execute

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

Throws:

com.atlassian.renderer.v2.macro.MacroException