Skip to end of metadata
Go to start of metadata

Available:

Web Panel plugin modules are available in JIRA 4.4 and later.

Purpose of this Module Type

Web Panel plugin modules allow plugins to define panels, or sections, on an HTML page. A panel is a set of HTML that will be inserted into a page.

Configuration

The root element for the Web Panel plugin module is web-panel. It allows the following attributes and child elements for configuration:

Attributes

Name

Required

Description

Default

class

 

The class which implements this plugin module and which is responsible for providing the web panel's HTML. In most cases you will not need to provide a custom class to generate the content, as you can simply point to a static HTML file or a (Velocity) template. See the plugin framework guide to creating plugin module instances. If you omit this attribute, you MUST provide a resource element and vice versa, to ensure there is always exactly one source for the web panel's content.

 

state

 

Indicate whether the plugin module should be disabled by default (value='disabled') or enabled by default (value='enabled').

enabled

i18n-name-key

 

The localisation key for the human-readable name of the plugin module.

 

key

(tick)

The unique identifier of the plugin module. You refer to this key to use the resource from other contexts in your plugin, such as from the plugin Java code or JavaScript resources.
<component-import key="appProps" interface="com.atlassian.sal.api.ApplicationProperties"/>

In the example, appProps is the key for this particular module declaration, for component-import, in this case.

N/A

name

 

The human-readable name of the plugin module. Used only in the plugin's administrative user interface.

 

system

 

Indicates whether this plugin module is a system plugin module (value='true') or not (value='false'). Only available for non-OSGi plugins.

false

weight

 

Determines the order in which web panels appear. Web panels are displayed top to bottom or left to right in order of ascending weight. The 'lightest' weight is displayed first, the 'heaviest' weights sink to the bottom. The weights for most applications' system sections start from 100, and the weights for the links generally start from 10. The weight is incremented by 10 for each in sequence so that there is ample space to insert your own panels.

1000

location

(tick)

The location in the host application where the web panel must be rendered. Note that every host application declares its own set of web panel plugin points. Currently a web panel can only be associated with a single location.

 

Elements

The table summarises the elements. The sections below contain further information.

Name

Required

Description

Default

condition

 

Defines a condition that must be satisfied for the web panel to be displayed. If you want to 'invert' a condition, add an attribute 'invert="true"' to it. The web item will then be displayed if the condition returns false (not true).

N/A

conditions

 

Defines the logical operator type to evaluate its condition elements. By default 'AND' will be used.

AND

context-provider

 

Allows dynamic addition to the Velocity context available for various web panel elements (in XML descriptors only). Currently only one context-provider can be specified per web panel.

 

label

(tick)

Is the i18n key that will be used to look up the textual representation of the link.

N/A

param

 

Parameters for the plugin module. Use the 'key' attribute to declare the parameter key, then specify the value in either the 'value' attribute or the element body. This element may be repeated. An example is the configuration link described in Adding a Configuration UI for your Plugin. This is handy if you want to use additional custom values from the UI.

N/A

description

 

The description of the plugin module. The 'key' attribute can be specified to declare a localisation key for the value instead of text in the element body. I.e. the description of the web panel.

 

resource

 

A resource element is used to provide a web panel with content. It can be used in a way similar to normal resources, using the resource's location attribute to point to a static HTML file or (Velocity) template file that is provided by the plugin's JAR file. To differentiate between static HTML and Velocity templates that need to be rendered, always specify the type attribute. See the examples further down on this page. It is also possible to embed the contents (both static HTML or velocity) directly in the atlassian-plugin.xml file by encoding it in the resource element's body and then omitting the location attribute. Note that if you omit the resource element you MUST provide the module descriptor's class attribute, and vice versa, to ensure there is always exactly one source for the web panel's content.

N/A

Condition and Conditions Elements

Conditions can be added to the web section, web item and web panel modules, to display them only when all the given conditions are true.

Condition elements must contain a class attribute with the fully-qualified name of a Java class. The referenced class:

  • must implement com.atlassian.plugin.web.Condition, and
  • will be auto-wired by Spring before any condition checks are performed.

Condition elements can take optional parameters. These parameters will be passed in to the condition's init() method as a map of string key/value pairs after autowiring, but before any condition checks are performed. For example:

(info) In versions before JIRA 3.7, this class is called com.atlassian.jira.plugin.web.conditions.JiraGlobalPermissionCondition

To invert a condition, add the attribute 'invert="true"' to the condition element. This is useful where you want to show the section if a certain condition is not satisfied.
Conditions elements are composed of a collection of condition/conditions elements and a type attribute. The type attribute defines what logical operator is used to evaluate its collection of condition elements. The type can be one of AND or OR.

For example: The following condition is true if the current user is a system administrator OR a project administrator:

(info) In versions before JIRA 3.7, the second class is called com.atlassian.jira.plugin.web.conditions.UserHasProjectsCondition

Context-provider Element

Available:

Atlassian Plugins 2.5, Confluence 2.5, Bamboo 3.0, JIRA 4.2 and later

The context-provider element adds to the Velocity context available to the web section and web item modules. You can add what you need to the context, to build more flexible section and item elements. Currently only one context-provider can be specified per module. Additional context-providers are ignored.

The context-provider element must contain a class attribute with the fully-qualified name of a Java class. The referenced class:

  • must implement com.atlassian.plugin.web.ContextProvider, and
  • will be auto-wired by Spring before any additions to the Velocity context.

For example, the following context-provider will add historyWindowHeight and filtersWindowHeight to the context.

In the following example, HeightContextProvider extends AbstractJiraContextProvider, which is only available in JIRA and happens to implement ContextProvider. The AbstractJiraContextProvider conveniently extracts the User and JiraHelper from the context map, which you would otherwise have to do manually.

The above HeightContextProvider can be used by nesting the following element in a web item module.

The newly added context entries historyWindowHeight and filtersWindowHeight can be used in the XML module descriptors just like normal velocity context variables, by prefixing them with the dollar symbol ($):

Label Elements

Label elements may contain optional parameters, as shown below:

  • The parameters allow you to insert values into the label using Java's MessageFormat syntax.
  • Parameter names must start with param and will be mapped in alphabetical order to the substitutions in the format string. I.e. param0 is {0}, param1 is {1}, param2 is {2}, etc.
  • Parameter values are rendered using Velocity, allowing you to include dynamic content.

Param Elements

Param elements represent a map of key/value pairs, where each entry corresponds to the param elements attribute: name and value respectively.

The value can be retrieved from within the Velocity view with the following code, where $item is a WebItemModuleDescriptor:

If the value attribute is not specified, the value will be set to the body of the element. I.e. the following two param elements are equivalent:

Resource Element

Unless the module descriptor's class attribute is specified, a web panel will contain 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 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 resource element's type attribute identifies the format of the panel's content (currently "static" and "velocity" are provided by Atlassian Plugin Framework 2.5.0 and atlassian-template-renderer 2.5.0 respectively) which allows the plugin framework to use the appropriate com.atlassian.plugin.web.renderer.WebPanelRenderer.

Type

Description

static

Used to indicate that the web panel's contents must not be processed, but included in the page as is.

velocity

Used to indicate that the web panel contains Velocity markup that needs to be parsed.

The template rendering system is extensible. You can add custom renderers by creating plugins. For more information on this, check out the Web Panel Renderer Plugin Module.

Web Panel Examples

(info) The values of the location attributes in the examples below are not real. They are just illustrative of the kind of location that Confluence, Bamboo and FishEye make available.

A web panel that contains static, embedded HTML:

A web panel that contains an embedded Velocity template:

A web panel containing a Velocity template that is on the classpath (part of the plugin's JAR file):

As mentioned previously, 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 (which makes the resource element redundant):

Note that com.example.FooWebPanel MUST implement WebPanel.

Useful hints

If you use web-panel to hook into view issue screen, then param with name=containerClass is really handy. It allows to add any CSS class to the enclosing div element (e.g. to make it initially hidden). The following code illustrates it:

See Also

  • Web Fragments — This reference guide describes how to combine Web Items, Web Sections and Web Panels together to generate links, sections of links and panels at specific locations of the JIRA user interface.
  • No labels

1 Comment

  1. Anonymous

    Please document the differen available webpanel locations in jira amd the meaning of the label element in web-panel.