public class

FieldScreenRendererFactoryImpl

extends Object
implements FieldScreenRendererFactory
java.lang.Object
   ↳ com.atlassian.jira.issue.fields.screen.FieldScreenRendererFactoryImpl

Class Overview

Default implementation of the FieldScreenRendererFactory.

Summary

Public Constructors
FieldScreenRendererFactoryImpl(FieldManager fieldManager, FieldLayoutManager fieldLayoutManager, IssueTypeScreenSchemeManager issueTypeScreenSchemeManager, FieldScreenManager fieldScreenManager, HackyFieldRendererRegistry hackyFieldRendererRegistry, FieldScreenTabRendererFactory fieldScreenTabRendererFactory)
Public Methods
FieldScreenRenderer getFieldScreenRenderer(ApplicationUser remoteUser, 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(List<String> fieldIds, ApplicationUser 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(ApplicationUser remoteUser, 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(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)
Used when need to populate a field without showing a screen - e.g.
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(ApplicationUser remoteUser, Issue issue, IssueOperation issueOperation, boolean onlyShownCustomFields)
Obtain a field screen renderer that can be used to render JIRA's fields for the passed arguments.
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.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.issue.fields.screen.FieldScreenRendererFactory

Public Constructors

public FieldScreenRendererFactoryImpl (FieldManager fieldManager, FieldLayoutManager fieldLayoutManager, IssueTypeScreenSchemeManager issueTypeScreenSchemeManager, FieldScreenManager fieldScreenManager, HackyFieldRendererRegistry hackyFieldRendererRegistry, FieldScreenTabRendererFactory fieldScreenTabRendererFactory)

Public Methods

public FieldScreenRenderer getFieldScreenRenderer (ApplicationUser remoteUser, 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
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 (List<String> fieldIds, ApplicationUser 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 (ApplicationUser remoteUser, 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
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 (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)

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 (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 (ApplicationUser remoteUser, Issue issue, IssueOperation issueOperation, boolean onlyShownCustomFields)

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.

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.