com.atlassian.jira.plugin.navigation
Class TopNavigationModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor
      com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
          com.atlassian.jira.plugin.navigation.TopNavigationModuleDescriptor

All Implemented Interfaces:

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

public class TopNavigationModuleDescriptor
extends JiraResourcedModuleDescriptor
implements OrderableModuleDescriptor

Module descriptor used for plugins that render the top navigation in JIRA.

Since:

v3.12

Field Summary

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

RESOURCE_TYPE_I18N

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

plugin, resources, singleton

Constructor Summary

TopNavigationModuleDescriptor(JiraAuthenticationContext authenticationContext, ApplicationProperties applicationProperties, com.atlassian.plugin.webresource.WebResourceManager webResourceManager, PermissionManager permissionManager, WebFragmentWebComponent webFragmentWebComponent, JiraSession jiraSession)

Method Summary

Object	getModule()
int	getOrder()
String	getTopNavigationHtml(javax.servlet.http.HttpServletRequest request, Map startingParms)
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)

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

assertResourceExists, createVelocityParams, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getI18nLocations, getName, getText, getText, isResourceExist

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

assertModuleClassImplements, destroy, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, satisfiesMinJavaVersion, setPlugin, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TopNavigationModuleDescriptor

public TopNavigationModuleDescriptor(JiraAuthenticationContext authenticationContext,
                                     ApplicationProperties applicationProperties,
                                     com.atlassian.plugin.webresource.WebResourceManager webResourceManager,
                                     PermissionManager permissionManager,
                                     WebFragmentWebComponent webFragmentWebComponent,
                                     JiraSession jiraSession)

Method Detail

getModule

public Object getModule()

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

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 JiraResourcedModuleDescriptor

Throws:

com.atlassian.plugin.PluginParseException

getOrder

public int getOrder()

Specified by:

getOrder in interface OrderableModuleDescriptor

getTopNavigationHtml

public String getTopNavigationHtml(javax.servlet.http.HttpServletRequest request,
                                   Map startingParms)