com.atlassian.confluence.plugins.macros.advanced.xhtml

Class ExcerptMacro

java.lang.Object

com.atlassian.confluence.plugins.macros.advanced.xhtml.ExcerptMacro

All Implemented Interfaces:

Macro

public class ExcerptMacro
extends Object
implements Macro

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)

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.

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.confluence.macro.Macro

Macro.BodyType, Macro.OutputType

Field Summary

Fields

Modifier and Type	Field and Description
protected static Pattern	stripPattern

Constructor Summary

Constructors

Constructor and Description
ExcerptMacro()

Method Summary

Modifier and Type	Method and Description
String	execute(Map<String,String> parameters, String body, ConversionContext conversionContext)
Macro.BodyType	getBodyType() The type of body that this macro has, this is used to infer the migration task if no custom one is provided.
Macro.OutputType	getOutputType()

Methods inherited from class java.lang.Object

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

Field Detail

stripPattern

protected static Pattern stripPattern

Constructor Detail

ExcerptMacro

public ExcerptMacro()

Method Detail

execute

public String execute(Map<String,String> parameters,
                      String body,
                      ConversionContext conversionContext)
               throws MacroExecutionException

Specified by:

execute in interface Macro

Throws:

MacroExecutionException

getBodyType

public Macro.BodyType getBodyType()

Description copied from interface: Macro

The type of body that this macro has, this is used to infer the migration task if no custom one is provided.

Specified by:

getBodyType in interface Macro

Returns:

The type of body this macro has.

getOutputType

public Macro.OutputType getOutputType()

Specified by:

getOutputType in interface Macro