WebItemModuleDescriptor

implements WebFragmentModuleDescriptor

com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor

Known Indirect Subclasses

DefaultWebItemModuleDescriptor

Class Overview

A web-item plugin adds extra links to a particular section.

Summary

[Expand]

Inherited Constants

From interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor

Public Methods
abstract WebIcon	getIcon()
abstract WebLink	getLink()
abstract String	getSection()
abstract String	getStyleClass() Returns the item style as a "class" String consisting of one or more style classes.

[Expand]

Inherited Methods

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

Public Methods

public abstract WebIcon getIcon ()

public abstract WebLink getLink ()

public abstract String getSection ()

public abstract 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

Interfaces

Classes