|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.confluence.macro.browser.beans.MacroFormDetails
public class MacroFormDetails
A Bean that encapsulates the detailed metadata of a macro. This includes the macro parameter information, documentation links and notation help guide contents.
Method Summary | |
---|---|
MacroBody |
getBody()
|
DocumentationLink |
getDocumentationLink()
|
java.lang.String |
getDocumentationUrl()
Deprecated. |
java.lang.String |
getMacroName()
|
java.lang.String |
getNotationHelp()
|
java.util.List<MacroParameter> |
getParameters()
|
boolean |
hasRequiredParameters()
|
boolean |
isFreeform()
|
boolean |
isShowDefaultParamInPlaceholder()
|
static MacroFormDetails |
makeFreeformDetails(java.lang.String macroName,
java.lang.String documentationUrl,
com.atlassian.plugin.elements.ResourceDescriptor notationHelpResource)
Deprecated. since 4.0 freeform macros are no longer supported |
static MacroFormDetails |
makeParameterFormDetails(java.lang.String macroName,
java.lang.String documentationUrl,
boolean showDefaultParamInPlaceholder,
java.util.List<MacroParameter> parameters)
|
static MacroFormDetails |
makeParameterFormDetails(java.lang.String macroName,
java.lang.String documentationUrl,
java.util.List<MacroParameter> parameters)
Deprecated. since 4.0 use makeParameterFormDetails(String, String, boolean, java.util.List) instead |
void |
renderForDisplay(org.apache.velocity.context.Context context)
This method should be called to render macro details before passing to the front end for display. |
void |
setBody(MacroBody body)
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
@Deprecated public static MacroFormDetails makeFreeformDetails(java.lang.String macroName, java.lang.String documentationUrl, com.atlassian.plugin.elements.ResourceDescriptor notationHelpResource)
@Deprecated public static MacroFormDetails makeParameterFormDetails(java.lang.String macroName, java.lang.String documentationUrl, java.util.List<MacroParameter> parameters)
makeParameterFormDetails(String, String, boolean, java.util.List)
instead
public static MacroFormDetails makeParameterFormDetails(java.lang.String macroName, java.lang.String documentationUrl, boolean showDefaultParamInPlaceholder, java.util.List<MacroParameter> parameters)
public java.lang.String getMacroName()
public void renderForDisplay(org.apache.velocity.context.Context context)
context
- the velocity context to render withpublic java.lang.String getNotationHelp()
renderForDisplay(Context)
method must be called
before this.@Deprecated public java.lang.String getDocumentationUrl()
getDocumentationLink()
instead.
public DocumentationLink getDocumentationLink()
public void setBody(MacroBody body)
public MacroBody getBody()
MacroMetadata.isBodyDeprecated()
public boolean isFreeform()
public boolean isShowDefaultParamInPlaceholder()
public java.util.List<MacroParameter> getParameters()
public boolean hasRequiredParameters()
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |