public abstract class IssueConstantsSearchRenderer<T extends IssueConstant> extends AbstractSearchRenderer implements SearchRenderer
EDIT_TEMPLATE_SUFFIX, VIEW_TEMPLATE_SUFFIX| Constructor and Description |
|---|
IssueConstantsSearchRenderer(SimpleFieldSearchConstants constants,
String searcherNameKey,
ConstantsManager constantsManager,
VelocityRequestContextFactory velocityRequestContextFactory,
ApplicationProperties applicationProperties,
VelocityTemplatingEngine templatingEngine,
FieldVisibilityManager fieldVisibilityManager) |
| Modifier and Type | Method and Description |
|---|---|
protected Collection<T> |
getAllSelectListOptions() |
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.
|
abstract Collection<T> |
getSelectListOptions(SearchContext searchContext) |
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.
|
boolean |
isRelevantForQuery(com.atlassian.crowd.embedded.api.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
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 user,
SearchContext searchContext)
Checks if the searcher should be shown in this context on the Issue Navigator.
|
getI18n, getVelocityParams, isRelevantForQuery, renderEditTemplate, renderViewTemplatepublic IssueConstantsSearchRenderer(SimpleFieldSearchConstants constants, String searcherNameKey, ConstantsManager constantsManager, VelocityRequestContextFactory velocityRequestContextFactory, ApplicationProperties applicationProperties, VelocityTemplatingEngine templatingEngine, FieldVisibilityManager fieldVisibilityManager)
public abstract Collection<T> getSelectListOptions(SearchContext searchContext)
public String getEditHtml(com.atlassian.crowd.embedded.api.User user, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map displayParameters, webwork.action.Action action)
SearchRendererSearchInputTransformer
that will know how to transform these input parameters into JIRA search objects.getEditHtml in interface SearchRendereruser - 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.protected Collection<T> getAllSelectListOptions()
public boolean isShown(com.atlassian.crowd.embedded.api.User user,
SearchContext searchContext)
SearchRendererisShown in interface SearchRendereruser - performing this action.searchContext - the context of the search (i.e. projects and issue types selected).public String getViewHtml(com.atlassian.crowd.embedded.api.User user, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map displayParameters, webwork.action.Action action)
SearchRenderergetViewHtml in interface SearchRendereruser - 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.public boolean isRelevantForQuery(com.atlassian.crowd.embedded.api.User user,
Query query)
SearchRendererSearchRenderer.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.isRelevantForQuery in interface SearchRendereruser - performing this action.query - contains the search criteria used to determine if this query is relevevant to the searcher.Copyright © 2002-2015 Atlassian. All Rights Reserved.