Package com.atlassian.confluence.macro.browser.beans

Class MacroBody

java.lang.Object

com.atlassian.confluence.macro.browser.beans.MacroBody

public class MacroBody
extends Object

Represents body metadata for a macro.

If the i18n properties file has values for Label and Description these will appear in the Macro Browser (for example) instead of the default text.

Constructor Summary

Constructors

Constructor	Description
MacroBody(String pluginKey, String macroName)
MacroBody(String pluginKey, String macroName, boolean hidden)

Method Summary

Modifier and Type	Method	Description
String	getBodyType()
Message	getDescription()
Message	getLabel()
boolean	isHidden()	Whether or not to display the macro body in the macro browser.
void	setBodyType(String bodyType)

Methods inherited from class java.lang.Object

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

Constructor Detail

MacroBody

public MacroBody(String pluginKey,
                 String macroName)

MacroBody

public MacroBody(String pluginKey,
                 String macroName,
                 boolean hidden)

Method Detail

getLabel

public Message getLabel()

getDescription

public Message getDescription()

isHidden

public boolean isHidden()

Whether or not to display the macro body in the macro browser.

getBodyType

public String getBodyType()

setBodyType

public void setBodyType(String bodyType)