public class

CustomFieldDescription

extends Object
java.lang.Object
   ↳ com.atlassian.jira.issue.fields.CustomFieldDescription

Class Overview

Helper class for rendering the custom field description field.

Summary

Public Constructors
CustomFieldDescription(RenderablePropertyFactory renderablePropertyFactory, I18nHelper.BeanFactory i18nFactory, JiraAuthenticationContext authenticationContext)
Public Methods
@Nonnull RenderableProperty createRenderablePropertyFor(String description)
Creates a RenderableProperty used for translating a given CustomField.
@Nonnull RenderableProperty createRenderablePropertyFor(CustomField customField)
Creates a RenderableProperty used for rendering view/edit controls for a given CustomField.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

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

Public Methods

@Nonnull public RenderableProperty createRenderablePropertyFor (String description)

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

Returns
  • a RenderableProperty

@Nonnull public RenderableProperty createRenderablePropertyFor (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