com.atlassian.jira.web.bean

Class ShareTypeRendererBean

java.lang.Object

com.atlassian.jira.web.bean.ShareTypeRendererBean

public class ShareTypeRendererBean
extends Object

Helper class that is used to render share types.

Since:

v3.13

Constructor Summary

Constructors

Constructor and Description
ShareTypeRendererBean(ShareType shareType, JiraAuthenticationContext authenticationContext, ShareTypeRenderer.RenderMode renderMode, SharedEntity.TypeDescriptor typeDescriptor)

Method Summary

Modifier and Type	Method and Description
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.
static Collection<ShareTypeRendererBean>	getShareTypeRendererBeans(JiraAuthenticationContext authCtx, ShareTypeFactory shareTypeFactory, ShareType.UsageContextType usageContextType, SharedEntity.TypeDescriptor typeDescriptor) Return a collection of renderer beans which can be used in specified context
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.
boolean	isAvailable() Return true if the share types is available to be used.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShareTypeRendererBean

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

Method Detail

getShareType

public String getShareType()

getShareTypeEditor

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.

getShareTypeSelector

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.

isAddButtonNeeded

public boolean isAddButtonNeeded()

Return whether or not the component needs a button.

Returns:

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

getShareTypeLabel

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.

isAvailable

public boolean isAvailable()

Return true if the share types is available to be used.

Returns:

true if the share types is available to be used.

getTranslatedTemplates

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.

getShareTypeRendererBeans

public static Collection<ShareTypeRendererBean> getShareTypeRendererBeans(JiraAuthenticationContext authCtx,
                                                                          ShareTypeFactory shareTypeFactory,
                                                                          ShareType.UsageContextType usageContextType,
                                                                          SharedEntity.TypeDescriptor typeDescriptor)

Return a collection of renderer beans which can be used in specified context

Parameters:

authCtx - used to initialize the bean

shareTypeFactory - used to get share types

usageContextType - used to filter share types by specified context

typeDescriptor - used to initialize the bean

Returns:

Collection of filtered beans which can be used in specified context

Since:

v7.12