public abstract class

AbstractWebFragmentModuleDescriptor

extends AbstractModuleDescriptor<T>
implements StateAware WebFragmentModuleDescriptor
java.lang.Object
   ↳ com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
     ↳ com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor
Known Direct Subclasses

Class Overview

An abstract convenience class for web fragment descriptors.

Summary

[Expand]
Inherited Constants
From interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor
Fields
protected Condition condition
protected ContextProvider contextProvider
protected Element element
protected DefaultWebLabel label
protected WebParam params
protected DefaultWebLabel tooltip
protected WebInterfaceManager webInterfaceManager
protected int weight
[Expand]
Inherited Fields
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
Public Constructors
AbstractWebFragmentModuleDescriptor()
Protected Constructors
AbstractWebFragmentModuleDescriptor(WebInterfaceManager webInterfaceManager)
Public Methods
void disabled()
Disables the module descriptor.
void enabled()
Enables the descriptor by loading the module class.
Condition getCondition()
ContextProvider getContextProvider()
WebLabel getTooltip()
WebLabel getWebLabel()
WebParam getWebParams()
int getWeight()
void init(Plugin plugin, Element element)
Initialise a module given it's parent plugin and the XML element representing the module.
void setWebInterfaceManager(WebInterfaceManager webInterfaceManager)
Protected Methods
Condition makeCondition(Element element)
Condition makeConditions(List elements, int type)
Condition makeConditions(Element element, int type)
Create a condition for when this web fragment should be displayed
ContextProvider makeContextProvider(Element element)
[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
From interface com.atlassian.plugin.web.descriptors.ConditionalDescriptor
From interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor
From interface com.atlassian.plugin.web.descriptors.WeightedDescriptor

Fields

protected Condition condition

protected ContextProvider contextProvider

protected Element element

protected DefaultWebLabel label

protected WebParam params

protected DefaultWebLabel tooltip

protected WebInterfaceManager webInterfaceManager

protected int weight

Public Constructors

public AbstractWebFragmentModuleDescriptor ()

Protected Constructors

protected AbstractWebFragmentModuleDescriptor (WebInterfaceManager webInterfaceManager)

Public Methods

public void disabled ()

Disables the module descriptor. Classes overriding this method MUST call super.disabled() after their own disabling code.

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 Condition getCondition ()

public ContextProvider getContextProvider ()

public WebLabel getTooltip ()

public WebLabel getWebLabel ()

public WebParam getWebParams ()

public int getWeight ()

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

public void setWebInterfaceManager (WebInterfaceManager webInterfaceManager)

Protected Methods

protected Condition makeCondition (Element element)

Throws
PluginParseException

protected Condition makeConditions (List elements, int type)

Throws
PluginParseException

protected Condition makeConditions (Element element, int type)

Create a condition for when this web fragment should be displayed

Parameters
element Element of web-section or web-item
type logical operator type ConditionElementParser#get(String)
Throws
PluginParseException

protected ContextProvider makeContextProvider (Element element)

Throws
PluginParseException