1 package com.atlassian.plugin.web.descriptors;
2
3 import com.atlassian.plugin.ModuleDescriptor;
4 import com.atlassian.plugin.StateAware;
5 import com.atlassian.plugin.web.ContextProvider;
6 import com.atlassian.plugin.web.model.WebPanel;
7
8 /**
9 * <p>
10 * The web panel module declares a single web panel in atlassian-plugin.xml. Its
11 * XML element contains a location string that should match existing locations
12 * in the host application where web panels can be embedded.
13 * </p>
14 * <p>
15 * The descriptor specifies a resource or class that renders HTML given a context map,
16 * and may specify a {@link ContextProvider} that augments the context with custom
17 * properties.
18 * </p>
19 *
20 * @since 2.6.0
21 */
22 public interface WebPanelModuleDescriptor extends WebFragmentModuleDescriptor<WebPanel>, WeightedDescriptor
23 {
24 /**
25 * Returns the location in the host application where the web panel should be embedded.
26 */
27 String getLocation();
28 }