com.atlassian.jira.plugin.navigation
Class TopNavigationModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
      com.atlassian.jira.plugin.JiraResourcedModuleDescriptor<PluggableTopNavigation>
          com.atlassian.jira.plugin.navigation.TopNavigationModuleDescriptor

All Implemented Interfaces:

OrderableModuleDescriptor, com.atlassian.plugin.ModuleDescriptor<PluggableTopNavigation>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware

public class TopNavigationModuleDescriptor
extends JiraResourcedModuleDescriptor<PluggableTopNavigation>
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

moduleClassName, plugin, resources, singleton

Constructor Summary

TopNavigationModuleDescriptor(JiraAuthenticationContext authenticationContext, ApplicationProperties applicationProperties, com.atlassian.plugin.webresource.WebResourceManager webResourceManager, PermissionManager permissionManager, WebFragmentWebComponent webFragmentWebComponent, UserProjectHistoryManager userProjectHistoryManager, com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

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

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

assertResourceExists, createModule, createVelocityParams, disabled, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getModule, getName, getText, getText, isResourceExist

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

assertModuleClassImplements, destroy, enabled, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, 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,
                                     UserProjectHistoryManager userProjectHistoryManager,
                                     com.atlassian.plugin.module.ModuleFactory moduleFactory)

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<PluggableTopNavigation>

Overrides:

init in class JiraResourcedModuleDescriptor<PluggableTopNavigation>

Throws:

com.atlassian.plugin.PluginParseException

getOrder

public int getOrder()

Specified by:

getOrder in interface OrderableModuleDescriptor

getTopNavigationHtml

public java.lang.String getTopNavigationHtml(javax.servlet.http.HttpServletRequest request,
                                             java.util.Map<java.lang.String,java.lang.Object> startingParms)