public class

WebPanelRendererModuleDescriptor

extends AbstractModuleDescriptor<T>
java.lang.Object
   ↳ com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
     ↳ com.atlassian.plugin.web.descriptors.WebPanelRendererModuleDescriptor

Class Overview

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

Summary

Constants
String XML_ELEMENT_NAME Host applications should use this string when registering the WebPanelRendererModuleDescriptor.
[Expand]
Inherited Fields
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
Public Constructors
WebPanelRendererModuleDescriptor(ModuleFactory moduleClassFactory)
Public Methods
void enabled()
Enables the descriptor by loading the module class.
WebPanelRenderer getModule()
The particular module object created by this plugin.
void init(Plugin plugin, Element element)
Initialise a module given it's parent plugin and the XML element representing the module.
Protected Methods
void provideValidationRules(ValidationPattern pattern)
Provides validation rules for the pattern
[Expand]
Inherited Methods
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
From class java.lang.Object
From interface com.atlassian.plugin.ModuleDescriptor
From interface com.atlassian.plugin.Resourced
From interface com.atlassian.plugin.StateAware

Constants

public static final String XML_ELEMENT_NAME

Host applications should use this string when registering the WebPanelRendererModuleDescriptor.

Constant Value: "web-panel-renderer"

Public Constructors

public WebPanelRendererModuleDescriptor (ModuleFactory moduleClassFactory)

Public Methods

public void enabled ()

Enables the descriptor by loading the module class. Classes overriding this method MUST call super.enabled() before their own enabling code.

public WebPanelRenderer getModule ()

The particular module object created by this plugin.

Returns
  • The module object created by this plugin.

public void init (Plugin plugin, Element element)

Initialise a module given it's parent plugin and the XML element representing the module.

Since atlassian-plugins v2.2, you can no longer load classes from the plugin in this method, because the OSGi bundle that they will live in is not built yet. Load classes in the enabled() method instead.

Parameters
plugin The plugin that the module belongs to. Must not be null.
element XML element representing the module. Must not be null.
Throws
PluginParseException

Protected Methods

protected void provideValidationRules (ValidationPattern pattern)

Provides validation rules for the pattern

Parameters
pattern The validation pattern