@PublicApi public interface

FieldScreenRendererFactory

com.atlassian.jira.issue.fields.screen.FieldScreenRendererFactory
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

A factory for obtaining FieldScreenRenderers.

Summary

Public Methods
FieldScreenRenderer getFieldScreenRenderer(Issue issue, IssueOperation issueOperation, Predicate<? super Field> predicate)
Obtain a field screen renderer that can be used to render JIRA's fields for the passed arguments.
FieldScreenRenderer getFieldScreenRenderer(Issue issue, IssueOperation issueOperation)
Obtain a field screen renderer that can be used to render JIRA's fields for the passed arguments.
FieldScreenRenderer getFieldScreenRenderer(Issue issue)
Used when need to populate a field without showing a screen - e.g.
FieldScreenRenderer getFieldScreenRenderer(List<String> fieldIds, User remoteUser, Issue issue, IssueOperation issueOperation)
Returns a FieldScreenRenderer that represents a 'field screen' with the fields the ids of which are in fieldIds.
FieldScreenRenderer getFieldScreenRenderer(User remoteUser, Issue issue, IssueOperation issueOperation, Predicate<? super Field> predicate)
FieldScreenRenderer getFieldScreenRenderer(Collection<Issue> issues, ActionDescriptor actionDescriptor)
Get a renderer that can be used to render the fields when transitioning a collection of issues through workflow.
FieldScreenRenderer getFieldScreenRenderer(Issue issue, ActionDescriptor actionDescriptor)
Obtain a field screen renderer that can be used to render JIRA's fields when transitioning through the passed workflow.
FieldScreenRenderer getFieldScreenRenderer(User remoteUser, Issue issue, ActionDescriptor actionDescriptor)
FieldScreenRenderer getFieldScreenRenderer(User remoteUser, Issue issue, IssueOperation issueOperation, boolean onlyShownCustomFields)
This method is deprecated. Use getFieldScreenRenderer(com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.operation.IssueOperation) instead. Use FieldPredicates.isCustomField() in the version that takes a predicate if you only want custom fields. Since v6.2.

Public Methods

public FieldScreenRenderer getFieldScreenRenderer (Issue issue, IssueOperation issueOperation, Predicate<? super Field> predicate)

Obtain a field screen renderer that can be used to render JIRA's fields for the passed arguments.

Only the fields that match the passed predicate will be included in the returned FieldScreenRenderer.

Parameters
issue the issue to be rendered.
issueOperation the current issue operation.
predicate only fields that cause ths predicate to return true will be returned in the FieldScreenRenderer
Returns
  • a FieldScreenRenderer for the provided context.

public FieldScreenRenderer getFieldScreenRenderer (Issue issue, IssueOperation issueOperation)

Obtain a field screen renderer that can be used to render JIRA's fields for the passed arguments.

Parameters
issue the issue to be rendered.
issueOperation the current issue operation.
Returns
  • a FieldScreenRenderer for the provided context.

public FieldScreenRenderer getFieldScreenRenderer (Issue issue)

Used when need to populate a field without showing a screen - e.g. When using a UpdateIssueFieldFunction in workflow

Parameters
issue the currentIssue.
Returns
  • a FieldScreenRenderer without any tabs.

public FieldScreenRenderer getFieldScreenRenderer (List<String> fieldIds, User remoteUser, Issue issue, IssueOperation issueOperation)

Returns a FieldScreenRenderer that represents a 'field screen' with the fields the ids of which are in fieldIds. The returned Field Renderer places all given fields on one tab.

Parameters
fieldIds the fields to create the renderer for.
remoteUser the current user
issue the issue to be rendered.
issueOperation the current issue operation.
Returns
  • a FieldScreenRenderer for the passed fields.

public FieldScreenRenderer getFieldScreenRenderer (User remoteUser, Issue issue, IssueOperation issueOperation, Predicate<? super Field> predicate)

This method is deprecated.
Use getFieldScreenRenderer(com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.operation.IssueOperation, com.atlassian.jira.util.Predicate) instead. Since v6.2.

Obtain a field screen renderer that can be used to render JIRA's fields for the passed arguments. Only the fields that match the passed predicate will be included in the returned FieldScreenRenderer.

Parameters
remoteUser the current user
issue the issue to be rendered.
issueOperation the current issue operation.
predicate only fields that cause ths predicate to return true will be returned in the FieldScreenRenderer
Returns
  • a FieldScreenRenderer for the provided context.

public FieldScreenRenderer getFieldScreenRenderer (Collection<Issue> issues, ActionDescriptor actionDescriptor)

Get a renderer that can be used to render the fields when transitioning a collection of issues through workflow.

Parameters
issues the issues to be rendered.
actionDescriptor current workflow action descriptor
Returns
  • a BulkFieldScreenRenderer - aggregates the tabs and fields for the specified collection of issues

public FieldScreenRenderer getFieldScreenRenderer (Issue issue, ActionDescriptor actionDescriptor)

Obtain a field screen renderer that can be used to render JIRA's fields when transitioning through the passed workflow.

Parameters
issue the issue to be rendered.
actionDescriptor the current workflow action descriptor
Returns
  • a FieldScreenRenderer for the provided context.

public FieldScreenRenderer getFieldScreenRenderer (User remoteUser, Issue issue, ActionDescriptor actionDescriptor)

This method is deprecated.
Use getFieldScreenRenderer(com.atlassian.jira.issue.Issue, com.opensymphony.workflow.loader.ActionDescriptor) instead. Since v6.2.

Obtain a field screen renderer that can be used to render JIRA's fields when transitioning through the passed workflow.

Parameters
remoteUser the current user
issue the issue to be rendered.
actionDescriptor the current workflow action descriptor
Returns
  • a FieldScreenRenderer for the provided context.

public FieldScreenRenderer getFieldScreenRenderer (User remoteUser, Issue issue, IssueOperation issueOperation, boolean onlyShownCustomFields)

This method is deprecated.
Use getFieldScreenRenderer(com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.operation.IssueOperation) instead. Use FieldPredicates.isCustomField() in the version that takes a predicate if you only want custom fields. Since v6.2.

Obtain a field screen renderer that can be used to render JIRA's fields for the passed arguments.

Parameters
remoteUser the current user
issue the issue to be rendered.
issueOperation the current issue operation.
onlyShownCustomFields if true will only return custom fields in the FieldScreenRenderer, otherwise all fields will be returned.
Returns
  • a FieldScreenRenderer for the provided context.