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

java.lang.Object
  extended by com.atlassian.jira.issue.customfields.searchers.renderer.CustomFieldRenderer
      extended by com.atlassian.jira.issue.customfields.searchers.renderer.GroupCustomFieldSearchRenderer
All Implemented Interfaces:
SearchRenderer

@Internal
public class GroupCustomFieldSearchRenderer
extends CustomFieldRenderer

Since:
v5.2

Constructor Summary
GroupCustomFieldSearchRenderer(ClauseNames clauseNames, CustomFieldSearcherModuleDescriptor customFieldSearcherModuleDescriptor, CustomField field, CustomFieldValueProvider customFieldValueProvider, FieldVisibilityManager fieldVisibilityManager)
           
 
Method Summary
 String getEditHtml(com.atlassian.crowd.embedded.api.User user, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map<?,?> displayParameters, webwork.action.Action action)
          Used to produce an HTML input that is rendered on the JIRA issue navigator.
 String getViewHtml(com.atlassian.crowd.embedded.api.User user, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map<?,?> displayParameters, webwork.action.Action action)
          Used to produce the HTML that displays a searchers summary information (e.g.
 List<com.atlassian.crowd.embedded.api.Group> transformUserInput(Collection<String> values)
           
 
Methods inherited from class com.atlassian.jira.issue.customfields.searchers.renderer.CustomFieldRenderer
getEditHtml, getField, getViewHtml, isRelevantForQuery, isShown
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GroupCustomFieldSearchRenderer

public GroupCustomFieldSearchRenderer(ClauseNames clauseNames,
                                      CustomFieldSearcherModuleDescriptor customFieldSearcherModuleDescriptor,
                                      CustomField field,
                                      CustomFieldValueProvider customFieldValueProvider,
                                      FieldVisibilityManager fieldVisibilityManager)
Method Detail

getViewHtml

public String getViewHtml(com.atlassian.crowd.embedded.api.User user,
                          SearchContext searchContext,
                          FieldValuesHolder fieldValuesHolder,
                          Map<?,?> displayParameters,
                          webwork.action.Action action)
Description copied from interface: SearchRenderer
Used to produce the HTML that displays a searchers summary information (e.g. if this is the priority searcher and a user has selected two priorities then this method will render HTML that shows something like 'priority: Major, Minor').

Specified by:
getViewHtml in interface SearchRenderer
Overrides:
getViewHtml in class CustomFieldRenderer
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 SearchInputTransformer.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 issue navigator to show a SearchRequest summary.

getEditHtml

public String getEditHtml(com.atlassian.crowd.embedded.api.User user,
                          SearchContext searchContext,
                          FieldValuesHolder fieldValuesHolder,
                          Map<?,?> displayParameters,
                          webwork.action.Action action)
Description copied from interface: SearchRenderer
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.

Specified by:
getEditHtml in interface SearchRenderer
Overrides:
getEditHtml in class CustomFieldRenderer
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 SearchInputTransformer.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.

transformUserInput

public List<com.atlassian.crowd.embedded.api.Group> transformUserInput(Collection<String> values)


Copyright © 2002-2012 Atlassian. All Rights Reserved.