public class

MacroFormDetails

extends Object
java.lang.Object
   ↳ com.atlassian.confluence.macro.browser.beans.MacroFormDetails

Class Overview

A Bean that encapsulates the detailed metadata of a macro. This includes the macro parameter information, documentation links and notation help guide contents.

Summary

Public Methods
MacroBody getBody()
String getDocumentationUrl()
String getMacroName()
String getNotationHelp()
List<MacroParameter> getParameters()
boolean isFreeform()
boolean isShowDefaultParamInPlaceholder()
@Deprecated static MacroFormDetails makeFreeformDetails(String macroName, String documentationUrl, ResourceDescriptor notationHelpResource)
This method is deprecated. since 4.0 freeform macros are no longer supported
@Deprecated static MacroFormDetails makeParameterFormDetails(String macroName, String documentationUrl, List<MacroParameter> parameters)
This method is deprecated. since 4.0 use makeParameterFormDetails(String, String, boolean, java.util.List) instead
static MacroFormDetails makeParameterFormDetails(String macroName, String documentationUrl, boolean showDefaultParamInPlaceholder, List<MacroParameter> parameters)
void renderForDisplay(Context context)
This method should be called to render macro details before passing to the front end for display.
void setBody(MacroBody body)
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public MacroBody getBody ()

Returns
  • true if the macro implementation of hasBody() returns true.

public String getDocumentationUrl ()

Returns
  • the url string to the macro's documentation, if available. Otherwise, null is returned.

public String getMacroName ()

public String getNotationHelp ()

Returns

public List<MacroParameter> getParameters ()

Returns
  • a list of macro paramaters.

public boolean isFreeform ()

Returns
  • true if the macro parameter information is not available.

public boolean isShowDefaultParamInPlaceholder ()

@Deprecated public static MacroFormDetails makeFreeformDetails (String macroName, String documentationUrl, ResourceDescriptor notationHelpResource)

This method is deprecated.
since 4.0 freeform macros are no longer supported

@Deprecated public static MacroFormDetails makeParameterFormDetails (String macroName, String documentationUrl, List<MacroParameter> parameters)

This method is deprecated.
since 4.0 use makeParameterFormDetails(String, String, boolean, java.util.List) instead

public static MacroFormDetails makeParameterFormDetails (String macroName, String documentationUrl, boolean showDefaultParamInPlaceholder, List<MacroParameter> parameters)

public void renderForDisplay (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

public void setBody (MacroBody body)

public String toString ()