com.atlassian.jira.issue.customfields.searchers.renderer

Class UserPickerGroupCustomFieldRenderer

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

All Implemented Interfaces:

SearchRenderer

public class UserPickerGroupCustomFieldRenderer
extends AbstractUserSearchRenderer
implements SearchRenderer

Since:

v4.0

Field Summary

Fields inherited from class com.atlassian.jira.issue.search.searchers.renderer.AbstractUserSearchRenderer

permissionManager, SELECT_LIST_GROUP, SELECT_LIST_NONE, SELECT_LIST_USER, userSearcherHelper

Fields inherited from class com.atlassian.jira.issue.search.searchers.renderer.AbstractSearchRenderer

EDIT_TEMPLATE_SUFFIX, VIEW_TEMPLATE_SUFFIX

Constructor Summary

Constructors

Constructor and Description

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

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	addUserGroupSuggestionParams(FieldValuesHolder fieldValuesHolder, ApplicationUser user, SearchContext searchContext, List<String> selectedUsers) add user and group suggestions into parameters.
protected String	getEmptyValueKey()
protected List<Map<String,String>>	getSelectedListOptions(ApplicationUser searcher) Returns a list of select box options
protected Map<String,Object>	getVelocityParams(ApplicationUser searcher, SearchContext searchContext, FieldLayoutItem fieldLayoutItem, FieldValuesHolder fieldValuesHolder, Map displayParameters, webwork.action.Action action)
boolean	isShown(ApplicationUser user, SearchContext searchContext) Checks if the searcher should be shown in this context on the Issue Navigator.

Methods inherited from class com.atlassian.jira.issue.search.searchers.renderer.AbstractUserSearchRenderer

getEditHtml, getTextForuser, getViewHtml, isRelevantForQuery

Methods inherited from class com.atlassian.jira.issue.search.searchers.renderer.AbstractSearchRenderer

getI18n, isRelevantForQuery, renderEditTemplate, renderViewTemplate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.jira.issue.search.searchers.renderer.SearchRenderer

getEditHtml, getViewHtml, isRelevantForQuery

Constructor Detail

UserPickerGroupCustomFieldRenderer

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

Method Detail

isShown

public boolean isShown(ApplicationUser user,
                       SearchContext searchContext)

Description copied from interface: SearchRenderer

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

Specified by:

isShown in interface SearchRenderer

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.

getSelectedListOptions

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

Returns a list of select box options

Specified by:

getSelectedListOptions in class AbstractUserSearchRenderer

Parameters:

searcher - performing this action.

Returns:

a list of select box options

getVelocityParams

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

Overrides:

getVelocityParams in class AbstractUserSearchRenderer

addUserGroupSuggestionParams

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

Description copied from class: AbstractUserSearchRenderer

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.

Overrides:

addUserGroupSuggestionParams in class AbstractUserSearchRenderer

selectedUsers - recently selected users

Returns:

getEmptyValueKey

protected String getEmptyValueKey()

Specified by:

getEmptyValueKey in class AbstractUserSearchRenderer

Returns:

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