public class

TextQuerySearchRenderer

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

Class Overview

Renderer the produces a simple text input or just avalue (rendering is done in Javascript).

Summary

[Expand]
Inherited Constants
From class com.atlassian.jira.issue.search.searchers.renderer.AbstractSearchRenderer
Public Constructors
TextQuerySearchRenderer(String id, String name, String labelKey, VelocityRequestContextFactory velocityRequestContextFactory, ApplicationProperties applicationProperties, VelocityTemplatingEngine templatingEngine, SearchInputTransformer searchInputTransformer)
Public Methods
String getEditHtml(User user, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map displayParameters, Action action)
String getViewHtml(User user, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map displayParameters, Action action)
boolean isRelevantForQuery(User user, Query query)
Checks if the searchRequest object has a search representation that was created by the searcher and is used to determine if the getViewHtml(User, com.atlassian.jira.issue.search.SearchContext, com.atlassian.jira.issue.transport.FieldValuesHolder, java.util.Map, webwork.action.Action) method should be called when rendering the search summary.
boolean isShown(User user, SearchContext searchContext)
Checks if the searcher should be shown in this context on the Issue Navigator.
[Expand]
Inherited Methods
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 TextQuerySearchRenderer (String id, String name, String labelKey, VelocityRequestContextFactory velocityRequestContextFactory, ApplicationProperties applicationProperties, VelocityTemplatingEngine templatingEngine, SearchInputTransformer searchInputTransformer)

Public Methods

public String getEditHtml (User user, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map displayParameters, Action action)

public String getViewHtml (User user, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map displayParameters, Action action)

public boolean isRelevantForQuery (User user, Query query)

Checks if the searchRequest object has a search representation that was created by the searcher and is used to determine if the getViewHtml(User, com.atlassian.jira.issue.search.SearchContext, com.atlassian.jira.issue.transport.FieldValuesHolder, java.util.Map, webwork.action.Action) method should be called when rendering the search summary.

Parameters
user performing this action.
query contains the search criteria used to determine if this query is relevevant to the searcher.
Returns
  • true if the query has relevant clauses to the searchers, false otherwise.

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.