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
Fields Modifier and Type Field Description static String
BODY_TYPE_ESCAPE_HTML
static String
BODY_TYPE_NONE
static String
BODY_TYPE_RAW
static String
BODY_TYPE_RENDERED
static String
OUTPUT_TYPE_HTML
Deprecated.since 4.0.static String
OUTPUT_TYPE_WIKI
Deprecated.since 4.0.static String
VISIBLE_ADMINS_ONLY
static String
VISIBLE_ALL_USERS
-
Constructor Summary
Constructors Constructor Description UserMacroConfig()
-
Method Summary
-
-
-
Field Detail
-
OUTPUT_TYPE_HTML
@Deprecated public static final 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 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
-
VISIBLE_ALL_USERS
public static final String VISIBLE_ALL_USERS
- See Also:
- Constant Field Values
-
VISIBLE_ADMINS_ONLY
public static final String VISIBLE_ADMINS_ONLY
- 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
-
BODY_TYPE_NONE
public static final String BODY_TYPE_NONE
- See Also:
- Constant Field Values
-
-
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
@Deprecated public String getOutputType()
Deprecated.since 4.0. There will be only one output type of HTML beyond 4.0.
-
setOutputType
@Deprecated public void setOutputType(String outputType)
Deprecated.since 4.0. There will be only one output type of HTML beyond 4.0.- Parameters:
outputType
-
-
getBodyType
public String getBodyType()
-
setBodyType
public void setBodyType(String bodyType)
-
getTitle
public String getTitle()
-
setTitle
public void setTitle(String title)
-
getDescription
public String getDescription()
-
setDescription
public void setDescription(String description)
-
getIconLocation
public String getIconLocation()
-
setIconLocation
public void setIconLocation(String iconLocation)
-
getDocumentationUrl
public String getDocumentationUrl()
-
setDocumentationUrl
public void setDocumentationUrl(String documentationUrl)
-
isHidden
public boolean isHidden()
-
setHidden
public void setHidden(boolean hidden)
-
getParameters
public List<MacroParameter> getParameters()
-
setParameters
public void setParameters(List<MacroParameter> parameters)
-
toMacro
public Macro toMacro()
-
deriveBodyType
public static Macro.BodyType deriveBodyType(UserMacroConfig config)
-
-