public class

DefaultWebItemModuleDescriptor

extends AbstractWebFragmentModuleDescriptor<T>
implements WebItemModuleDescriptor
java.lang.Object
   ↳ com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
     ↳ com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor<T>
       ↳ com.atlassian.plugin.web.descriptors.DefaultWebItemModuleDescriptor

Class Overview

Represents a pluggable link.

Summary

[Expand]
Inherited Constants
From interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor
[Expand]
Inherited Fields
From class com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
Public Constructors
DefaultWebItemModuleDescriptor(WebInterfaceManager webInterfaceManager)
DefaultWebItemModuleDescriptor()
Public Methods
void enabled()
Enables the descriptor by loading the module class.
WebIcon getIcon()
WebLink getLink()
Void getModule()
The particular module object created by this plugin.
String getSection()
String getStyleClass()
Returns the item style as a "class" String consisting of one or more style classes.
void init(Plugin plugin, Element element)
Initialise a module given it's parent plugin and the XML element representing the module.
[Expand]
Inherited Methods
From class com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor
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
From interface com.atlassian.plugin.web.descriptors.ConditionalDescriptor
From interface com.atlassian.plugin.web.descriptors.ContextAware
From interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor
From interface com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor
From interface com.atlassian.plugin.web.descriptors.WeightedDescriptor

Public Constructors

public DefaultWebItemModuleDescriptor (WebInterfaceManager webInterfaceManager)

public DefaultWebItemModuleDescriptor ()

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 WebIcon getIcon ()

public WebLink getLink ()

public Void getModule ()

The particular module object created by this plugin.

Returns
  • The module object created by this plugin.

public String getSection ()

public String getStyleClass ()

Returns the item style as a "class" String consisting of one or more style classes. The default value returned should be an empty String rather than null.

Where possible, use of this method is preferred over getIcon as it allows more flexibility for CSS-based web element styling and class-based JavaScript behaviour.

Returns
  • space-separated list of style classes

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