com.atlassian.jira.admin
Interface IntroductionProperty

All Known Implementing Classes:
IntroductionPropertyImpl

public interface IntroductionProperty

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.

Since:
v5.0.7

Method Summary
 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.
 

Method Detail

getValue

String getValue()
Returns the value of the introduction property value in raw format.

Returns:
the property value in raw format
Since:
v5.0.7

setValue

void setValue(String value)
Sets the value of the introduction property.

Parameters:
value - a String containing the property
Since:
v5.0.7

getViewHtml

String getViewHtml()
Returns the view HTML for the introduction 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 the introduction field.

Returns:
a String containing the description HTML
Since:
v5.0.7


Copyright © 2002-2013 Atlassian. All Rights Reserved.