1 package com.atlassian.plugin.web.model;
2
3 import java.util.Map;
4
5 /**
6 * The module that is responsive for providing the raw content for a Web Panel.
7 * Whatever is returned by {@link #getHtml(java.util.Map)} is inserted into the
8 * host application's page, so it has to be valid HTML.
9 *
10 * @see com.atlassian.plugin.web.descriptors.DefaultWebPanelModuleDescriptor#getModule()
11 * @since 2.5.0
12 */
13 public interface WebPanel
14 {
15 /**
16 * Returns the HTML that will be placed in the host application's page.
17 *
18 * @param context the contextual information that can be used during
19 * rendering. Context elements are not standardized and are
20 * application-specific, so refer to your application's documentation to
21 * learn what is available.
22 * @return the HTML that will be placed in the host application's page.
23 */
24 String getHtml(Map<String, Object> context);
25 }