Summary: Methods | [Expand All]
@PublicApi public interface

RenderableProperty

com.atlassian.jira.admin.RenderableProperty
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

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.

Summary

Public Methods
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.

Public Methods

public String getDescriptionHtml ()

Returns the description HTML for this property.

Returns
  • a String containing the description HTML

public 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

public String getViewHtml ()

Returns the view HTML for this renderable application property.

Returns
  • a String containing the view HTML