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

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

All Implemented Interfaces:

com.atlassian.renderer.v2.macro.Macro

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

Macro to display a list of labels related to the page the macro is used on.

This macro has the optional 'labels' parameter, which allows the user to define a comma-separated list of labels whose related labels should be displayed.

Field Summary

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

RAW_PARAMS_KEY

Constructor Summary

RelatedLabelsMacro()

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	setLabelManager(LabelManager manager)

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

Constructor Detail

RelatedLabelsMacro

public RelatedLabelsMacro()

Method Detail

setLabelManager

public void setLabelManager(LabelManager manager)

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