com.atlassian.plugin.web.descriptors
Interface WebItemModuleDescriptor

All Superinterfaces:

ConditionalDescriptor, ContextAware, ModuleDescriptor<java.lang.Void>, Resourced, StateAware, WebFragmentModuleDescriptor, WeightedDescriptor

All Known Implementing Classes:

DefaultWebItemModuleDescriptor

public interface WebItemModuleDescriptor
extends WebFragmentModuleDescriptor

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

See Also:

WebSectionModuleDescriptor

Field Summary

Fields inherited from interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor

COMPOSITE_TYPE_AND, COMPOSITE_TYPE_OR

Method Summary

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

Methods inherited from interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor

getCondition, getTooltip, getWebLabel, getWebParams, getWeight

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

destroy, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, init, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation

Methods inherited from interface com.atlassian.plugin.StateAware

disabled, enabled

Methods inherited from interface com.atlassian.plugin.web.descriptors.ContextAware

getContextProvider

Method Detail

getSection

java.lang.String getSection()

getLink

WebLink getLink()

getIcon

WebIcon getIcon()

getStyleClass

java.lang.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