com.atlassian.jira.issue.fields

Class CustomFieldDescription

java.lang.Object

com.atlassian.jira.issue.fields.CustomFieldDescription

public class CustomFieldDescription
extends Object

Helper class for rendering the custom field description field.

Since:

v5.0.7

Constructor Summary

Constructors

Constructor and Description
CustomFieldDescription(RenderablePropertyFactory renderablePropertyFactory, I18nHelper.BeanFactory i18nFactory, JiraAuthenticationContext authenticationContext)

Method Summary

Modifier and Type	Method and Description
RenderableProperty	createRenderablePropertyFor(CustomField customField) Creates a RenderableProperty used for rendering view/edit controls for a given CustomField.
RenderableProperty	createRenderablePropertyFor(String description) Creates a RenderableProperty used for translating a given CustomField.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomFieldDescription

public CustomFieldDescription(RenderablePropertyFactory renderablePropertyFactory,
                              I18nHelper.BeanFactory i18nFactory,
                              JiraAuthenticationContext authenticationContext)

Method Detail

createRenderablePropertyFor

@Nonnull
public RenderableProperty createRenderablePropertyFor(@Nullable
                                                               CustomField customField)

Creates a RenderableProperty used for rendering view/edit controls for a given CustomField. If customField is null, then the RenderableProperty will not have any associated storage (but can be used to render the description field in the "create custom field" page).

Parameters:

customField - a CustomField (may be null)

Returns:

a RenderableProperty

createRenderablePropertyFor

@Nonnull
public RenderableProperty createRenderablePropertyFor(String description)

Creates a RenderableProperty used for translating a given CustomField. It just uses the passed in text.

Parameters:

description -

Returns:

a RenderableProperty