public class

VersionCustomFieldRenderer

extends CustomFieldRenderer
implements SearchRenderer
java.lang.Object
   ↳ com.atlassian.jira.issue.customfields.searchers.renderer.CustomFieldRenderer
     ↳ com.atlassian.jira.issue.customfields.searchers.renderer.VersionCustomFieldRenderer

Summary

Public Constructors
VersionCustomFieldRenderer(ClauseNames clauseNames, VersionManager versionManager, FieldVisibilityManager fieldVisibilityManager, CustomFieldSearcherModuleDescriptor customFieldSearcherModuleDescriptor, CustomFieldValueProvider customFieldValueProvider, CustomField field)
Public Methods
String getEditHtml(User user, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map<?, ?> displayParameters, Action action)
Used to produce an HTML input that is rendered on the JIRA issue navigator.
boolean isShown(User user, SearchContext searchContext)
Checks if the searcher should be shown in this context on the Issue Navigator.
[Expand]
Inherited Methods
From class com.atlassian.jira.issue.customfields.searchers.renderer.CustomFieldRenderer
From class java.lang.Object
From interface com.atlassian.jira.issue.search.searchers.renderer.SearchRenderer

Public Constructors

public VersionCustomFieldRenderer (ClauseNames clauseNames, VersionManager versionManager, FieldVisibilityManager fieldVisibilityManager, CustomFieldSearcherModuleDescriptor customFieldSearcherModuleDescriptor, CustomFieldValueProvider customFieldValueProvider, CustomField field)

Public Methods

public String getEditHtml (User user, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map<?, ?> displayParameters, Action action)

Used to produce an HTML input that is rendered on the JIRA issue navigator. This HTML provides the UI for searching a fields content. There will be a corresponding SearchInputTransformer that will know how to transform these input parameters into JIRA search objects.

Parameters
user performing this action.
searchContext the search context of the current search request that may be participating in rendering the issue navigator.
fieldValuesHolder contains any request parameters that the HTML input may need to use to pre-populate the input (e.g. if this is the priority renderer and the search request being rendered has two priorities already selected these params will contain these request parameters). These parameters will have been populated via a call to populateFromQuery(User, com.atlassian.jira.issue.transport.FieldValuesHolder, com.atlassian.query.Query, com.atlassian.jira.issue.search.SearchContext) if there is a SearchRequest involved in the rendering this IssueNavigator call.
displayParameters are a map of "hints" that can be passed from the caller to this code which can use these hints to alter the way it renders the HTML.
action is the WebWork 1 action object that is rendering the Issue Navigator view. This can be used to invoke methods on the view.
Returns
  • a String that contains HTML that can be rendered on the left-hand side of the JIRA issue navigator.

public boolean isShown (User user, SearchContext searchContext)

Checks if the searcher should be shown in this context on the Issue Navigator.

Parameters
user performing this action.
searchContext the context of the search (i.e. projects and issue types selected).
Returns
  • true if the searcher will appear in the issue navigator, false otherwise.