|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.confluence.renderer.UserMacroConfig
public class UserMacroConfig
Defines a user macro. This gets serialized by Bandana, so don't put any complex objects in it.
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 |
---|
@Deprecated public static final java.lang.String OUTPUT_TYPE_HTML
@Deprecated public static final java.lang.String OUTPUT_TYPE_WIKI
public static final java.lang.String BODY_TYPE_RAW
public static final java.lang.String BODY_TYPE_ESCAPE_HTML
public static final java.lang.String BODY_TYPE_RENDERED
public static final java.lang.String BODY_TYPE_NONE
Constructor Detail |
---|
public UserMacroConfig()
Method Detail |
---|
public java.lang.String getName()
public void setName(java.lang.String name)
public java.lang.String getTemplate()
public void setTemplate(java.lang.String template)
public boolean isHasBody()
public void setHasBody(boolean hasBody)
@Deprecated public java.lang.String getOutputType()
@Deprecated public void setOutputType(java.lang.String outputType)
outputType
- public java.lang.String getBodyType()
public void setBodyType(java.lang.String bodyType)
public java.lang.String getTitle()
public void setTitle(java.lang.String title)
public java.lang.String getDescription()
public void setDescription(java.lang.String description)
public java.util.Set<java.lang.String> getCategories()
public void setCategories(java.util.Set<java.lang.String> categories)
public java.lang.String getIconLocation()
public void setIconLocation(java.lang.String iconLocation)
public java.lang.String getDocumentationUrl()
public void setDocumentationUrl(java.lang.String documentationUrl)
public boolean isHidden()
public void setHidden(boolean hidden)
public java.util.List<MacroParameter> getParameters()
public void setParameters(java.util.List<MacroParameter> parameters)
public Macro toMacro()
public static Macro.BodyType deriveBodyType(UserMacroConfig config)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |