Package com.atlassian.jira.admin

Interface RenderableProperty

All Known Implementing Classes:
RenderablePropertyImpl
@PublicApi public interface RenderableProperty
Represents a String field that accepts user input and is rendered in JIRA pages. A RenderableProperty has two modes of operation, depending on whether JIRA is running in OnDemand or not.
  • in BTF: the property accepts raw HTML and renders it as-is
  • in OnDemand: the property accepts Wiki markup and renders it as HTML
Implementations of this interface are capable of rendering their own "view", "edit", and "description" HTML.
Since:
v5.0.7

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescriptionHtml()
    Returns the description HTML for this property.
    String
    getEditHtml(String fieldName)
    Returns the edit HTML for this renderable application property.
    String
    getViewHtml()
    Returns the view HTML for this renderable application property.

  • Method Details

    • getViewHtml

      String getViewHtml()
      Returns the view HTML for this renderable application property.
      Returns:
      a String containing the view HTML
      Since:
      v5.0.7

    • getEditHtml

      String getEditHtml(String fieldName)
      Returns the edit HTML for this renderable application property.
      Parameters:
      fieldName - the field name to use in the generated HTML
      Returns:
      a String containing the edit HTML
      Since:
      v5.0.7

    • getDescriptionHtml

      String getDescriptionHtml()
      Returns the description HTML for this property.
      Returns:
      a String containing the description HTML
      Since:
      v5.0.7