Package com.atlassian.confluence.macro.browser.beans

Class MacroFormDetails

java.lang.Object
com.atlassian.confluence.macro.browser.beans.MacroFormDetails
public class MacroFormDetails extends Object
A Bean that encapsulates the detailed metadata of a macro. This includes the macro parameter information, documentation links and notation help guide contents.

  • Method Details

    • builder

      public static MacroFormDetails.MacroFormDetailsBuilder builder()

    • getMacroName

      public String getMacroName()

    • renderForDisplay

      @Deprecated(since="9.0", forRemoval=true) public void renderForDisplay(org.apache.velocity.context.Context context)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.0. No replacement
      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

      @Deprecated(since="9.0", forRemoval=true) public String getNotationHelp()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.0. No replacement
      Returns:
      the notation help as raw HTML. The renderForDisplay(Context) method must be called before this.

    • getDocumentationUrl

      @Deprecated public String getDocumentationUrl()
      Deprecated.
      since 5.5. Use getDocumentationLink() instead.
      Returns:
      the url to the macro's documentation, if available. Otherwise, null is returned.

    • getDocumentationLink

      public DocumentationLink getDocumentationLink()
      Returns:
      the url to the macro's documentation, if available. Otherwise, null is returned.

    • isCommentable

      public boolean isCommentable()
      Returns:
      true if the Macro implementation allows comments

    • setBody

      public void setBody(MacroBody body)

    • getBody

      public MacroBody getBody()
      Returns:
      true if the macro implementation of hasBody() returns true.
      See Also:

    • isFreeform

      @Deprecated(since="9.0", forRemoval=true) public boolean isFreeform()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.0. No replacement
      Returns:
      true if the macro parameter information is not available.

    • isShowDefaultParamInPlaceholder

      public boolean isShowDefaultParamInPlaceholder()

    • getParameters

      public List<MacroParameter> getParameters()
      Returns:
      a list of macro paramaters.

    • hasRequiredParameters

      public boolean hasRequiredParameters()

    • getSchemaVersion

      public int getSchemaVersion()

    • getExcludedSchemaMigrationPoints

      public Set<MacroMigrationPoint> getExcludedSchemaMigrationPoints()
      Returns:
      points where MacroMigrations should not be run.

    • toString

      public String toString()
      Overrides:
      toString in class Object