Portlet Plugin Module

Added by Mike Cannon-Brookes, last edited by Jonathan Nolen on Sep 20, 2005  (view change)
JIRA Documentation

Index

A portlet plugin module defines a portlet that users can add to their Dashboards.

The properties that it can take are the same as the report plugin module above.

Here is a sample portlet module descriptor element:

<!--
The module class must implement
com.atlassian.jira.portal.Portlet
and will usually extend:
com.atlassian.jira.portal.PortletImpl
-->
<portlet key="assignedtome" name="Assigned Issues" 
    class="com.atlassian.jira.portal.portlets.AssignedToMePortlet">
    <description key="portlet.assignedtome.description">i18n description</description>
    <!-- this template produces the eventual HTML of the portlet -->
    <resource type="velocity" name="view" 
    location="templates/plugins/jira/portlets/assignedtome.vm" />
    <label key="portlet.assignedtome.name" />
    <!-- an optional thumbmail image used to preview the portlet for users -->
    <thumbnail>portlets/dashboard/thumbnails/assigned.gif</thumbnail>
    <!-- the permissions required to add this portlet 
    (optional - not often required) -->
    <permission>assignable</permission>
    <objectdescriptor key="portlet.assignedtome.display.name" />
    <!-- same as the properties of the report plugin module -->
    <properties>
        <property>
            <key>numofentries</key>
            <name>portlet.assignedtome.field.numofentries.name</name>
            <description>
            portlet.assignedtome.field.numofentries.description
            </description>
            <type>long</type>
            <default>10</default>
        </property>
    </properties>
</portlet>

For more details, see the How to create a JIRA Portlet.

Labels:

Enter labels to add to this page:
Wait Image 
Looking for a label? Just start typing.