com.atlassian.jira.plugin.aboutpagepanel

Class AboutPagePanelModuleDescriptorImpl

java.lang.Object

com.atlassian.plugin.web.descriptors.DefaultAbstractWebFragmentModuleDescriptor<Void>

com.atlassian.jira.plugin.webfragment.descriptors.JiraAbstractWebFragmentModuleDescriptor

com.atlassian.jira.plugin.aboutpagepanel.AboutPagePanelModuleDescriptorImpl

All Implemented Interfaces:

AboutPagePanelModuleDescriptor, JiraResourcedModuleDescriptor<Void>, com.atlassian.plugin.ModuleDescriptor<Void>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware, com.atlassian.plugin.web.descriptors.ConditionalDescriptor, com.atlassian.plugin.web.descriptors.ContextAware, com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor<Void>, com.atlassian.plugin.web.descriptors.WeightedDescriptor

public class AboutPagePanelModuleDescriptorImpl
extends JiraAbstractWebFragmentModuleDescriptor
implements AboutPagePanelModuleDescriptor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AboutPagePanelModuleDescriptorImpl.Material Encapsulates data from the Bill Of Materials
static class	AboutPagePanelModuleDescriptorImpl.PluginAndMaterials Ties a bill of materials in with its plugins

Field Summary

Fields inherited from class com.atlassian.jira.plugin.webfragment.descriptors.JiraAbstractWebFragmentModuleDescriptor

authenticationContext

Constructor Summary

Constructors

Constructor and Description
AboutPagePanelModuleDescriptorImpl(JiraAuthenticationContext jiraAuthenticationContext, com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager, EncodingConfiguration encodingConfiguration, SoyTemplateRendererProvider soyTemplateRendererProvider, BomParser bomParser)

Method Summary

Methods

Modifier and Type	Method and Description
String	getConclusionModuleKey()
String	getHtml(String resourceName)
String	getHtml(String resourceName, Map<String,?> startingParams)
String	getIntroductionModuleKey()
String	getLicensesLocation()
String	getPluginSectionHtml() Gets the rendered HTML for this plugin, to be displayed on the About page.
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
void	writeHtml(String resourceName, Map<String,?> startingParams, Writer writer)

Methods inherited from class com.atlassian.jira.plugin.webfragment.descriptors.JiraAbstractWebFragmentModuleDescriptor

getDescription, getI18nBean, getLabel, getName, getTooltip, getWebParams

Methods inherited from class com.atlassian.plugin.web.descriptors.DefaultAbstractWebFragmentModuleDescriptor

destroy, destroy, disabled, enabled, getCompleteKey, getCondition, getContextProvider, getDecoratedDescriptor, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, getWebLabel, getWeight, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setWebInterfaceManager, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor

getI18nBean

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

destroy, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation

Constructor Detail

AboutPagePanelModuleDescriptorImpl

public AboutPagePanelModuleDescriptorImpl(JiraAuthenticationContext jiraAuthenticationContext,
                                  com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager,
                                  EncodingConfiguration encodingConfiguration,
                                  SoyTemplateRendererProvider soyTemplateRendererProvider,
                                  BomParser bomParser)

Method Detail

init

public void init(com.atlassian.plugin.Plugin plugin,
        org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException

Specified by:

init in interface com.atlassian.plugin.ModuleDescriptor<Void>

Overrides:

init in class com.atlassian.plugin.web.descriptors.DefaultAbstractWebFragmentModuleDescriptor<Void>

Throws:

com.atlassian.plugin.PluginParseException

getPluginSectionHtml

public String getPluginSectionHtml()

Description copied from interface: AboutPagePanelModuleDescriptor

Gets the rendered HTML for this plugin, to be displayed on the About page.

Specified by:

getPluginSectionHtml in interface AboutPagePanelModuleDescriptor

Returns:

the rendered HTML for this plugin

getHtml

public String getHtml(String resourceName)

Specified by:

getHtml in interface JiraResourcedModuleDescriptor<Void>

getHtml

public String getHtml(String resourceName,
             Map<String,?> startingParams)

Specified by:

getHtml in interface JiraResourcedModuleDescriptor<Void>

writeHtml

public void writeHtml(String resourceName,
             Map<String,?> startingParams,
             Writer writer)
               throws IOException

Specified by:

writeHtml in interface JiraResourcedModuleDescriptor<Void>

Throws:

IOException

getIntroductionModuleKey

public String getIntroductionModuleKey()

getLicensesLocation

public String getLicensesLocation()

getConclusionModuleKey

public String getConclusionModuleKey()