Package com.atlassian.jira.issue.customfields.searchers.renderer

Class CustomFieldRenderer

java.lang.Object
com.atlassian.jira.issue.customfields.searchers.renderer.CustomFieldRenderer
All Implemented Interfaces:
SearchRenderer
Direct Known Subclasses:
GroupCustomFieldSearchRenderer, MultiSelectCustomFieldSearchRenderer, UserCustomFieldSearchRenderer
@PublicSpi public class CustomFieldRenderer extends Object implements SearchRenderer
An abstract implementation of a renderer for custom fields.

It delegates to the searcher module descriptor for actual rendering. The value is retrieved from the field values holder using the provided Custom Field Value Provider.

Since:
v4.0

  • Constructor Details

  • Method Details

    • isRelevantForQuery

      public boolean isRelevantForQuery(ApplicationUser user, 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
      invalid reference 
      #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:
      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.

    • 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
      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
      invalid reference 
      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.

    • getViewHtml

      public String getViewHtml(ApplicationUser user, 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:
      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
      invalid reference 
      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 issue navigator to show a SearchRequest summary.

    • getField

      public CustomField getField()

    • isShown

      public boolean isShown(ApplicationUser user, 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:
      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.

    • getEditHtml

      public String getEditHtml(SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map<?,?> displayParameters, webwork.action.Action action, Map<String,Object> velocityParams)

    • getViewHtml

      public String getViewHtml(SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map<?,?> displayParameters, webwork.action.Action action, Map<String,Object> velocityParams)