public interface

IntroductionProperty

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

Class Overview

Abstraction for the JIRA "Introduction" text, which can be configured in the General Configuration. When running in JIRA OnDemand, the introduction can uses wiki-markup and is always HTML-encoded before rendering.

In regular behind-the-firewall JIRA it accepts HTML and does not perform encoding.

Summary

Public Methods
String getDescriptionHtml()
Returns the description HTML for the introduction field.
String getEditHtml(String fieldName)
Returns the edit HTML for this renderable application property.
String getValue()
Returns the value of the introduction property value in raw format.
String getViewHtml()
Returns the view HTML for the introduction property.
void setValue(String value)
Sets the value of the introduction property.

Public Methods

public String getDescriptionHtml ()

Returns the description HTML for the introduction field.

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 getValue ()

Returns the value of the introduction property value in raw format.

Returns
  • the property value in raw format

public String getViewHtml ()

Returns the view HTML for the introduction property.

Returns
  • a String containing the view HTML

public void setValue (String value)

Sets the value of the introduction property.

Parameters
value a String containing the property