WebPanelModuleDescriptor

Class Overview

The web panel module declares a single web panel in atlassian-plugin.xml. Its XML element contains a location string that should match existing locations in the host application where web panels can be embedded.

The descriptor specifies a resource or class that renders HTML given a context map, and may specify a ContextProvider that augments the context with custom properties.

Summary

[Expand] Inherited Constants
From interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor int COMPOSITE_TYPE_AND This constant is deprecated. As of 2.5.0, use AND int COMPOSITE_TYPE_OR This constant is deprecated. As of 2.5.0, use OR

[Expand] Inherited Methods
From interface com.atlassian.plugin.ModuleDescriptor abstract void destroy(Plugin plugin) Override this if your plugin needs to clean up when it's been removed. abstract boolean equals(Object obj) Compares the specified object with this module descriptor for equality. abstract String getCompleteKey() The complete key for this module, including the plugin key. abstract String getDescription() A simple description of this descriptor. abstract String getDescriptionKey() Key used to override getDescription() when using internationalisation. abstract String getI18nNameKey() Key used to override getName() when using internationalisation. abstract String getKey() The key for this module, unique within the plugin. abstract Float getMinJavaVersion() abstract T getModule() The particular module object created by this plugin. abstract Class<T> getModuleClass() The class of the module this descriptor creates. abstract String getName() A simple string name for this descriptor. abstract Map<String, String> getParams() abstract Plugin getPlugin() abstract String getPluginKey() The plugin key for this module, derived from the complete key. abstract int hashCode() Returns the hash code value for this module descriptor. abstract void init(Plugin plugin, Element element) Initialise a module given it's parent plugin and the XML element representing the module. abstract boolean isEnabledByDefault() Whether or not this plugin module is enabled by default. abstract boolean isSystemModule() Whether or not this plugin module is a "system" plugin that shouldn't be made visible/disableable to the user. abstract boolean satisfiesMinJavaVersion() If a min java version has been specified this will return true if the running jvm is >= to the specified version.
From interface com.atlassian.plugin.Resourced abstract ResourceDescriptor getResourceDescriptor(String type, String name) Get a ResourceDescriptor of a particular type and name. abstract List<ResourceDescriptor> getResourceDescriptors(String type) This method is deprecated. since 2.5.0 use getResourceDescriptors() and filter as required abstract List<ResourceDescriptor> getResourceDescriptors() Get a List of all the descriptors . abstract ResourceLocation getResourceLocation(String type, String name) Get a ResourceLocation of a particular type and name.
From interface com.atlassian.plugin.StateAware abstract void disabled() Called by the plugin manager when the plugin or module is deactivated. abstract void enabled() Called by the plugin manager when a plugin or module is activated.
From interface com.atlassian.plugin.web.descriptors.ConditionalDescriptor abstract Condition getCondition()
From interface com.atlassian.plugin.web.descriptors.ContextAware abstract ContextProvider getContextProvider() Returns the ContextProvider that augments the context used to render a web module.
From interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor abstract Condition getCondition() abstract WebLabel getTooltip() abstract WebLabel getWebLabel() abstract WebParam getWebParams() abstract int getWeight()
From interface com.atlassian.plugin.web.descriptors.WeightedDescriptor abstract int getWeight()