Package 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<ComponentSearchInput,com.atlassian.jira.issue.search.searchers.renderer.ComponentOptions>

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

All Implemented Interfaces:

SearchRenderer

public class ComponentSearchRenderer
extends AbstractProjectConstantsRenderer<ComponentSearchInput,com.atlassian.jira.issue.search.searchers.renderer.ComponentOptions>

The new issue navigator's component search renderer.

Since:

v5.2

Nested Class Summary

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

projectManager, searchConstants

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

EDIT_TEMPLATE_SUFFIX, VIEW_TEMPLATE_SUFFIX

Constructor Summary

Constructors

Constructor

Description

ComponentSearchRenderer(ApplicationProperties applicationProperties, FieldVisibilityManager fieldVisibilityManager, ProjectComponentManager projectComponentManager, ProjectManager projectManager, SimpleFieldSearchConstantsWithEmpty searchConstants, String searcherNameKey, VelocityTemplatingEngine templatingEngine, VelocityRequestContextFactory velocityRequestContextFactory, PermissionManager permissionManager)

Method Summary

Modifier and Type	Method	Description
String	getEditHtml(ApplicationUser 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.

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

enableRestApiMode, getVelocityParams, getViewHtml, isRelevantForQuery, isShown, limitGroupChildOptions

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

Constructor Details

ComponentSearchRenderer

public ComponentSearchRenderer(ApplicationProperties applicationProperties,
 FieldVisibilityManager fieldVisibilityManager,
 ProjectComponentManager projectComponentManager,
 ProjectManager projectManager,
 SimpleFieldSearchConstantsWithEmpty searchConstants,
 String searcherNameKey,
 VelocityTemplatingEngine templatingEngine,
 VelocityRequestContextFactory velocityRequestContextFactory,
 PermissionManager permissionManager)

Method Details

getEditHtml

public String getEditHtml(ApplicationUser 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 AbstractProjectConstantsRenderer<ComponentSearchInput,com.atlassian.jira.issue.search.searchers.renderer.ComponentOptions>

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 com.atlassian.jira.issue.search.searchers.transformer.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.