com.atlassian.jira.plugin.portlet
Class PortletModuleDescriptor

java.lang.Object
  extended by com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
      extended by com.atlassian.jira.plugin.JiraResourcedModuleDescriptor<T>
          extended by com.atlassian.jira.plugin.ConfigurableModuleDescriptor<Portlet>
              extended by com.atlassian.jira.plugin.portlet.PortletModuleDescriptor
All Implemented Interfaces:
com.atlassian.plugin.ModuleDescriptor<Portlet>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware

public class PortletModuleDescriptor
extends ConfigurableModuleDescriptor<Portlet>

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


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
PortletModuleDescriptor(JiraAuthenticationContext authenticationContext, com.atlassian.plugin.module.ModuleFactory moduleFactory)
           
 
Method Summary
 void enabled()
           
 java.lang.String getLabel()
           
 java.lang.String getLabelKey()
           
 int getPermission()
           
 java.lang.String getThumbnail()
           
 void init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
           
 boolean isLazyLoad()
          Returns a boolean indicating whether the Portlet should be lazily loaded.
 
Methods inherited from class com.atlassian.jira.plugin.ConfigurableModuleDescriptor
disabled, getObjectConfiguration, getObjectDescriptor
 
Methods inherited from class com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
assertResourceExists, createModule, createVelocityParams, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getModule, 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, 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

PortletModuleDescriptor

public PortletModuleDescriptor(JiraAuthenticationContext authenticationContext,
                               com.atlassian.plugin.module.ModuleFactory moduleFactory)
Method Detail

enabled

public void enabled()
Specified by:
enabled in interface com.atlassian.plugin.StateAware
Overrides:
enabled in class ConfigurableModuleDescriptor<Portlet>

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<Portlet>
Overrides:
init in class ConfigurableModuleDescriptor<Portlet>
Throws:
com.atlassian.plugin.PluginParseException

getLabel

public java.lang.String getLabel()

getLabelKey

public java.lang.String getLabelKey()

getThumbnail

public java.lang.String getThumbnail()

getPermission

public int getPermission()

isLazyLoad

public boolean isLazyLoad()
Returns a boolean indicating whether the Portlet should be lazily loaded.

Returns:
true if the portlet should be lazily loaded
Since:
Jira 3.7


Copyright © 2002-2010 Atlassian. All Rights Reserved.