com.atlassian.plugin.web.descriptors
Interface WebPanelModuleDescriptor

All Superinterfaces:

ConditionalDescriptor, ContextAware, ModuleDescriptor<WebPanel>, Resourced, StateAware, WebFragmentModuleDescriptor<WebPanel>, WeightedDescriptor

All Known Implementing Classes:

DefaultWebPanelModuleDescriptor

public interface WebPanelModuleDescriptor
extends WebFragmentModuleDescriptor<WebPanel>, WeightedDescriptor

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.

Since:

2.6.0

Field Summary

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

COMPOSITE_TYPE_AND, COMPOSITE_TYPE_OR

Method Summary

String

getLocation() Returns the location in the host application where the web panel should be embedded.

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, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, init, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation

Methods inherited from interface com.atlassian.plugin.StateAware

disabled, enabled

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

getContextProvider

Method Detail

getLocation

String getLocation()

Returns the location in the host application where the web panel should be embedded.