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

Class ConfluenceWebItemModuleDescriptor

java.lang.Object
com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>
com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor<Void>
com.atlassian.plugin.web.descriptors.DefaultWebItemModuleDescriptor
com.atlassian.confluence.plugin.descriptor.web.descriptors.ConfluenceWebItemModuleDescriptor
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.WebItemModuleDescriptor, com.atlassian.plugin.web.api.descriptors.WeightedDescriptor, com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor<Void>, com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor
public class ConfluenceWebItemModuleDescriptor extends com.atlassian.plugin.web.descriptors.DefaultWebItemModuleDescriptor
Confluence specific extension for DefaultWebItemModuleDescriptor. It provides Confluence specific implementations for the link, icon, label and tooltip.

  • Field Summary

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

    condition, contextProvider, label, tooltip, webInterfaceManager, weight

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

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfluenceWebItemModuleDescriptor()
     
    ConfluenceWebItemModuleDescriptor(com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager)
     

  • Method Summary

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

    enabled, getEntryPoint, getModule, getSection, getStyleClass, init

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

    buildCondition, buildConditions, buildConditions, buildContextProvider, disabled, equals, getCondition, getContextProvider, getWeight, hashCode, setWebInterfaceManager

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

    assertModuleClassImplements, checkPermissions, destroy, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, satisfiesMinJavaVersion, setBroken, setPlugin, validate

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

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

    getCondition, getWeight

  • Constructor Details

    • ConfluenceWebItemModuleDescriptor

      public ConfluenceWebItemModuleDescriptor()

    • ConfluenceWebItemModuleDescriptor

      public ConfluenceWebItemModuleDescriptor(com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager)

  • Method Details

    • getLink

      public ConfluenceWebLink getLink()
      Specified by:
      getLink in interface com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor
      Overrides:
      getLink in class com.atlassian.plugin.web.descriptors.DefaultWebItemModuleDescriptor

    • getIcon

      public ConfluenceWebIcon getIcon()
      Specified by:
      getIcon in interface com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor
      Overrides:
      getIcon in class com.atlassian.plugin.web.descriptors.DefaultWebItemModuleDescriptor

    • getWebLabel

      public ConfluenceWebLabel getWebLabel()
      Specified by:
      getWebLabel in interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor<Void>
      Overrides:
      getWebLabel in class com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor<Void>

    • getTooltip

      public ConfluenceWebLabel getTooltip()
      Specified by:
      getTooltip in interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor<Void>
      Overrides:
      getTooltip in class com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor<Void>

    • getLabel

      public ConfluenceWebLabel getLabel()

    • toString

      public String toString()
      Overrides:
      toString in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

    • getRenderedParam

      public String getRenderedParam(String paramKey, Map<String,Object> context)