public class

UserPickerGroupCustomFieldRenderer

extends AbstractUserSearchRenderer
implements SearchRenderer
java.lang.Object
   ↳ com.atlassian.jira.issue.search.searchers.renderer.AbstractSearchRenderer
     ↳ com.atlassian.jira.issue.search.searchers.renderer.AbstractUserSearchRenderer
       ↳ com.atlassian.jira.issue.customfields.searchers.renderer.UserPickerGroupCustomFieldRenderer

Summary

[Expand]
Inherited Constants
From class com.atlassian.jira.issue.search.searchers.renderer.AbstractUserSearchRenderer
From class com.atlassian.jira.issue.search.searchers.renderer.AbstractSearchRenderer
[Expand]
Inherited Fields
From class com.atlassian.jira.issue.search.searchers.renderer.AbstractUserSearchRenderer
Public Constructors
UserPickerGroupCustomFieldRenderer(CustomField field, UserFieldSearchConstants searchConstants, String nameKey, VelocityRequestContextFactory velocityRequestContextFactory, ApplicationProperties applicationProperties, VelocityTemplatingEngine templatingEngine, UserPickerSearchService searchService, FieldVisibilityManager fieldVisibilityManager, UserManager userManager, PermissionManager permissionManager, UserFilterManager userFilterManager)
Public Methods
boolean isShown(User user, SearchContext searchContext)
Checks if the searcher should be shown in this context on the Issue Navigator.
Protected Methods
Map<String, Object> addUserGroupSuggestionParams(FieldValuesHolder fieldValuesHolder, User user, SearchContext searchContext, List<String> selectedUsers)
add user and group suggestions into parameters.
String getEmptyValueKey()
List<Map<String, String>> getSelectedListOptions(User searcher)
Returns a list of select box options
Map<String, Object> getVelocityParams(User searcher, SearchContext searchContext, FieldLayoutItem fieldLayoutItem, FieldValuesHolder fieldValuesHolder, Map displayParameters, Action action)
[Expand]
Inherited Methods
From class com.atlassian.jira.issue.search.searchers.renderer.AbstractUserSearchRenderer
From class com.atlassian.jira.issue.search.searchers.renderer.AbstractSearchRenderer
From class java.lang.Object
From interface com.atlassian.jira.issue.search.searchers.renderer.SearchRenderer

Public Constructors

public UserPickerGroupCustomFieldRenderer (CustomField field, UserFieldSearchConstants searchConstants, String nameKey, VelocityRequestContextFactory velocityRequestContextFactory, ApplicationProperties applicationProperties, VelocityTemplatingEngine templatingEngine, UserPickerSearchService searchService, FieldVisibilityManager fieldVisibilityManager, UserManager userManager, PermissionManager permissionManager, UserFilterManager userFilterManager)

Public Methods

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.

Protected Methods

protected Map<String, Object> addUserGroupSuggestionParams (FieldValuesHolder fieldValuesHolder, User user, SearchContext searchContext, List<String> selectedUsers)

add user and group suggestions into parameters. subclasses could override it to provide customized suggestions. default implementation returns recently selected users and the first few users from the system, if not enough recently selected users, and returns the groups the user is in, or first few groups in the system, if the user is not specified.

Parameters
selectedUsers recently selected users

protected String getEmptyValueKey ()

Returns
  • the i18n key for the text that describes an empty value for this searcher.

protected List<Map<String, String>> getSelectedListOptions (User searcher)

Returns a list of select box options

Parameters
searcher performing this action.
Returns
  • a list of select box options

protected Map<String, Object> getVelocityParams (User searcher, SearchContext searchContext, FieldLayoutItem fieldLayoutItem, FieldValuesHolder fieldValuesHolder, Map displayParameters, Action action)