com.atlassian.jira.plugin.navigation

Interface TopNavigationModuleDescriptor

All Superinterfaces:

com.atlassian.plugin.web.descriptors.ConditionalDescriptor, JiraResourcedModuleDescriptor<PluggableTopNavigation>, com.atlassian.plugin.ModuleDescriptor<PluggableTopNavigation>, OrderableModuleDescriptor, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware

All Known Implementing Classes:

TopNavigationModuleDescriptorImpl

public interface TopNavigationModuleDescriptor
extends JiraResourcedModuleDescriptor<PluggableTopNavigation>, OrderableModuleDescriptor, com.atlassian.plugin.web.descriptors.ConditionalDescriptor

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

Since:

v3.12

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getTopNavigationContext(javax.servlet.http.HttpServletRequest request, Map<String,Object> startingParms) getthe velocity context associated with this <top-navigation> module.
String	getTopNavigationHtml(javax.servlet.http.HttpServletRequest request, Map<String,Object> startingParms) render the velocity associated with this <top-navigation> module.

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

getHtml, getHtml, getI18nBean, writeHtml

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, init, init, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

Methods inherited from interface com.atlassian.plugin.ScopeAware

getScopeKey

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceLocation

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

getOrder

Methods inherited from interface com.atlassian.plugin.web.descriptors.ConditionalDescriptor

getCondition

Method Detail

getTopNavigationHtml

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

render the velocity associated with this <top-navigation> module.

getTopNavigationContext

Map<String,Object> getTopNavigationContext(javax.servlet.http.HttpServletRequest request,
                                           Map<String,Object> startingParms)

getthe velocity context associated with this <top-navigation> module.

Since:

5.2