com.atlassian.jira.plugin.portlet
Class PortletModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor
      com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
          com.atlassian.jira.plugin.ConfigurableModuleDescriptor
              com.atlassian.jira.plugin.portlet.PortletModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor, com.atlassian.plugin.Resourced

public class PortletModuleDescriptor

extends ConfigurableModuleDescriptor

The portlet plugin allows end users to write plugins for JIRA.

Field Summary

(package private) String	label
(package private) String	labelKey

Fields inherited from class com.atlassian.jira.plugin.ConfigurableModuleDescriptor

objectDescriptor

Fields inherited from class com.atlassian.jira.plugin.JiraResourcedModuleDescriptor

RESOURCE_TYPE_I18N

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

plugin, singleton

Constructor Summary

PortletModuleDescriptor(JiraAuthenticationContext authenticationContext)

Method Summary

protected List	getI18nLocations() Override the default resource locations to add 'Dashboard' as a i18n resource location
String	getLabel()
String	getLabelKey()
Object	getModule()
int	getPermission()
String	getThumbnail()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)

Methods inherited from class com.atlassian.jira.plugin.ConfigurableModuleDescriptor

getObjectConfiguration

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

assertResourceExists, createVelocityParams, getAuthenticationContext, getDefaultVelocityParams, getDescription, getHtml, getHtml, getHttpRequest, getI18nBean, getName, getText, getText, isResourceExist

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, destroy, getCompleteKey, getKey, getMinJavaVersion, getModuleClass, getParams, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, satisfiesMinJavaVersion, setPlugin

Methods inherited from class java.lang.Object

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

Field Detail

label

String label

labelKey

String labelKey

Constructor Detail

PortletModuleDescriptor

public PortletModuleDescriptor(JiraAuthenticationContext authenticationContext)

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

Overrides:

init in class ConfigurableModuleDescriptor

Throws:

com.atlassian.plugin.PluginParseException

getModule

public Object getModule()

getLabel

public String getLabel()

getLabelKey

public String getLabelKey()

getThumbnail

public String getThumbnail()

getPermission

public int getPermission()

getI18nLocations

protected List getI18nLocations()

Override the default resource locations to add 'Dashboard' as a i18n resource location

Overrides:

getI18nLocations in class JiraResourcedModuleDescriptor