com.atlassian.jira.sharing.type
Class GlobalShareTypeRenderer

java.lang.Object
  extended by com.atlassian.jira.sharing.type.GlobalShareTypeRenderer
All Implemented Interfaces:
ShareTypeRenderer

public class GlobalShareTypeRenderer
extends Object
implements ShareTypeRenderer

A renderer for the GlobalShareType.

Since:
v3.13

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.atlassian.jira.sharing.type.ShareTypeRenderer
ShareTypeRenderer.RenderMode
 
Constructor Summary
GlobalShareTypeRenderer()
           
 
Method Summary
 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 getTranslatedTemplates(JiraAuthenticationContext authenticationContext, SharedEntity.TypeDescriptor 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GlobalShareTypeRenderer

public GlobalShareTypeRenderer()
Method Detail

renderPermission

public String renderPermission(SharePermission permission,
                               JiraAuthenticationContext authenticationContext)
Description copied from interface: ShareTypeRenderer
Return HTML that shows the configured share.

Specified by:
renderPermission in interface ShareTypeRenderer
Parameters:
permission - the share to render.
authenticationContext - the context of the user calling this method.
Returns:
the HTML that shows the passed share.

getSimpleDescription

public String getSimpleDescription(SharePermission permission,
                                   JiraAuthenticationContext authenticationContext)
Description copied from interface: ShareTypeRenderer
Return a simple text only description of the share.

Specified by:
getSimpleDescription in interface ShareTypeRenderer
Parameters:
permission - the share to describe, containing permission params.
authenticationContext - the context of the user calling this method.
Returns:
the text description of the share.

getShareTypeEditor

public String getShareTypeEditor(JiraAuthenticationContext authenticationContext)
Description copied from interface: ShareTypeRenderer
Return the HTML of the component that is used to configure the ShareType when necessary.

Specified by:
getShareTypeEditor in interface ShareTypeRenderer
Parameters:
authenticationContext - 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.

Specified by:
isAddButtonNeeded in interface ShareTypeRenderer
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 authenticationContext)
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.

Specified by:
getShareTypeLabel in interface ShareTypeRenderer
Parameters:
authenticationContext - the context of the user calling this method.
Returns:
A ShareType description.

getTranslatedTemplates

public Map getTranslatedTemplates(JiraAuthenticationContext authenticationContext,
                                  SharedEntity.TypeDescriptor 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.

Specified by:
getTranslatedTemplates in interface ShareTypeRenderer
Parameters:
authenticationContext - 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.


Copyright © 2002-2008 Atlassian. All Rights Reserved.