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

java.lang.Object
  extended bycom.atlassian.renderer.v2.macro.BaseMacro
      extended bycom.atlassian.confluence.renderer.v2.macros.RelatedLabelsMacro
All Implemented Interfaces:
Macro

public class RelatedLabelsMacro
extends 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
 String execute(Map parameters, String body, RenderContext renderContext)
           
 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 RenderMode getBodyRenderMode()

execute

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


Confluence is developed by Atlassian.