com.atlassian.confluence.renderer
Class UserMacroConfig

java.lang.Object
  com.atlassian.confluence.renderer.UserMacroConfig

All Implemented Interfaces:

Serializable

public class UserMacroConfig

extends Object

implements Serializable

Defines a user macro. This gets serialized by Bandana, so don't put any complex objects in it.

See Also:

Serialized Form

Field Summary

static String	BODY_TYPE_ESCAPE_HTML
static String	BODY_TYPE_RAW
static String	BODY_TYPE_RENDERED
static String	OUTPUT_TYPE_HTML
static String	OUTPUT_TYPE_WIKI

Constructor Summary

UserMacroConfig()

Method Summary

String	getBodyType()
String	getName()
String	getOutputType()
String	getTemplate()
boolean	isHasBody()
void	setBodyType(String bodyType)
void	setHasBody(boolean hasBody)
void	setName(String name) Sets the name of the macro, converting to lower-case first.
void	setOutputType(String outputType)
void	setTemplate(String template)
Macro	toMacro()

Methods inherited from class java.lang.Object

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

Field Detail

OUTPUT_TYPE_HTML

public static final String OUTPUT_TYPE_HTML

See Also:

Constant Field Values

OUTPUT_TYPE_WIKI

public static final String OUTPUT_TYPE_WIKI

See Also:

Constant Field Values

BODY_TYPE_RAW

public static final String BODY_TYPE_RAW

See Also:

Constant Field Values

BODY_TYPE_ESCAPE_HTML

public static final String BODY_TYPE_ESCAPE_HTML

See Also:

Constant Field Values

BODY_TYPE_RENDERED

public static final String BODY_TYPE_RENDERED

See Also:

Constant Field Values

Constructor Detail

UserMacroConfig

public UserMacroConfig()

Method Detail

getName

public String getName()

Returns:

the name of the macro, always lower-case.

setName

public void setName(String name)

Sets the name of the macro, converting to lower-case first.

getTemplate

public String getTemplate()

setTemplate

public void setTemplate(String template)

isHasBody

public boolean isHasBody()

setHasBody

public void setHasBody(boolean hasBody)

getOutputType

public String getOutputType()

setOutputType

public void setOutputType(String outputType)

getBodyType

public String getBodyType()

setBodyType

public void setBodyType(String bodyType)

toMacro

public Macro toMacro()