com.atlassian.jira.issue.search.searchers.renderer
Class ComponentSearchRenderer

java.lang.Object
  com.atlassian.jira.issue.search.searchers.renderer.AbstractSearchRenderer
      com.atlassian.jira.issue.search.searchers.renderer.AbstractProjectConstantsRenderer
          com.atlassian.jira.issue.search.searchers.renderer.ComponentSearchRenderer

All Implemented Interfaces:

SearchRenderer

public class ComponentSearchRenderer
extends AbstractProjectConstantsRenderer
implements SearchRenderer

A search renderer for the component searcher

Since:

v4.0

Nested Class Summary

protected class

ComponentSearchRenderer.ComponentLabelFunction

Nested classes/interfaces inherited from class com.atlassian.jira.issue.search.searchers.renderer.AbstractProjectConstantsRenderer

AbstractProjectConstantsRenderer.GenericProjectConstantsLabel

Field Summary

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

EDIT_TEMPLATE_SUFFIX, VIEW_TEMPLATE_SUFFIX

Constructor Summary

ComponentSearchRenderer(SimpleFieldSearchConstantsWithEmpty searchConstants, VelocityRequestContextFactory velocityRequestContextFactory, FieldVisibilityManager fieldVisibilityManager, ApplicationProperties applicationProperties, com.atlassian.velocity.VelocityManager velocityManager, String searcherNameKey, ProjectComponentManager componentManager, ProjectManager projectManager, ComponentResolver componentResolver)

Method Summary

String	getEditHtml(com.atlassian.crowd.embedded.api.User searcher, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map displayParameters, webwork.action.Action action) Used to produce an HTML input that is rendered on the JIRA issue navigator.
protected List<Option>	getSelectListOptions(com.atlassian.crowd.embedded.api.User searcher, SearchContext searchContext)
protected Map<String,Object>	getVelocityParams(com.atlassian.crowd.embedded.api.User searcher, SearchContext searchContext, FieldLayoutItem fieldLayoutItem, FieldValuesHolder fieldValuesHolder, Map displayParameters, webwork.action.Action action)
String	getViewHtml(com.atlassian.crowd.embedded.api.User searcher, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map displayParameters, webwork.action.Action action) Used to produce the HTML that displays a searchers summary information (e.g.

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

isRelevantForQuery, isShown

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

isRelevantForQuery, isShown

Constructor Detail

ComponentSearchRenderer

public ComponentSearchRenderer(SimpleFieldSearchConstantsWithEmpty searchConstants,
                               VelocityRequestContextFactory velocityRequestContextFactory,
                               FieldVisibilityManager fieldVisibilityManager,
                               ApplicationProperties applicationProperties,
                               com.atlassian.velocity.VelocityManager velocityManager,
                               String searcherNameKey,
                               ProjectComponentManager componentManager,
                               ProjectManager projectManager,
                               ComponentResolver componentResolver)

Method Detail

getEditHtml

public String getEditHtml(com.atlassian.crowd.embedded.api.User searcher,
                          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

Parameters:

searcher - 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.

getViewHtml

public String getViewHtml(com.atlassian.crowd.embedded.api.User searcher,
                          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

Parameters:

searcher - 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.

getVelocityParams

protected Map<String,Object> getVelocityParams(com.atlassian.crowd.embedded.api.User searcher,
                                               SearchContext searchContext,
                                               FieldLayoutItem fieldLayoutItem,
                                               FieldValuesHolder fieldValuesHolder,
                                               Map displayParameters,
                                               webwork.action.Action action)

Overrides:

getVelocityParams in class AbstractSearchRenderer

getSelectListOptions

protected List<Option> getSelectListOptions(com.atlassian.crowd.embedded.api.User searcher,
                                            SearchContext searchContext)