com.atlassian.confluence.macro.browser.beans
Class MacroFormDetails
java.lang.Object
com.atlassian.confluence.macro.browser.beans.MacroFormDetails
public class MacroFormDetails
- extends java.lang.Object
A Bean that encapsulates the detailed metadata of a macro.
This includes the macro paramater information, documentation links and notation help guide contents.
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
makeFreeformDetails
public static MacroFormDetails makeFreeformDetails(java.lang.String macroName,
com.atlassian.plugin.elements.ResourceDescriptor notationHelpResource)
makeParameterFormDetails
public static MacroFormDetails makeParameterFormDetails(java.lang.String macroName,
java.lang.String documentationUrl,
java.util.List<MacroParameter> parameters)
getMacroName
public java.lang.String getMacroName()
renderForDisplay
public 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.
- Parameters:
context
- the velocity context to render with
getNotationHelp
public java.lang.String getNotationHelp()
- Returns:
- the notation help as raw HTML. The
renderForDisplay(Context)
method must be called
before this.
getDocumentationUrl
public java.lang.String getDocumentationUrl()
- Returns:
- the url string to the macro's documentation, if available. Otherwise, null is returned.
setBody
public void setBody(MacroBody body)
getBody
public MacroBody getBody()
- Returns:
- true if the macro implementation of hasBody() returns true.
- See Also:
MacroMetadata.isBodyDeprecated()
isFreeform
public boolean isFreeform()
- Returns:
- true if the macro parameter information is not available.
getParameters
public java.util.List<MacroParameter> getParameters()
- Returns:
- a list of macro paramaters.
toString
public java.lang.String toString()
- Overrides:
toString
in class java.lang.Object
Copyright © 2003-2010 Atlassian. All Rights Reserved.