com.atlassian.jira.plugin.portlet
Class PortletModuleDescriptor

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

public class PortletModuleDescriptor
extends ConfigurableModuleDescriptor

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


Field Summary
 
Fields inherited from class com.atlassian.jira.plugin.ConfigurableModuleDescriptor
objectDescriptor
 
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
PortletModuleDescriptor(JiraAuthenticationContext authenticationContext)
           
 
Method Summary
 String getLabel()
           
 String getLabelKey()
           
 Object getModule()
           
 int getPermission()
           
 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
getObjectConfiguration
 
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

PortletModuleDescriptor

public PortletModuleDescriptor(JiraAuthenticationContext authenticationContext)
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
Overrides:
init in class ConfigurableModuleDescriptor
Throws:
com.atlassian.plugin.PluginParseException

getModule

public Object getModule()
Specified by:
getModule in interface com.atlassian.plugin.ModuleDescriptor
Specified by:
getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

getLabel

public String getLabel()

getLabelKey

public String getLabelKey()

getThumbnail

public 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-2008 Atlassian. All Rights Reserved.