com.atlassian.confluence.plugin.descriptor.web.descriptors

Class ConfluenceWebSectionModuleDescriptor

java.lang.Object

com.atlassian.plugin.web.descriptors.DefaultAbstractWebFragmentModuleDescriptor<Void>

com.atlassian.confluence.plugin.descriptor.web.descriptors.ConfluenceAbstractWebFragmentModuleDescriptor

com.atlassian.confluence.plugin.descriptor.web.descriptors.ConfluenceWebSectionModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor<Void>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware, com.atlassian.plugin.web.descriptors.ConditionalDescriptor, com.atlassian.plugin.web.descriptors.ContextAware, com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor<Void>, com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor, com.atlassian.plugin.web.descriptors.WeightedDescriptor

public class ConfluenceWebSectionModuleDescriptor
extends ConfluenceAbstractWebFragmentModuleDescriptor
implements com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor

Constructor Summary

Constructors

Constructor and Description
ConfluenceWebSectionModuleDescriptor()

Method Summary

Modifier and Type	Method and Description
String	getLocation()
boolean	hideSingleWebItem()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)

Methods inherited from class com.atlassian.confluence.plugin.descriptor.web.descriptors.ConfluenceAbstractWebFragmentModuleDescriptor

disabled, enabled, equals, getLabel, getTooltip, getWebLabel, hashCode

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

destroy, getCompleteKey, getCondition, getContextProvider, getDecoratedDescriptor, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getWebParams, getWeight, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setWebInterfaceManager, 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, equals, getCompleteKey, getDescription, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

Methods inherited from interface com.atlassian.plugin.ScopeAware

getScopeKey

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceLocation

Methods inherited from interface com.atlassian.plugin.StateAware

disabled, enabled

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

getContextProvider

Constructor Detail

ConfluenceWebSectionModuleDescriptor

public ConfluenceWebSectionModuleDescriptor()

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 com.atlassian.plugin.web.descriptors.DefaultAbstractWebFragmentModuleDescriptor<Void>

Throws:

com.atlassian.plugin.PluginParseException

getLocation

public String getLocation()

Specified by:

getLocation in interface com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor

hideSingleWebItem

public boolean hideSingleWebItem()

Returns:

true if second level navigation should be hidden if a section has just one web-item

Since:

7.5