DefaultWebPanelModuleDescriptor

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.

A web panel also contains a single resource child element that contains the contents of the web panel. This can be plain HTML, or a (velocity) template to provide dynamic content.

A resource element's type attribute identifies the format of the panel's content (currently "static" and "velocity" are supported) which allows the plugin framework to use the appropriate WebPanelRenderer.

A web panel's resource element can either contain its contents embedded in the resource element itself, as part of the atlassian-plugin.xml file, or it can link to a file on the classpath when the location attribute is used.

A web panel that contains static, embedded HTML:

     <web-panel key="myPanel" location="general">
         <resource name="view" type="static"><![CDATA[<b>Hello World!</b>]]></resource>
     </web-panel>
 

A web panel that contains an embedded velocity template:

     <web-panel key="myPanel" location="general">
         <resource name="view" type="velocity"><![CDATA[#set($name = 'foo')My name is $name]]></resource>
     </web-panel>
 

A web panel that contains uses a velocity template that is on the classpath (part of the plugin's jar file):

     <web-panel key="myPanel" location="general">
         <resource name="view" type="velocity" location="templates/pie.vm"/>
     </web-panel>
 

Finally it is also possible to provide your own custom class that is responsible for producing the panel's HTML, by using the descriptor's class attribute:

     <web-panel key="myPanel" location="general" class="com.example.FooWebPanel"/>
 

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 Fields
From class com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor protected Condition condition protected ContextProvider contextProvider protected Element element protected DefaultWebLabel label protected WebParam params protected DefaultWebLabel tooltip protected WebInterfaceManager webInterfaceManager protected int weight
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor protected Class<T> moduleClass protected String moduleClassName protected final ModuleFactory moduleFactory protected Plugin plugin protected Resources resources protected boolean singleton This field is deprecated. since 2.2.0

[Expand] Inherited Methods
From class com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor void disabled() Disables the module descriptor. void enabled() Enables the descriptor by loading the module class. 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(Plugin plugin, Element element) Initialise a module given it's parent plugin and the XML element representing the module. Condition makeCondition(Element element) Condition makeConditions(List elements, int type) Condition makeConditions(Element element, int type) Create a condition for when this web fragment should be displayed ContextProvider makeContextProvider(Element element) void setWebInterfaceManager(WebInterfaceManager webInterfaceManager)
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor final void assertModuleClassImplements(Class<T> requiredModuleClazz) Check that the module class of this descriptor implements a given interface, or extends a given class. void destroy(Plugin plugin) Override this if your plugin needs to clean up when it's been removed. void disabled() Disables the module descriptor. void enabled() Enables the descriptor by loading the module class. boolean equals(Object obj) String getCompleteKey() The complete key for this module, including the plugin key. String getDescription() A simple description of this descriptor. String getDescriptionKey() Key used to override getDescription() when using internationalisation. String getI18nNameKey() Key used to override getName() when using internationalisation. String getKey() The key for this module, unique within the plugin. Float getMinJavaVersion() abstract T getModule() The particular module object created by this plugin. Class<T> getModuleClass() The class of the module this descriptor creates. String getName() A simple string name for this descriptor. Map<String, String> getParams() Plugin getPlugin() String getPluginKey() The plugin key for this module, derived from the complete key. ResourceDescriptor getResourceDescriptor(String type, String name) Get a ResourceDescriptor of a particular type and name. List<ResourceDescriptor> getResourceDescriptors() Get a List of all the descriptors . List<ResourceDescriptor> getResourceDescriptors(String type) Get a list of all descriptors of a particular type. ResourceLocation getResourceLocation(String type, String name) Get a ResourceLocation of a particular type and name. int hashCode() void init(Plugin plugin, Element element) Initialise a module given it's parent plugin and the XML element representing the module. boolean isEnabledByDefault() Whether or not this plugin module is enabled by default. @Deprecated boolean isSingleton() This method is deprecated. Since 2.2.0 @Deprecated boolean isSingletonByDefault() This method is deprecated. Since 2.2.0 boolean isSystemModule() Whether or not this plugin module is a "system" plugin that shouldn't be made visible/disableable to the user. void loadClass(Plugin plugin, String clazz) Loads the module class that this descriptor provides, and will not necessarily be the implementation class. @Deprecated void loadClass(Plugin plugin, Element element) This method is deprecated. Since 2.1.0, use loadClass(Plugin, String) instead void provideValidationRules(ValidationPattern pattern) Provides validation rules for the pattern boolean satisfiesMinJavaVersion() If a min java version has been specified this will return true if the running jvm is >= to the specified version. void setPlugin(Plugin plugin) Sets the plugin for the ModuleDescriptor String toString()
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface com.atlassian.plugin.ModuleDescriptor void destroy(Plugin plugin) Override this if your plugin needs to clean up when it's been removed. boolean equals(Object obj) Compares the specified object with this module descriptor for equality. String getCompleteKey() The complete key for this module, including the plugin key. String getDescription() A simple description of this descriptor. String getDescriptionKey() Key used to override getDescription() when using internationalisation. String getI18nNameKey() Key used to override getName() when using internationalisation. String getKey() The key for this module, unique within the plugin. Float getMinJavaVersion() T getModule() The particular module object created by this plugin. Class<T> getModuleClass() The class of the module this descriptor creates. String getName() A simple string name for this descriptor. Map<String, String> getParams() Plugin getPlugin() String getPluginKey() The plugin key for this module, derived from the complete key. int hashCode() Returns the hash code value for this module descriptor. void init(Plugin plugin, Element element) Initialise a module given it's parent plugin and the XML element representing the module. boolean isEnabledByDefault() Whether or not this plugin module is enabled by default. boolean isSystemModule() Whether or not this plugin module is a "system" plugin that shouldn't be made visible/disableable to the user. 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 ResourceDescriptor getResourceDescriptor(String type, String name) Get a ResourceDescriptor of a particular type and name. @Deprecated List<ResourceDescriptor> getResourceDescriptors(String type) This method is deprecated. since 2.5.0 use getResourceDescriptors() and filter as required List<ResourceDescriptor> getResourceDescriptors() Get a List of all the descriptors . ResourceLocation getResourceLocation(String type, String name) Get a ResourceLocation of a particular type and name.
From interface com.atlassian.plugin.StateAware void disabled() Called by the plugin manager when the plugin or module is deactivated. void enabled() Called by the plugin manager when a plugin or module is activated.
From interface com.atlassian.plugin.web.descriptors.ConditionalDescriptor Condition getCondition()
From interface com.atlassian.plugin.web.descriptors.ContextAware ContextProvider getContextProvider() Returns the ContextProvider that augments the context used to render a web module.
From interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor Condition getCondition() WebLabel getTooltip() WebLabel getWebLabel() WebParam getWebParams() int getWeight()
From interface com.atlassian.plugin.web.descriptors.WebPanelModuleDescriptor String getLocation() Returns the location in the host application where the web panel should be embedded.
From interface com.atlassian.plugin.web.descriptors.WeightedDescriptor int getWeight()