com.atlassian.jira.sharing.type

Class UserShareTypeRenderer

java.lang.Object

com.atlassian.jira.sharing.type.VelocityShareTypeRenderer

com.atlassian.jira.sharing.type.UserShareTypeRenderer

All Implemented Interfaces:

ShareTypeRenderer

public class UserShareTypeRenderer
extends VelocityShareTypeRenderer

A ShareTypeRenderer for the UserShareType.

Since:

v7.12

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.sharing.type.ShareTypeRenderer

ShareTypeRenderer.RenderMode

Field Summary

Fields inherited from class com.atlassian.jira.sharing.type.VelocityShareTypeRenderer

BOLD_END, BOLD_START

Constructor Summary

Constructors

Constructor and Description
UserShareTypeRenderer(EncodingConfiguration encoding, VelocityTemplatingEngine templatingEngine, UserManager userManager, GlobalPermissionManager globalPermissionManager)

Method Summary

Modifier and Type	Method and Description
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, SharedEntity.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.

Methods inherited from class com.atlassian.jira.sharing.type.VelocityShareTypeRenderer

renderVelocity

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserShareTypeRenderer

public UserShareTypeRenderer(EncodingConfiguration encoding,
                             VelocityTemplatingEngine templatingEngine,
                             UserManager userManager,
                             GlobalPermissionManager globalPermissionManager)

Method Detail

renderPermission

public String renderPermission(SharePermission permission,
                               JiraAuthenticationContext userCtx)

Description copied from interface: ShareTypeRenderer

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.

getSimpleDescription

public String getSimpleDescription(SharePermission permission,
                                   JiraAuthenticationContext userCtx)

Description copied from interface: ShareTypeRenderer

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.

getShareTypeEditor

public String getShareTypeEditor(JiraAuthenticationContext userCtx)

Description copied from interface: ShareTypeRenderer

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.

isAddButtonNeeded

public boolean isAddButtonNeeded(JiraAuthenticationContext userCtx)

Description copied from interface: ShareTypeRenderer

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.

getShareTypeLabel

public String getShareTypeLabel(JiraAuthenticationContext userCtx)

Description copied from interface: ShareTypeRenderer

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.

getTranslatedTemplates

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

Description copied from interface: ShareTypeRenderer

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.