@PublicApi public interface

JiraRendererModuleDescriptor

implements JiraResourcedModuleDescriptor<T>
com.atlassian.jira.plugin.renderer.JiraRendererModuleDescriptor
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Descriptor that defines a JiraRendererModule.

Summary

Constants
String TEMPLATE_NAME_CSS
String TEMPLATE_NAME_EDIT
String TEMPLATE_NAME_JS
Public Methods
String getCss()
String getEditVM(String value, String issueKey, String rendererType, String fieldId, String fieldName, Map params, boolean singleLine)
This render an editable input field for the given values based on the edit template provided for the renderer.
String getJavaScript(String contextPath)
boolean isCSSTemplateExists()
boolean isEditTemplateExists()
boolean isJavaScriptTemplateExists()
[Expand]
Inherited Methods
From interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
From interface com.atlassian.plugin.ModuleDescriptor
From interface com.atlassian.plugin.Resourced

Constants

public static final String TEMPLATE_NAME_CSS

Constant Value: "css"

public static final String TEMPLATE_NAME_EDIT

Constant Value: "edit"

public static final String TEMPLATE_NAME_JS

Constant Value: "javascript"

Public Methods

public String getCss ()

public String getEditVM (String value, String issueKey, String rendererType, String fieldId, String fieldName, Map params, boolean singleLine)

This render an editable input field for the given values based on the edit template provided for the renderer.

Returns
  • the renderered html for the edit input

public String getJavaScript (String contextPath)

public boolean isCSSTemplateExists ()

public boolean isEditTemplateExists ()

public boolean isJavaScriptTemplateExists ()