public class GlobalShareTypeRenderer extends Object implements ShareTypeRenderer
GlobalShareType
.ShareTypeRenderer.RenderMode
Constructor and Description |
---|
GlobalShareTypeRenderer() |
Modifier and Type | Method and Description |
---|---|
String |
getShareTypeEditor(JiraAuthenticationContext authenticationContext)
Return the HTML of the component that is used to configure the ShareType when necessary.
|
String |
getShareTypeLabel(JiraAuthenticationContext authenticationContext)
Return a string that can be used to differentiate the associated ShareType.
|
String |
getSimpleDescription(SharePermission permission,
JiraAuthenticationContext authenticationContext)
Return a simple text only description of the share.
|
Map<String,String> |
getTranslatedTemplates(JiraAuthenticationContext authenticationContext,
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 authenticationContext)
Return HTML that shows the configured share.
|
public String renderPermission(SharePermission permission, JiraAuthenticationContext authenticationContext)
ShareTypeRenderer
renderPermission
in interface ShareTypeRenderer
permission
- the share to render.authenticationContext
- the context of the user calling this method.public String getSimpleDescription(SharePermission permission, JiraAuthenticationContext authenticationContext)
ShareTypeRenderer
getSimpleDescription
in interface ShareTypeRenderer
permission
- the share to describe, containing permission params.authenticationContext
- the context of the user calling this method.public String getShareTypeEditor(JiraAuthenticationContext authenticationContext)
ShareTypeRenderer
getShareTypeEditor
in interface ShareTypeRenderer
authenticationContext
- the context of the user calling this method.public boolean isAddButtonNeeded(JiraAuthenticationContext userCtx)
ShareTypeRenderer
isAddButtonNeeded
in interface ShareTypeRenderer
userCtx
- the context of the user calling this method.public String getShareTypeLabel(JiraAuthenticationContext authenticationContext)
ShareTypeRenderer
getShareTypeLabel
in interface ShareTypeRenderer
authenticationContext
- the context of the user calling this method.public Map<String,String> getTranslatedTemplates(JiraAuthenticationContext authenticationContext, SharedEntity.TypeDescriptor<? extends SharedEntity> type, ShareTypeRenderer.RenderMode mode)
ShareTypeRenderer
getTranslatedTemplates
in interface ShareTypeRenderer
authenticationContext
- the context of the user calling this method.type
- the type of the shared entity .mode
- the mode that should be rendered.Copyright © 2002-2023 Atlassian. All Rights Reserved.