com.atlassian.confluence.renderer
Class UserMacroConfig

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

All Implemented Interfaces:

java.io.Serializable

public class UserMacroConfig
extends java.lang.Object
implements java.io.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 java.lang.String	BODY_TYPE_ESCAPE_HTML
static java.lang.String	BODY_TYPE_NONE
static java.lang.String	BODY_TYPE_RAW
static java.lang.String	BODY_TYPE_RENDERED
static java.lang.String	OUTPUT_TYPE_HTML Deprecated. since 4.0. There is only a single output type of HTML supported.
static java.lang.String	OUTPUT_TYPE_WIKI Deprecated. since 4.0. There is only a single output type of HTML supported beyond 4.0.

Constructor Summary

UserMacroConfig()

Method Summary

static Macro.BodyType	deriveBodyType(UserMacroConfig config)
java.lang.String	getBodyType()
java.util.Set<java.lang.String>	getCategories()
java.lang.String	getDescription()
java.lang.String	getDocumentationUrl()
java.lang.String	getIconLocation()
java.lang.String	getName()
java.lang.String	getOutputType() Deprecated. since 4.0. There will be only one output type of HTML beyond 4.0.
java.util.List<MacroParameter>	getParameters()
java.lang.String	getTemplate()
java.lang.String	getTitle()
boolean	isHasBody()
boolean	isHidden()
void	setBodyType(java.lang.String bodyType)
void	setCategories(java.util.Set<java.lang.String> categories)
void	setDescription(java.lang.String description)
void	setDocumentationUrl(java.lang.String documentationUrl)
void	setHasBody(boolean hasBody)
void	setHidden(boolean hidden)
void	setIconLocation(java.lang.String iconLocation)
void	setName(java.lang.String name) Sets the name of the macro, converting to lower-case first.
void	setOutputType(java.lang.String outputType) Deprecated. since 4.0. There will be only one output type of HTML beyond 4.0.
void	setParameters(java.util.List<MacroParameter> parameters)
void	setTemplate(java.lang.String template)
void	setTitle(java.lang.String title)
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

@Deprecated
public static final java.lang.String OUTPUT_TYPE_HTML

Deprecated. since 4.0. There is only a single output type of HTML supported.

See Also:

Constant Field Values

OUTPUT_TYPE_WIKI

@Deprecated
public static final java.lang.String OUTPUT_TYPE_WIKI

Deprecated. since 4.0. There is only a single output type of HTML supported beyond 4.0.

See Also:

Constant Field Values

BODY_TYPE_RAW

public static final java.lang.String BODY_TYPE_RAW

See Also:

Constant Field Values

BODY_TYPE_ESCAPE_HTML

public static final java.lang.String BODY_TYPE_ESCAPE_HTML

See Also:

Constant Field Values

BODY_TYPE_RENDERED

public static final java.lang.String BODY_TYPE_RENDERED

See Also:

Constant Field Values

BODY_TYPE_NONE

public static final java.lang.String BODY_TYPE_NONE

See Also:

Constant Field Values

Constructor Detail

UserMacroConfig

public UserMacroConfig()

Method Detail

getName

public java.lang.String getName()

Returns:

the name of the macro, always lower-case.

setName

public void setName(java.lang.String name)

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

getTemplate

public java.lang.String getTemplate()

setTemplate

public void setTemplate(java.lang.String template)

isHasBody

public boolean isHasBody()

setHasBody

public void setHasBody(boolean hasBody)

getOutputType

@Deprecated
public java.lang.String getOutputType()

Deprecated. since 4.0. There will be only one output type of HTML beyond 4.0.

setOutputType

@Deprecated
public void setOutputType(java.lang.String outputType)

Deprecated. since 4.0. There will be only one output type of HTML beyond 4.0.

Parameters:

outputType -

getBodyType

public java.lang.String getBodyType()

setBodyType

public void setBodyType(java.lang.String bodyType)

getTitle

public java.lang.String getTitle()

setTitle

public void setTitle(java.lang.String title)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getCategories

public java.util.Set<java.lang.String> getCategories()

setCategories

public void setCategories(java.util.Set<java.lang.String> categories)

getIconLocation

public java.lang.String getIconLocation()

setIconLocation

public void setIconLocation(java.lang.String iconLocation)

getDocumentationUrl

public java.lang.String getDocumentationUrl()

setDocumentationUrl

public void setDocumentationUrl(java.lang.String documentationUrl)

isHidden

public boolean isHidden()

setHidden

public void setHidden(boolean hidden)

getParameters

public java.util.List<MacroParameter> getParameters()

setParameters

public void setParameters(java.util.List<MacroParameter> parameters)

toMacro

public Macro toMacro()

deriveBodyType

public static Macro.BodyType deriveBodyType(UserMacroConfig config)