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

DefaultWebItemModuleDescriptor, DefaultWebSectionModuleDescriptor

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() Returns the ContextProvider that augments the context used to render a web module.
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

final void	assertModuleClassImplements(Class<T> requiredModuleClazz) Check that the module class of this descriptor implements a given interface, or extends a given class.
void	destroy(Plugin plugin) Override this if your plugin needs to clean up when it's been removed.
void	disabled() Disables the module descriptor.
void	enabled() Enables the descriptor by loading the module class.
String	getCompleteKey() The complete key for this module, including the plugin key.
String	getDescription() A simple description of this descriptor.
String	getDescriptionKey() Key used to override `getDescription()` when using internationalisation.
String	getI18nNameKey() Key used to override `getName()` when using internationalisation.
String	getKey() The key for this module, unique within the plugin.
Float	getMinJavaVersion()
abstract T	getModule() The particular module object created by this plugin.
Class<T>	getModuleClass() The class of the module this descriptor creates.
String	getName() A simple string name for this descriptor.
Map<String, String>	getParams()
Plugin	getPlugin()
String	getPluginKey() The plugin key for this module, derived from the complete key.
ResourceDescriptor	getResourceDescriptor(String type, String name) Get a `ResourceDescriptor` of a particular type and name.
List<ResourceDescriptor>	getResourceDescriptors() Get a List of all the `descriptors` .
List<ResourceDescriptor>	getResourceDescriptors(String type) Get a list of all `descriptors` of a particular type.
ResourceLocation	getResourceLocation(String type, String name) Get a `ResourceLocation` of a particular type and name.
void	init(Plugin plugin, Element element) Initialise a module given it's parent plugin and the XML element representing the module.
boolean	isEnabledByDefault() Whether or not this plugin module is enabled by default.
boolean	isSingleton() This method is deprecated. Since 2.2.0
boolean	isSingletonByDefault() This method is deprecated. Since 2.2.0
boolean	isSystemModule() Whether or not this plugin module is a "system" plugin that shouldn't be made visible/disableable to the user.
void	loadClass(Plugin plugin, String clazz) Loads the module class that this descriptor provides, and will not necessarily be the implementation class.
void	loadClass(Plugin plugin, Element element) This method is deprecated. Since 2.1.0, use `loadClass(Plugin, String)` instead
void	provideValidationRules(ValidationPattern pattern) Provides validation rules for the pattern
boolean	satisfiesMinJavaVersion() If a min java version has been specified this will return true if the running jvm is >= to the specified version.
void	setPlugin(Plugin plugin) Sets the plugin for the ModuleDescriptor
String	toString()

From class java.lang.Object

From interface com.atlassian.plugin.ModuleDescriptor

abstract void	destroy(Plugin plugin) Override this if your plugin needs to clean up when it's been removed.
abstract String	getCompleteKey() The complete key for this module, including the plugin key.
abstract String	getDescription() A simple description of this descriptor.
abstract String	getDescriptionKey() Key used to override `getDescription()` when using internationalisation.
abstract String	getI18nNameKey() Key used to override `getName()` when using internationalisation.
abstract String	getKey() The key for this module, unique within the plugin.
abstract Float	getMinJavaVersion()
abstract T	getModule() The particular module object created by this plugin.
abstract Class<T>	getModuleClass() The class of the module this descriptor creates.
abstract String	getName() A simple string name for this descriptor.
abstract Map<String, String>	getParams()
abstract Plugin	getPlugin()
abstract String	getPluginKey() The plugin key for this module, derived from the complete key.
abstract void	init(Plugin plugin, Element element) Initialise a module given it's parent plugin and the XML element representing the module.
abstract boolean	isEnabledByDefault() Whether or not this plugin module is enabled by default.
abstract boolean	isSystemModule() Whether or not this plugin module is a "system" plugin that shouldn't be made visible/disableable to the user.
abstract boolean	satisfiesMinJavaVersion() If a min java version has been specified this will return true if the running jvm is >= to the specified version.

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.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 ()

Returns the ContextProvider that augments the context used to render a web module.

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

Interfaces

Classes

AbstractWebFragmentModuleDescriptor

Class Overview

Summary

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

public void enabled ()

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)

Parameters

Throws

public void setWebInterfaceManager (WebInterfaceManager webInterfaceManager)

Protected Methods

protected Condition makeCondition (Element element)

Throws

protected Condition makeConditions (List elements, int type)

Throws

protected Condition makeConditions (Element element, int type)

Parameters

Throws

protected ContextProvider makeContextProvider (Element element)

Throws