Package 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.api.descriptors.ConditionalDescriptor, com.atlassian.plugin.web.api.descriptors.ContextAware, com.atlassian.plugin.web.api.descriptors.WebFragmentModuleDescriptor<Void>, com.atlassian.plugin.web.api.descriptors.WebSectionModuleDescriptor, com.atlassian.plugin.web.api.descriptors.WeightedDescriptor, com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor<Void>, com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor
public class ConfluenceWebSectionModuleDescriptor extends ConfluenceAbstractWebFragmentModuleDescriptor implements com.atlassian.plugin.web.api.descriptors.WebSectionModuleDescriptor, com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfluenceWebSectionModuleDescriptor()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getLocation()
     
    boolean
    hideSingleWebItem()
     
    void
    init(@NonNull com.atlassian.plugin.Plugin plugin, @NonNull com.atlassian.plugin.module.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, 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.api.descriptors.ContextAware

    getContextProvider

    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.Resourced

    getResourceDescriptor, getResourceDescriptors, getResourceLocation

    Methods inherited from interface com.atlassian.plugin.ScopeAware

    getScopeKey

    Methods inherited from interface com.atlassian.plugin.StateAware

    disabled, enabled

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

    getCondition, getWeight

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

    getTooltip, getWebLabel

  • Constructor Details

    • ConfluenceWebSectionModuleDescriptor

      public ConfluenceWebSectionModuleDescriptor()

  • Method Details

    • init

      public void init(@NonNull com.atlassian.plugin.Plugin plugin, @NonNull com.atlassian.plugin.module.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.api.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