public abstract class

VelocityShareTypeRenderer

extends Object
implements ShareTypeRenderer
java.lang.Object
   ↳ com.atlassian.jira.sharing.type.VelocityShareTypeRenderer
Known Direct Subclasses

Class Overview

A partial implementation of ShareTypeRenderer that can be used to generate HTML using Velocity templates.

Summary

Public Constructors
VelocityShareTypeRenderer(EncodingConfiguration encoding, VelocityTemplatingEngine templatingEngine)
Protected Methods
final String renderVelocity(String template, Map<StringObject> params, JiraAuthenticationContext authenticationContext)
Get the text returned by running a velocity template.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.sharing.type.ShareTypeRenderer

Public Constructors

public VelocityShareTypeRenderer (EncodingConfiguration encoding, VelocityTemplatingEngine templatingEngine)

Protected Methods

protected final String renderVelocity (String template, Map<StringObject> params, JiraAuthenticationContext authenticationContext)

Get the text returned by running a velocity template. This can be used to create the view/editor of a ShareType from a Velocity template.

Parameters
template the filename of the velocity template to run. It is assumed to be located under 'templates/jira/sharing/'.
params the parameters that should be passed to the velocity template.
authenticationContext the authentication context the template should run under.
Returns
  • the text of the velocity template.