com.atlassian.jira.issue.search.searchers.renderer
Class LabelsSearchRenderer
java.lang.Object
com.atlassian.jira.issue.search.searchers.renderer.AbstractSearchRenderer
com.atlassian.jira.issue.search.searchers.renderer.LabelsSearchRenderer
- All Implemented Interfaces:
- SearchRenderer
public class LabelsSearchRenderer
- extends AbstractSearchRenderer
- implements SearchRenderer
A search renderer for the Labels searcher
- Since:
- v4.2
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. |
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. |
boolean |
isRelevantForQuery(com.atlassian.crowd.embedded.api.User searcher,
Query query)
Checks if the searchRequest object has a search representation that was created by the searcher and is
used to determine if the SearchRenderer.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(com.atlassian.crowd.embedded.api.User searcher,
SearchContext searchContext)
Checks if the searcher should be shown in this context on the Issue Navigator. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
LabelsSearchRenderer
public LabelsSearchRenderer(SimpleFieldSearchConstantsWithEmpty constants,
VelocityRequestContextFactory velocityRequestContextFactory,
FieldVisibilityManager fieldVisibilityManager,
ApplicationProperties applicationProperties,
com.atlassian.velocity.VelocityManager velocityManager,
String nameKey)
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.
isShown
public boolean isShown(com.atlassian.crowd.embedded.api.User searcher,
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:
searcher
- 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.
isRelevantForQuery
public boolean isRelevantForQuery(com.atlassian.crowd.embedded.api.User searcher,
Query query)
- Description copied from interface:
SearchRenderer
- Checks if the searchRequest object has a search representation that was created by the searcher and is
used to determine if the
SearchRenderer.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.
- Specified by:
isRelevantForQuery
in interface SearchRenderer
- Parameters:
searcher
- 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.
Copyright © 2002-2012 Atlassian. All Rights Reserved.