com.atlassian.plugin.web.descriptors

Class WebPanelRendererModuleDescriptor

java.lang.Object

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

com.atlassian.plugin.web.descriptors.WebPanelRendererModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor<WebPanelRenderer>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware

public class WebPanelRendererModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<WebPanelRenderer>

The web panel renderer module is used to add web panel renderers to the plugin system.

Since:

2.5.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	XML_ELEMENT_NAME Host applications should use this string when registering the WebPanelRendererModuleDescriptor.

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

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

Constructor Summary

Constructors

Constructor and Description
WebPanelRendererModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleClassFactory)

Method Summary

Modifier and Type	Method and Description
void	enabled()
WebPanelRenderer	getModule()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
protected void	provideValidationRules(com.atlassian.plugin.util.validation.ValidationPattern pattern)

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

assertModuleClassImplements, checkPermissions, destroy, disabled, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, 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.plugin.ModuleDescriptor

getDisplayName

Field Detail

XML_ELEMENT_NAME

public static final String XML_ELEMENT_NAME

Host applications should use this string when registering the WebPanelRendererModuleDescriptor.

See Also:

Constant Field Values

Constructor Detail

WebPanelRendererModuleDescriptor

public WebPanelRendererModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleClassFactory)

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

Overrides:

init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<WebPanelRenderer>

Throws:

com.atlassian.plugin.PluginParseException

provideValidationRules

protected void provideValidationRules(com.atlassian.plugin.util.validation.ValidationPattern pattern)

Overrides:

provideValidationRules in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<WebPanelRenderer>

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<WebPanelRenderer>

getModule

public WebPanelRenderer getModule()

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor<WebPanelRenderer>

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<WebPanelRenderer>