com.atlassian.jira.plugin.navigation

Class TopNavigationModuleDescriptorImpl

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>

com.atlassian.jira.plugin.AbstractJiraModuleDescriptor<PluggableTopNavigation>

com.atlassian.jira.plugin.navigation.TopNavigationModuleDescriptorImpl

All Implemented Interfaces:

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

public class TopNavigationModuleDescriptorImpl
extends AbstractJiraModuleDescriptor<PluggableTopNavigation>
implements TopNavigationModuleDescriptor

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

Since:

v3.12

Field Summary

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

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources

Constructor Summary

Constructors

Constructor and Description

TopNavigationModuleDescriptorImpl(JiraAuthenticationContext authenticationContext, ApplicationProperties applicationProperties, com.atlassian.plugin.webresource.WebResourceUrlProvider webResourceUrlProvider, PermissionManager permissionManager, WebFragmentWebComponent webFragmentWebComponent, UserProjectHistoryManager userProjectHistoryManager, com.atlassian.plugin.module.ModuleFactory moduleFactory, JiraWebInterfaceManager webInterfaceManager, ConditionDescriptorFactoryImpl conditionDescriptorFactory)

Method Summary

Modifier and Type	Method and Description
void	enabled()
com.atlassian.plugin.web.Condition	getCondition()
int	getOrder()
Map<String,Object>	getTopNavigationContext(javax.servlet.http.HttpServletRequest request, Map<String,Object> startingParams) 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.
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)

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

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

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

assertModuleClassImplements, checkPermissions, destroy, equals, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, provideValidationRules, satisfiesMinJavaVersion, setBroken, setPlugin, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

Constructor Detail

TopNavigationModuleDescriptorImpl

public TopNavigationModuleDescriptorImpl(JiraAuthenticationContext authenticationContext,
                                         ApplicationProperties applicationProperties,
                                         com.atlassian.plugin.webresource.WebResourceUrlProvider webResourceUrlProvider,
                                         PermissionManager permissionManager,
                                         WebFragmentWebComponent webFragmentWebComponent,
                                         UserProjectHistoryManager userProjectHistoryManager,
                                         com.atlassian.plugin.module.ModuleFactory moduleFactory,
                                         JiraWebInterfaceManager webInterfaceManager,
                                         ConditionDescriptorFactoryImpl conditionDescriptorFactory)

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

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<String,Object> startingParms)

Description copied from interface: TopNavigationModuleDescriptor

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

Specified by:

getTopNavigationHtml in interface TopNavigationModuleDescriptor

getTopNavigationContext

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

Description copied from interface: TopNavigationModuleDescriptor

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

Specified by:

getTopNavigationContext in interface TopNavigationModuleDescriptor

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class AbstractJiraModuleDescriptor<PluggableTopNavigation>

getCondition

public com.atlassian.plugin.web.Condition getCondition()

Specified by:

getCondition in interface com.atlassian.plugin.web.descriptors.ConditionalDescriptor