public class

ShareTypeRendererBean

extends Object
java.lang.Object
   ↳ com.atlassian.jira.web.bean.ShareTypeRendererBean

Class Overview

Helper class that is used to render share types.

Summary

Public Constructors
ShareTypeRendererBean(ShareType shareType, JiraAuthenticationContext authenticationContext, ShareTypeRenderer.RenderMode renderMode, TypeDescriptor typeDescriptor)
Public Methods
String getShareType()
String getShareTypeEditor()
Return the HTML of the component that is used to configure the ShareType when necessary.
String getShareTypeLabel()
Return a string that can be used to differentiate the associated ShareType.
String getShareTypeSelector()
Return the HTML of the component that is used to select the ShareType instance when necessary.
Map getTranslatedTemplates()
Return a map of key-> message templates for inclusion in the Javascript that renders the shares.
boolean isAddButtonNeeded()
Return whether or not the component needs a button.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ShareTypeRendererBean (ShareType shareType, JiraAuthenticationContext authenticationContext, ShareTypeRenderer.RenderMode renderMode, TypeDescriptor typeDescriptor)

Public Methods

public String getShareType ()

public String getShareTypeEditor ()

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

Returns
  • The HTML component to render the ShareType.

public String getShareTypeLabel ()

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.

Returns
  • A ShareType description.

public String getShareTypeSelector ()

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

Returns
  • The HTML component to render the ShareType selector.

public Map getTranslatedTemplates ()

Return a map of key-> message templates for inclusion in the Javascript that renders the shares.

Returns
  • map of key->message for inclusion in the Javascript that renders the shares.

public boolean isAddButtonNeeded ()

Return whether or not the component needs a button.

Returns
  • true if the HTML component needs a button or false otherwise.