com.atlassian.plugin.web.descriptors
Class DefaultWebItemModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
      com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor<Void>
          com.atlassian.plugin.web.descriptors.DefaultWebItemModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor<Void>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware, ConditionalDescriptor, ContextAware, WebFragmentModuleDescriptor<Void>, WebItemModuleDescriptor, WeightedDescriptor

public class DefaultWebItemModuleDescriptor
extends AbstractWebFragmentModuleDescriptor<Void>
implements WebItemModuleDescriptor

Represents a pluggable link.

Field Summary

Fields inherited from class com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor

condition, contextProvider, element, label, params, tooltip, webInterfaceManager, weight

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources, singleton

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

COMPOSITE_TYPE_AND, COMPOSITE_TYPE_OR

Constructor Summary

DefaultWebItemModuleDescriptor()

DefaultWebItemModuleDescriptor(WebInterfaceManager webInterfaceManager)

Method Summary

void	enabled()
WebIcon	getIcon()
WebLink	getLink()
Void	getModule()
String	getSection()
String	getStyleClass() Returns the item style as a "class" String consisting of one or more style classes.
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)

Methods inherited from class com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor

disabled, equals, getCondition, getContextProvider, getTooltip, getWebLabel, getWebParams, getWeight, hashCode, makeCondition, makeConditions, makeConditions, makeContextProvider, setWebInterfaceManager

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, checkPermissions, destroy, destroy, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setPlugin, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getCondition, getTooltip, getWebLabel, getWebParams, getWeight

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

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

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation

Methods inherited from interface com.atlassian.plugin.StateAware

disabled

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

getContextProvider

Constructor Detail

DefaultWebItemModuleDescriptor

public DefaultWebItemModuleDescriptor(WebInterfaceManager webInterfaceManager)

DefaultWebItemModuleDescriptor

public DefaultWebItemModuleDescriptor()

Method Detail

init

public void init(com.atlassian.plugin.Plugin plugin,
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException

Specified by:

init in interface com.atlassian.plugin.ModuleDescriptor<Void>

Overrides:

init in class AbstractWebFragmentModuleDescriptor<Void>

Throws:

com.atlassian.plugin.PluginParseException

getSection

public String getSection()

Specified by:

getSection in interface WebItemModuleDescriptor

getLink

public WebLink getLink()

Specified by:

getLink in interface WebItemModuleDescriptor

getIcon

public WebIcon getIcon()

Specified by:

getIcon in interface WebItemModuleDescriptor

getStyleClass

public String getStyleClass()

Description copied from interface: WebItemModuleDescriptor

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.

Specified by:

getStyleClass in interface WebItemModuleDescriptor

Returns:

space-separated list of style classes

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class AbstractWebFragmentModuleDescriptor<Void>

getModule

public Void getModule()

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor<Void>

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>