public interface

ShareTypeRenderer

com.atlassian.jira.sharing.type.ShareTypeRenderer
Known Indirect Subclasses

Class Overview

Implemented by ShareTypes to render their representation on the UI.

Summary

Nested Classes
class ShareTypeRenderer.RenderMode Enumeration representing the modes that shared can be rendered in Javascript. 
Public Methods
String getShareTypeEditor(JiraAuthenticationContext userCtx)
Return the HTML of the component that is used to configure the ShareType when necessary.
String getShareTypeLabel(JiraAuthenticationContext userCtx)
Return a string that can be used to differentiate the associated ShareType.
String getSimpleDescription(SharePermission permission, JiraAuthenticationContext userCtx)
Return a simple text only description of the share.
Map<String, String> getTranslatedTemplates(JiraAuthenticationContext userCtx, TypeDescriptor<? extends SharedEntity> type, ShareTypeRenderer.RenderMode mode)
Return map of key -> template that can be used to show a configured shares in Javascript.
boolean isAddButtonNeeded(JiraAuthenticationContext userCtx)
Return whether or not the component needs a button.
String renderPermission(SharePermission permission, JiraAuthenticationContext userCtx)
Return HTML that shows the configured share.

Public Methods

public String getShareTypeEditor (JiraAuthenticationContext userCtx)

Return the HTML of the component that is used to configure the ShareType when necessary.

Parameters
userCtx the context of the user calling this method.
Returns
  • The HTML component to render the ShareType.

public String getShareTypeLabel (JiraAuthenticationContext userCtx)

Return a string that can be used to differentiate the associated ShareType. This string is used in the web component that selects a particular ShareType.

Parameters
userCtx the context of the user calling this method.
Returns
  • A ShareType description.

public String getSimpleDescription (SharePermission permission, JiraAuthenticationContext userCtx)

Return a simple text only description of the share.

Parameters
permission the share to describe, containing permission params.
userCtx the context of the user calling this method.
Returns
  • the text description of the share.

public Map<String, String> getTranslatedTemplates (JiraAuthenticationContext userCtx, TypeDescriptor<? extends SharedEntity> type, ShareTypeRenderer.RenderMode mode)

Return map of key -> template that can be used to show a configured shares in Javascript.

Parameters
userCtx the context of the user calling this method.
type the type of the shared entity .
mode the mode that should be rendered.
Returns
  • a map of key -> templates that can be used to render a share type.

public boolean isAddButtonNeeded (JiraAuthenticationContext userCtx)

Return whether or not the component needs a button.

Parameters
userCtx the context of the user calling this method.
Returns
  • true if the HTML component needs a button or false otherwise.

public String renderPermission (SharePermission permission, JiraAuthenticationContext userCtx)

Return HTML that shows the configured share.

Parameters
permission the share to render.
userCtx the context of the user calling this method.
Returns
  • the HTML that shows the passed share.