com.atlassian.plugin.web.descriptors
Class AbstractWebFragmentModuleDescriptor<T>

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultWebItemModuleDescriptor, DefaultWebPanelModuleDescriptor, DefaultWebSectionModuleDescriptor

public abstract class AbstractWebFragmentModuleDescriptor<T>
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
implements com.atlassian.plugin.StateAware, WebFragmentModuleDescriptor<T>

An abstract convenience class for web fragment descriptors.

Field Summary

protected Condition	condition
protected ContextProvider	contextProvider
protected org.dom4j.Element	element
protected DefaultWebLabel	label
protected WebParam	params
protected DefaultWebLabel	tooltip
protected WebInterfaceManager	webInterfaceManager
protected int	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

	AbstractWebFragmentModuleDescriptor()
	AbstractWebFragmentModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleClassFactory, WebInterfaceManager webInterfaceManager)
protected	AbstractWebFragmentModuleDescriptor(WebInterfaceManager webInterfaceManager)

Method Summary

void	disabled()
void	enabled()
boolean	equals(Object obj)
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()
int	hashCode()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
protected Condition	makeCondition(org.dom4j.Element element)
protected Condition	makeConditions(org.dom4j.Element element, int type) Create a condition for when this web fragment should be displayed
protected Condition	makeConditions(List elements, int type)
protected ContextProvider	makeContextProvider(org.dom4j.Element element)
void	setWebInterfaceManager(WebInterfaceManager webInterfaceManager)

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

assertModuleClassImplements, checkPermissions, destroy, destroy, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModule, 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.ModuleDescriptor

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

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation

Field Detail

webInterfaceManager

protected WebInterfaceManager webInterfaceManager

element

protected org.dom4j.Element element

weight

protected int weight

condition

protected Condition condition

contextProvider

protected ContextProvider contextProvider

label

protected DefaultWebLabel label

tooltip

protected DefaultWebLabel tooltip

params

protected WebParam params

Constructor Detail

AbstractWebFragmentModuleDescriptor

protected AbstractWebFragmentModuleDescriptor(WebInterfaceManager webInterfaceManager)

AbstractWebFragmentModuleDescriptor

public AbstractWebFragmentModuleDescriptor()

AbstractWebFragmentModuleDescriptor

public AbstractWebFragmentModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleClassFactory,
                                           WebInterfaceManager webInterfaceManager)

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<T>

Overrides:

init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>

Throws:

com.atlassian.plugin.PluginParseException

makeConditions

protected Condition makeConditions(org.dom4j.Element element,
                                   int type)
                            throws com.atlassian.plugin.PluginParseException

Create a condition for when this web fragment should be displayed

Parameters:

element - Element of web-section or web-item

type - logical operator type

Throws:

com.atlassian.plugin.PluginParseException

makeConditions

protected Condition makeConditions(List elements,
                                   int type)
                            throws com.atlassian.plugin.PluginParseException

Throws:

com.atlassian.plugin.PluginParseException

makeCondition

protected Condition makeCondition(org.dom4j.Element element)
                           throws com.atlassian.plugin.PluginParseException

Throws:

com.atlassian.plugin.PluginParseException

makeContextProvider

protected ContextProvider makeContextProvider(org.dom4j.Element element)
                                       throws com.atlassian.plugin.PluginParseException

Throws:

com.atlassian.plugin.PluginParseException

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>

getWeight

public int getWeight()

Specified by:

getWeight in interface WebFragmentModuleDescriptor<T>

Specified by:

getWeight in interface WeightedDescriptor

getWebLabel

public WebLabel getWebLabel()

Specified by:

getWebLabel in interface WebFragmentModuleDescriptor<T>

getTooltip

public WebLabel getTooltip()

Specified by:

getTooltip in interface WebFragmentModuleDescriptor<T>

setWebInterfaceManager

public void setWebInterfaceManager(WebInterfaceManager webInterfaceManager)

getCondition

public Condition getCondition()

Specified by:

getCondition in interface ConditionalDescriptor

Specified by:

getCondition in interface WebFragmentModuleDescriptor<T>

getContextProvider

public ContextProvider getContextProvider()

Description copied from interface: ContextAware

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

Specified by:

getContextProvider in interface ContextAware

getWebParams

public WebParam getWebParams()

Specified by:

getWebParams in interface WebFragmentModuleDescriptor<T>

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.atlassian.plugin.ModuleDescriptor<T>

Overrides:

equals in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>

hashCode

public int hashCode()

Specified by:

hashCode in interface com.atlassian.plugin.ModuleDescriptor<T>

Overrides:

hashCode in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>